mini-static 0.7.1

A secure, async static file server with streaming, traversal protection, and connection limits.
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

use mini_static::resolve;
use std::fs;
use tempfile::TempDir;

fn canon_eq(a: &std::path::Path, b: &std::path::Path) {
    let a_canon = a.canonicalize().unwrap();
    let b_canon = b.canonicalize().unwrap();
    assert_eq!(a_canon, b_canon);
}

#[test]
fn resolve_legitimate_filename_with_double_dot_substring() {
    let root = TempDir::new().unwrap();
    let test_file = root.path().join("jquery..min.js");
    fs::write(&test_file, b"content").unwrap();

    let result = resolve(root.path(), "/jquery..min.js");
    assert!(result.is_ok(), "should allow legitimate filename with .. substring");
    canon_eq(&result.unwrap(), &test_file);
}

#[test]
fn resolve_traversal_attempt_rejected() {
    let root = TempDir::new().unwrap();

    let result = resolve(root.path(), "/../../etc/passwd");
    assert!(result.is_err(), "should reject traversal attempt");
    assert!(matches!(result, Err(mini_static::StaticError::Traversal(_))));
}

#[test]
fn resolve_traversal_single_segment_rejected() {
    let root = TempDir::new().unwrap();

    let result = resolve(root.path(), "/../etc/passwd");
    assert!(result.is_err(), "should reject single .. segment");
}

#[test]
fn resolve_traversal_middle_segment_rejected() {
    let root = TempDir::new().unwrap();

    let result = resolve(root.path(), "/foo/../../../etc/passwd");
    assert!(result.is_err(), "should reject .. segment in middle of path");
}

#[test]
fn resolve_regular_file() {
    let root = TempDir::new().unwrap();
    let test_file = root.path().join("test.txt");
    fs::write(&test_file, b"hello").unwrap();

    let result = resolve(root.path(), "/test.txt");
    assert!(result.is_ok());
    canon_eq(&result.unwrap(), &test_file);
}

#[test]
fn resolve_missing_file() {
    let root = TempDir::new().unwrap();

    let result = resolve(root.path(), "/nonexistent.txt");
    assert!(result.is_err(), "should reject missing file");
    assert!(matches!(result, Err(mini_static::StaticError::NotFound(_))));
}

#[test]
fn resolve_directory_with_index_html() {
    let root = TempDir::new().unwrap();
    fs::create_dir(root.path().join("docs")).unwrap();
    let index = root.path().join("docs/index.html");
    fs::write(&index, b"<html></html>").unwrap();

    let result = resolve(root.path(), "/docs");
    assert!(result.is_ok());
    canon_eq(&result.unwrap(), &index);
}

#[test]
fn resolve_directory_without_index_html() {
    let root = TempDir::new().unwrap();
    fs::create_dir(root.path().join("empty")).unwrap();

    let result = resolve(root.path(), "/empty");
    assert!(result.is_err(), "should reject directory without index.html");
    assert!(matches!(result, Err(mini_static::StaticError::NotFound(_))));
}

#[test]
fn resolve_null_byte_rejected() {
    let root = TempDir::new().unwrap();

    let result = resolve(root.path(), "/file\x00.txt");
    assert!(result.is_err(), "should reject null bytes");
    assert!(matches!(result, Err(mini_static::StaticError::Traversal(_))));
}

#[test]
fn resolve_percent_encoded_path() {
    let root = TempDir::new().unwrap();
    let test_file = root.path().join("hello world.txt");
    fs::write(&test_file, b"content").unwrap();

    let result = resolve(root.path(), "/hello%20world.txt");
    assert!(result.is_ok());
    canon_eq(&result.unwrap(), &test_file);
}

#[test]
fn resolve_leading_slash() {
    let root = TempDir::new().unwrap();
    let test_file = root.path().join("test.txt");
    fs::write(&test_file, b"content").unwrap();

    let result = resolve(root.path(), "test.txt");
    assert!(result.is_ok(), "should work with or without leading slash");
    canon_eq(&result.unwrap(), &test_file);
}

#[test]
fn resolve_ensures_boundary() {
    let root = TempDir::new().unwrap();

    let result = resolve(root.path(), "/");
    assert!(result.is_err(), "root itself has no index.html");
}

#[test]
fn resolve_rejects_symlink_escaping_root() {
    let outside = TempDir::new().unwrap();
    let secret = outside.path().join("secret.txt");
    fs::write(&secret, b"secret").unwrap();

    let root = TempDir::new().unwrap();
    let link = root.path().join("escape.txt");
    std::os::unix::fs::symlink(&secret, &link).unwrap();

    let result = resolve(root.path(), "/escape.txt");
    assert!(
        result.is_err(),
        "a symlink resolving outside root should be rejected"
    );
    assert!(matches!(result, Err(mini_static::StaticError::Traversal(_))));
}

#[test]
fn resolve_rejects_symlinked_index_html_escaping_root() {
    // The directory-index path (`canon.join("index.html")`) is a separate code path from
    // the main file resolution — verify its boundary check independently.
    let outside = TempDir::new().unwrap();
    let secret = outside.path().join("secret.txt");
    fs::write(&secret, b"secret").unwrap();

    let root = TempDir::new().unwrap();
    fs::create_dir(root.path().join("docs")).unwrap();
    let index_link = root.path().join("docs/index.html");
    std::os::unix::fs::symlink(&secret, &index_link).unwrap();

    let result = resolve(root.path(), "/docs/");
    assert!(
        result.is_err(),
        "a symlinked index.html resolving outside root should be rejected"
    );
    assert!(matches!(result, Err(mini_static::StaticError::Traversal(_))));
}

#[test]
fn resolve_allows_symlink_within_root() {
    let root = TempDir::new().unwrap();
    let real_file = root.path().join("real.txt");
    fs::write(&real_file, b"content").unwrap();
    let link = root.path().join("link.txt");
    std::os::unix::fs::symlink(&real_file, &link).unwrap();

    let result = resolve(root.path(), "/link.txt");
    assert!(result.is_ok(), "a symlink resolving within root should be allowed");
    canon_eq(&result.unwrap(), &real_file);
}