moq-uring 0.0.8

Experimental Linux io_uring support for Media 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
//! The PR-4 milestone: a real moq-lite session over the worker's QUIC path.
//!
//! A publisher and a subscriber session run on one worker (two sockets, two
//! [`moq_uring::quic::Connection`]s over loopback), negotiated end to end by
//! `moq_net::Server::accept_lite` / `Client::connect_lite`, with a broadcast,
//! a track, and a frame flowing through the model.
//!
//! Origin drivers run through Tokio's explicit-time adapter while session
//! drivers use the worker's clock and timer.

#![cfg(all(target_os = "linux", feature = "noq"))]

#[path = "support.rs"]
mod support;

use std::net::UdpSocket;

use moq_net::origin;
use moq_uring::{Config, Error, Worker, quic, udp};

fn worker() -> Option<Worker> {
	match Worker::new(Config::default()) {
		Ok(worker) => Some(worker),
		Err(Error::Unsupported(reason)) => {
			eprintln!("skipping io_uring session test: {reason}");
			None
		}
		Err(err) => panic!("worker setup failed: {err}"),
	}
}

const ALPN: &str = "moq-lite-05";
const PAYLOAD: &[u8] = b"hello over io_uring";

#[test]
fn lite_session_over_the_worker() {
	let Some(mut worker) = worker() else { return };
	let handle = worker.handle();

	// The model and its origins, driven on a tokio thread (see module docs).
	let (pub_origin, pub_driver) = origin::Producer::new(origin::Config::default());
	let (sub_origin, sub_driver) = origin::Producer::new(origin::Config::default());
	let origins = std::thread::spawn(move || {
		let rt = tokio::runtime::Builder::new_current_thread()
			.enable_time()
			.build()
			.expect("tokio runtime");
		rt.block_on(async move {
			tokio::join!(moq_net::time::run(pub_driver), moq_net::time::run(sub_driver));
		});
	});

	// Content ready before anyone connects: one broadcast, one track, one
	// finished group.
	let broadcast = pub_origin.create_broadcast("test").expect("create broadcast");
	broadcast.announce(Default::default()).expect("create broadcast");
	let track = broadcast.create_track("data", None).expect("create track");
	let mut group = track.append_group().expect("append group");
	group
		.write_frame(moq_net::Timestamp::ZERO, PAYLOAD)
		.expect("write frame");
	group.finish().expect("finish group");

	let certs = support::certs().expect("certificates");
	let mut server_config = quic::server::Config::new(quic::Identity::open(&certs.cert, &certs.key).expect("identity"));
	server_config.alpn = vec![ALPN.to_string()];

	let server_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("server socket");
	let server_addr = server_sock.local_addr().expect("server addr");
	let client_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("client socket");
	let mut dial = quic::client::Config::new(server_addr, "localhost");
	dial.alpn = vec![ALPN.to_string()];
	// The server's certificate is our own self-signed one; this is loopback.
	dial.verify = false;

	// The publisher session runs as a worker task for the life of the test.
	let server_handle = handle.clone();
	handle.spawn(async move {
		let conn = quic::server::accept(server_sock, &server_config)
			.await
			.expect("quic accept");
		let (session, driver) = moq_net::Server::new()
			.with_publisher(&pub_origin)
			.accept_lite(std::time::Instant::now(), quic::web::Session::raw(conn))
			.await
			.expect("accept_lite");
		let _ = server_handle.run(driver).await;
		// Serve until the client walks away.
		session.closed().await;
	});

	let sub = sub_origin.clone();
	let payload = worker
		.block_on(async move {
			let conn = quic::client::connect(client_sock, &dial).await.expect("quic connect");
			assert_eq!(
				web_transport_trait::poll::Session::protocol(&conn),
				Some(ALPN),
				"negotiated ALPN"
			);

			let (session, driver) = moq_net::Client::new()
				.with_subscriber(sub.clone())
				.connect_lite(std::time::Instant::now(), quic::web::Session::raw(conn))
				.await
				.expect("connect_lite");
			let task_handle = handle.clone();
			handle.spawn(async move {
				let _ = task_handle.run(driver).await;
			});

			let bc = {
				let consumer = sub.consume();
				consumer.routed("test").await.expect("broadcast announced");
				consumer.request_broadcast("test").await.expect("broadcast resolves")
			};
			let mut track = bc
				.track("data")
				.expect("track")
				.subscribe(None)
				.await
				.expect("subscribe");
			let mut group = track
				.recv_group()
				.await
				.expect("recv group")
				.expect("track closed prematurely");
			let frame = group.read_frame().await.expect("read frame").expect("frame");

			session.abort(moq_net::Error::Cancel);
			frame.payload
		})
		.expect("worker");

	assert_eq!(&payload[..], PAYLOAD);

	// Dropping the worker drops the server task (and with it the last
	// publisher handle), which is what lets the origin drivers resolve.
	drop(worker);
	drop(broadcast);
	drop(track);
	drop(sub_origin);
	origins.join().expect("origin drivers");
}

/// Two clients handshake and run moq-lite sessions against one server
/// socket: the endpoint demuxes them by connection id, which is the relay
/// shape (one socket per worker, every session on it).
#[test]
fn two_lite_sessions_share_the_server_socket() {
	let Some(mut worker) = worker() else { return };
	let handle = worker.handle();

	let (pub_origin, pub_driver) = origin::Producer::new(origin::Config::default());
	let (sub_a, sub_a_driver) = origin::Producer::new(origin::Config::default());
	let (sub_b, sub_b_driver) = origin::Producer::new(origin::Config::default());
	let origins = std::thread::spawn(move || {
		let rt = tokio::runtime::Builder::new_current_thread()
			.enable_time()
			.build()
			.expect("tokio runtime");
		rt.block_on(async move {
			tokio::join!(
				moq_net::time::run(pub_driver),
				moq_net::time::run(sub_a_driver),
				moq_net::time::run(sub_b_driver),
			);
		});
	});

	let broadcast = pub_origin.create_broadcast("test").expect("create broadcast");
	broadcast.announce(Default::default()).expect("create broadcast");
	let track = broadcast.create_track("data", None).expect("create track");
	let mut group = track.append_group().expect("append group");
	group
		.write_frame(moq_net::Timestamp::ZERO, PAYLOAD)
		.expect("write frame");
	group.finish().expect("finish group");

	let certs = support::certs().expect("certificates");
	let mut server_config = quic::server::Config::new(quic::Identity::open(&certs.cert, &certs.key).expect("identity"));
	server_config.alpn = vec![ALPN.to_string()];

	let server_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("server socket");
	let endpoint = quic::Endpoint::new(
		server_sock,
		quic::endpoint::Config::default().with_server(server_config),
	)
	.expect("endpoint");
	let server_addr = endpoint.local_addr();

	// The listener: every accepted connection becomes a publisher session.
	let server_handle = handle.clone();
	handle.spawn(async move {
		while let Ok(conn) = endpoint.accept().await {
			let pub_origin = pub_origin.clone();
			let session_handle = server_handle.clone();
			server_handle.spawn(async move {
				let (session, driver) = moq_net::Server::new()
					.with_publisher(&pub_origin)
					.accept_lite(std::time::Instant::now(), quic::web::Session::raw(conn))
					.await
					.expect("accept_lite");
				let _ = session_handle.run(driver).await;
				session.closed().await;
			});
		}
	});

	let mut dial = quic::client::Config::new(server_addr, "localhost");
	dial.alpn = vec![ALPN.to_string()];
	dial.verify = false;

	let subs = [sub_a.clone(), sub_b.clone()];
	worker
		.block_on(async move {
			for sub in subs {
				let client_sock = handle
					.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
					.expect("client socket");
				let conn = quic::client::connect(client_sock, &dial).await.expect("quic connect");
				let (session, driver) = moq_net::Client::new()
					.with_subscriber(sub.clone())
					.connect_lite(std::time::Instant::now(), quic::web::Session::raw(conn))
					.await
					.expect("connect_lite");
				let task_handle = handle.clone();
				handle.spawn(async move {
					let _ = task_handle.run(driver).await;
				});

				let bc = {
					let consumer = sub.consume();
					consumer.routed("test").await.expect("broadcast announced");
					consumer.request_broadcast("test").await.expect("broadcast resolves")
				};
				let mut track = bc
					.track("data")
					.expect("track")
					.subscribe(None)
					.await
					.expect("subscribe");
				let mut group = track
					.recv_group()
					.await
					.expect("recv group")
					.expect("track closed prematurely");
				let frame = group.read_frame().await.expect("read frame").expect("frame");
				assert_eq!(&frame.payload[..], PAYLOAD);

				session.abort(moq_net::Error::Cancel);
			}
		})
		.expect("worker");

	drop(worker);
	drop(broadcast);
	drop(track);
	drop(sub_a);
	drop(sub_b);
	origins.join().expect("origin drivers");
}

/// The client verifies for real, trusting only the certificate the server
/// presents: nothing handshakes unless the configured roots reach noq.
#[test]
fn configured_roots_verify_the_server() {
	let Some(mut worker) = worker() else { return };
	let handle = worker.handle();
	let certs = support::certs().expect("certificates");

	let mut server_config = quic::server::Config::new(quic::Identity::open(&certs.cert, &certs.key).expect("identity"));
	server_config.alpn = vec![ALPN.to_string()];

	let server_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("server socket");
	let server_addr = server_sock.local_addr().expect("server addr");
	let client_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("client socket");
	let mut dial = quic::client::Config::new(server_addr, "localhost");
	dial.alpn = vec![ALPN.to_string()];
	// Verification on, trusting nothing but the certificate this server
	// presents. The platform store is off, so if it leaked in, an unrelated
	// public CA would be trusted too.
	dial.system_roots = false;
	dial.roots = vec![certs.cert.clone()];

	handle.spawn(async move {
		quic::server::accept(server_sock, &server_config)
			.await
			.expect("quic accept");
	});

	worker
		.block_on(async move {
			let conn = quic::client::connect(client_sock, &dial).await.expect("quic connect");
			assert_eq!(
				web_transport_trait::poll::Session::protocol(&conn),
				Some(ALPN),
				"negotiated ALPN"
			);
		})
		.expect("worker");
}

/// `ClientAuth::Required` is the only setting that actually demands a client
/// certificate. `SSL_VERIFY_PEER` on its own validates one that arrives and
/// waves through a client that presents none, so a server meaning mTLS has to
/// say `Required`.
///
/// A failed handshake never reaches `accept` (the endpoint keeps listening),
/// so the assertion is double-sided: the server accepts nothing, and the
/// client's connection dies. Under TLS 1.3 the client may finish its own
/// handshake before the server's verdict on the certificate it never sent
/// comes back, so `connect` returning `Ok` proves nothing; the refusal
/// arrives as the connection's terminal error.
#[test]
fn required_client_auth_refuses_an_anonymous_client() {
	let Some(mut worker) = worker() else { return };
	let handle = worker.handle();
	let certs = support::certs().expect("certificates");

	let mut server_config = quic::server::Config::new(quic::Identity::open(&certs.cert, &certs.key).expect("identity"));
	server_config.alpn = vec![ALPN.to_string()];
	// Any root will do: the client presents nothing, so it fails before the
	// chain is ever checked.
	server_config.client_auth = quic::server::ClientAuth::Required(vec![certs.cert.clone()]);

	let server_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("server socket");
	let client_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("client socket");

	let endpoint = quic::Endpoint::new(
		server_sock,
		quic::endpoint::Config::default().with_server(server_config),
	)
	.expect("endpoint");
	let server_addr = endpoint.local_addr();

	let mut dial = quic::client::Config::new(server_addr, "localhost");
	dial.alpn = vec![ALPN.to_string()];
	dial.verify = false;
	// No identity: this client is anonymous.

	let accepted = std::rc::Rc::new(std::cell::Cell::new(false));
	let accept_flag = accepted.clone();
	handle.spawn(async move {
		if endpoint.accept().await.is_ok() {
			accept_flag.set(true);
		}
	});

	worker
		.block_on(async move {
			match quic::client::connect(client_sock, &dial).await {
				// The dial itself was refused; done.
				Err(_) => {}
				// Established locally, but the server's refusal closes it.
				Ok(mut conn) => {
					std::future::poll_fn(|cx| web_transport_trait::poll::Session::poll_closed(&mut conn, cx)).await;
				}
			}
		})
		.expect("worker");

	assert!(
		!accepted.get(),
		"a server requiring a certificate must refuse an anonymous client"
	);
}

/// A root file is routinely a bundle of several CAs, and it has to be loaded
/// whole.
///
/// Only the second CA in the bundle below signed the server, so a loader that
/// stops at the first certificate rejects a peer that is perfectly valid while
/// still looking configured. The relay reaches this through `listen.tls.root`.
#[test]
fn a_root_bundle_is_loaded_whole() {
	let Some(mut worker) = worker() else { return };
	let handle = worker.handle();
	let bundle = support::bundle().expect("bundle");

	let mut server_config =
		quic::server::Config::new(quic::Identity::open(&bundle.cert, &bundle.key).expect("identity"));
	server_config.alpn = vec![ALPN.to_string()];

	let server_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("server socket");
	let server_addr = server_sock.local_addr().expect("server addr");
	let client_sock = handle
		.udp(UdpSocket::bind("127.0.0.1:0").expect("bind"), udp::Config::default())
		.expect("client socket");
	let mut dial = quic::client::Config::new(server_addr, "localhost");
	dial.alpn = vec![ALPN.to_string()];
	dial.system_roots = false;
	dial.roots = vec![bundle.roots.clone()];

	handle.spawn(async move {
		quic::server::accept(server_sock, &server_config)
			.await
			.expect("quic accept");
	});

	worker
		.block_on(async move {
			let conn = quic::client::connect(client_sock, &dial).await.expect("quic connect");
			assert_eq!(
				web_transport_trait::poll::Session::protocol(&conn),
				Some(ALPN),
				"negotiated ALPN"
			);
		})
		.expect("worker");
}