soop3 0.14.0

the based http fileserver (rust port)
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
// file serving and directory listing behavior

mod support;

use axum::http::{StatusCode, header};
use support::{app, base_config, body_string, get, get_with_range, head, head_with_range};
use tempfile::TempDir;
use tower::ServiceExt;

use std::fs;
#[cfg(unix)]
use std::os::unix::fs::PermissionsExt;

#[tokio::test]
async fn serves_files_and_directory_listings() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("test.txt"), "Hello, World!").unwrap();
    fs::create_dir(public_dir.join("subdir")).unwrap();
    fs::write(public_dir.join("subdir/nested.txt"), "Nested content").unwrap();

    let app = app(base_config(public_dir));

    let response = app.clone().oneshot(get("/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("Index of"));
    assert!(body.contains("test.txt"));
    assert!(body.contains("subdir"));

    let response = app.clone().oneshot(get("/test.txt")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert_eq!(body, "Hello, World!");

    let response = app
        .clone()
        .oneshot(get("/subdir/nested.txt"))
        .await
        .unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert_eq!(body, "Nested content");

    let response = app.clone().oneshot(get("/nonexistent.txt")).await.unwrap();
    assert_eq!(response.status(), StatusCode::NOT_FOUND);
}

#[tokio::test]
async fn head_requests_return_empty_body() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("test.txt"), "Hello, World!").unwrap();

    let app = app(base_config(public_dir));
    let response = app.oneshot(head("/test.txt")).await.unwrap();

    assert_eq!(response.status(), StatusCode::OK);
    assert_eq!(
        response.headers().get(header::CONTENT_LENGTH).unwrap(),
        "13"
    );
    let body = body_string(response).await;
    assert!(body.is_empty());
}

#[tokio::test]
async fn head_range_returns_partial_headers() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("test.txt"), "abcdef").unwrap();

    let app = app(base_config(public_dir));
    let response = app
        .oneshot(head_with_range("/test.txt", "bytes=1-3"))
        .await
        .unwrap();

    assert_eq!(response.status(), StatusCode::PARTIAL_CONTENT);
    assert_eq!(
        response.headers().get(header::CONTENT_RANGE).unwrap(),
        "bytes 1-3/6"
    );
    assert_eq!(response.headers().get(header::CONTENT_LENGTH).unwrap(), "3");
    let body = body_string(response).await;
    assert!(body.is_empty());
}

#[tokio::test]
async fn range_suffix_requests_return_tail() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("test.txt"), "abcdef").unwrap();

    let app = app(base_config(public_dir));
    let response = app
        .oneshot(get_with_range("/test.txt", "bytes=-2"))
        .await
        .unwrap();

    assert_eq!(response.status(), StatusCode::PARTIAL_CONTENT);
    let body = body_string(response).await;
    assert_eq!(body, "ef");
}

#[tokio::test]
async fn invalid_range_returns_416() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("test.txt"), "abcdef").unwrap();

    let app = app(base_config(public_dir));
    let response = app
        .oneshot(get_with_range("/test.txt", "bytes=10-20"))
        .await
        .unwrap();

    assert_eq!(response.status(), StatusCode::RANGE_NOT_SATISFIABLE);
    assert_eq!(
        response.headers().get(header::CONTENT_RANGE).unwrap(),
        "bytes */6"
    );
}

#[tokio::test]
async fn returns_not_found_when_path_component_is_file() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("not_a_dir"), "content").unwrap();

    let app = app(base_config(public_dir));

    let response = app.oneshot(get("/not_a_dir/child")).await.unwrap();
    assert_eq!(response.status(), StatusCode::NOT_FOUND);
}

#[tokio::test]
async fn serves_directory_index_files_with_precedence() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::create_dir(public_dir.join("with_index")).unwrap();
    fs::write(
        public_dir.join("with_index/index.html"),
        "<h1>Directory Index</h1>",
    )
    .unwrap();

    fs::create_dir(public_dir.join("with_index_htm")).unwrap();
    fs::write(
        public_dir.join("with_index_htm/index.htm"),
        "<h1>HTM Index</h1>",
    )
    .unwrap();

    fs::create_dir(public_dir.join("both_indexes")).unwrap();
    fs::write(
        public_dir.join("both_indexes/index.html"),
        "<h1>HTML Index</h1>",
    )
    .unwrap();
    fs::write(
        public_dir.join("both_indexes/index.htm"),
        "<h1>HTM Index</h1>",
    )
    .unwrap();

    let app = app(base_config(public_dir));

    let response = app.clone().oneshot(get("/with_index/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("Directory Index"));

    let response = app.clone().oneshot(get("/with_index_htm/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("HTM Index"));

    let response = app.clone().oneshot(get("/both_indexes/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("HTML Index"));
    assert!(!body.contains("HTM Index"));
}

#[tokio::test]
async fn range_requests_apply_to_directory_index_files() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::create_dir(public_dir.join("with_index")).unwrap();
    fs::write(public_dir.join("with_index/index.html"), "abcdef").unwrap();

    let app = app(base_config(public_dir));
    let response = app
        .oneshot(get_with_range("/with_index/", "bytes=0-2"))
        .await
        .unwrap();

    assert_eq!(response.status(), StatusCode::PARTIAL_CONTENT);
    let body = body_string(response).await;
    assert_eq!(body, "abc");
}

#[tokio::test]
async fn renders_directory_links_and_url_encoding() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::create_dir_all(public_dir.join("level1/level2")).unwrap();
    fs::write(public_dir.join("level1/level2/file.txt"), "content").unwrap();
    fs::write(public_dir.join("level1/file1.txt"), "content1").unwrap();
    fs::write(public_dir.join("file with spaces.txt"), "content").unwrap();
    fs::write(public_dir.join("file#hash.txt"), "content").unwrap();

    let app = app(base_config(public_dir));

    let response = app.clone().oneshot(get("/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("href=\"level1/\""));
    assert!(body.contains("href=\"file%20with%20spaces.txt\""));
    assert!(body.contains(">file with spaces.txt<"));
    assert!(body.contains("href=\"file%23hash.txt\""));
    assert!(body.contains(">file#hash.txt<"));

    let response = app.clone().oneshot(get("/level1/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("href=\"level2/\""));
    assert!(body.contains("href=\"file1.txt\""));
    assert!(!body.contains("href=\"level1/level1/"));

    let response = app.oneshot(get("/level1/level2/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("href=\"file.txt\""));
    assert!(!body.contains("href=\"level1/level2/"));
}

#[tokio::test]
async fn listing_links_do_not_double_encode_request_paths() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::create_dir_all(public_dir.join("space dir")).unwrap();
    fs::write(public_dir.join("space dir/file with spaces.txt"), "content").unwrap();

    let app = app(base_config(public_dir));

    let response = app.oneshot(get("/space%20dir/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("href=\"file%20with%20spaces.txt\""));
    assert!(!body.contains("%2520"));
}

#[tokio::test]
async fn applies_ignore_file_in_nested_directories() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::create_dir_all(public_dir.join("nested")).unwrap();
    fs::write(public_dir.join("nested/hidden.log"), "hidden").unwrap();
    fs::write(public_dir.join("nested/visible.txt"), "visible").unwrap();
    fs::write(public_dir.join(".gitignore"), "nested/*.log\n").unwrap();

    let mut config = base_config(public_dir);
    config.listing.ignore_file = Some(".gitignore".into());

    let app = app(config);
    let response = app.oneshot(get("/nested/")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("visible.txt"));
    assert!(!body.contains("hidden.log"));
}

#[tokio::test]
async fn rejects_path_traversal_attempts() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("public.txt"), "public content").unwrap();
    let outside_file = temp_dir.path().parent().unwrap().join("secret.txt");
    fs::write(&outside_file, "secret content").unwrap();

    let app = app(base_config(public_dir));

    let response = app.clone().oneshot(get("/public.txt")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);

    for attempt in [
        "/../secret.txt",
        "/../../secret.txt",
        "/../../../etc/passwd",
        "/..%2fsecret.txt",
        "/%2e%2e/secret.txt",
    ] {
        let response = app.clone().oneshot(get(attempt)).await.unwrap();
        assert_ne!(
            response.status(),
            StatusCode::OK,
            "Traversal attempt succeeded: {attempt}"
        );
    }
}

#[tokio::test]
async fn rejects_encoded_slash_in_path() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::create_dir(public_dir.join("dir")).unwrap();
    fs::write(public_dir.join("dir/file.txt"), "content").unwrap();

    let app = app(base_config(public_dir));
    let response = app.clone().oneshot(get("/dir%2Ffile.txt")).await.unwrap();

    assert_eq!(response.status(), StatusCode::BAD_REQUEST);
}

#[tokio::test]
async fn rejects_backslash_in_path() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::create_dir(public_dir.join("dir")).unwrap();
    fs::write(public_dir.join("dir/file.txt"), "content").unwrap();

    let app = app(base_config(public_dir));

    let response = app.clone().oneshot(get("/dir%5Cfile.txt")).await.unwrap();
    assert_eq!(response.status(), StatusCode::BAD_REQUEST);

    let response = app.oneshot(get("/dir\\file.txt")).await.unwrap();
    assert_eq!(response.status(), StatusCode::BAD_REQUEST);
}

#[cfg(unix)]
#[tokio::test]
async fn permission_denied_file_returns_forbidden() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();
    let file_path = public_dir.join("secret.txt");

    fs::write(&file_path, "secret").unwrap();
    fs::set_permissions(&file_path, fs::Permissions::from_mode(0o000)).unwrap();

    let app = app(base_config(public_dir));
    let response = app.clone().oneshot(get("/secret.txt")).await.unwrap();

    assert_eq!(response.status(), StatusCode::FORBIDDEN);
    fs::set_permissions(&file_path, fs::Permissions::from_mode(0o600)).unwrap();
}

#[cfg(unix)]
#[tokio::test]
async fn permission_denied_directory_returns_forbidden() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();
    let dir_path = public_dir.join("locked");

    fs::create_dir(&dir_path).unwrap();
    fs::set_permissions(&dir_path, fs::Permissions::from_mode(0o000)).unwrap();

    let app = app(base_config(public_dir));
    let response = app.clone().oneshot(get("/locked/")).await.unwrap();

    assert_eq!(response.status(), StatusCode::FORBIDDEN);
    fs::set_permissions(&dir_path, fs::Permissions::from_mode(0o700)).unwrap();
}

#[cfg(unix)]
#[tokio::test]
async fn listing_skips_broken_symlinks() {
    use std::os::unix::fs::symlink;

    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("visible.txt"), "visible").unwrap();
    symlink(public_dir.join("missing.txt"), public_dir.join("broken")).unwrap();

    let app = app(base_config(public_dir));
    let response = app.oneshot(get("/")).await.unwrap();

    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert!(body.contains("visible.txt"));
}

#[tokio::test]
async fn serves_unicode_and_hidden_files() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("🌍.txt"), "unicode filename").unwrap();
    fs::write(public_dir.join(".hidden"), "hidden file").unwrap();
    fs::write(public_dir.join("CAPS.TXT"), "uppercase ext").unwrap();

    let app = app(base_config(public_dir));

    let response = app.clone().oneshot(get("/%F0%9F%8C%8D.txt")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert_eq!(body, "unicode filename");

    let response = app.clone().oneshot(get("/.hidden")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert_eq!(body, "hidden file");

    let response = app.clone().oneshot(get("/CAPS.TXT")).await.unwrap();
    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert_eq!(body, "uppercase ext");
}

#[tokio::test]
async fn serves_percent_encoded_filenames_without_double_decode() {
    let temp_dir = TempDir::new().unwrap();
    let public_dir = temp_dir.path();

    fs::write(public_dir.join("%2F.txt"), "encoded slash").unwrap();

    let app = app(base_config(public_dir));
    let response = app.clone().oneshot(get("/%252F.txt")).await.unwrap();

    assert_eq!(response.status(), StatusCode::OK);
    let body = body_string(response).await;
    assert_eq!(body, "encoded slash");
}