dquic 0.5.0

An IETF quic transport protocol implemented natively using async Rust
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
use std::{future::Future, sync::Arc, time::Duration};

use dquic::{
    prelude::{handy::*, *},
    qbase,
    qresolve::Source,
};
use qbase::param::ServerParameters;
use qconnection::qinterface::{bind_uri::BindUri, component::route::QuicRouter};
use rustls::{
    pki_types::{CertificateDer, pem::PemObject},
    server::WebPkiClientVerifier,
};
use tokio::{
    io::{AsyncReadExt, AsyncWriteExt},
    time,
};
use tokio_util::task::AbortOnDropHandle;

mod common;
use common::*;
mod echo_common;
use echo_common::*;

#[test]
fn client_without_verify() -> Result<(), BoxError> {
    run(async {
        let router = Arc::new(QuicRouter::default());
        let (listeners, server_task) =
            launch_echo_server(router.clone(), server_parameters()).await?;
        let _server_task = AbortOnDropHandle::new(tokio::spawn(server_task));

        let server_addr = get_server_addr(&listeners);

        let client = {
            let parameters = client_parameters();
            let client = QuicClient::builder()
                .with_router(router)
                .without_verifier()
                .with_parameters(parameters)
                .without_cert()
                .with_qlog(qlogger())
                .enable_sslkeylog()
                .build();
            Arc::new(client)
        };

        let connection = client
            .connected_to_with_source("localhost", [(Source::System, server_addr.into())])
            .await?;
        send_and_verify_echo(&connection, TEST_DATA).await?;

        listeners.shutdown();
        Ok(())
    })
}

struct ClientNameAuther<const SILENT_REFUSE: bool>;

impl<const SILENT: bool> AuthClient for ClientNameAuther<SILENT> {
    fn verify_client_name(
        &self,
        _: &LocalAgent,
        client_name: Option<&str>,
    ) -> ClientNameVerifyResult {
        match matches!(client_name, Some("client")) {
            true => ClientNameVerifyResult::Accept,
            false if !SILENT => ClientNameVerifyResult::Refuse("".to_owned()),
            false => ClientNameVerifyResult::SilentRefuse("Client name ".to_owned()),
        }
    }

    fn verify_client_agent(&self, _: &LocalAgent, _: &RemoteAgent) -> ClientAgentVerifyResult {
        ClientAgentVerifyResult::Accept
    }
}

async fn launch_client_auth_test_server<const SILENT_REFUSE: bool>(
    quic_router: Arc<QuicRouter>,
    server_parameters: ServerParameters,
) -> Result<(Arc<QuicListeners>, impl Future<Output: Send>), BoxError> {
    let mut roots = rustls::RootCertStore::empty();
    roots.add_parsable_certificates(CertificateDer::pem_slice_iter(CA_CERT).map(Result::unwrap));
    let listeners = QuicListeners::builder()
        .with_router(quic_router)
        .with_client_cert_verifier(
            WebPkiClientVerifier::builder(Arc::new(roots))
                .build()
                .unwrap(),
        )
        .with_client_auther(ClientNameAuther::<SILENT_REFUSE>)
        .with_parameters(server_parameters)
        .with_qlog(qlogger())
        .listen(128)?;
    listeners
        .add_server(
            "localhost",
            SERVER_CERT,
            SERVER_KEY,
            [BindUri::from("inet://127.0.0.1:0").alloc_port()],
            None,
        )
        .await?;
    Ok((listeners.clone(), serve_echo(listeners)))
}

#[test]
fn auth_client_name() -> Result<(), BoxError> {
    run(async {
        const SILENT_REFUSE: bool = false;

        let router = Arc::new(QuicRouter::default());
        let (listeners, server_task) =
            launch_client_auth_test_server::<SILENT_REFUSE>(router.clone(), server_parameters())
                .await?;
        let _server_task = AbortOnDropHandle::new(tokio::spawn(server_task));
        let server_addr = get_server_addr(&listeners);

        let client = {
            let mut roots = rustls::RootCertStore::empty();
            roots.add_parsable_certificates(
                CertificateDer::pem_slice_iter(CA_CERT).map(Result::unwrap),
            );
            let client = QuicClient::builder()
                .with_router(router)
                .with_root_certificates(roots)
                .with_parameters(client_parameters())
                .with_cert(CLIENT_CERT, CLIENT_KEY)
                .with_name("client")
                .with_qlog(qlogger())
                .enable_sslkeylog()
                .build();

            Arc::new(client)
        };
        let connection = client
            .connected_to_with_source("localhost", [(Source::System, server_addr.into())])
            .await?;
        send_and_verify_echo(&connection, TEST_DATA).await?;

        listeners.shutdown();
        Ok(())
    })
}

#[test]
fn auth_client_name_incorrect_name() -> Result<(), BoxError> {
    run(async {
        const SILENT_REFUSE: bool = false;

        let router = Arc::new(QuicRouter::default());
        let (listeners, server_task) =
            launch_client_auth_test_server::<SILENT_REFUSE>(router.clone(), server_parameters())
                .await?;
        let _server_task = AbortOnDropHandle::new(tokio::spawn(server_task));
        let server_addr = get_server_addr(&listeners);

        let client = {
            let mut roots = rustls::RootCertStore::empty();
            roots.add_parsable_certificates(
                CertificateDer::pem_slice_iter(CA_CERT).map(Result::unwrap),
            );
            let client = QuicClient::builder()
                .with_router(router)
                .with_root_certificates(roots)
                .with_parameters(client_parameters())
                .with_cert(CLIENT_CERT, CLIENT_KEY)
                .with_name("wrong_name")
                .with_qlog(qlogger())
                .enable_sslkeylog()
                .build();

            Arc::new(client)
        };
        let connection = client
            .connected_to_with_source("localhost", [(Source::System, server_addr.into())])
            .await?;
        let error = connection.terminated().await;
        // TODO: 偶尔以NoViablePath结束,需要调查原因
        assert_eq!(error.kind(), ErrorKind::ConnectionRefused);

        listeners.shutdown();
        Ok(())
    })
}

#[test]
fn auth_client_refuse() -> Result<(), BoxError> {
    run(async {
        const SILENT_REFUSE: bool = false;

        let router = Arc::new(QuicRouter::default());
        let (listeners, server_task) =
            launch_client_auth_test_server::<SILENT_REFUSE>(router.clone(), server_parameters())
                .await?;
        let _server_task = AbortOnDropHandle::new(tokio::spawn(server_task));
        let server_addr = get_server_addr(&listeners);

        let client = {
            let parameters = client_parameters();
            // no CLIENT_NAME

            let mut roots = rustls::RootCertStore::empty();
            roots.add_parsable_certificates(
                CertificateDer::pem_slice_iter(CA_CERT).map(Result::unwrap),
            );
            let client = QuicClient::builder()
                .with_router(router)
                .with_root_certificates(roots)
                .with_parameters(parameters)
                .with_cert(CLIENT_CERT, CLIENT_KEY)
                .with_qlog(qlogger())
                .enable_sslkeylog()
                .build();

            Arc::new(client)
        };
        let connection = client
            .connected_to_with_source("localhost", [(Source::System, server_addr.into())])
            .await?;

        let error = connection.terminated().await;
        // TODO: 偶尔以NoViablePath结束,需要调查原因
        assert_eq!(error.kind(), ErrorKind::ConnectionRefused);

        listeners.shutdown();
        Ok(())
    })
}

#[test]
fn auth_client_refuse_silently() -> Result<(), BoxError> {
    run(async {
        const SILENT_REFUSE: bool = true;

        let router = Arc::new(QuicRouter::default());
        let (listeners, server_task) =
            launch_client_auth_test_server::<SILENT_REFUSE>(router.clone(), server_parameters())
                .await?;
        let _server_task = AbortOnDropHandle::new(tokio::spawn(server_task));
        let server_addr = get_server_addr(&listeners);

        let client = {
            let parameters = client_parameters();
            // no CLIENT_NAME

            let mut roots = rustls::RootCertStore::empty();
            roots.add_parsable_certificates(
                CertificateDer::pem_slice_iter(CA_CERT).map(Result::unwrap),
            );
            let client = QuicClient::builder()
                .with_router(router)
                .with_root_certificates(roots)
                .with_parameters(parameters)
                .with_cert(CLIENT_CERT, CLIENT_KEY)
                .with_qlog(qlogger())
                .enable_sslkeylog()
                .build();

            Arc::new(client)
        };
        let connection = client
            .connected_to_with_source("localhost", [(Source::System, server_addr.into())])
            .await?;

        // Silent refuse means server doesn't send CCF, so client should either:
        // 1. Timeout waiting for handshake
        // 2. Fail with NoViablePath when path times out
        let result = time::timeout(Duration::from_secs(1), connection.handshaked()).await;
        match result {
            Err(_timeout) => {}                                     // Expected: timeout
            Ok(Err(e)) if e.kind() == ErrorKind::NoViablePath => {} // Also acceptable: path timeout
            Ok(other) => panic!("Expected timeout or NoViablePath, got {:?}", other),
        }

        listeners.shutdown();
        Ok(())
    })
}

#[derive(serde::Serialize, serde::Deserialize)]
struct Message {
    data: Vec<u8>,
    sign: Vec<u8>,
}

const SIGNATURE_SCHEME: rustls::SignatureScheme = rustls::SignatureScheme::ECDSA_NISTP256_SHA256;

async fn send_and_verify_echo_with_sign_verify(
    connection: &Connection,
    data: &[u8],
) -> Result<(), BoxError> {
    let local_agent = connection.local_agent().await.unwrap().unwrap();
    let remote_agent = connection.remote_agent().await.unwrap().unwrap();
    let (_sid, (mut reader, mut writer)) = connection.open_bi_stream().await?.unwrap();
    tracing::debug!("stream opened");

    let write = async {
        let data = data.to_vec();
        let sign = local_agent.sign(SIGNATURE_SCHEME, &data).unwrap();
        let message = postcard::to_stdvec(&Message { data, sign }).unwrap();
        writer.write_all(&message).await?;
        writer.shutdown().await?;
        tracing::info!("write done");
        Result::<(), BoxError>::Ok(())
    };
    let read = async {
        let mut message = Vec::new();
        reader.read_to_end(&mut message).await?;
        let message: Message = postcard::from_bytes(&message).unwrap();
        remote_agent
            .verify(SIGNATURE_SCHEME, &message.data, &message.sign)
            .unwrap();
        assert_eq!(message.data, data);
        tracing::info!("read done");
        Result::<(), BoxError>::Ok(())
    };

    tokio::try_join!(read, write).map(|_| ())
}

async fn echo_stream_with_sign_verify(
    local_agent: LocalAgent,
    remote_agent: RemoteAgent,
    mut reader: StreamReader,
    mut writer: StreamWriter,
) {
    let mut message = Vec::new();
    reader.read_to_end(&mut message).await.unwrap();
    let Message { data, sign } = postcard::from_bytes(&message).unwrap();
    remote_agent.verify(SIGNATURE_SCHEME, &data, &sign).unwrap();
    tracing::debug!("message received and verified");

    let sign = local_agent.sign(SIGNATURE_SCHEME, &data).unwrap();
    let message = postcard::to_stdvec(&Message { data, sign }).unwrap();
    writer.write_all(&message).await.unwrap();
    writer.shutdown().await.unwrap();
    tracing::debug!("signed echo sent");
}

pub async fn serve_echo_with_sign_verify(listeners: Arc<QuicListeners>) {
    while let Ok((connection, server, pathway, _link)) = listeners.accept().await {
        assert_eq!(server, "localhost");
        let local_agent = connection.local_agent().await.unwrap().unwrap();
        let remote_agent = connection.remote_agent().await.unwrap().unwrap();
        tracing::info!(source = ?pathway.remote(),"accepted new connection");
        tokio::spawn(async move {
            while let Ok((_sid, (reader, writer))) = connection.accept_bi_stream().await {
                tokio::spawn(echo_stream_with_sign_verify(
                    local_agent.clone(),
                    remote_agent.clone(),
                    reader,
                    writer,
                ));
            }
        });
    }
}

async fn launch_echo_with_sign_verify_server(
    quic_router: Arc<QuicRouter>,
    parameters: ServerParameters,
) -> Result<(Arc<QuicListeners>, impl Future<Output: Send>), BoxError> {
    let mut roots = rustls::RootCertStore::empty();
    roots.add_parsable_certificates(CertificateDer::pem_slice_iter(CA_CERT).map(Result::unwrap));
    let listeners = QuicListeners::builder()
        .with_router(quic_router)
        .with_client_cert_verifier(
            WebPkiClientVerifier::builder(Arc::new(roots))
                .build()
                .unwrap(),
        )
        .with_parameters(parameters)
        .with_qlog(qlogger())
        .listen(128)?;
    listeners
        .add_server(
            "localhost",
            SERVER_CERT,
            SERVER_KEY,
            [BindUri::from("inet://127.0.0.1:0").alloc_port()],
            None,
        )
        .await?;
    Ok((listeners.clone(), serve_echo_with_sign_verify(listeners)))
}

#[test]
fn sign_and_verify() -> Result<(), BoxError> {
    run(async {
        let router = Arc::new(QuicRouter::default());
        let (listeners, server_task) =
            launch_echo_with_sign_verify_server(router.clone(), server_parameters()).await?;
        let _server_task = AbortOnDropHandle::new(tokio::spawn(server_task));
        let server_addr = get_server_addr(&listeners);

        let client = {
            let mut roots = rustls::RootCertStore::empty();
            roots.add_parsable_certificates(
                CertificateDer::pem_slice_iter(CA_CERT).map(Result::unwrap),
            );
            let client = QuicClient::builder()
                .with_router(router)
                .with_root_certificates(roots)
                .with_parameters(client_parameters())
                .with_cert(CLIENT_CERT, CLIENT_KEY)
                .with_name("client")
                .with_qlog(qlogger())
                .enable_sslkeylog()
                .build();

            Arc::new(client)
        };
        let connection = client
            .connected_to_with_source("localhost", [(Source::System, server_addr.into())])
            .await?;
        send_and_verify_echo_with_sign_verify(&connection, TEST_DATA).await?;

        listeners.shutdown();
        Ok(())
    })
}