mechanics-http-server 0.1.3

Opportunistic HTTP/3 (QUIC) listener and Alt-Svc middleware for mechanics-family servers, with aws-lc-rs as the sole crypto provider.
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
use std::convert::Infallible;
use std::net::{Ipv4Addr, SocketAddr};
use std::pin::Pin;
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::task::{Context, Poll};
use std::time::Duration;

use bytes::{Buf, Bytes};
use http::header::ALT_SVC;
use http::{Method, Request, Response, StatusCode};
use http_body::Frame;
use http_body_util::{BodyExt, Full};
use rcgen::{CertifiedKey, generate_simple_self_signed};
use rustls::pki_types::{CertificateDer, PrivateKeyDer, PrivatePkcs8KeyDer};
use tokio::net::UdpSocket;
use tower::util::BoxCloneService;
use tower::{Layer, Service, ServiceExt, service_fn};

use crate::{
    H3RequestBody, Http3Server, Http3ServerConfig, alt_svc_layer,
    axum_compat::router_into_h3_service, default_zero_rtt_methods, is_zero_rtt_safe,
};

const STREAM_TEST_BYTES: usize = 8 * 1024 * 1024;
const STREAM_TEST_CHUNK_BYTES: usize = 64 * 1024;

fn test_service() -> BoxCloneService<Request<H3RequestBody>, Response<Full<Bytes>>, Infallible> {
    service_fn(|request: Request<H3RequestBody>| async move {
        let body = if request.uri().path() == "/test" {
            Bytes::from_static(b"routed")
        } else {
            Bytes::new()
        };
        Ok::<_, Infallible>(Response::new(Full::new(body)))
    })
    .boxed_clone()
}

fn test_tls_material() -> (Vec<CertificateDer<'static>>, PrivateKeyDer<'static>) {
    let CertifiedKey { cert, key_pair } =
        generate_simple_self_signed(vec!["localhost".to_owned()]).unwrap();
    let cert_chain = vec![cert.der().clone()];
    let key = PrivateKeyDer::from(PrivatePkcs8KeyDer::from(key_pair.serialize_der()));
    (cert_chain, key)
}

#[tokio::test]
async fn start_with_no_bind_is_inert() {
    let (cert_chain, key) = test_tls_material();
    let server = Http3Server::new(Http3ServerConfig {
        bind_h3: None,
        ..Http3ServerConfig::default()
    });

    let handle = server.start(test_service(), cert_chain, key).unwrap();

    assert!(handle.is_inert());
    assert_eq!(handle.local_addr(), None);
    assert!(
        tokio::time::timeout(Duration::from_millis(50), handle)
            .await
            .unwrap()
            .is_ok()
    );
}

#[tokio::test]
async fn start_with_bind_opens_listener() {
    let (cert_chain, key) = test_tls_material();
    let bind_h3 = SocketAddr::from((Ipv4Addr::LOCALHOST, 0));
    let server = Http3Server::new(Http3ServerConfig {
        bind_h3: Some(bind_h3),
        ..Http3ServerConfig::default()
    });

    let handle = server.start(test_service(), cert_chain, key).unwrap();
    let local_addr = handle.local_addr().unwrap();

    assert_ne!(local_addr.port(), 0);
    assert!(!handle.is_finished());
    assert!(UdpSocket::bind(local_addr).await.is_err());

    handle.shutdown();
    assert!(
        tokio::time::timeout(Duration::from_secs(1), handle)
            .await
            .unwrap()
            .is_ok()
    );
}

#[tokio::test]
#[ignore = "D22 server round 02 fixture work: mechanics-http-client does not expose a self-signed test trust hook"]
async fn end_to_end_h3_request_via_mhc() {}

#[tokio::test]
async fn request_routes_into_tower_service_substitute() {
    fn assert_h3_service<S>(service: S) -> S
    where
        S: Service<Request<H3RequestBody>, Response = Response<Full<Bytes>>>,
    {
        service
    }

    let _service = assert_h3_service(test_service());
}

#[tokio::test]
async fn axum_router_adapter_returns_streaming_body_response() {
    let router = axum::Router::new().route(
        "/test",
        axum::routing::get(|| async { axum::response::Html("routed") }),
    );
    let service = router_into_h3_service(router);

    fn assert_h3_service<S>(service: S) -> S
    where
        S: Service<Request<H3RequestBody>, Response = Response<axum::body::Body>>,
    {
        service
    }

    let _service = assert_h3_service(service);
}

#[tokio::test]
#[ignore = "binds UDP and exercises an in-process HTTP/3 client/server pair"]
async fn end_to_end_h3_streams_large_request_and_response_bodies() {
    let (cert_chain, key) = test_tls_material();
    let request_frame_count = Arc::new(AtomicUsize::new(0));
    let service_frame_count = Arc::clone(&request_frame_count);
    let service = service_fn(move |request: Request<H3RequestBody>| {
        let service_frame_count = Arc::clone(&service_frame_count);
        async move {
            let response = match request.uri().path() {
                "/echo" => {
                    let mut body = request.into_body();
                    let mut echoed = Vec::with_capacity(STREAM_TEST_BYTES);
                    while let Some(frame) = body.frame().await {
                        let frame = frame.unwrap();
                        if let Ok(mut data) = frame.into_data() {
                            service_frame_count.fetch_add(1, Ordering::Relaxed);
                            let remaining = data.remaining();
                            echoed.extend_from_slice(&data.copy_to_bytes(remaining));
                        }
                    }
                    Response::new(StreamingTestBody::once(Bytes::from(echoed)))
                }
                "/pattern" => Response::new(StreamingTestBody::pattern(STREAM_TEST_BYTES)),
                _ => {
                    let mut response = Response::new(StreamingTestBody::once(Bytes::new()));
                    *response.status_mut() = StatusCode::NOT_FOUND;
                    response
                }
            };
            Ok::<_, Infallible>(response)
        }
    });

    let server = Http3Server::new(Http3ServerConfig {
        bind_h3: Some(SocketAddr::from((Ipv4Addr::LOCALHOST, 0))),
        ..Http3ServerConfig::default()
    });
    let handle = server.start(service, cert_chain.clone(), key).unwrap();
    let local_addr = handle.local_addr().unwrap();
    let mut client = H3TestClient::connect(local_addr, cert_chain[0].clone()).await;

    let request_body = randomish_bytes(STREAM_TEST_BYTES);
    let (echoed, request_frames_sent, _) = client
        .request_with_body(Method::POST, "/echo", &request_body)
        .await;
    assert_eq!(echoed, request_body);
    assert!(request_frames_sent > 1);
    assert!(request_frame_count.load(Ordering::Relaxed) > 1);

    let (pattern, _, response_frames_received) =
        client.request_with_body(Method::GET, "/pattern", &[]).await;
    assert_eq!(pattern, incrementing_pattern(STREAM_TEST_BYTES));
    assert!(response_frames_received > 1);

    handle.shutdown();
    tokio::time::timeout(Duration::from_secs(1), handle)
        .await
        .unwrap()
        .unwrap();
}

#[tokio::test]
async fn alt_svc_layer_adds_header() {
    let layer = alt_svc_layer(443, 86_400);
    let mut service = layer.layer(service_fn(|_: Request<()>| async {
        Ok::<_, Infallible>(Response::new(()))
    }));

    for _ in 0..2 {
        let response = service
            .ready()
            .await
            .unwrap()
            .call(Request::new(()))
            .await
            .unwrap();
        assert_eq!(
            response.headers().get(ALT_SVC).unwrap(),
            r#"h3=":443"; ma=86400"#
        );
    }
}

#[tokio::test]
async fn alt_svc_layer_respects_custom_port_and_max_age() {
    let layer = alt_svc_layer(8443, 3_600);
    let mut service = layer.layer(service_fn(|_: Request<()>| async {
        Ok::<_, Infallible>(Response::new(()))
    }));

    let response = service
        .ready()
        .await
        .unwrap()
        .call(Request::new(()))
        .await
        .unwrap();

    assert_eq!(
        response.headers().get(ALT_SVC).unwrap(),
        r#"h3=":8443"; ma=3600"#
    );
}

#[tokio::test]
async fn alt_svc_layer_is_idempotent_under_repeated_layer_stacking() {
    let layer = alt_svc_layer(443, 86_400);
    let mut service = layer
        .clone()
        .layer(layer.layer(service_fn(|_: Request<()>| async {
            Ok::<_, Infallible>(Response::new(()))
        })));

    let response = service
        .ready()
        .await
        .unwrap()
        .call(Request::new(()))
        .await
        .unwrap();

    let mut values = response.headers().get_all(ALT_SVC).iter();
    assert_eq!(values.next().unwrap(), r#"h3=":443"; ma=86400"#);
    assert!(values.next().is_none());
}

#[test]
fn zero_rtt_policy_default_rejects_non_idempotent_methods() {
    let allowed = default_zero_rtt_methods();

    assert!(is_zero_rtt_safe(&Method::GET, &allowed));
    assert!(is_zero_rtt_safe(&Method::HEAD, &allowed));
    assert!(!is_zero_rtt_safe(&Method::POST, &allowed));
    assert!(!is_zero_rtt_safe(&Method::PUT, &allowed));
    assert!(!is_zero_rtt_safe(&Method::PATCH, &allowed));
    assert!(!is_zero_rtt_safe(&Method::DELETE, &allowed));
    assert!(!is_zero_rtt_safe(&Method::OPTIONS, &allowed));
}

#[test]
fn zero_rtt_policy_honours_config_override() {
    let allowed = vec![Method::GET, Method::HEAD, Method::OPTIONS];

    assert!(is_zero_rtt_safe(&Method::OPTIONS, &allowed));
}

struct StreamingTestBody {
    kind: StreamingTestBodyKind,
}

enum StreamingTestBodyKind {
    Once(Option<Bytes>),
    Pattern {
        offset: usize,
        len: usize,
        chunk_size: usize,
    },
}

impl StreamingTestBody {
    fn once(bytes: Bytes) -> Self {
        Self {
            kind: StreamingTestBodyKind::Once(Some(bytes)),
        }
    }

    fn pattern(len: usize) -> Self {
        Self {
            kind: StreamingTestBodyKind::Pattern {
                offset: 0,
                len,
                chunk_size: STREAM_TEST_CHUNK_BYTES,
            },
        }
    }
}

impl http_body::Body for StreamingTestBody {
    type Data = Bytes;
    type Error = Infallible;

    fn poll_frame(
        mut self: Pin<&mut Self>,
        _cx: &mut Context<'_>,
    ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>> {
        match &mut self.kind {
            StreamingTestBodyKind::Once(bytes) => {
                Poll::Ready(bytes.take().map(|bytes| Ok(Frame::data(bytes))))
            }
            StreamingTestBodyKind::Pattern {
                offset,
                len,
                chunk_size,
            } => {
                if *offset >= *len {
                    return Poll::Ready(None);
                }
                let end = (*offset + *chunk_size).min(*len);
                let chunk = incrementing_pattern_range(*offset, end);
                *offset = end;
                Poll::Ready(Some(Ok(Frame::data(Bytes::from(chunk)))))
            }
        }
    }

    fn is_end_stream(&self) -> bool {
        match &self.kind {
            StreamingTestBodyKind::Once(bytes) => bytes.is_none(),
            StreamingTestBodyKind::Pattern { offset, len, .. } => offset >= len,
        }
    }
}

struct H3TestClient {
    _endpoint: quinn::Endpoint,
    send_request: h3::client::SendRequest<h3_quinn::OpenStreams, Bytes>,
}

impl H3TestClient {
    async fn connect(addr: SocketAddr, cert: CertificateDer<'static>) -> Self {
        let mut roots = rustls::RootCertStore::empty();
        roots.add(cert).unwrap();
        let provider = Arc::new(rustls::crypto::aws_lc_rs::default_provider());
        let mut tls_config = rustls::ClientConfig::builder_with_provider(provider)
            .with_safe_default_protocol_versions()
            .unwrap()
            .with_root_certificates(roots)
            .with_no_client_auth();
        tls_config.alpn_protocols = vec![b"h3".to_vec()];
        let quic_config = quinn::crypto::rustls::QuicClientConfig::try_from(tls_config).unwrap();
        let client_config = quinn::ClientConfig::new(Arc::new(quic_config));
        let mut endpoint =
            quinn::Endpoint::client(SocketAddr::from((Ipv4Addr::LOCALHOST, 0))).unwrap();
        endpoint.set_default_client_config(client_config);
        let connection = endpoint.connect(addr, "localhost").unwrap().await.unwrap();
        let quic = h3_quinn::Connection::new(connection);
        let (mut driver, send_request) = h3::client::builder().build(quic).await.unwrap();
        tokio::spawn(async move {
            let _ = driver.wait_idle().await;
        });

        Self {
            _endpoint: endpoint,
            send_request,
        }
    }

    async fn request_with_body(
        &mut self,
        method: Method,
        path: &str,
        body: &[u8],
    ) -> (Vec<u8>, usize, usize) {
        let uri = format!("https://localhost{path}");
        let request = Request::builder().method(method).uri(uri).body(()).unwrap();
        let mut stream = self.send_request.send_request(request).await.unwrap();
        let mut request_frames_sent = 0;
        for chunk in body.chunks(STREAM_TEST_CHUNK_BYTES) {
            stream
                .send_data(Bytes::copy_from_slice(chunk))
                .await
                .unwrap();
            request_frames_sent += 1;
        }
        stream.finish().await.unwrap();

        let response = stream.recv_response().await.unwrap();
        assert_eq!(response.status(), StatusCode::OK);
        let mut response_body = Vec::new();
        let mut response_frames_received = 0;
        while let Some(mut data) = stream.recv_data().await.unwrap() {
            response_frames_received += 1;
            let remaining = data.remaining();
            response_body.extend_from_slice(&data.copy_to_bytes(remaining));
        }

        (response_body, request_frames_sent, response_frames_received)
    }
}

fn randomish_bytes(len: usize) -> Vec<u8> {
    let mut state = 0x9e37_79b9_u32;
    let mut bytes = Vec::with_capacity(len);
    for _ in 0..len {
        state ^= state << 13;
        state ^= state >> 17;
        state ^= state << 5;
        bytes.push((state >> 24) as u8);
    }
    bytes
}

fn incrementing_pattern(len: usize) -> Vec<u8> {
    incrementing_pattern_range(0, len)
}

fn incrementing_pattern_range(start: usize, end: usize) -> Vec<u8> {
    (start..end).map(|index| (index % 251) as u8).collect()
}