crawlberg 1.0.1

High-performance web crawling engine
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321

//! Unit tests for the WAF module.

#![cfg(test)]

use std::collections::HashMap;

use crate::http::HttpResponse;
use crate::types::WafClassifier;
use crate::waf::rules::{MAX_FINGERPRINTS, MAX_PATTERN_LEN, MAX_SIGNALS_PER_FINGERPRINT, Rules};
use crate::waf::{TomlClassifier, load_from_str};

fn make_response(status: u16, headers: Vec<(&str, &str)>, body: &str) -> HttpResponse {
    let mut header_map: HashMap<String, Vec<String>> = HashMap::new();
    for (k, v) in headers {
        header_map.entry(k.to_lowercase()).or_default().push(v.to_string());
    }
    let body_bytes = body.as_bytes().to_vec();
    HttpResponse {
        status,
        content_type: "text/html".into(),
        body: body.to_string(),
        body_bytes,
        headers: header_map,
        browser_extras: None,
        final_url: "https://example.com/".into(),
    }
}

// ---------------------------------------------------------------------------
// Builtin corpus sanity checks
// ---------------------------------------------------------------------------

#[test]
fn classifier_cloudflare_challenge_detected() {
    let c = TomlClassifier::builtin();
    let resp = make_response(
        403,
        vec![("server", "cloudflare")],
        "<html><script src='/cdn-cgi/challenge-platform/h/g/orchestrate/v1'></script></html>",
    );
    let signal = c.classify(&resp).expect("classify must not fail");
    assert!(signal.is_some(), "cloudflare challenge must be detected");
    assert_eq!(signal.expect("signal is Some — asserted above").vendor, "cloudflare");
}

#[test]
fn classifier_datadome_header_detected() {
    let c = TomlClassifier::builtin();
    let resp = make_response(200, vec![("x-datadome", "blocked")], "<html>ok</html>");
    let signal = c.classify(&resp).expect("classify must not fail");
    assert!(signal.is_some(), "datadome x-datadome header must be detected");
    assert_eq!(signal.expect("signal is Some — asserted above").vendor, "datadome");
}

#[test]
fn classifier_perimeterx_header_detected() {
    let c = TomlClassifier::builtin();
    let resp = make_response(200, vec![("x-px-block", "1")], "<html>ok</html>");
    let signal = c.classify(&resp).expect("classify must not fail");
    // x-px-block header → perimeterx_header fingerprint via headers_only check
    // The TOML fingerprint checks for name="x-px-block" specifically;
    // the prefix-match for x-px-* is handled in header_matches via the "x-px-" sentinel.
    assert!(signal.is_some(), "perimeterx x-px-* header must be detected");
    assert_eq!(signal.expect("signal is Some — asserted above").vendor, "perimeterx");
}

#[test]
fn classifier_imperva_incap_ses_detected() {
    let c = TomlClassifier::builtin();
    let resp = make_response(403, vec![], "<html>_incap_ses_xyz_123</html>");
    let signal = c.classify(&resp).expect("classify must not fail");
    assert!(signal.is_some(), "imperva _incap_ses_ must be detected");
    assert_eq!(signal.expect("signal is Some — asserted above").vendor, "imperva");
}

#[test]
fn classifier_aws_waf_action_header() {
    let c = TomlClassifier::builtin();
    let resp = make_response(403, vec![("x-amzn-waf-action", "block")], "<html>blocked</html>");
    let signal = c.classify(&resp).expect("classify must not fail");
    assert!(signal.is_some(), "aws waf action header must be detected");
    assert_eq!(signal.expect("signal is Some — asserted above").vendor, "aws-waf");
}

#[test]
fn classifier_akamai_server_header() {
    let c = TomlClassifier::builtin();
    let resp = make_response(403, vec![("server", "AkamaiGHost")], "<html>Access Denied</html>");
    let signal = c.classify(&resp).expect("classify must not fail");
    assert!(signal.is_some(), "akamai server header must be detected");
    assert_eq!(signal.expect("signal is Some — asserted above").vendor, "akamai");
}

#[test]
fn classifier_large_2xx_not_flagged() {
    let c = TomlClassifier::builtin();
    // Build body > 100KB mentioning cloudflare but no JS challenge tokens.
    let mut body = String::from("<html><body><h1>About Cloudflare</h1>");
    body.push_str(&"<p>Lorem ipsum dolor sit amet.</p>".repeat(5000));
    body.push_str("</body></html>");
    assert!(body.len() > 100 * 1024, "body must exceed CHALLENGE_BODY_LIMIT");

    let resp = make_response(200, vec![("server", "nginx")], &body);
    assert!(
        c.classify(&resp).expect("classify must not fail").is_none(),
        "large 2xx body mentioning vendor names must not be classified as WAF block"
    );
}

#[test]
fn classifier_benign_small_page_not_flagged() {
    let c = TomlClassifier::builtin();
    let body = "<html><head><title>Welcome</title></head><body><p>Hello world</p></body></html>";
    let resp = make_response(200, vec![], body);
    assert!(
        c.classify(&resp).expect("classify must not fail").is_none(),
        "small benign page must not be classified as WAF block"
    );
}

#[test]
fn classifier_datadome_captcha_delivery() {
    let c = TomlClassifier::builtin();
    let body = "<html><script>var dd={'host':'geo.captcha-delivery.com'}</script>\
                <script src='https://ct.captcha-delivery.com/i.js'></script></html>";
    let resp = make_response(200, vec![], body);
    let signal = c.classify(&resp).expect("classify must not fail");
    assert!(signal.is_some(), "captcha-delivery.com must be detected as datadome");
    assert_eq!(signal.expect("signal is Some — asserted above").vendor, "datadome");
}

// ---------------------------------------------------------------------------
// Rules loader validation
// ---------------------------------------------------------------------------

#[test]
fn custom_rules_single_signal_matches() {
    let toml_src = r#"
[[fingerprint]]
id = "custom_vendor_v1"
vendor = "custom"
weight = 1.0
[[fingerprint.signals]]
kind = "body_substring"
pattern = "custom-challenge-token"
"#;
    let rules = load_from_str(toml_src).expect("static test TOML is valid");
    use crate::waf::TomlClassifier;
    let c = TomlClassifier::from_rules(rules);
    let resp = make_response(403, vec![], "<html>custom-challenge-token</html>");
    let signal = c.classify(&resp).expect("classify must not fail");
    assert!(signal.is_some());
    let signal = signal.expect("signal is Some — asserted above");
    assert_eq!(signal.vendor, "custom");
    assert_eq!(signal.fingerprint_id, "custom_vendor_v1");
}

#[test]
fn all_signals_must_match() {
    // Fingerprint requires BOTH server=cloudflare AND body pattern.
    // Only supplying the header without the body pattern must not fire.
    let toml_src = r#"
[[fingerprint]]
id = "multi_signal_test"
vendor = "testvendor"
weight = 1.0
[[fingerprint.signals]]
kind = "response_header"
name = "server"
value_contains = "testvendor"
[[fingerprint.signals]]
kind = "body_substring"
pattern = "tv-challenge-token"
"#;
    let rules = load_from_str(toml_src).expect("static test TOML is valid");
    let c = TomlClassifier::from_rules(rules);

    // Missing body pattern — must not match.
    let resp = make_response(403, vec![("server", "testvendor")], "<html>no token here</html>");
    assert!(
        c.classify(&resp).expect("classify must not fail").is_none(),
        "must not match without body pattern"
    );

    // Both signals present — must match.
    let resp2 = make_response(403, vec![("server", "testvendor")], "<html>tv-challenge-token</html>");
    assert!(
        c.classify(&resp2).expect("classify must not fail").is_some(),
        "must match when all signals present"
    );
}

// ---------------------------------------------------------------------------
// Input validation (B8, B9)
// ---------------------------------------------------------------------------

#[test]
fn load_from_str_rejects_too_many_fingerprints() {
    let mut toml = String::new();
    for i in 0..(MAX_FINGERPRINTS + 1) {
        use std::fmt::Write as _;
        let _ = write!(
            toml,
            r#"
[[fingerprint]]
id = "fp_{i}"
vendor = "test"
weight = 1.0
[[fingerprint.signals]]
kind = "body_substring"
pattern = "pattern_{i}"
"#
        );
    }
    let result = load_from_str(&toml);
    let err = result.expect_err("should reject too many fingerprints");
    assert!(
        matches!(err, crate::waf::rules::RulesError::Validation { .. }),
        "expected Validation error, got {err:?}"
    );
    if let crate::waf::rules::RulesError::Validation { reason, .. } = err {
        assert!(reason.contains("too many fingerprints"), "got: {reason}");
    }
}

#[test]
fn load_from_str_rejects_oversized_pattern() {
    let big_pattern = "a".repeat(MAX_PATTERN_LEN + 1);
    let toml = format!(
        r#"
[[fingerprint]]
id = "fp_big"
vendor = "test"
weight = 1.0
[[fingerprint.signals]]
kind = "body_substring"
pattern = "{big_pattern}"
"#
    );
    let result = load_from_str(&toml);
    let err = result.expect_err("should reject oversized pattern");
    assert!(
        matches!(err, crate::waf::rules::RulesError::Validation { .. }),
        "expected Validation error, got {err:?}"
    );
}

#[test]
fn load_from_str_rejects_too_many_signals() {
    let mut signals_block = String::new();
    for i in 0..(MAX_SIGNALS_PER_FINGERPRINT + 1) {
        use std::fmt::Write as _;
        let _ = write!(
            signals_block,
            r#"
[[fingerprint.signals]]
kind = "body_substring"
pattern = "s_{i}"
"#
        );
    }
    let toml = format!(
        r#"
[[fingerprint]]
id = "fp_many"
vendor = "test"
weight = 1.0
{signals_block}
"#
    );
    let result = load_from_str(&toml);
    let err = result.expect_err("should reject too many signals");
    assert!(
        matches!(err, crate::waf::rules::RulesError::Validation { .. }),
        "expected Validation error, got {err:?}"
    );
}

#[test]
fn load_from_str_accepts_corpus_at_limit() {
    // The builtin corpus must remain BELOW MAX_FINGERPRINTS. If this test
    // breaks because the canonical corpus has grown past 1000 fingerprints,
    // raise the limit deliberately rather than masking the warning.
    let builtin = Rules::builtin();
    assert!(
        builtin.fingerprint_count() < MAX_FINGERPRINTS,
        "builtin corpus ({}) is approaching the MAX_FINGERPRINTS limit ({})",
        builtin.fingerprint_count(),
        MAX_FINGERPRINTS,
    );
}

/// This test is INTENTIONALLY BROKEN to prove the fixture corpus is load-bearing.
///
/// It checks that the `cloudflare_cf_chl` fingerprint fires on a body containing
/// `cf-chl-`. To demonstrate the corpus matters, we patch the rules to use a
/// non-matching pattern and verify the test detects the missing fingerprint.
///
/// Mark `#[ignore]` to skip in normal CI; un-ignore to validate the corpus gate.
#[test]
#[ignore = "intentional broken-fingerprint gate — un-ignore to verify corpus is load-bearing"]
fn broken_fingerprint_correctly_fails() {
    // Deliberately use wrong pattern to prove test fails.
    let toml_src = r#"
[[fingerprint]]
id = "cloudflare_cf_chl_intentionally_broken"
vendor = "cloudflare"
weight = 1.0
[[fingerprint.signals]]
kind = "body_substring"
pattern = "THIS_PATTERN_WILL_NEVER_MATCH_ANYTHING_xyzzy_12345"
"#;
    let rules = load_from_str(toml_src).expect("static test TOML is valid");
    let c = TomlClassifier::from_rules(rules);
    let resp = make_response(403, vec![], "<html>cf-chl-widget-abc</html>");
    // This must fail to detect — proving that if we break the pattern the test breaks.
    assert!(
        c.classify(&resp).expect("classify must not fail").is_none(),
        "broken fingerprint correctly produces no match"
    );
}