flashsieve 0.1.3

Storage-level pre-filtering for pattern matching, skip blocks that can't contain matches
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
//! Correctness audit invariants for flashsieve bloom filters.
//! A failure here is a security-critical finding: false negatives cause warpscan
//! to skip files that contain malware.

use flashsieve::{BlockedNgramBloom, NgramBloom};
use rand::rngs::StdRng;
use rand::{Rng, SeedableRng};
use std::collections::HashSet;
use std::fs::File;
use std::io::{Read, Write};
use std::sync::Arc;
use std::thread;

fn insert_pattern_ngram(bloom: &mut NgramBloom, pattern: &[u8]) {
    for w in pattern.windows(2) {
        bloom.insert_ngram(w[0], w[1]);
    }
}
fn insert_pattern_blocked(bloom: &mut BlockedNgramBloom, pattern: &[u8]) {
    for w in pattern.windows(2) {
        bloom.insert(w[0], w[1]);
    }
}
fn blocked_maybe_contains_pattern(bloom: &BlockedNgramBloom, pattern: &[u8]) -> bool {
    pattern.windows(2).all(|w| bloom.maybe_contains(w[0], w[1]))
}
fn random_patterns(rng: &mut StdRng, n: usize, len: usize) -> Vec<Vec<u8>> {
    (0..n)
        .map(|_| (0..len).map(|_| rng.random::<u8>()).collect())
        .collect()
}
fn random_distinct_ngrams(rng: &mut StdRng, n: usize) -> Vec<(u8, u8)> {
    let mut set = HashSet::new();
    while set.len() < n {
        set.insert((rng.random(), rng.random()));
    }
    set.into_iter().collect()
}

// 1. ZERO FALSE NEGATIVES
#[test]
fn zero_false_negatives_across_scales() {
    let mut rng = StdRng::seed_from_u64(0xC0FF_EE00);
    const PATTERN_LEN: usize = 8;
    for &n in &[1usize, 10, 100, 1000, 10000, 100000] {
        let patterns = random_patterns(&mut rng, n, PATTERN_LEN);
        let expected_ngrams = n * (PATTERN_LEN - 1);
        let mut bloom = NgramBloom::with_target_fpr(0.01, expected_ngrams)
            .unwrap_or_else(|e| panic!("failed to create bloom for N={n}: {e}"));
        for p in &patterns {
            insert_pattern_ngram(&mut bloom, p);
        }
        for p in &patterns {
            assert!(
                bloom.maybe_contains_pattern(p),
                "FALSE NEGATIVE at scale N={n} for pattern {p:?}"
            );
        }
    }
    for &n in &[100usize, 1000, 10000] {
        let patterns = random_patterns(&mut rng, n, PATTERN_LEN);
        let mut bloom = BlockedNgramBloom::new(65_536)
            .unwrap_or_else(|e| panic!("failed to create blocked bloom for N={n}: {e}"));
        for p in &patterns {
            insert_pattern_blocked(&mut bloom, p);
        }
        for p in &patterns {
            assert!(
                blocked_maybe_contains_pattern(&bloom, p),
                "FALSE NEGATIVE in BlockedNgramBloom at scale N={n} for pattern {p:?}"
            );
        }
    }
}

// 2. FALSE POSITIVE RATE
#[test]
fn false_positive_rate_matches_theory() {
    let mut rng = StdRng::seed_from_u64(0xDEAD_BEEF);
    const M: usize = 2048;
    const N: usize = 500;
    const K: u32 = 3;
    const TRIALS: usize = 20_000;
    let mut bloom = NgramBloom::new(M).unwrap();
    let inserted: HashSet<(u8, u8)> = random_distinct_ngrams(&mut rng, N).into_iter().collect();
    for &(a, b) in &inserted {
        bloom.insert_ngram(a, b);
    }
    let mut false_positives = 0usize;
    for _ in 0..TRIALS {
        let (a, b) = loop {
            let p = (rng.random::<u8>(), rng.random::<u8>());
            if !inserted.contains(&p) {
                break p;
            }
        };
        if bloom.maybe_contains_bloom(a, b) {
            false_positives += 1;
        }
    }
    let measured = false_positives as f64 / TRIALS as f64;
    let theoretical = (1.0f64 - (-(K as f64) * N as f64 / M as f64).exp()).powi(K as i32);
    let diff = (measured - theoretical).abs();
    assert!(
        diff < 0.02,
        "FP rate mismatch: measured={measured:.4}, theoretical={theoretical:.4}, diff={diff:.4}"
    );
}

// 3. HASH INDEPENDENCE
#[test]
fn hash_independence_verified() {
    #[inline(always)]
    fn wyhash_pair(a: u8, b: u8) -> u64 {
        let x = (u64::from(a) << 8) | u64::from(b);
        let x = x.wrapping_mul(0x9E37_79B9_7F4A_7C15);
        x ^ (x >> 32)
    }
    #[inline(always)]
    fn derive_second_hash(h1: u64) -> u64 {
        let h2 = h1 ^ (h1 >> 32);
        h2.max(1)
    }
    let mut rng = StdRng::seed_from_u64(0x1111_2222_3333_4444);
    const M: usize = 1 << 20;
    const SAMPLES: usize = 100_000;
    const BUCKETS: usize = 1024;
    let mask = (M as u64).wrapping_sub(1);
    let (mut idx0, mut idx1, mut idx2) = (
        vec![0usize; SAMPLES],
        vec![0usize; SAMPLES],
        vec![0usize; SAMPLES],
    );
    for i in 0..SAMPLES {
        let (a, b) = (rng.random::<u8>(), rng.random::<u8>());
        let h1 = wyhash_pair(a, b);
        let h2 = derive_second_hash(h1);
        idx0[i] = (h1 & mask) as usize;
        idx1[i] = (h1.wrapping_add(h2) & mask) as usize;
        idx2[i] = (h1.wrapping_add(h2.wrapping_mul(2)) & mask) as usize;
    }
    let expected = SAMPLES as f64 / BUCKETS as f64;
    for probe in [&idx0, &idx1, &idx2] {
        let mut counts = vec![0usize; BUCKETS];
        for &v in probe.iter() {
            counts[v % BUCKETS] += 1;
        }
        assert!(
            counts.iter().copied().min().unwrap() > 0,
            "uniformity failure: empty bucket"
        );
        assert!(
            counts.iter().copied().max().unwrap() < (expected * 3.0) as usize,
            "uniformity failure: max bucket count far exceeds expected {expected}"
        );
    }
    let (mut c01, mut c02, mut c12) = (0usize, 0usize, 0usize);
    for i in 0..SAMPLES {
        if idx0[i] == idx1[i] {
            c01 += 1;
        }
        if idx0[i] == idx2[i] {
            c02 += 1;
        }
        if idx1[i] == idx2[i] {
            c12 += 1;
        }
    }
    assert!(c01 <= 5, "too many idx0==idx1 collisions: {c01}");
    assert!(c02 <= 5, "too many idx0==idx2 collisions: {c02}");
    assert!(c12 <= 5, "too many idx1==idx2 collisions: {c12}");
    fn pearson(x: &[usize], y: &[usize]) -> f64 {
        let n = x.len() as f64;
        let (mx, my) = (
            x.iter().sum::<usize>() as f64 / n,
            y.iter().sum::<usize>() as f64 / n,
        );
        let num: f64 = x
            .iter()
            .zip(y)
            .map(|(&xi, &yi)| {
                let (dx, dy) = (xi as f64 - mx, yi as f64 - my);
                dx * dy
            })
            .sum();
        let denx: f64 = x
            .iter()
            .map(|&xi| {
                let dx = xi as f64 - mx;
                dx * dx
            })
            .sum();
        let deny: f64 = y
            .iter()
            .map(|&yi| {
                let dy = yi as f64 - my;
                dy * dy
            })
            .sum();
        num / (denx.sqrt() * deny.sqrt())
    }
    assert!(
        pearson(&idx0, &idx1).abs() < 0.01,
        "correlation idx0-idx1 too high"
    );
    assert!(
        pearson(&idx0, &idx2).abs() < 0.01,
        "correlation idx0-idx2 too high"
    );
    assert!(
        pearson(&idx1, &idx2).abs() < 0.01,
        "correlation idx1-idx2 too high"
    );
}

// 4. CAPACITY OVERFLOW
#[test]
fn capacity_overflow_never_creates_false_negatives() {
    let mut rng = StdRng::seed_from_u64(0x0BAD_C0DE);
    let mut bloom = NgramBloom::with_target_fpr(0.01, 100).unwrap();
    let inserted = random_distinct_ngrams(&mut rng, 10_000);
    for &(a, b) in &inserted {
        bloom.insert_ngram(a, b);
    }
    for &(a, b) in &inserted {
        assert!(bloom.maybe_contains(a, b), "false negative after overflow");
    }
    const TRIALS: usize = 1_000;
    let mut fp = 0usize;
    for _ in 0..TRIALS {
        let (a, b) = loop {
            let p = (rng.random::<u8>(), rng.random::<u8>());
            if !inserted.contains(&p) {
                break p;
            }
        };
        if bloom.maybe_contains(a, b) {
            fp += 1;
        }
    }
    let rate = fp as f64 / TRIALS as f64;
    assert!(
        rate > 0.5,
        "expected severe FP degradation after overflow, got {rate}"
    );
}

// 5. SERIALIZATION ROUNDTRIP
#[test]
fn serialization_roundtrip_zero_false_negatives() {
    let mut rng = StdRng::seed_from_u64(0x5EED_5EED);
    let patterns = random_patterns(&mut rng, 1_000, 8);
    let mut bloom = NgramBloom::new(8192).unwrap();
    for p in &patterns {
        insert_pattern_ngram(&mut bloom, p);
    }
    let (num_bits, bits, exact_pairs) = bloom.serialize_with_exact_pairs();
    let mut file = tempfile::NamedTempFile::new().unwrap();
    file.write_all(&(num_bits as u64).to_le_bytes()).unwrap();
    file.write_all(&(bits.len() as u64).to_le_bytes()).unwrap();
    for &w in bits {
        file.write_all(&w.to_le_bytes()).unwrap();
    }
    file.write_all(&[if exact_pairs.is_some() { 1u8 } else { 0u8 }])
        .unwrap();
    if let Some(ep) = exact_pairs {
        for &w in ep.as_ref() {
            file.write_all(&w.to_le_bytes()).unwrap();
        }
    }
    file.flush().unwrap();
    let mut buf = Vec::new();
    File::open(file.path())
        .unwrap()
        .read_to_end(&mut buf)
        .unwrap();
    let mut rest = &buf[..];
    let read_u64 = |slice: &mut &[u8]| -> u64 {
        let (bytes, tail) = slice.split_at(8);
        *slice = tail;
        u64::from_le_bytes(bytes.try_into().unwrap())
    };
    let read_num_bits = read_u64(&mut rest) as usize;
    let read_bits_len = read_u64(&mut rest) as usize;
    let mut read_bits = Vec::with_capacity(read_bits_len);
    for _ in 0..read_bits_len {
        read_bits.push(read_u64(&mut rest));
    }
    let has_exact = rest[0] == 1;
    rest = &rest[1..];
    let read_exact_pairs = if has_exact {
        let mut ep = Box::new([0u64; 1024]);
        for i in 0..1024 {
            ep[i] = read_u64(&mut rest);
        }
        Some(ep)
    } else {
        None
    };
    let reconstructed =
        NgramBloom::from_serialized_parts(read_num_bits, read_bits, read_exact_pairs).unwrap();
    // Verify exact-pairs were restored by checking a known-absent n-gram returns false.
    let inserted_ngrams: HashSet<(u8, u8)> = patterns
        .iter()
        .flat_map(|p| p.windows(2).map(|w| (w[0], w[1])))
        .collect();
    let absent = (0u8..=255)
        .flat_map(|a| (0u8..=255).map(move |b| (a, b)))
        .find(|p| !inserted_ngrams.contains(p));
    if let Some((a, b)) = absent {
        assert!(
            !reconstructed.maybe_contains(a, b),
            "exact-pairs likely missing: true for uninserted ({a}, {b})"
        );
    }
    for p in &patterns {
        assert!(
            reconstructed.maybe_contains_pattern(p),
            "false negative after roundtrip for pattern {p:?}"
        );
    }
    // raw-parts roundtrip (no exact pairs)
    let mut small = NgramBloom::new(1024).unwrap();
    let small_patterns = random_patterns(&mut rng, 100, 4);
    for p in &small_patterns {
        insert_pattern_ngram(&mut small, p);
    }
    let (nb, sbits) = small.raw_parts();
    let raw_reconstructed = NgramBloom::from_raw_parts(nb, sbits.to_vec()).unwrap();
    for p in &small_patterns {
        assert!(
            raw_reconstructed.maybe_contains_pattern(p),
            "false negative after raw roundtrip for pattern {p:?}"
        );
    }
}

// 6. CONCURRENT ACCESS
#[test]
fn concurrent_queries_match_single_threaded() {
    let mut rng = StdRng::seed_from_u64(0xC0FF_EE01);
    let mut bloom = NgramBloom::new(1 << 16).unwrap();
    let inserted = random_distinct_ngrams(&mut rng, 5_000);
    for &(a, b) in &inserted {
        bloom.insert_ngram(a, b);
    }
    let bloom = Arc::new(bloom);
    let mut queries: Vec<(u8, u8)> = inserted.clone();
    queries.extend((0..5_000).map(|_| (rng.random::<u8>(), rng.random::<u8>())));
    let expected: Vec<bool> = queries
        .iter()
        .map(|&(a, b)| bloom.maybe_contains(a, b))
        .collect();
    let mut handles = Vec::new();
    for _ in 0..16 {
        let b = Arc::clone(&bloom);
        let (q, e) = (queries.clone(), expected.clone());
        handles.push(thread::spawn(move || {
            let actual: Vec<bool> = q.iter().map(|&(x, y)| b.maybe_contains(x, y)).collect();
            assert_eq!(
                actual, e,
                "concurrent query results diverged from single-threaded"
            );
        }));
    }
    for h in handles {
        h.join().unwrap();
    }
}

// 7. EMPTY BLOOM
#[test]
fn empty_bloom_rejects_everything() {
    let bloom = NgramBloom::new(1024).unwrap();
    for a in 0u8..=255 {
        for b in 0u8..=255 {
            assert!(
                !bloom.maybe_contains(a, b),
                "empty NgramBloom returned true for ({a}, {b})"
            );
        }
    }
    let blocked = BlockedNgramBloom::new(4096).unwrap();
    for a in 0u8..=255 {
        for b in 0u8..=255 {
            assert!(
                !blocked.maybe_contains(a, b),
                "empty BlockedNgramBloom returned true for ({a}, {b})"
            );
        }
    }
    let mut rng = StdRng::seed_from_u64(0xE77E_E77E);
    for _ in 0..100 {
        let pattern: Vec<u8> = (0..16).map(|_| rng.random()).collect();
        assert!(
            !bloom.maybe_contains_pattern(&pattern),
            "empty bloom matched pattern"
        );
    }
    assert!(
        bloom.maybe_contains_all(&[]),
        "empty maybe_contains_all should be vacuously true"
    );
    assert!(
        !bloom.maybe_contains_any(&[]),
        "empty maybe_contains_any should be false"
    );
}

// 8. ADVERSARIAL INPUTS
#[test]
fn adversarial_collisions_no_false_negatives() {
    #[inline(always)]
    fn wyhash_pair(a: u8, b: u8) -> u64 {
        let x = (u64::from(a) << 8) | u64::from(b);
        let x = x.wrapping_mul(0x9E37_79B9_7F4A_7C15);
        x ^ (x >> 32)
    }
    #[inline(always)]
    fn derive_second_hash(h1: u64) -> u64 {
        let h2 = h1 ^ (h1 >> 32);
        h2.max(1)
    }
    const M: usize = 64;
    let mask = (M as u64).wrapping_sub(1);
    let mut groups: std::collections::HashMap<(usize, usize, usize), Vec<(u8, u8)>> =
        std::collections::HashMap::new();
    for a in 0u8..=255 {
        for b in 0u8..=255 {
            let h1 = wyhash_pair(a, b);
            let h2 = derive_second_hash(h1);
            let i0 = (h1 & mask) as usize;
            let i1 = (h1.wrapping_add(h2) & mask) as usize;
            let i2 = (h1.wrapping_add(h2.wrapping_mul(2)) & mask) as usize;
            groups.entry((i0, i1, i2)).or_default().push((a, b));
        }
    }
    let mut max_group = Vec::new();
    for g in groups.values() {
        if g.len() > max_group.len() {
            max_group.clone_from(g);
        }
    }
    assert!(!max_group.is_empty(), "collision search failed");
    let mut bloom = NgramBloom::new(M).unwrap();
    for &(a, b) in &max_group {
        bloom.insert_ngram(a, b);
    }
    for &(a, b) in &max_group {
        assert!(
            bloom.maybe_contains(a, b),
            "false negative for adversarial collision pair ({a}, {b})"
        );
    }
    // Ultimate adversarial load: every possible 2-byte n-gram into a 64-bit filter.
    let mut exhaustive = NgramBloom::new(M).unwrap();
    for a in 0u8..=255 {
        for b in 0u8..=255 {
            exhaustive.insert_ngram(a, b);
        }
    }
    for a in 0u8..=255 {
        for b in 0u8..=255 {
            assert!(
                exhaustive.maybe_contains(a, b),
                "false negative in exhaustive adversarial load for ({a}, {b})"
            );
        }
    }
}