1use crate::client::ClientConfig;
4use crate::quic::CongestionControl;
5use crate::quic::Resolved;
6use crate::quic::ServerId;
7use crate::server::ServerConfig;
8use crate::tls::{FingerprintVerifier, ServeCerts};
9use std::net;
10use std::sync::Arc;
11use std::time::Duration;
12use url::Url;
13
14pub use web_transport_quinn;
15
16fn apply_qlog(transport: &mut quinn::TransportConfig, quic: &Resolved, role: &str) -> Result<()> {
22 let Some(dir) = quic.qlog_dir() else {
25 return Ok(());
26 };
27
28 #[cfg(feature = "qlog")]
29 {
30 let path = dir.join(format!("moq-{role}-{}.sqlog", std::process::id()));
32 let file = std::fs::File::create(&path).map_err(Error::CreateQlog)?;
33
34 let mut config = quinn::QlogConfig::default();
39 config.writer(Box::new(file)).title(Some(format!("moq-native {role}")));
40
41 transport.qlog_stream(config.into_stream());
42 tracing::info!(path = %path.display(), "writing qlog");
43 }
44
45 #[cfg(not(feature = "qlog"))]
46 let _ = (transport, dir, role);
47
48 Ok(())
49}
50
51fn apply_transport(transport: &mut quinn::TransportConfig, quic: &Resolved) {
53 transport.max_idle_timeout(Some(quic.idle_timeout.try_into().expect("idle timeout out of range")));
54 transport.keep_alive_interval(quic.keep_alive);
55
56 if !quic.mtu_discovery {
58 transport.mtu_discovery_config(None);
59 }
60
61 let max_streams = quinn::VarInt::from_u64(quic.max_streams).unwrap_or(quinn::VarInt::MAX);
62 transport.max_concurrent_bidi_streams(max_streams);
63 transport.max_concurrent_uni_streams(max_streams);
64
65 if let Some(gso) = quic.gso {
67 transport.enable_segmentation_offload(gso);
68 }
69
70 transport.congestion_controller_factory(congestion_factory(congestion_control(quic)));
71}
72
73fn congestion_control(quic: &Resolved) -> CongestionControl {
78 quic.congestion_control.unwrap_or(CongestionControl::Delay)
79}
80
81fn congestion_factory(family: CongestionControl) -> Arc<dyn quinn::congestion::ControllerFactory + Send + Sync> {
83 match family {
84 CongestionControl::Loss => Arc::new(quinn::congestion::CubicConfig::default()),
85 CongestionControl::Delay => Arc::new(quinn::congestion::BbrConfig::default()),
86 }
87}
88
89#[derive(Debug, thiserror::Error)]
91#[non_exhaustive]
92pub enum Error {
93 #[error("failed to bind UDP socket")]
95 BindSocket(#[source] std::io::Error),
96
97 #[error("failed to create QUIC endpoint")]
99 CreateEndpoint(#[source] std::io::Error),
100
101 #[error("failed to create qlog file")]
103 CreateQlog(#[source] std::io::Error),
104
105 #[error("no async runtime")]
107 NoRuntime,
108
109 #[error("failed to get local address")]
111 LocalAddr(#[source] std::io::Error),
112
113 #[error("failed to resolve bind address")]
115 ResolveBind(#[source] std::io::Error),
116
117 #[error("invalid DNS name")]
119 InvalidDnsName,
120
121 #[error("failed DNS lookup")]
123 DnsLookup(#[source] std::io::Error),
124
125 #[error("no DNS entries")]
127 NoDnsEntries,
128
129 #[error("failed to fetch fingerprint")]
131 FetchFingerprint(#[source] reqwest::Error),
132
133 #[error("fingerprint request failed")]
135 FingerprintStatus(#[source] reqwest::Error),
136
137 #[error("failed to read fingerprint")]
139 ReadFingerprint(#[source] reqwest::Error),
140
141 #[error("invalid fingerprint")]
143 InvalidFingerprint(#[from] hex::FromHexError),
144
145 #[error("url scheme must be 'https', 'moqt', or 'moql'")]
147 InvalidScheme,
148
149 #[error("unsupported URL scheme: {0}")]
151 UnsupportedScheme(String),
152
153 #[error("missing handshake data")]
155 MissingHandshake,
156
157 #[error("missing ALPN")]
159 MissingAlpn,
160
161 #[error("failed to decode ALPN")]
163 DecodeAlpn(#[from] std::string::FromUtf8Error),
164
165 #[error("unsupported ALPN: {0}")]
167 UnsupportedAlpn(String),
168
169 #[error("missing server name for raw QUIC connection")]
171 MissingServerName,
172
173 #[error("failed to construct URL from server name")]
175 BuildUrl(#[source] url::ParseError),
176
177 #[error("quic_lb_nonce must be at least 4")]
179 QuicLbNonceTooSmall,
180
181 #[error("connection ID length ({0}) exceeds maximum of 20")]
183 QuicLbCidTooLong(usize),
184
185 #[error("failed to build client certificate verifier")]
187 ClientVerifier(#[source] rustls::server::VerifierBuilderError),
188
189 #[error(transparent)]
191 NoInitialCipherSuite(#[from] quinn::crypto::rustls::NoInitialCipherSuite),
192
193 #[error(transparent)]
195 Connect(#[from] quinn::ConnectError),
196
197 #[error(transparent)]
199 Connection(#[from] quinn::ConnectionError),
200
201 #[error(transparent)]
203 Client(#[from] web_transport_quinn::ClientError),
204
205 #[error(transparent)]
207 ConnectRejected(#[from] crate::ConnectError),
208
209 #[error(transparent)]
211 Server(#[from] web_transport_quinn::ServerError),
212
213 #[error("failed to establish QUIC connection")]
215 Establish(#[source] quinn::ConnectionError),
216
217 #[error("failed to receive WebTransport request")]
219 RecvRequest(#[source] web_transport_quinn::ServerError),
220
221 #[error(transparent)]
223 Tls(#[from] crate::tls::Error),
224
225 #[error("all {} connection attempts failed: {}", .0.len(), crate::failover::describe(.0))]
231 Failover(Vec<crate::failover::Failure<Error>>),
232}
233
234impl crate::failover::Aggregate for Error {
235 fn aggregate(failures: Vec<crate::failover::Failure<Self>>) -> Self {
236 Self::Failover(failures)
237 }
238
239 fn resolve(error: Option<std::io::Error>) -> Self {
240 match error {
241 Some(error) => Self::DnsLookup(error),
242 None => Self::NoDnsEntries,
243 }
244 }
245}
246
247type Result<T> = std::result::Result<T, Error>;
248
249#[derive(Clone)]
252pub(crate) struct QuinnClient {
253 pub quic: quinn::Endpoint,
254 pub transport: Arc<quinn::TransportConfig>,
255 pub http_bootstrap: bool,
257 pub host_name: Option<String>,
259 pub failover_delay: Duration,
261 pub resolution_delay: Duration,
264 dual_stack: bool,
268}
269
270impl QuinnClient {
271 pub fn new(config: &ClientConfig) -> Result<Self> {
272 let socket = crate::bind::udp(config.bind).map_err(Error::BindSocket)?;
273 let dual_stack = crate::bind::udp_is_dual_stack(&socket);
274
275 let quic = config.quic.resolve();
276 let mut transport = quinn::TransportConfig::default();
277 apply_transport(&mut transport, &quic);
278 apply_qlog(&mut transport, &quic, "client")?;
279 let transport = Arc::new(transport);
280
281 let runtime = quinn::default_runtime().ok_or(Error::NoRuntime)?;
283 let endpoint_config = quinn::EndpointConfig::default();
284
285 let quic = quinn::Endpoint::new(endpoint_config, None, socket, runtime).map_err(Error::CreateEndpoint)?;
287
288 Ok(Self {
289 quic,
290 transport,
291 http_bootstrap: config.tls.allows_http_bootstrap(),
292 host_name: config.tls.host_name.clone(),
293 failover_delay: config.resolved_failover_delay(),
294 resolution_delay: config.resolved_resolution_delay(),
295 dual_stack,
296 })
297 }
298
299 pub async fn connect(
300 &self,
301 tls: &rustls::ClientConfig,
302 url: Url,
303 versions: &moq_net::Versions,
304 ) -> Result<web_transport_quinn::Session> {
305 let mut url = url;
306 let mut config = tls.clone();
307
308 let target = url.host().ok_or(Error::InvalidDnsName)?;
309 let host = target.to_string();
310 let port = url.port().unwrap_or(443);
311
312 let local = self.quic.local_addr().map_err(Error::LocalAddr)?;
316 let candidates =
317 crate::resolve::Candidates::resolve(target, port, self.resolution_delay).with_local(local, self.dual_stack);
318
319 if url.scheme() == "http" {
320 if self.http_bootstrap {
324 let mut fingerprint = url.clone();
326 fingerprint.set_path("/certificate.sha256");
327 fingerprint.set_query(None);
328 fingerprint.set_fragment(None);
329
330 tracing::warn!(url = %fingerprint, "performing insecure HTTP request for certificate");
331
332 let resp = reqwest::get(fingerprint.as_str())
333 .await
334 .map_err(Error::FetchFingerprint)?
335 .error_for_status()
336 .map_err(Error::FingerprintStatus)?;
337
338 let fingerprint = resp.text().await.map_err(Error::ReadFingerprint)?;
339 let fingerprint = hex::decode(fingerprint.trim())?;
340
341 let verifier = FingerprintVerifier::new(config.crypto_provider().clone(), vec![fingerprint]);
342 config.dangerous().set_certificate_verifier(Arc::new(verifier));
343 } else {
344 tracing::warn!(
345 "ignoring insecure http:// fingerprint bootstrap; using the configured TLS verification"
346 );
347 }
348
349 url.set_scheme("https").expect("failed to set scheme");
350 }
351
352 let alpns: Vec<Vec<u8>> = match url.scheme() {
353 "https" => vec![web_transport_quinn::ALPN.as_bytes().to_vec()],
354 "moqt" | "moql" => versions.alpns().iter().map(|alpn| alpn.as_bytes().to_vec()).collect(),
355 _ => return Err(Error::InvalidScheme),
356 };
357
358 config.alpn_protocols = alpns;
359 config.key_log = Arc::new(rustls::KeyLogFile::new());
360
361 let config: quinn::crypto::rustls::QuicClientConfig = config.try_into()?;
362 let mut config = quinn::ClientConfig::new(Arc::new(config));
363 config.transport_config(self.transport.clone());
364
365 tracing::debug!(%url, "connecting");
366
367 let host_name = self.host_name.clone().unwrap_or(host);
369
370 let connection = crate::failover::race(candidates, self.failover_delay, |addr| {
374 let endpoint = self.quic.clone();
375 let config = config.clone();
376 let host_name = host_name.clone();
377 async move { Ok::<_, Error>(endpoint.connect_with(config, addr, &host_name)?.await?) }
378 })
379 .await?;
380 tracing::Span::current().record("id", connection.stable_id());
381
382 let session = match url.scheme() {
383 "https" => {
384 let mut request = web_transport_quinn::proto::ConnectRequest::new(url.clone());
385 for alpn in versions.alpns() {
386 request = request.with_protocol(alpn.to_string());
387 }
388 web_transport_quinn::Session::connect(connection, request)
389 .await
390 .map_err(map_client_error)?
391 }
392 "moqt" | "moql" => web_transport_quinn::Session::raw(connection),
393 _ => return Err(Error::UnsupportedScheme(url.scheme().to_string())),
394 };
395
396 Ok(session)
397 }
398}
399
400impl Error {
401 pub(crate) fn connect_error(&self) -> Option<crate::ConnectError> {
402 match self {
403 Self::ConnectRejected(err) => Some(*err),
404 Self::Client(err) => classify_client_error(err),
405 Self::Failover(failures) => failures.iter().find_map(|failure| failure.error.connect_error()),
406 _ => None,
407 }
408 }
409
410 pub(crate) fn status(&self) -> Option<u16> {
415 match self {
416 Self::FetchFingerprint(err) | Self::FingerprintStatus(err) | Self::ReadFingerprint(err) => {
417 err.status().map(|status| status.as_u16())
418 }
419 Self::Client(err) => client_status(err),
420 Self::Failover(failures) => {
424 let mut settled = None;
425 for failure in failures {
426 match failure.error.status() {
427 Some(status) if !crate::error::status_retryable(status) => settled = Some(status),
428 _ => return None,
429 }
430 }
431 settled
432 }
433 _ => None,
434 }
435 }
436}
437
438fn map_client_error(err: web_transport_quinn::ClientError) -> Error {
439 if let Some(err) = classify_client_error(&err) {
440 return err.into();
441 }
442
443 err.into()
444}
445
446fn classify_client_error(err: &web_transport_quinn::ClientError) -> Option<crate::ConnectError> {
447 client_status(err).and_then(crate::ConnectError::from_status_u16)
448}
449
450fn client_status(err: &web_transport_quinn::ClientError) -> Option<u16> {
458 match err {
459 web_transport_quinn::ClientError::HttpError(err) => connect_status(err),
460 _ => None,
461 }
462}
463
464fn connect_status(err: &web_transport_quinn::ConnectError) -> Option<u16> {
465 match err {
466 web_transport_quinn::ConnectError::ErrorStatus(status) => Some(status.as_u16()),
467 web_transport_quinn::ConnectError::ProtoError(err) => proto_status(err),
468 _ => None,
469 }
470}
471
472fn proto_status(err: &web_transport_quinn::proto::ConnectError) -> Option<u16> {
473 match err {
474 web_transport_quinn::proto::ConnectError::ErrorStatus(status)
475 | web_transport_quinn::proto::ConnectError::WrongStatus(Some(status)) => Some(status.as_u16()),
476 _ => None,
477 }
478}
479
480pub(crate) struct QuinnServer {
483 pub quic: quinn::Endpoint,
484 pub certs: Arc<ServeCerts>,
485}
486
487impl QuinnServer {
488 pub fn new(config: ServerConfig) -> Result<Self> {
489 let quic = config.quic.resolve();
490 let mut transport = quinn::TransportConfig::default();
491 apply_transport(&mut transport, &quic);
492 apply_qlog(&mut transport, &quic, "server")?;
493 let transport = Arc::new(transport);
494
495 let provider = crate::crypto::provider();
496
497 let certs = ServeCerts::new(provider.clone());
498 certs.load_certs(&config.tls)?;
499 let certs = Arc::new(certs);
500
501 let tls_builder = rustls::ServerConfig::builder_with_provider(provider.clone())
502 .with_protocol_versions(&[&rustls::version::TLS13])
503 .map_err(crate::tls::Error::from)?;
504
505 let mut tls = if config.tls.root.is_empty() {
506 tls_builder.with_no_client_auth().with_cert_resolver(certs.clone())
507 } else {
508 let verifier = config.tls.client_verifier(provider)?;
509 tls_builder
510 .with_client_cert_verifier(verifier)
511 .with_cert_resolver(certs.clone())
512 };
513
514 let mut alpns: Vec<Vec<u8>> = config
516 .versions()
517 .alpns()
518 .iter()
519 .map(|alpn| alpn.as_bytes().to_vec())
520 .collect();
521 alpns.push(web_transport_quinn::ALPN.as_bytes().to_vec());
522
523 tls.alpn_protocols = alpns;
524 tls.key_log = Arc::new(rustls::KeyLogFile::new());
525 config.tls.disable_resumption(&mut tls);
526
527 let tls: quinn::crypto::rustls::QuicServerConfig = tls.try_into()?;
528 let mut tls = quinn::ServerConfig::with_crypto(Arc::new(tls));
529 tls.transport_config(transport);
530
531 if let Some(addr) = config.quic.preferred_v4 {
534 tls.preferred_address_v4(Some(addr));
535 }
536 if let Some(addr) = config.quic.preferred_v6 {
537 tls.preferred_address_v6(Some(addr));
538 }
539
540 let runtime = quinn::default_runtime().ok_or(Error::NoRuntime)?;
542
543 let listen =
544 crate::util::resolve(config.bind.as_deref(), crate::server::DEFAULT_BIND).map_err(Error::ResolveBind)?;
545
546 let mut endpoint_config = quinn::EndpointConfig::default();
548 if let Some(server_id) = config.quic.quic_lb_id {
549 let nonce_len = config.quic.quic_lb_nonce.unwrap_or(8);
550 if nonce_len < 4 {
551 return Err(Error::QuicLbNonceTooSmall);
552 }
553
554 let cid_len = 1 + server_id.len() + nonce_len;
555 if cid_len > 20 {
556 return Err(Error::QuicLbCidTooLong(cid_len));
557 }
558
559 tracing::info!(
560 ?server_id,
561 nonce_len,
562 "using QUIC-LB compatible connection ID generation"
563 );
564 endpoint_config.cid_generator(move || Box::new(ServerIdGenerator::new(server_id.clone(), nonce_len)));
565 }
566
567 let socket = crate::bind::udp(listen).map_err(Error::BindSocket)?;
568
569 let quic = quinn::Endpoint::new(endpoint_config, Some(tls), socket, runtime).map_err(Error::CreateEndpoint)?;
571
572 tokio::spawn(crate::tls::reload_certs(certs.clone(), config.tls.clone()));
575
576 Ok(Self { quic, certs })
577 }
578
579 pub fn accept(&self) -> impl std::future::Future<Output = Option<quinn::Incoming>> + '_ {
580 self.quic.accept()
581 }
582
583 pub fn certificates(&self) -> crate::tls::Certificates {
584 crate::tls::Certificates::new(self.certs.info.clone())
585 }
586
587 pub fn local_addr(&self) -> Result<net::SocketAddr> {
588 self.quic.local_addr().map_err(Error::LocalAddr)
589 }
590
591 pub fn close(&self) {
592 self.quic.close(quinn::VarInt::from_u32(0), b"server shutdown");
593 }
594}
595
596pub(crate) async fn accept(
603 conn: quinn::Incoming,
604 alpns: Vec<&'static str>,
605) -> Result<(
606 web_transport_quinn::Session,
607 Option<Url>,
608 Option<crate::tls::PeerIdentity>,
609)> {
610 let mut conn = conn.accept()?;
611
612 let handshake = conn
613 .handshake_data()
614 .await?
615 .downcast::<quinn::crypto::rustls::HandshakeData>()
616 .unwrap();
617
618 let alpn = handshake.protocol.ok_or(Error::MissingAlpn)?;
619 let alpn = String::from_utf8(alpn)?;
620 let host = handshake.server_name.unwrap_or_default();
621
622 tracing::debug!(%host, ip = %conn.remote_address(), %alpn, "accepting");
623
624 let conn = conn.await.map_err(Error::Establish)?;
626
627 let span = tracing::Span::current();
628 span.record("id", conn.stable_id()); tracing::debug!(%host, ip = %conn.remote_address(), %alpn, "accepted");
630
631 match alpn.as_str() {
632 web_transport_quinn::ALPN => {
633 let request = web_transport_quinn::Request::accept(conn)
636 .await
637 .map_err(Error::RecvRequest)?;
638 let url = Some(request.url.clone());
639 let identity = crate::tls::PeerIdentity::from_any(request.conn().peer_identity());
640
641 let mut response = web_transport_quinn::proto::ConnectResponse::OK;
642 if let Some(protocol) = request.protocols.iter().find(|p| alpns.contains(&p.as_str())) {
648 response = response.with_protocol(protocol);
649 }
650 let session = request.respond(response).await.map_err(Error::Server)?;
651 Ok((session, url, identity))
652 }
653 alpn if alpns.contains(&alpn) => {
658 let identity = crate::tls::PeerIdentity::from_any(conn.peer_identity());
659 let session = web_transport_quinn::Session::raw(conn);
661 Ok((session, None, identity))
662 }
663 _ => Err(Error::UnsupportedAlpn(alpn)),
664 }
665}
666
667struct ServerIdGenerator {
670 server_id: ServerId,
671 nonce_len: usize,
672}
673
674impl ServerIdGenerator {
675 fn new(server_id: ServerId, nonce_len: usize) -> Self {
676 Self { server_id, nonce_len }
677 }
678}
679
680impl quinn::ConnectionIdGenerator for ServerIdGenerator {
681 fn generate_cid(&mut self) -> quinn::ConnectionId {
682 use rand::RngExt;
683 let cid_len = self.cid_len();
684 let mut cid = Vec::with_capacity(cid_len);
685 cid.push((cid_len - 1) as u8);
687 cid.extend(self.server_id.0.iter());
688 cid.extend(rand::rng().random_iter::<u8>().take(self.nonce_len));
689 quinn::ConnectionId::new(cid.as_slice())
690 }
691
692 fn cid_len(&self) -> usize {
693 1 + self.server_id.len() + self.nonce_len
694 }
695
696 fn cid_lifetime(&self) -> Option<Duration> {
697 None
698 }
699}
700
701#[cfg(test)]
702mod tests {
703 use super::*;
704
705 fn connect_rejected(status: u16) -> Error {
706 Error::Client(web_transport_quinn::ClientError::HttpError(
707 web_transport_quinn::ConnectError::ErrorStatus(
708 web_transport_quinn::http::StatusCode::from_u16(status).unwrap(),
709 ),
710 ))
711 }
712
713 #[test]
717 fn a_rejected_connect_reports_its_status() {
718 for status in [400, 404, 405, 410, 501] {
719 assert_eq!(connect_rejected(status).status(), Some(status));
720 assert!(
721 !crate::error::status_retryable(status),
722 "{status} should stop the reconnect loop"
723 );
724 }
725
726 for status in [408, 429, 502, 503, 504] {
727 assert_eq!(connect_rejected(status).status(), Some(status));
728 assert!(crate::error::status_retryable(status), "{status} should be retried");
729 }
730
731 assert_eq!(
733 connect_rejected(401).connect_error(),
734 Some(crate::ConnectError::Unauthorized)
735 );
736 assert_eq!(
737 connect_rejected(403).connect_error(),
738 Some(crate::ConnectError::Forbidden)
739 );
740 }
741
742 #[test]
745 fn congestion_factory_maps_each_family() {
746 let now = std::time::Instant::now();
747 let mtu = 1200;
748
749 let loss = congestion_factory(CongestionControl::Loss).build(now, mtu);
750 assert!(loss.into_any().downcast::<quinn::congestion::Cubic>().is_ok());
751
752 let delay = congestion_factory(CongestionControl::Delay).build(now, mtu);
753 assert!(delay.into_any().downcast::<quinn::congestion::Bbr>().is_ok());
754 }
755
756 #[test]
758 fn congestion_control_defaults_to_delay() {
759 let mut quic = crate::quic::Client::default();
760 assert_eq!(congestion_control(&quic.resolve()), CongestionControl::Delay);
761
762 quic.congestion_control = Some(CongestionControl::Loss);
764 assert_eq!(congestion_control(&quic.resolve()), CongestionControl::Loss);
765 }
766
767 #[tokio::test]
770 async fn delay_reaches_the_live_connection() {
771 let server_config = ServerConfig {
772 bind: Some("127.0.0.1:0".to_string()),
773 tls: crate::tls::Server {
774 generate: vec!["localhost".into()],
775 ..Default::default()
776 },
777 quic: crate::quic::Server {
778 congestion_control: Some(CongestionControl::Delay),
779 ..Default::default()
780 },
781 ..Default::default()
782 };
783
784 let server = QuinnServer::new(server_config).expect("server init");
785 let addr = server.local_addr().expect("local addr");
786
787 let accepted = tokio::spawn(async move {
788 let incoming = server.accept().await.expect("no incoming connection");
789 let conn = incoming.accept().expect("accept").await.expect("handshake");
790 conn.congestion_state()
791 .into_any()
792 .downcast::<quinn::congestion::Bbr>()
793 .is_ok()
794 });
795
796 let mut tls_config = crate::tls::Client::default();
798 tls_config.disable_verify = Some(true);
799
800 let client_config = ClientConfig {
801 bind: "127.0.0.1:0".parse().unwrap(),
802 tls: tls_config,
803 quic: crate::quic::Client {
804 congestion_control: Some(CongestionControl::Delay),
805 ..Default::default()
806 },
807 ..Default::default()
808 };
809
810 let tls = client_config.tls.build().expect("tls config");
811 let client = QuinnClient::new(&client_config).expect("client init");
812 let url: Url = format!("moqt://127.0.0.1:{}", addr.port()).parse().unwrap();
814
815 tokio::time::timeout(Duration::from_secs(5), async move {
818 let session = client
819 .connect(&tls, url, &moq_net::Versions::default())
820 .await
821 .expect("connect failed");
822
823 assert!(
825 session
826 .congestion_state()
827 .into_any()
828 .downcast::<quinn::congestion::Bbr>()
829 .is_ok(),
830 "client connection is not running BBR"
831 );
832 assert!(
833 accepted.await.expect("server task panicked"),
834 "server connection is not running BBR"
835 );
836 })
837 .await
838 .expect("test timed out");
839 }
840}