h3x 0.6.1

Peer-to-peer DHTTP/3 transport over QUIC
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
use std::sync::Arc;

use bytes::Bytes;
use http::{Method, StatusCode};
use http_body::Body;
use http_body_util::Empty;
use snafu::{OptionExt, ResultExt, Snafu, ensure};

use crate::{
    connection::ConnectionState,
    dhttp::message::{MessageReader, MessageWriter, hyper::upgrade::TakeoverError},
    extended_connect::{EstablishedConnect, PendingWriteStreamError},
    qpack::field::Protocol,
    quic,
    stream_id::StreamId,
};

#[derive(Debug, Snafu)]
#[snafu(module, visibility(pub))]
pub enum EstablishError {
    #[snafu(display("extended connect response was rejected with status {status}"))]
    Rejected { status: StatusCode },
    #[snafu(display("extended connect response is missing stream ID metadata"))]
    MissingStreamId,
    #[snafu(display("extended connect response is missing connection metadata"))]
    MissingConnection,
    #[snafu(display("failed to take over extended connect read stream"))]
    TakeRead { source: TakeoverError },
    #[snafu(display("failed to take over extended connect write stream"))]
    TakeWrite { source: TakeoverError },
}

#[derive(Debug, Snafu)]
#[snafu(module, visibility(pub))]
pub enum AcceptError {
    #[snafu(display("request method {method} is not extended connect"))]
    NotConnect { method: Method },
    #[snafu(display("extended connect request is missing stream ID metadata"))]
    MissingStreamId,
    #[snafu(display("extended connect request is missing connection metadata"))]
    MissingConnection,
    #[snafu(display("failed to take over extended connect read stream"))]
    TakeRead { source: TakeoverError },
}

fn pending_write_error(error: TakeoverError) -> PendingWriteStreamError {
    match error {
        TakeoverError::Unsupported => PendingWriteStreamError::Unsupported,
        TakeoverError::AlreadyTaken => PendingWriteStreamError::AlreadyTaken,
        TakeoverError::Aborted => PendingWriteStreamError::Aborted,
        TakeoverError::BodyNotReleased => PendingWriteStreamError::BodyNotReleased,
    }
}

pub async fn establish<B>(
    mut response: http::Response<B>,
) -> Result<EstablishedConnect, EstablishError>
where
    B: Body + Unpin + Send + 'static,
{
    ensure!(
        response.status().is_success(),
        establish_error::RejectedSnafu {
            status: response.status(),
        }
    );

    let stream_id = *response
        .extensions()
        .get::<StreamId>()
        .context(establish_error::MissingStreamIdSnafu)?;
    let connection = response
        .extensions()
        .get::<Arc<ConnectionState<dyn quic::DynConnection>>>()
        .cloned()
        .context(establish_error::MissingConnectionSnafu)?;
    let protocol = response.extensions().get::<Protocol>().cloned();

    let read = crate::hyper::upgrade::take::<MessageReader>(&mut response)
        .await
        .context(establish_error::TakeReadSnafu)?;
    let write = crate::hyper::upgrade::take::<MessageWriter>(&mut response)
        .await
        .context(establish_error::TakeWriteSnafu)?;

    Ok(EstablishedConnect::ready(
        stream_id, protocol, connection, read, write,
    ))
}

pub async fn accept<B>(
    mut request: http::Request<B>,
) -> Result<(http::Response<Empty<Bytes>>, EstablishedConnect), AcceptError>
where
    B: Body + Unpin + Send + 'static,
{
    ensure!(
        request.method() == Method::CONNECT,
        accept_error::NotConnectSnafu {
            method: request.method().clone(),
        }
    );

    let stream_id = *request
        .extensions()
        .get::<StreamId>()
        .context(accept_error::MissingStreamIdSnafu)?;
    let connection = request
        .extensions()
        .get::<Arc<ConnectionState<dyn quic::DynConnection>>>()
        .cloned()
        .context(accept_error::MissingConnectionSnafu)?;
    let protocol = request.extensions().get::<Protocol>().cloned();

    let read = crate::hyper::upgrade::take::<MessageReader>(&mut request)
        .await
        .context(accept_error::TakeReadSnafu)?;

    let write = async move {
        match crate::hyper::upgrade::take::<MessageWriter>(&mut request).await {
            Ok(write) => Ok(write),
            Err(error) => Err(pending_write_error(error)),
        }
    };

    let response = http::Response::builder()
        .status(StatusCode::OK)
        .body(Empty::<Bytes>::new())
        .expect("200 OK response with empty body is valid");

    let connect = EstablishedConnect::pending(stream_id, protocol, connection, read, write);
    Ok((response, connect))
}

#[cfg(test)]
mod tests {
    use std::{
        pin::Pin,
        sync::Arc,
        task::{Context, Poll},
    };

    use http::{Request, Response, StatusCode};
    use http_body::Body;

    use super::*;
    use crate::{
        connection::{ConnectionState, tests::MockConnection},
        dhttp::message::{
            hyper::upgrade::{RemainStream, TakeoverSlot},
            test::{read_stream_for_test, write_stream_for_test},
        },
        protocol::Protocols,
        qpack::field::Protocol,
        varint::VarInt,
    };

    #[derive(Debug, Clone)]
    struct ErrorBody;

    impl Body for ErrorBody {
        type Data = Bytes;
        type Error = std::io::Error;

        fn poll_frame(
            self: Pin<&mut Self>,
            _cx: &mut Context<'_>,
        ) -> Poll<Option<Result<http_body::Frame<Self::Data>, Self::Error>>> {
            Poll::Ready(Some(Err(std::io::Error::other("body error"))))
        }
    }

    fn state_for_test() -> Arc<ConnectionState<dyn quic::DynConnection>> {
        let quic = Arc::new(MockConnection::new());
        let erased: Arc<dyn quic::DynConnection> = quic;
        Arc::new(ConnectionState::new_for_test(
            erased,
            Arc::new(Protocols::new()),
        ))
    }

    #[tokio::test]
    async fn establish_rejects_non_success_status() {
        let response = Response::builder()
            .status(StatusCode::BAD_REQUEST)
            .body(Empty::<Bytes>::new())
            .expect("valid response");

        let error = match establish(response).await {
            Ok(_) => panic!("non-2xx CONNECT is rejected"),
            Err(error) => error,
        };
        assert!(
            matches!(error, EstablishError::Rejected { status } if status == StatusCode::BAD_REQUEST)
        );
    }

    #[tokio::test]
    async fn establish_requires_stream_id_metadata() {
        let response = Response::builder()
            .status(StatusCode::OK)
            .body(Empty::<Bytes>::new())
            .expect("valid response");

        let error = match establish(response).await {
            Ok(_) => panic!("stream ID metadata is required"),
            Err(error) => error,
        };
        assert!(matches!(error, EstablishError::MissingStreamId));
    }

    #[tokio::test]
    async fn establish_requires_connection_metadata() {
        let stream_id = StreamId::from(VarInt::from_u32(4));
        let mut response = Response::builder()
            .status(StatusCode::OK)
            .body(Empty::<Bytes>::new())
            .expect("valid response");

        response.extensions_mut().insert(stream_id);
        response
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));
        response
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                write_stream_for_test(stream_id.0),
            )));

        let error = match establish(response).await {
            Ok(_) => panic!("connection metadata is required"),
            Err(error) => error,
        };
        assert!(matches!(error, EstablishError::MissingConnection));
    }

    #[tokio::test]
    async fn establish_returns_ready_connect_with_protocol_and_streams() {
        let stream_id = StreamId::from(VarInt::from_u32(8));
        let state = state_for_test();
        let protocol = Protocol::new("webtransport-h3");
        let mut response = Response::builder()
            .status(StatusCode::OK)
            .body(Empty::<Bytes>::new())
            .expect("valid response");

        response.extensions_mut().insert(stream_id);
        response.extensions_mut().insert(state.clone());
        response.extensions_mut().insert(protocol.clone());
        response
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));
        response
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                write_stream_for_test(stream_id.0),
            )));

        let connect = establish(response).await.expect("establish should succeed");
        assert!(Arc::ptr_eq(connect.connection(), &state));
        assert_eq!(connect.stream_id(), stream_id);
        assert_eq!(
            connect.protocol().map(Protocol::as_str),
            Some("webtransport-h3")
        );

        let (_read, _write) = connect
            .into_streams()
            .await
            .expect("establish should provide streams");
    }

    #[tokio::test]
    async fn establish_missing_protocol_defaults_to_none() {
        let stream_id = StreamId::from(VarInt::from_u32(12));
        let state = state_for_test();
        let mut response = Response::builder()
            .status(StatusCode::OK)
            .body(Empty::<Bytes>::new())
            .expect("valid response");

        response.extensions_mut().insert(stream_id);
        response.extensions_mut().insert(state);
        response
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));
        response
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                write_stream_for_test(stream_id.0),
            )));

        let connect = establish(response).await.expect("establish should succeed");
        assert_eq!(connect.protocol(), None);
        assert_eq!(connect.stream_id(), stream_id);
    }

    #[tokio::test]
    async fn establish_fails_when_write_slot_is_missing() {
        let stream_id = StreamId::from(VarInt::from_u32(16));
        let state = state_for_test();
        let mut response = Response::builder()
            .status(StatusCode::OK)
            .body(Empty::<Bytes>::new())
            .expect("valid response");

        response.extensions_mut().insert(stream_id);
        response.extensions_mut().insert(state);
        response
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));

        let error = match establish(response).await {
            Ok(_) => panic!("missing write takeover slot should fail"),
            Err(error) => error,
        };
        assert!(matches!(
            error,
            EstablishError::TakeWrite {
                source: TakeoverError::Unsupported
            }
        ));
    }

    #[tokio::test]
    async fn establish_fails_when_read_slot_is_missing() {
        let stream_id = StreamId::from(VarInt::from_u32(18));
        let state = state_for_test();
        let mut response = Response::builder()
            .status(StatusCode::OK)
            .body(Empty::<Bytes>::new())
            .expect("valid response");

        response.extensions_mut().insert(stream_id);
        response.extensions_mut().insert(state);
        response
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                write_stream_for_test(stream_id.0),
            )));

        let error = establish(response)
            .await
            .err()
            .expect("missing read takeover slot should fail");
        assert!(matches!(
            error,
            EstablishError::TakeRead {
                source: TakeoverError::Unsupported
            }
        ));
    }

    #[tokio::test]
    async fn accept_rejects_non_connect_request() {
        let request = Request::builder()
            .method(http::Method::GET)
            .uri("https://example.test/")
            .extension(Protocol::new("webtransport-h3"))
            .body(Empty::<Bytes>::new())
            .expect("valid request");

        let error = match accept(request).await {
            Ok(_) => panic!("only CONNECT can be accepted"),
            Err(error) => error,
        };
        assert!(matches!(error, AcceptError::NotConnect { method } if method == http::Method::GET));
    }

    #[tokio::test]
    async fn accept_requires_stream_id_metadata() {
        let request = Request::builder()
            .method(http::Method::CONNECT)
            .uri("https://example.test/session")
            .body(Empty::<Bytes>::new())
            .expect("valid request");

        let error = match accept(request).await {
            Ok(_) => panic!("stream ID metadata is required"),
            Err(error) => error,
        };
        assert!(matches!(error, AcceptError::MissingStreamId));
    }

    #[tokio::test]
    async fn accept_requires_connection_metadata() {
        let stream_id = StreamId::from(VarInt::from_u32(20));
        let mut request = Request::builder()
            .method(http::Method::CONNECT)
            .uri("https://example.test/session")
            .body(Empty::<Bytes>::new())
            .expect("valid request");

        request.extensions_mut().insert(stream_id);
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                write_stream_for_test(stream_id.0),
            )));

        let error = match accept(request).await {
            Ok(_) => panic!("connection metadata is required"),
            Err(error) => error,
        };
        assert!(matches!(error, AcceptError::MissingConnection));
    }

    #[tokio::test]
    async fn accept_returns_ok_response_and_connect_with_streams() {
        let stream_id = StreamId::from(VarInt::from_u32(24));
        let state = state_for_test();
        let protocol = Protocol::new("webtransport-h3");
        let mut request = Request::builder()
            .method(http::Method::CONNECT)
            .uri("https://example.test/session")
            .body(Empty::<Bytes>::new())
            .expect("valid request");

        request.extensions_mut().insert(stream_id);
        request.extensions_mut().insert(state.clone());
        request.extensions_mut().insert(protocol.clone());
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                write_stream_for_test(stream_id.0),
            )));

        let (response, connect) = accept(request).await.expect("accept should succeed");
        assert_eq!(response.status(), StatusCode::OK);

        assert_eq!(connect.stream_id(), stream_id);
        assert_eq!(
            connect.protocol().map(Protocol::as_str),
            Some("webtransport-h3")
        );
        assert!(Arc::ptr_eq(connect.connection(), &state));

        let (_read, _write) = connect
            .into_streams()
            .await
            .expect("streams should be ready");
    }

    #[tokio::test]
    async fn accept_missing_protocol_defaults_to_none() {
        let stream_id = StreamId::from(VarInt::from_u32(28));
        let state = state_for_test();
        let mut request = Request::builder()
            .method(http::Method::CONNECT)
            .uri("https://example.test/session")
            .body(Empty::<Bytes>::new())
            .expect("valid request");

        request.extensions_mut().insert(stream_id);
        request.extensions_mut().insert(state);
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                write_stream_for_test(stream_id.0),
            )));

        let (_response, connect) = accept(request).await.expect("accept should succeed");
        assert_eq!(connect.protocol(), None);
    }

    #[tokio::test]
    async fn accept_fails_when_read_takeover_fails() {
        let stream_id = StreamId::from(VarInt::from_u32(32));
        let mut request = Request::builder()
            .method(http::Method::CONNECT)
            .uri("https://example.test/session")
            .body(ErrorBody)
            .expect("valid request");

        request.extensions_mut().insert(stream_id);
        request.extensions_mut().insert(state_for_test());
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                write_stream_for_test(stream_id.0),
            )));

        let error = match accept(request).await {
            Ok(_) => panic!("read body errors should fail takeover"),
            Err(error) => error,
        };
        assert!(matches!(
            error,
            AcceptError::TakeRead {
                source: TakeoverError::BodyNotReleased
            }
        ));
    }

    #[tokio::test]
    async fn accept_into_streams_reports_missing_write_takeover_as_pending_error() {
        let stream_id = StreamId::from(VarInt::from_u32(36));
        let mut request = Request::builder()
            .method(http::Method::CONNECT)
            .uri("https://example.test/session")
            .body(Empty::<Bytes>::new())
            .expect("valid request");

        request.extensions_mut().insert(stream_id);
        request.extensions_mut().insert(state_for_test());
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));

        let (_response, connect) = accept(request).await.expect("accept should parse request");
        let error = match connect.into_streams().await {
            Ok(_) => panic!("write takeover should be unsupported"),
            Err(error) => error,
        };
        assert!(matches!(
            error,
            crate::extended_connect::IntoStreamsError::PendingWriteStream {
                source: crate::extended_connect::PendingWriteStreamError::Unsupported
            }
        ));
    }

    #[tokio::test]
    async fn accept_into_streams_reports_aborted_write_takeover_as_pending_error() {
        let stream_id = StreamId::from(VarInt::from_u32(40));
        let mut request = Request::builder()
            .method(http::Method::CONNECT)
            .uri("https://example.test/session")
            .body(Empty::<Bytes>::new())
            .expect("valid request");

        request.extensions_mut().insert(stream_id);
        request.extensions_mut().insert(state_for_test());
        request
            .extensions_mut()
            .insert(TakeoverSlot::new(RemainStream::immediately(
                read_stream_for_test(stream_id.0),
            )));
        let (write_tx, write) = RemainStream::<MessageWriter>::pending();
        request.extensions_mut().insert(TakeoverSlot::new(write));
        drop(write_tx);

        let (_response, connect) = accept(request).await.expect("accept should parse request");
        let error = connect
            .into_streams()
            .await
            .err()
            .expect("write takeover should be aborted");
        assert!(matches!(
            error,
            crate::extended_connect::IntoStreamsError::PendingWriteStream {
                source: crate::extended_connect::PendingWriteStreamError::Aborted
            }
        ));
    }
}