exarch-core 0.3.0

Memory-safe archive extraction library with security validation
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
//! Security validation benchmarks for exarch.
//!
//! Measures validation performance:
//! - Path validation throughput (target: < 1 us per entry)
//! - Symlink validation
//! - Hardlink validation
//! - Compression ratio checks (zip bomb detection)
//!
//! These benchmarks are critical for ensuring security checks
//! do not become a bottleneck during extraction.

#![allow(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::field_reassign_with_default,
    clippy::items_after_statements,
    clippy::too_many_lines,
    missing_docs
)]

use criterion::Criterion;
use criterion::criterion_group;
use criterion::criterion_main;
use exarch_core::SecurityConfig;
use exarch_core::security::EntryValidator;
use exarch_core::security::HardlinkTracker;
use exarch_core::security::validate_compression_ratio;
use exarch_core::security::validate_symlink;
use exarch_core::types::DestDir;
use exarch_core::types::EntryType;
use exarch_core::types::SafePath;
use std::hint::black_box;
use std::path::Path;
use std::path::PathBuf;
use tempfile::TempDir;

/// Path validation benchmarks.
fn benchmark_path_validation(c: &mut Criterion) {
    let mut group = c.benchmark_group("path_validation");

    let temp = TempDir::new().unwrap();
    let dest = DestDir::new(temp.path().to_path_buf()).unwrap();
    let config = SecurityConfig::default();

    // Simple path (most common case)
    group.bench_function("simple_nonexistent", |b| {
        let path = PathBuf::from("foo/bar/baz.txt");
        b.iter(|| SafePath::validate(black_box(&path), black_box(&dest), black_box(&config)));
    });

    // Path with dots (requires normalization)
    group.bench_function("with_dot_components", |b| {
        let path = PathBuf::from("./foo/./bar/./baz.txt");
        b.iter(|| SafePath::validate(black_box(&path), black_box(&dest), black_box(&config)));
    });

    // Deep path (tests depth limits)
    group.bench_function("deep_path", |b| {
        let path = PathBuf::from("a/b/c/d/e/f/g/h/i/j/file.txt");
        b.iter(|| SafePath::validate(black_box(&path), black_box(&dest), black_box(&config)));
    });

    // Path with banned component (should fail fast)
    group.bench_function("banned_component", |b| {
        let path = PathBuf::from("foo/__MACOSX/bar.txt");
        b.iter(|| SafePath::validate(black_box(&path), black_box(&dest), black_box(&config)));
    });

    // No banned components config (optimized path)
    group.bench_function("no_banned_components", |b| {
        let mut config_no_banned = SecurityConfig::default();
        config_no_banned.banned_path_components.clear();
        let path = PathBuf::from("foo/bar/baz.txt");
        b.iter(|| {
            SafePath::validate(
                black_box(&path),
                black_box(&dest),
                black_box(&config_no_banned),
            )
        });
    });

    group.finish();
}

/// Path normalization benchmarks.
fn benchmark_normalization(c: &mut Criterion) {
    let mut group = c.benchmark_group("normalization");

    let temp = TempDir::new().unwrap();
    let dest = DestDir::new(temp.path().to_path_buf()).unwrap();
    let config = SecurityConfig::default();

    // Path without . components (should use Cow::Borrowed)
    group.bench_function("no_normalization_needed", |b| {
        let path = PathBuf::from("foo/bar/baz.txt");
        b.iter(|| SafePath::validate(black_box(&path), black_box(&dest), black_box(&config)));
    });

    // Path with many . components (requires normalization)
    group.bench_function("heavy_normalization", |b| {
        let path = PathBuf::from("./././foo/./././bar/./././baz.txt");
        b.iter(|| SafePath::validate(black_box(&path), black_box(&dest), black_box(&config)));
    });

    group.finish();
}

/// Symlink validation benchmarks.
fn benchmark_symlink_validation(c: &mut Criterion) {
    let mut group = c.benchmark_group("symlink_validation");

    let temp = TempDir::new().unwrap();
    let dest = DestDir::new(temp.path().to_path_buf()).unwrap();
    let mut config = SecurityConfig::default();
    config.allowed.symlinks = true;

    // Valid relative symlink
    group.bench_function("valid_relative", |b| {
        let link = SafePath::validate(&PathBuf::from("link"), &dest, &config).unwrap();
        let target = PathBuf::from("target.txt");
        b.iter(|| {
            validate_symlink(
                black_box(&link),
                black_box(&target),
                black_box(&dest),
                black_box(&config),
            )
        });
    });

    // Valid symlink in subdirectory
    group.bench_function("valid_subdir", |b| {
        let link = SafePath::validate(&PathBuf::from("foo/link"), &dest, &config).unwrap();
        let target = PathBuf::from("../bar/target.txt");
        b.iter(|| {
            validate_symlink(
                black_box(&link),
                black_box(&target),
                black_box(&dest),
                black_box(&config),
            )
        });
    });

    // Escape attempt (should fail fast)
    group.bench_function("escape_reject", |b| {
        let link = SafePath::validate(&PathBuf::from("link"), &dest, &config).unwrap();
        let target = PathBuf::from("../../etc/passwd");
        b.iter(|| {
            validate_symlink(
                black_box(&link),
                black_box(&target),
                black_box(&dest),
                black_box(&config),
            )
        });
    });

    // Disabled symlinks (should fail very fast)
    group.bench_function("disabled_reject", |b| {
        let disabled_config = SecurityConfig::default(); // symlinks disabled
        let link = SafePath::validate(&PathBuf::from("link"), &dest, &disabled_config).unwrap();
        let target = PathBuf::from("target.txt");
        b.iter(|| {
            validate_symlink(
                black_box(&link),
                black_box(&target),
                black_box(&dest),
                black_box(&disabled_config),
            )
        });
    });

    group.finish();
}

/// Hardlink validation benchmarks.
fn benchmark_hardlink_validation(c: &mut Criterion) {
    let mut group = c.benchmark_group("hardlink_validation");

    let temp = TempDir::new().unwrap();
    let dest = DestDir::new(temp.path().to_path_buf()).unwrap();
    let mut config = SecurityConfig::default();
    config.allowed.hardlinks = true;

    // Valid hardlink
    group.bench_function("valid_target", |b| {
        let mut tracker = HardlinkTracker::new();
        let link = SafePath::validate(&PathBuf::from("link"), &dest, &config).unwrap();
        let target = PathBuf::from("target.txt");
        b.iter(|| {
            tracker.validate_hardlink(
                black_box(&link),
                black_box(&target),
                black_box(&dest),
                black_box(&config),
            )
        });
    });

    // Multiple hardlinks (tracker grows)
    group.bench_function("multiple_unique_targets", |b| {
        b.iter(|| {
            let mut tracker = HardlinkTracker::new();
            for i in 0..100 {
                let link = SafePath::validate(&PathBuf::from(format!("link_{i}")), &dest, &config)
                    .unwrap();
                let target = PathBuf::from(format!("target_{i}.txt"));
                let _ = tracker.validate_hardlink(&link, &target, &dest, &config);
            }
            black_box(tracker.count())
        });
    });

    // Same target multiple times (de-duplication)
    group.bench_function("multiple_same_target", |b| {
        b.iter(|| {
            let mut tracker = HardlinkTracker::new();
            let target = PathBuf::from("shared_target.txt");
            for i in 0..100 {
                let link = SafePath::validate(&PathBuf::from(format!("link_{i}")), &dest, &config)
                    .unwrap();
                let _ = tracker.validate_hardlink(&link, &target, &dest, &config);
            }
            black_box(tracker.count())
        });
    });

    // Escape attempt (should fail fast)
    group.bench_function("escape_reject", |b| {
        let mut tracker = HardlinkTracker::new();
        let link = SafePath::validate(&PathBuf::from("link"), &dest, &config).unwrap();
        let target = PathBuf::from("../../etc/passwd");
        b.iter(|| {
            tracker.validate_hardlink(
                black_box(&link),
                black_box(&target),
                black_box(&dest),
                black_box(&config),
            )
        });
    });

    group.finish();
}

/// Compression ratio validation (zip bomb detection).
fn benchmark_compression_ratio(c: &mut Criterion) {
    let mut group = c.benchmark_group("compression_ratio");

    let config = SecurityConfig::default();

    // Normal ratio (should pass quickly)
    group.bench_function("normal_ratio", |b| {
        let compressed: u64 = 1000;
        let uncompressed: u64 = 2000; // 2x ratio
        b.iter(|| {
            validate_compression_ratio(
                black_box(compressed),
                black_box(uncompressed),
                black_box(&config),
            )
        });
    });

    // High but acceptable ratio
    group.bench_function("high_ratio", |b| {
        let compressed: u64 = 1000;
        let uncompressed: u64 = 50000; // 50x ratio
        b.iter(|| {
            validate_compression_ratio(
                black_box(compressed),
                black_box(uncompressed),
                black_box(&config),
            )
        });
    });

    // Bomb ratio (should fail)
    group.bench_function("bomb_ratio_reject", |b| {
        let compressed: u64 = 100;
        let uncompressed: u64 = 100_000_000; // 1M:1 ratio
        b.iter(|| {
            validate_compression_ratio(
                black_box(compressed),
                black_box(uncompressed),
                black_box(&config),
            )
        });
    });

    group.finish();
}

/// Entry validator orchestration benchmark.
fn benchmark_entry_validator(c: &mut Criterion) {
    let mut group = c.benchmark_group("entry_validator");

    let temp = TempDir::new().unwrap();
    let dest = DestDir::new(temp.path().to_path_buf()).unwrap();
    let config = SecurityConfig::default();

    // Single file entry
    group.bench_function("single_file", |b| {
        b.iter(|| {
            let mut validator = EntryValidator::new(&config, &dest);
            validator.validate_entry(
                black_box(Path::new("file.txt")),
                black_box(&EntryType::File),
                black_box(1024),
                black_box(None),
                black_box(Some(0o644)),
                None,
            )
        });
    });

    // File with compression ratio
    group.bench_function("file_with_compression", |b| {
        b.iter(|| {
            let mut validator = EntryValidator::new(&config, &dest);
            validator.validate_entry(
                black_box(Path::new("file.txt")),
                black_box(&EntryType::File),
                black_box(10240),
                black_box(Some(5120)), // 2x compression
                black_box(Some(0o644)),
                None,
            )
        });
    });

    // Directory entry
    group.bench_function("directory", |b| {
        b.iter(|| {
            let mut validator = EntryValidator::new(&config, &dest);
            validator.validate_entry(
                black_box(Path::new("subdir")),
                black_box(&EntryType::Directory),
                black_box(0),
                black_box(None),
                black_box(None),
                None,
            )
        });
    });

    // Multiple entries (simulates real extraction)
    group.bench_function("100_files", |b| {
        b.iter(|| {
            let mut validator = EntryValidator::new(&config, &dest);
            for i in 0..100 {
                let path = PathBuf::from(format!("dir/file_{i}.txt"));
                let _ = validator.validate_entry(
                    &path,
                    &EntryType::File,
                    1024,
                    None,
                    Some(0o644),
                    None,
                );
            }
            validator.finish()
        });
    });

    // Mixed entries
    group.bench_function("mixed_entries", |b| {
        let mut config_with_links = config.clone();
        config_with_links.allowed.symlinks = true;
        config_with_links.allowed.hardlinks = true;

        b.iter(|| {
            let mut validator = EntryValidator::new(&config_with_links, &dest);

            // Add directories
            for i in 0..10 {
                let path = PathBuf::from(format!("dir_{i}"));
                let _ = validator.validate_entry(&path, &EntryType::Directory, 0, None, None, None);
            }

            // Add files
            for i in 0..80 {
                let path = PathBuf::from(format!("dir_{}/file_{}.txt", i % 10, i));
                let _ = validator.validate_entry(
                    &path,
                    &EntryType::File,
                    1024,
                    Some(512),
                    Some(0o644),
                    None,
                );
            }

            // Add symlinks
            for i in 0..5 {
                let path = PathBuf::from(format!("link_{i}"));
                let _ = validator.validate_entry(
                    &path,
                    &EntryType::Symlink {
                        target: PathBuf::from(format!("dir_0/file_{i}.txt")),
                    },
                    0,
                    None,
                    None,
                    None,
                );
            }

            // Add hardlinks
            for i in 0..5 {
                let path = PathBuf::from(format!("hardlink_{i}"));
                let _ = validator.validate_entry(
                    &path,
                    &EntryType::Hardlink {
                        target: PathBuf::from(format!("dir_1/file_{i}.txt")),
                    },
                    0,
                    None,
                    None,
                    None,
                );
            }

            validator.finish()
        });
    });

    group.finish();
}

/// Throughput benchmark - validate entries per second.
fn benchmark_validation_throughput(c: &mut Criterion) {
    let mut group = c.benchmark_group("validation_throughput");

    let temp = TempDir::new().unwrap();
    let dest = DestDir::new(temp.path().to_path_buf()).unwrap();
    let config = SecurityConfig::default();

    // Pre-generate paths for consistent timing
    let paths: Vec<PathBuf> = (0..1000)
        .map(|i| PathBuf::from(format!("subdir/file_{i:04}.txt")))
        .collect();

    group.throughput(criterion::Throughput::Elements(1000));
    group.bench_function("1000_entries", |b| {
        b.iter(|| {
            let mut validator = EntryValidator::new(&config, &dest);
            for path in &paths {
                let _ =
                    validator.validate_entry(path, &EntryType::File, 1024, None, Some(0o644), None);
            }
            validator.finish()
        });
    });

    group.finish();
}

/// `SecurityConfig` creation benchmark.
fn benchmark_security_config(c: &mut Criterion) {
    let mut group = c.benchmark_group("security_config");

    group.bench_function("default", |b| {
        b.iter(|| black_box(SecurityConfig::default()));
    });

    group.bench_function("clone", |b| {
        let config = SecurityConfig::default();
        b.iter(|| black_box(config.clone()));
    });

    group.finish();
}

criterion_group!(
    benches,
    benchmark_path_validation,
    benchmark_normalization,
    benchmark_symlink_validation,
    benchmark_hardlink_validation,
    benchmark_compression_ratio,
    benchmark_entry_validator,
    benchmark_validation_throughput,
    benchmark_security_config,
);
criterion_main!(benches);