use std::sync::Arc;
use bytes::{Buf, Bytes, BytesMut};
use crate::draft13::endpoint::{Endpoint, EndpointError};
use crate::draft13::event::{ClientEvent, Direction, FetchObject, StreamKind, SubgroupObject};
use crate::draft13::observer::ConnectionObserver;
use crate::transport::quic::QuicTransport;
use crate::transport::{RecvStream, SendStream, Transport, TransportError};
use moqtap_codec::dispatch::{
AnyControlMessage, AnyDatagramHeader, AnyFetchHeader, AnySubgroupHeader,
};
use moqtap_codec::draft13::data_stream::{FetchObjectHeader, ObjectHeader};
use moqtap_codec::draft13::message::ControlMessage;
use moqtap_codec::error::CodecError;
use moqtap_codec::types::*;
use moqtap_codec::varint::VarInt;
use moqtap_codec::version::DraftVersion;
pub const MOQT_ALPN: &[u8] = b"moq-00";
#[derive(Debug, thiserror::Error)]
pub enum ConnectionError {
#[error("endpoint error: {0}")]
Endpoint(#[from] EndpointError),
#[error("codec error: {0}")]
Codec(#[from] CodecError),
#[error("transport error: {0}")]
Transport(#[from] TransportError),
#[error("varint error: {0}")]
VarInt(#[from] moqtap_codec::varint::VarIntError),
#[error("control stream not open")]
NoControlStream,
#[error("unexpected end of stream")]
UnexpectedEnd,
#[error("stream finished")]
StreamFinished,
#[error("invalid server address: {0}")]
InvalidAddress(String),
#[error("TLS config error: {0}")]
TlsConfig(String),
}
#[derive(Debug, Clone)]
pub enum TransportType {
Quic,
WebTransport {
url: String,
},
}
pub struct ClientConfig {
pub additional_versions: Vec<DraftVersion>,
pub transport: TransportType,
pub skip_cert_verification: bool,
pub ca_certs: Vec<Vec<u8>>,
pub setup_parameters: Vec<moqtap_codec::kvp::KeyValuePair>,
}
impl ClientConfig {
pub fn supported_versions(&self) -> Vec<VarInt> {
let mut versions = vec![DraftVersion::Draft13.version_varint()];
for v in &self.additional_versions {
let varint = v.version_varint();
if !versions.contains(&varint) {
versions.push(varint);
}
}
versions
}
pub fn alpn(&self) -> Vec<Vec<u8>> {
match &self.transport {
TransportType::Quic => vec![DraftVersion::Draft13.quic_alpn().to_vec()],
TransportType::WebTransport { .. } => vec![b"h3".to_vec()],
}
}
}
pub struct FramedSendStream {
inner: SendStream,
}
impl FramedSendStream {
pub fn new(inner: SendStream) -> Self {
Self { inner }
}
pub fn stream_id(&self) -> u64 {
self.inner.stream_id()
}
pub async fn write_control(
&mut self,
msg: &AnyControlMessage,
) -> Result<Vec<u8>, ConnectionError> {
let mut buf = Vec::new();
msg.encode(&mut buf)?;
self.inner.write_all(&buf).await?;
Ok(buf)
}
pub async fn write_subgroup_header(
&mut self,
header: &AnySubgroupHeader,
) -> Result<(), ConnectionError> {
let mut buf = Vec::new();
header.encode(&mut buf);
self.inner.write_all(&buf).await?;
Ok(())
}
pub async fn write_fetch_header(
&mut self,
header: &AnyFetchHeader,
) -> Result<(), ConnectionError> {
let mut buf = Vec::new();
header.encode(&mut buf);
self.inner.write_all(&buf).await?;
Ok(())
}
pub async fn write_subgroup_object(
&mut self,
object: &SubgroupObject,
) -> Result<(), ConnectionError> {
let mut buf = Vec::new();
object.header.encode(&mut buf);
buf.extend_from_slice(&object.payload);
self.inner.write_all(&buf).await?;
Ok(())
}
pub async fn write_fetch_object(
&mut self,
object: &FetchObject,
) -> Result<(), ConnectionError> {
let mut buf = Vec::new();
object.header.encode(&mut buf);
buf.extend_from_slice(&object.payload);
self.inner.write_all(&buf).await?;
Ok(())
}
pub async fn finish(&mut self) -> Result<(), ConnectionError> {
self.inner.finish()?;
Ok(())
}
}
pub struct FramedRecvStream {
inner: RecvStream,
buf: BytesMut,
}
impl FramedRecvStream {
pub fn new(inner: RecvStream) -> Self {
Self { inner, buf: BytesMut::with_capacity(4096) }
}
pub fn stream_id(&self) -> u64 {
self.inner.stream_id()
}
async fn fill(&mut self) -> Result<bool, ConnectionError> {
let mut tmp = [0u8; 4096];
match self.inner.read(&mut tmp).await {
Ok(Some(n)) => {
self.buf.extend_from_slice(&tmp[..n]);
Ok(true)
}
Ok(None) => Ok(false),
Err(e) => Err(ConnectionError::Transport(e)),
}
}
async fn ensure(&mut self, n: usize) -> Result<(), ConnectionError> {
while self.buf.len() < n {
if !self.fill().await? {
return Err(ConnectionError::UnexpectedEnd);
}
}
Ok(())
}
pub async fn read_control(
&mut self,
capture_raw: bool,
) -> Result<(AnyControlMessage, Option<Vec<u8>>), ConnectionError> {
self.ensure(1).await?;
let type_len = varint_len(self.buf[0]);
self.ensure(type_len).await?;
let mut cursor = &self.buf[..type_len];
let _type_id = VarInt::decode(&mut cursor)?;
let len_field_size = 2;
self.ensure(type_len + len_field_size).await?;
let payload_len = u16::from_be_bytes([self.buf[type_len], self.buf[type_len + 1]]) as usize;
let total = type_len + len_field_size + payload_len;
self.ensure(total).await?;
let raw = capture_raw.then(|| self.buf[..total].to_vec());
let mut frame = &self.buf[..total];
let msg = AnyControlMessage::decode(DraftVersion::Draft13, &mut frame)?;
self.buf.advance(total);
Ok((msg, raw))
}
pub async fn read_subgroup_header(&mut self) -> Result<AnySubgroupHeader, ConnectionError> {
self.ensure(1).await?;
loop {
let mut cursor = &self.buf[..];
match AnySubgroupHeader::decode(DraftVersion::Draft13, &mut cursor) {
Ok(header) => {
let consumed = self.buf.len() - cursor.remaining();
self.buf.advance(consumed);
return Ok(header);
}
Err(CodecError::UnexpectedEnd) => {
if !self.fill().await? {
return Err(ConnectionError::UnexpectedEnd);
}
}
Err(e) => return Err(ConnectionError::Codec(e)),
}
}
}
pub async fn read_fetch_header(&mut self) -> Result<AnyFetchHeader, ConnectionError> {
self.ensure(1).await?;
loop {
let mut cursor = &self.buf[..];
match AnyFetchHeader::decode(DraftVersion::Draft13, &mut cursor) {
Ok(header) => {
let consumed = self.buf.len() - cursor.remaining();
self.buf.advance(consumed);
return Ok(header);
}
Err(CodecError::UnexpectedEnd) => {
if !self.fill().await? {
return Err(ConnectionError::UnexpectedEnd);
}
}
Err(e) => return Err(ConnectionError::Codec(e)),
}
}
}
pub async fn read_subgroup_object(&mut self) -> Result<SubgroupObject, ConnectionError> {
loop {
let mut cursor = &self.buf[..];
match ObjectHeader::decode(&mut cursor) {
Ok(header) => {
let header_consumed = self.buf.len() - cursor.remaining();
let payload_len = header.payload_length.into_inner() as usize;
let total = header_consumed + payload_len;
if self.buf.len() < total {
if !self.fill().await? {
return Err(ConnectionError::UnexpectedEnd);
}
continue;
}
let payload = self.buf[header_consumed..total].to_vec();
self.buf.advance(total);
return Ok(SubgroupObject { header, payload });
}
Err(CodecError::UnexpectedEnd) => {
if !self.fill().await? {
return Err(ConnectionError::UnexpectedEnd);
}
}
Err(e) => return Err(ConnectionError::Codec(e)),
}
}
}
pub async fn read_fetch_object(&mut self) -> Result<FetchObject, ConnectionError> {
loop {
let mut cursor = &self.buf[..];
match FetchObjectHeader::decode(&mut cursor) {
Ok(header) => {
let header_consumed = self.buf.len() - cursor.remaining();
let payload_len = header.payload_length.into_inner() as usize;
let total = header_consumed + payload_len;
if self.buf.len() < total {
if !self.fill().await? {
return Err(ConnectionError::UnexpectedEnd);
}
continue;
}
let payload = self.buf[header_consumed..total].to_vec();
self.buf.advance(total);
return Ok(FetchObject { header, payload });
}
Err(CodecError::UnexpectedEnd) => {
if !self.fill().await? {
return Err(ConnectionError::UnexpectedEnd);
}
}
Err(e) => return Err(ConnectionError::Codec(e)),
}
}
}
}
pub struct Connection {
transport: Transport,
endpoint: Endpoint,
control_send: Option<FramedSendStream>,
control_recv: Option<FramedRecvStream>,
observer: Option<Box<dyn ConnectionObserver>>,
pending_events: Vec<ClientEvent>,
}
impl Connection {
pub async fn connect(addr: &str, config: ClientConfig) -> Result<Self, ConnectionError> {
let transport = match &config.transport {
TransportType::Quic => Self::connect_quic(addr, &config).await?,
TransportType::WebTransport { url } => {
let url = url.clone();
Self::connect_webtransport(&url, &config).await?
}
};
let (send, recv) = transport.open_bi().await?;
let mut control_send = FramedSendStream::new(send);
let mut control_recv = FramedRecvStream::new(recv);
let mut endpoint = Endpoint::new();
endpoint.connect()?;
let setup_msg = endpoint
.send_client_setup(config.supported_versions(), config.setup_parameters.clone())?;
let any_setup = AnyControlMessage::Draft13(setup_msg);
let raw_setup = control_send.write_control(&any_setup).await?;
let (server_setup, raw_server_setup) = control_recv.read_control(true).await?;
match &server_setup {
AnyControlMessage::Draft13(ControlMessage::ServerSetup(ref ss)) => {
endpoint.receive_server_setup(ss)?;
}
_ => {
return Err(ConnectionError::Endpoint(EndpointError::NotActive));
}
}
let mut pending_events = Vec::with_capacity(3);
pending_events.push(ClientEvent::ControlMessage {
direction: Direction::Send,
message: any_setup,
raw: Some(raw_setup),
});
pending_events.push(ClientEvent::ControlMessage {
direction: Direction::Receive,
message: server_setup,
raw: raw_server_setup,
});
if let Some(v) = endpoint.negotiated_version() {
pending_events.push(ClientEvent::SetupComplete { negotiated_version: v.into_inner() });
}
Ok(Self {
transport,
endpoint,
control_send: Some(control_send),
control_recv: Some(control_recv),
observer: None,
pending_events,
})
}
async fn connect_quic(addr: &str, config: &ClientConfig) -> Result<Transport, ConnectionError> {
let server_addr = addr.parse().map_err(|e: std::net::AddrParseError| {
ConnectionError::InvalidAddress(e.to_string())
})?;
let mut tls_config = if config.skip_cert_verification {
rustls::ClientConfig::builder()
.dangerous()
.with_custom_certificate_verifier(Arc::new(SkipVerification))
.with_no_client_auth()
} else {
let mut roots = rustls::RootCertStore::empty();
roots.extend(webpki_roots::TLS_SERVER_ROOTS.iter().cloned());
for der in &config.ca_certs {
roots
.add(rustls::pki_types::CertificateDer::from(der.clone()))
.map_err(|e| ConnectionError::TlsConfig(format!("bad CA cert: {e}")))?;
}
rustls::ClientConfig::builder().with_root_certificates(roots).with_no_client_auth()
};
tls_config.alpn_protocols = config.alpn();
let quic_config: quinn::crypto::rustls::QuicClientConfig =
tls_config.try_into().map_err(|e| ConnectionError::TlsConfig(format!("{e}")))?;
let client_config = quinn::ClientConfig::new(Arc::new(quic_config));
let mut quinn_endpoint = quinn::Endpoint::client("0.0.0.0:0".parse().unwrap())
.map_err(|e| ConnectionError::InvalidAddress(e.to_string()))?;
quinn_endpoint.set_default_client_config(client_config);
let server_name = addr.split(':').next().unwrap_or("localhost").to_string();
let quic = quinn_endpoint
.connect(server_addr, &server_name)
.map_err(TransportError::from)?
.await
.map_err(TransportError::from)?;
Ok(Transport::Quic(QuicTransport::new(quic)))
}
#[cfg(feature = "webtransport")]
async fn connect_webtransport(
url: &str,
config: &ClientConfig,
) -> Result<Transport, ConnectionError> {
use crate::transport::webtransport::WebTransportTransport;
let wt_config = if config.skip_cert_verification {
wtransport::ClientConfig::builder()
.with_bind_default()
.with_no_cert_validation()
.build()
} else {
wtransport::ClientConfig::builder().with_bind_default().with_native_certs().build()
};
let endpoint = wtransport::Endpoint::client(wt_config)
.map_err(|e| ConnectionError::Transport(TransportError::Connect(e.to_string())))?;
let connection = endpoint
.connect(url)
.await
.map_err(|e| ConnectionError::Transport(TransportError::Connect(e.to_string())))?;
Ok(Transport::WebTransport(WebTransportTransport::new(connection)))
}
#[cfg(not(feature = "webtransport"))]
async fn connect_webtransport(
_url: &str,
_config: &ClientConfig,
) -> Result<Transport, ConnectionError> {
Err(ConnectionError::Transport(TransportError::Connect(
"webtransport feature not enabled".into(),
)))
}
pub fn set_observer(&mut self, observer: Box<dyn ConnectionObserver>) {
self.observer = Some(observer);
for event in self.pending_events.drain(..) {
if let Some(ref obs) = self.observer {
obs.on_event_owned(event);
}
}
}
pub fn clear_observer(&mut self) {
self.observer = None;
}
fn emit(&self, event: ClientEvent) {
if let Some(ref obs) = self.observer {
obs.on_event_owned(event);
}
}
pub async fn send_control(&mut self, msg: &ControlMessage) -> Result<(), ConnectionError> {
let any = AnyControlMessage::Draft13(msg.clone());
let send = self.control_send.as_mut().ok_or(ConnectionError::NoControlStream)?;
let raw = send.write_control(&any).await?;
self.emit(ClientEvent::ControlMessage {
direction: Direction::Send,
message: any,
raw: Some(raw),
});
Ok(())
}
pub async fn recv_control(&mut self) -> Result<ControlMessage, ConnectionError> {
let recv = self.control_recv.as_mut().ok_or(ConnectionError::NoControlStream)?;
let capture_raw = self.observer.is_some();
let (any, raw) = recv.read_control(capture_raw).await?;
if capture_raw {
self.emit(ClientEvent::ControlMessage {
direction: Direction::Receive,
message: any.clone(),
raw,
});
}
match any {
AnyControlMessage::Draft13(msg) => Ok(msg),
_ => Err(ConnectionError::Codec(CodecError::UnknownMessageType(0))),
}
}
pub async fn recv_and_dispatch(&mut self) -> Result<ControlMessage, ConnectionError> {
let msg = self.recv_control().await?;
self.endpoint.receive_message(msg.clone())?;
if let ControlMessage::GoAway(ref ga) = msg {
self.emit(ClientEvent::Draining { new_session_uri: ga.new_session_uri.clone() });
}
Ok(msg)
}
pub async fn subscribe(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
subscriber_priority: u8,
group_order: VarInt,
filter_type: VarInt,
) -> Result<VarInt, ConnectionError> {
let (req_id, msg) = self.endpoint.subscribe(
track_namespace,
track_name,
subscriber_priority,
group_order,
filter_type,
)?;
self.send_control(&msg).await?;
Ok(req_id)
}
pub async fn unsubscribe(&mut self, request_id: VarInt) -> Result<(), ConnectionError> {
let msg = self.endpoint.unsubscribe(request_id)?;
self.send_control(&msg).await
}
#[allow(clippy::too_many_arguments)]
pub async fn fetch(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
subscriber_priority: u8,
group_order: VarInt,
start_group: VarInt,
start_object: VarInt,
end_group: VarInt,
end_object: VarInt,
) -> Result<VarInt, ConnectionError> {
let (req_id, msg) = self.endpoint.fetch(
track_namespace,
track_name,
subscriber_priority,
group_order,
start_group,
start_object,
end_group,
end_object,
)?;
self.send_control(&msg).await?;
Ok(req_id)
}
pub async fn fetch_cancel(&mut self, request_id: VarInt) -> Result<(), ConnectionError> {
let msg = self.endpoint.fetch_cancel(request_id)?;
self.send_control(&msg).await
}
pub async fn subscribe_namespace(
&mut self,
track_namespace_prefix: TrackNamespace,
) -> Result<VarInt, ConnectionError> {
let (req_id, msg) = self.endpoint.subscribe_namespace(track_namespace_prefix)?;
self.send_control(&msg).await?;
Ok(req_id)
}
pub async fn announce(
&mut self,
track_namespace: TrackNamespace,
) -> Result<VarInt, ConnectionError> {
let (req_id, msg) = self.endpoint.announce(track_namespace)?;
self.send_control(&msg).await?;
Ok(req_id)
}
pub async fn unannounce(
&mut self,
track_namespace: TrackNamespace,
) -> Result<(), ConnectionError> {
let msg = self.endpoint.unannounce(track_namespace)?;
self.send_control(&msg).await
}
#[allow(clippy::too_many_arguments)]
pub async fn track_status_request(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
subscriber_priority: u8,
group_order: VarInt,
forward: VarInt,
filter_type: VarInt,
) -> Result<VarInt, ConnectionError> {
let (req_id, msg) = self.endpoint.track_status_request(
track_namespace,
track_name,
subscriber_priority,
group_order,
forward,
filter_type,
)?;
self.send_control(&msg).await?;
Ok(req_id)
}
pub async fn open_subgroup_stream(
&self,
header: &AnySubgroupHeader,
) -> Result<FramedSendStream, ConnectionError> {
let send = self.transport.open_uni().await?;
let mut framed = FramedSendStream::new(send);
let sid = framed.stream_id();
framed.write_subgroup_header(header).await?;
self.emit(ClientEvent::StreamOpened {
direction: Direction::Send,
stream_kind: StreamKind::Subgroup,
stream_id: sid,
});
self.emit(ClientEvent::DataStreamHeader {
stream_id: sid,
direction: Direction::Send,
header: header.clone(),
});
Ok(framed)
}
pub async fn accept_subgroup_stream(
&self,
) -> Result<(AnySubgroupHeader, FramedRecvStream), ConnectionError> {
let recv = self.transport.accept_uni().await?;
let mut framed = FramedRecvStream::new(recv);
let sid = framed.stream_id();
let header = framed.read_subgroup_header().await?;
self.emit(ClientEvent::StreamOpened {
direction: Direction::Receive,
stream_kind: StreamKind::Subgroup,
stream_id: sid,
});
self.emit(ClientEvent::DataStreamHeader {
stream_id: sid,
direction: Direction::Receive,
header: header.clone(),
});
Ok((header, framed))
}
pub fn send_datagram(
&self,
header: &AnyDatagramHeader,
payload: &[u8],
) -> Result<(), ConnectionError> {
let mut buf = Vec::new();
header.encode(&mut buf);
buf.extend_from_slice(payload);
self.emit(ClientEvent::DatagramReceived {
direction: Direction::Send,
header: header.clone(),
payload_len: payload.len(),
});
self.transport.send_datagram(bytes::Bytes::from(buf))?;
Ok(())
}
pub async fn recv_datagram(&self) -> Result<(AnyDatagramHeader, Bytes), ConnectionError> {
let data = self.transport.recv_datagram().await?;
let mut cursor = &data[..];
let header = AnyDatagramHeader::decode(DraftVersion::Draft13, &mut cursor)?;
let consumed = data.len() - cursor.len();
let payload = data.slice(consumed..);
self.emit(ClientEvent::DatagramReceived {
direction: Direction::Receive,
header: header.clone(),
payload_len: payload.len(),
});
Ok((header, payload))
}
pub fn endpoint(&self) -> &Endpoint {
&self.endpoint
}
pub fn endpoint_mut(&mut self) -> &mut Endpoint {
&mut self.endpoint
}
pub fn negotiated_version(&self) -> Option<VarInt> {
self.endpoint.negotiated_version()
}
pub fn close(&self, code: u32, reason: &[u8]) {
self.emit(ClientEvent::Closed { code, reason: reason.to_vec() });
self.transport.close(code, reason);
}
}
fn varint_len(first_byte: u8) -> usize {
1 << (first_byte >> 6)
}
#[derive(Debug)]
struct SkipVerification;
impl rustls::client::danger::ServerCertVerifier for SkipVerification {
fn verify_server_cert(
&self,
_end_entity: &rustls::pki_types::CertificateDer<'_>,
_intermediates: &[rustls::pki_types::CertificateDer<'_>],
_server_name: &rustls::pki_types::ServerName<'_>,
_ocsp_response: &[u8],
_now: rustls::pki_types::UnixTime,
) -> Result<rustls::client::danger::ServerCertVerified, rustls::Error> {
Ok(rustls::client::danger::ServerCertVerified::assertion())
}
fn verify_tls12_signature(
&self,
_message: &[u8],
_cert: &rustls::pki_types::CertificateDer<'_>,
_dcs: &rustls::DigitallySignedStruct,
) -> Result<rustls::client::danger::HandshakeSignatureValid, rustls::Error> {
Ok(rustls::client::danger::HandshakeSignatureValid::assertion())
}
fn verify_tls13_signature(
&self,
_message: &[u8],
_cert: &rustls::pki_types::CertificateDer<'_>,
_dcs: &rustls::DigitallySignedStruct,
) -> Result<rustls::client::danger::HandshakeSignatureValid, rustls::Error> {
Ok(rustls::client::danger::HandshakeSignatureValid::assertion())
}
fn supported_verify_schemes(&self) -> Vec<rustls::SignatureScheme> {
vec![
rustls::SignatureScheme::ECDSA_NISTP256_SHA256,
rustls::SignatureScheme::ECDSA_NISTP384_SHA384,
rustls::SignatureScheme::ED25519,
rustls::SignatureScheme::RSA_PSS_SHA256,
rustls::SignatureScheme::RSA_PSS_SHA384,
rustls::SignatureScheme::RSA_PSS_SHA512,
]
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn client_config_supported_versions_default() {
let config = ClientConfig {
additional_versions: Vec::new(),
transport: TransportType::Quic,
skip_cert_verification: false,
ca_certs: Vec::new(),
setup_parameters: Vec::new(),
};
let versions = config.supported_versions();
assert_eq!(versions.len(), 1);
assert_eq!(versions[0].into_inner(), 0xff000000 + 13);
}
#[test]
fn client_config_alpn_quic() {
let config = ClientConfig {
additional_versions: Vec::new(),
transport: TransportType::Quic,
skip_cert_verification: false,
ca_certs: Vec::new(),
setup_parameters: Vec::new(),
};
assert_eq!(config.alpn(), vec![DraftVersion::Draft13.quic_alpn().to_vec()]);
}
#[test]
fn moqt_alpn_value() {
assert_eq!(MOQT_ALPN, b"moq-00");
}
}