mini-static 0.18.0

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
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

use mini_static::Server;
use std::fs;
use std::time::Duration;
use tempfile::TempDir;
use tokio::io::{AsyncReadExt, AsyncWriteExt};

#[tokio::test]
async fn range_simple_start_to_end() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr).await.unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=0-4\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("206 Partial Content"), "got: {response_str}");
    assert!(response_str.contains("Content-Range: bytes 0-4/10"), "got: {response_str}");
    assert!(response_str.contains("Content-Length: 5"), "got: {response_str}");
    assert!(response_str.contains("01234"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn range_open_ended() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=5-\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("206 Partial Content"), "got: {response_str}");
    assert!(response_str.contains("Content-Range: bytes 5-9/10"), "got: {response_str}");
    assert!(response_str.contains("Content-Length: 5"), "got: {response_str}");
    assert!(response_str.contains("56789"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn range_suffix() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=-3\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("206 Partial Content"), "got: {response_str}");
    assert!(response_str.contains("Content-Range: bytes 7-9/10"), "got: {response_str}");
    assert!(response_str.contains("Content-Length: 3"), "got: {response_str}");
    assert!(response_str.contains("789"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn range_out_of_bounds_returns_416() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=100-200\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("416 Range Not Satisfiable"), "got: {response_str}");
    assert!(response_str.contains("Content-Range: bytes */10"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn range_clamped_end() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=5-100\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("206 Partial Content"), "got: {response_str}");
    assert!(response_str.contains("Content-Range: bytes 5-9/10"), "got: {response_str}");
    assert!(response_str.contains("Content-Length: 5"), "got: {response_str}");
    assert!(response_str.contains("56789"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn range_if_range_matching_etag() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    // First request to get the ETag.
    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\n\r\n")
        .await
        .unwrap();
    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    let etag = response_str
        .lines()
        .find(|l| l.starts_with("ETag: "))
        .unwrap()
        .strip_prefix("ETag: ")
        .unwrap()
        .to_string();

    // Second request with matching If-Range.
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();
    let request = format!(
        "GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=0-4\r\nIf-Range: {}\r\n\r\n",
        etag
    );
    conn.write_all(request.as_bytes()).await.unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("206 Partial Content"), "got: {response_str}");
    assert!(response_str.contains("Content-Range: bytes 0-4/10"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn range_if_range_mismatched_etag_returns_200() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(
        b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=0-4\r\nIf-Range: \"stale-etag\"\r\n\r\n",
    )
    .await
    .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("200 OK"), "got: {response_str}");
    assert!(!response_str.contains("206"), "got: {response_str}");
    assert!(response_str.contains("Content-Length: 10"), "got: {response_str}");
    assert!(response_str.contains("0123456789"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn range_multi_range_returns_200() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=0-2,5-7\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("200 OK"), "got: {response_str}");
    assert!(!response_str.contains("206"), "got: {response_str}");
    assert!(response_str.contains("Content-Length: 10"), "got: {response_str}");
    assert!(response_str.contains("0123456789"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn head_with_range_returns_206_with_empty_body() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"HEAD /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=0-4\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("206 Partial Content"), "got: {response_str}");
    assert!(response_str.contains("Content-Range: bytes 0-4/10"), "got: {response_str}");
    assert!(response_str.contains("Content-Length: 5"), "got: {response_str}");

    // For HEAD, there should be headers ending with \r\n\r\n and no body content.
    // Just verify there's no actual data bytes after headers (only newlines).
    let parts: Vec<&str> = response_str.split("\r\n\r\n").collect();
    assert_eq!(parts.len(), 2, "HEAD response should have headers and empty body");
    assert!(parts[1].is_empty(), "HEAD response body must be empty, got: {}", parts[1]);

    server_handle.shutdown().await;
}

#[tokio::test]
async fn accept_ranges_header_on_200_response() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("200 OK"), "got: {response_str}");
    assert!(response_str.contains("Accept-Ranges: bytes"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn accept_ranges_header_on_206_response() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=0-4\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("206 Partial Content"), "got: {response_str}");
    assert!(response_str.contains("Accept-Ranges: bytes"), "got: {response_str}");

    server_handle.shutdown().await;
}

#[tokio::test]
async fn accept_ranges_header_on_416_response() {
    let root = TempDir::new().unwrap();
    let file_path = root.path().join("data.bin");
    fs::write(&file_path, b"0123456789").unwrap();

    let server = Server::new(root.path()).unwrap();
    let (port, server_handle) = server.run_ephemeral().await.unwrap();

    tokio::time::sleep(Duration::from_millis(10)).await;

    let addr = format!("127.0.0.1:{}", port);
    let mut conn = tokio::net::TcpStream::connect(&addr)
        .await
        .unwrap();

    conn.write_all(b"GET /data.bin HTTP/1.1\r\nHost: localhost\r\nRange: bytes=100-200\r\n\r\n")
        .await
        .unwrap();

    let mut response = Vec::new();
    conn.read_to_end(&mut response).await.unwrap();
    let response_str = String::from_utf8_lossy(&response);

    assert!(response_str.contains("416 Range Not Satisfiable"), "got: {response_str}");
    assert!(response_str.contains("Accept-Ranges: bytes"), "got: {response_str}");

    server_handle.shutdown().await;
}