libfw-server 0.1.1

Embeddable libfw server handlers/middleware (axum integration)
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

//! End-to-end HTTP integration tests for the axum router: upload/download,
//! Range/ETag resume, conditional requests, compression, auth and listing.

use std::sync::Arc;

use axum::body::Body;
use axum::http::header::{self, HeaderMap, HeaderValue};
use axum::http::{Request, StatusCode};
use http_body_util::BodyExt;
use libfw_core::auth::{AuthError, PathValidator, TokenVerifier};
use libfw_core::claims::{Permission, TokenClaims};
use libfw_core::compress::{compressor, decompressor, CompressionFormat};
use libfw_core::metadata::encode_file_meta_header;
use libfw_server::{router, FsStorage, ServerState, HEADER_COMPRESS, HEADER_FILE_META, HEADER_OFFSET};
use tower::ServiceExt;

/// A verifier that maps the token to a subject with full permissions.
#[derive(Clone)]
struct DevVerifier;
impl TokenVerifier for DevVerifier {
    fn verify(&self, token: &str) -> Result<TokenClaims, AuthError> {
        Ok(TokenClaims {
            sub: token.to_string(),
            exp: None,
            permissions: vec![Permission::Read, Permission::Write],
            allowed_paths: vec!["/".to_string()],
        })
    }
}

/// A verifier that only allows reads on `/public/`.
#[derive(Clone)]
struct RestrictedVerifier;
impl TokenVerifier for RestrictedVerifier {
    fn verify(&self, token: &str) -> Result<TokenClaims, AuthError> {
        Ok(TokenClaims {
            sub: token.to_string(),
            exp: None,
            permissions: vec![Permission::Read],
            allowed_paths: vec!["/public/".to_string()],
        })
    }
}

fn app(verifier: impl TokenVerifier) -> axum::Router {
    let state = Arc::new(
        ServerState::builder()
            .storage(FsStorage::new(tempfile::tempdir().unwrap().path()))
            .verifier(verifier)
            .validator(PathValidator::new())
            .build(),
    );
    router(state)
}

fn auth_header(token: &str) -> HeaderMap {
    let mut headers = HeaderMap::new();
    headers.insert(
        header::AUTHORIZATION,
        HeaderValue::from_str(&format!("Bearer {token}")).unwrap(),
    );
    headers
}

/// Build a `Request<Body>` from a `HeaderMap`.
fn request(method: &str, uri: &str, headers: HeaderMap, body: Body) -> Request<Body> {
    let mut builder = Request::builder().method(method).uri(uri);
    for (name, value) in headers.iter() {
        builder = builder.header(name, value);
    }
    builder.body(body).unwrap()
}

async fn body_string(response: axum::response::Response) -> String {
    let bytes = response.into_body().collect().await.unwrap().to_bytes();
    String::from_utf8(bytes.to_vec()).unwrap()
}

#[tokio::test]
async fn upload_then_download_roundtrip() {
    let app = app(DevVerifier);
    let data = b"hello libfw streaming transfer".repeat(100);

    // Upload (Create mode: no x-libfw-offset).
    let meta = libfw_core::metadata::FileMeta::new("a/b.txt", data.len() as u64, 1_700_000_000);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    let resp = app
        .clone()
        .oneshot(request("POST", "/file/a/b.txt", headers, Body::from(data.to_vec())))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::CREATED, "body: {}", body_string(resp).await);

    // Download it back.
    let resp = app
        .oneshot(request("GET", "/file/a/b.txt", auth_header("tok"), Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::OK);
    let got = body_string(resp).await.into_bytes();
    assert_eq!(got, data);
}

#[tokio::test]
async fn range_requests_return_206() {
    let app = app(DevVerifier);
    let data = b"0123456789".to_vec();
    let meta = libfw_core::metadata::FileMeta::new("r.bin", 10, 0);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    app.clone()
        .oneshot(request("POST", "/file/r.bin", headers, Body::from(data.clone())))
        .await
        .unwrap();

    let mut headers = auth_header("tok");
    headers.insert(header::RANGE, HeaderValue::from_static("bytes=2-5"));
    let resp = app
        .oneshot(request("GET", "/file/r.bin", headers, Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::PARTIAL_CONTENT);
    assert_eq!(resp.headers().get(header::CONTENT_RANGE).unwrap(), "bytes 2-5/10");
    assert_eq!(resp.headers().get(header::ACCEPT_RANGES).unwrap(), "bytes");
    let got = body_string(resp).await.into_bytes();
    assert_eq!(got, b"2345");
}

#[tokio::test]
async fn if_none_match_returns_304() {
    let app = app(DevVerifier);
    let meta = libfw_core::metadata::FileMeta::new("e.txt", 3, 0);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    let upload = app
        .clone()
        .oneshot(request("POST", "/file/e.txt", headers, Body::from(b"abc".to_vec())))
        .await
        .unwrap();
    assert_eq!(upload.status(), StatusCode::CREATED);

    // The server computes its own ETag from the real file (size + mtime);
    // use that for the conditional request.
    let upload_json: serde_json::Value =
        serde_json::from_str(&body_string(upload).await).expect("upload response is JSON");
    let etag = upload_json["file"]["etag"].as_str().expect("etag present").to_string();

    let mut headers = auth_header("tok");
    headers.insert(header::IF_NONE_MATCH, HeaderValue::from_str(&etag).unwrap());
    let resp = app
        .oneshot(request("GET", "/file/e.txt", headers, Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::NOT_MODIFIED);
}

#[tokio::test]
async fn missing_token_is_401() {
    let app = app(DevVerifier);
    let resp = app
        .oneshot(request("GET", "/file/x.txt", HeaderMap::new(), Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

#[tokio::test]
async fn restricted_path_is_403() {
    let app = app(RestrictedVerifier);
    // Read allowed under /public/, denied elsewhere.
    let resp = app
        .clone()
        .oneshot(request("GET", "/file/private/secret.txt", auth_header("tok"), Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::FORBIDDEN);

    // Write always denied (Read-only token).
    let resp = app
        .oneshot(request("POST", "/file/public/x.txt", auth_header("tok"), Body::from(b"x".to_vec())))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::FORBIDDEN);
}

#[tokio::test]
async fn upload_then_list_dir() {
    let app = app(DevVerifier);
    let meta = libfw_core::metadata::FileMeta::new("sub/f.txt", 2, 0);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    app.clone()
        .oneshot(request("POST", "/file/sub/f.txt", headers, Body::from(b"hi".to_vec())))
        .await
        .unwrap();

    let resp = app
        .oneshot(request("GET", "/dir/sub", auth_header("tok"), Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::OK);
    let body = body_string(resp).await;
    assert!(body.contains("f.txt"), "listing: {body}");
}

#[tokio::test]
async fn compressed_upload_and_download_roundtrip() {
    let app = app(DevVerifier);
    let data: Vec<u8> = (0..200_000u32).map(|i| (i % 251) as u8).collect();

    // Upload compressed: one zstd frame for the whole body.
    let mut enc = compressor(CompressionFormat::Zrip).unwrap();
    let mut payload = Vec::new();
    enc.compress(&data, &mut payload).unwrap();
    enc.finish(&mut payload).unwrap();

    let meta = libfw_core::metadata::FileMeta::new("c.bin", data.len() as u64, 0);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    headers.insert(HEADER_COMPRESS, HeaderValue::from_static("zrip"));
    let resp = app
        .clone()
        .oneshot(request("POST", "/file/c.bin", headers, Body::from(payload)))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::CREATED);

    // Download with Accept-Encoding: zrip and decompress the response.
    let mut headers = auth_header("tok");
    headers.insert(header::ACCEPT_ENCODING, HeaderValue::from_static("zrip"));
    let resp = app
        .oneshot(request("GET", "/file/c.bin", headers, Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::OK);
    assert_eq!(resp.headers().get(HEADER_COMPRESS).unwrap(), "zrip");
    let compressed = resp.into_body().collect().await.unwrap().to_bytes();
    let mut dec = decompressor(CompressionFormat::Zrip);
    let mut plain = Vec::new();
    dec.decompress(&compressed, &mut plain).unwrap();
    dec.finish(&mut plain).unwrap();
    assert_eq!(plain, data);
}

#[tokio::test]
async fn browser_zstd_accept_encoding_does_not_trigger_zrip() {
    // Regression: a browser sends `Accept-Encoding: gzip, deflate, br,
    // zstd` automatically. This must NOT be interpreted as a request for
    // libfw's private zrip wire format (which a plain browser `fetch`
    // cannot decode) — the server must reply identity instead.
    let app = app(DevVerifier);
    let data = b"plain text body".to_vec();
    let meta = libfw_core::metadata::FileMeta::new("z.bin", data.len() as u64, 0);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    app.clone()
        .oneshot(request("POST", "/file/z.bin", headers, Body::from(data.clone())))
        .await
        .unwrap();

    let mut headers = auth_header("tok");
    headers.insert(
        header::ACCEPT_ENCODING,
        HeaderValue::from_static("gzip, deflate, br, zstd"),
    );
    let resp = app
        .oneshot(request("GET", "/file/z.bin", headers, Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::OK);
    // No zrip — a plain consumer can read the body verbatim.
    assert_eq!(resp.headers().get(HEADER_COMPRESS).unwrap(), "identity");
    let got = body_string(resp).await.into_bytes();
    assert_eq!(got, data);
}

#[tokio::test]
async fn resume_upload_at_offset() {
    let app = app(DevVerifier);
    let meta = libfw_core::metadata::FileMeta::new("res.txt", 6, 0);

    // First chunk: offset 0 → overwrite mode.
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    headers.insert(HEADER_OFFSET, HeaderValue::from_static("0"));
    app.clone()
        .oneshot(request("POST", "/file/res.txt", headers.clone(), Body::from(b"ABCD".to_vec())))
        .await
        .unwrap();

    // Second chunk: offset 4 → resume mode appends.
    headers.insert(HEADER_OFFSET, HeaderValue::from_static("4"));
    let resp = app
        .clone()
        .oneshot(request("POST", "/file/res.txt", headers, Body::from(b"EF".to_vec())))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::CREATED);

    let resp = app
        .oneshot(request("GET", "/file/res.txt", auth_header("tok"), Body::empty()))
        .await
        .unwrap();
    assert_eq!(body_string(resp).await, "ABCDEF");
}

#[tokio::test]
async fn bad_resume_offset_is_412() {
    let app = app(DevVerifier);
    let meta = libfw_core::metadata::FileMeta::new("bad.txt", 4, 0);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    app.clone()
        .oneshot(request("POST", "/file/bad.txt", headers.clone(), Body::from(b"ABCD".to_vec())))
        .await
        .unwrap();

    // Resume at a wrong offset must fail with 412 so the client resets.
    headers.insert(HEADER_OFFSET, HeaderValue::from_static("9"));
    let resp = app
        .oneshot(request("POST", "/file/bad.txt", headers, Body::from(b"X".to_vec())))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::PRECONDITION_FAILED);
}

#[tokio::test]
async fn unsatisfiable_range_is_416() {
    let app = app(DevVerifier);
    let meta = libfw_core::metadata::FileMeta::new("s.bin", 5, 0);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    app.clone()
        .oneshot(request("POST", "/file/s.bin", headers, Body::from(b"12345".to_vec())))
        .await
        .unwrap();

    let mut headers = auth_header("tok");
    headers.insert(header::RANGE, HeaderValue::from_static("bytes=100-"));
    let resp = app
        .oneshot(request("GET", "/file/s.bin", headers, Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::RANGE_NOT_SATISFIABLE);
    assert_eq!(resp.headers().get(header::CONTENT_RANGE).unwrap(), "bytes */5");
}

#[tokio::test]
async fn path_traversal_is_rejected() {
    let app = app(DevVerifier);
    let resp = app
        .oneshot(request("GET", "/file/../secret", auth_header("tok"), Body::empty()))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
}

#[tokio::test]
async fn duplicate_upload_without_offset_conflicts() {
    let app = app(DevVerifier);
    let meta = libfw_core::metadata::FileMeta::new("dup.txt", 1, 0);
    let mut headers = auth_header("tok");
    headers.insert(HEADER_FILE_META, HeaderValue::from_str(&encode_file_meta_header(&meta)).unwrap());
    app.clone()
        .oneshot(request("POST", "/file/dup.txt", headers.clone(), Body::from(b"a".to_vec())))
        .await
        .unwrap();

    // Second Create-mode upload (no offset) → 409 Conflict.
    let resp = app
        .oneshot(request("POST", "/file/dup.txt", headers, Body::from(b"b".to_vec())))
        .await
        .unwrap();
    assert_eq!(resp.status(), StatusCode::CONFLICT);
}