scanclient 0.1.0

High-performance, observable HTTP client for Santh security scanners
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

# scanclient — HTTP client tuned for security scanning

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Tests](https://img.shields.io/badge/tests-13%20passing-brightgreen.svg)](https://img.shields.io/badge/tests-13%20passing-brightgreen.svg) [![Crates.io](https://img.shields.io/crates/v/scanclient.svg)](https://crates.io/crates/scanclient)

## Why
Security scanners perform huge numbers of HTTP requests under strict resource constraints and retry semantics. `scanclient` gives one production-oriented client with timeout, retry, proxy, rate limiting, and request observability baked into the crate.

It wraps `reqwest` but keeps a small, scan-specific API focused on scan workloads: easy defaults, bounded retries, response helpers, and typed errors.

## Quick Start
```rust
use scanclient::{HttpConfig, ScanClient};

#[tokio::main]
async fn main() -> scanclient::Result<()> {
    let mut config = HttpConfig::default();
    config.timeout_secs = 5;
    config.max_retries = 2;

    let client = ScanClient::from_config(config)?;
    let response = client.get("https://example.com").await?;

    println!("status={}", response.status());
    if let Ok(body) = response.body_text() {
        println!("len={}", body.len());
    }
    Ok(())
}
```

## Features
- Thin `ScanClient` API (`get`, `head`, `post`, `request`, `execute`).
- Configurable retries with exponential backoff and idempotent status retry policy.
- Optional rate limiting and proxy support.
- Request/response helpers (`body_text`, `contains`, header lookup).
- TOML load/parse for client configuration.

## TOML Configuration
Use `HttpConfig::from_toml` or `HttpConfig::load`.

```toml
timeout_secs = 10
max_retries = 3
retry_delay_ms = 250
max_redirects = 5
user_agent = "SanthScanner/1.0"
tls_verify = false
rate_limit_per_sec = 8

[custom_headers]
X-Scanner = "santh"
```

```rust
use scanclient::{HttpConfig, ScanClient};

let cfg = HttpConfig::from_toml(r#"timeout_secs=12\nrate_limit_per_sec=5\n"#).unwrap();
let _client = ScanClient::from_config(cfg);
```

## API Overview
- `HttpConfig`: configuration model.
- `ScanClient::from_config`: create client.
- `ScanClient::get`, `head`, `post`, `request`, `execute`.
- `ScanResponse`: typed response wrapper (`status`, `headers`, `body_*`, `contains`).
- `Error`, `Result`: crate-level error handling.

## Examples
### 1) Submit a POST and inspect response
```rust
use scanclient::{HttpConfig, ScanClient};

#[tokio::main]
async fn main() -> scanclient::Result<()> {
    let client = ScanClient::from_config(HttpConfig::default())?;
    let response = client.post("https://httpbin.org/post", "a=b&c=d").await?;

    println!("status={} contains=a={}", response.status(), response.contains("args"));
    Ok(())
}
```

### 2) Reuse a custom request with method + execute
```rust
use reqwest::Method;
use scanclient::{HttpConfig, ScanClient};

#[tokio::main]
async fn main() -> scanclient::Result<()> {
    let client = ScanClient::from_config(HttpConfig::default())?;
    let builder = client.request(Method::HEAD, "https://example.com");
    let response = client.execute(builder).await?;
    println!("ok={}", response.status().is_success());
    Ok(())
}
```

### 3) Load settings from TOML in scanner bootstrap
```rust
use scanclient::HttpConfig;

let cfg = HttpConfig::from_toml(r#"
user_agent = "MyScanner/2.0"
timeout_secs = 8
max_redirects = 2
"#).unwrap();
println!("ua={}", cfg.user_agent);
```

## Traits
`scanclient` does not define custom traits in the public API.

## Related Crates
- [secreport](https://docs.rs/secreport)
- [multimatch](https://docs.rs/multimatch)
- [scanstate](https://docs.rs/scanstate)

## License
MIT, Corum Collective LLC

Docs: https://docs.rs/scanclient

Santh ecosystem: https://santh.io