From 6fed4acf5394da97f9b070f218106a1e9fae6778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ruben=20Gonz=C3=A1lez?= Date: Mon, 14 Oct 2024 15:03:06 +0200 Subject: [PATCH] quinn: add a new WebTransport server sink Co-authored-by: Andoni Morales Alastruey Part-of: --- net/quinn/src/lib.rs | 2 + net/quinn/src/quinnwtserversink/imp.rs | 643 +++++++++++++++++++++++++ net/quinn/src/quinnwtserversink/mod.rs | 41 ++ 3 files changed, 686 insertions(+) create mode 100644 net/quinn/src/quinnwtserversink/imp.rs create mode 100644 net/quinn/src/quinnwtserversink/mod.rs diff --git a/net/quinn/src/lib.rs b/net/quinn/src/lib.rs index 0142ffa7..d444476b 100644 --- a/net/quinn/src/lib.rs +++ b/net/quinn/src/lib.rs @@ -29,6 +29,7 @@ mod quinnquicsrc; mod quinnroqdemux; mod quinnroqmux; mod quinnwtclientsrc; +mod quinnwtserversink; mod utils; fn plugin_init(plugin: &gst::Plugin) -> Result<(), glib::BoolError> { @@ -44,6 +45,7 @@ fn plugin_init(plugin: &gst::Plugin) -> Result<(), glib::BoolError> { quinnquicsink::register(plugin)?; quinnquicsrc::register(plugin)?; quinnwtclientsrc::register(plugin)?; + quinnwtserversink::register(plugin)?; Ok(()) } diff --git a/net/quinn/src/quinnwtserversink/imp.rs b/net/quinn/src/quinnwtserversink/imp.rs new file mode 100644 index 00000000..913aa84e --- /dev/null +++ b/net/quinn/src/quinnwtserversink/imp.rs @@ -0,0 +1,643 @@ +// Copyright (C) 2024, Fluendo, SA +// Author: Ruben González +// Author: Andoni Morales +// +// Copyright (C) 2024, Asymptotic Inc. +// Author: Sanchayan Maity +// +// This Source Code Form is subject to the terms of the Mozilla Public License, v2.0. +// If a copy of the MPL was not distributed with this file, You can obtain one at +// . +// +// SPDX-License-Identifier: MPL-2.0 + +use crate::utils::{ + client_endpoint, get_stats, make_socket_addr, server_endpoint, wait, QuinnQuicEndpointConfig, + WaitError, CONNECTION_CLOSE_CODE, CONNECTION_CLOSE_MSG, +}; +use crate::{common::*, utils}; +use bytes::Bytes; +use futures::future; +use gst::{glib, prelude::*, subclass::prelude::*}; +use gst_base::subclass::prelude::*; +use once_cell::sync::Lazy; +use quinn::{Connection, TransportConfig}; +use web_transport_quinn::{Request, SendStream, Session}; + +use std::path::PathBuf; +use std::sync::Mutex; + +static CAT: Lazy = Lazy::new(|| { + gst::DebugCategory::new( + "quinnwtserversink", + gst::DebugColorFlags::empty(), + Some("Quinn WebTransport Server Sink"), + ) +}); + +struct Started { + session: Session, + stream: Option, +} + +#[derive(Default)] +enum State { + #[default] + Stopped, + Started(Started), +} + +#[derive(Debug)] +struct Settings { + address: String, + port: u16, + server_name: String, + timeout: u32, + use_datagram: bool, + certificate_file: Option, + private_key_file: Option, + transport_config: QuinnQuicTransportConfig, + drop_buffer_for_datagram: bool, +} + +impl Default for Settings { + fn default() -> Self { + let mut transport_config = QuinnQuicTransportConfig::default(); + // Required for the WebTransport handshake + transport_config.max_concurrent_bidi_streams = 2u32.into(); + transport_config.max_concurrent_uni_streams = 1u32.into(); + + Settings { + address: DEFAULT_ADDR.to_string(), + port: DEFAULT_PORT, + server_name: DEFAULT_SERVER_NAME.to_string(), + timeout: 0, + use_datagram: false, + certificate_file: None, + private_key_file: None, + transport_config, + drop_buffer_for_datagram: DEFAULT_DROP_BUFFER_FOR_DATAGRAM, + } + } +} + +pub struct QuinnWebTransportServerSink { + settings: Mutex, + state: Mutex, + canceller: Mutex, +} + +impl Default for QuinnWebTransportServerSink { + fn default() -> Self { + Self { + settings: Mutex::new(Settings::default()), + state: Mutex::new(State::default()), + canceller: Mutex::new(utils::Canceller::default()), + } + } +} + +impl GstObjectImpl for QuinnWebTransportServerSink {} + +impl ElementImpl for QuinnWebTransportServerSink { + fn metadata() -> Option<&'static gst::subclass::ElementMetadata> { + static ELEMENT_METADATA: Lazy = Lazy::new(|| { + gst::subclass::ElementMetadata::new( + "Quinn WebTransport Server Sink", + "Source/Network/WebTransport", + "Send data over the network via WebTransport", + "Ruben Gonzalez ", + ) + }); + Some(&*ELEMENT_METADATA) + } + + fn pad_templates() -> &'static [gst::PadTemplate] { + static PAD_TEMPLATES: Lazy> = Lazy::new(|| { + let sink_pad_template = gst::PadTemplate::new( + "sink", + gst::PadDirection::Sink, + gst::PadPresence::Always, + &gst::Caps::new_any(), + ) + .unwrap(); + + vec![sink_pad_template] + }); + + PAD_TEMPLATES.as_ref() + } + + fn change_state( + &self, + transition: gst::StateChange, + ) -> Result { + if transition == gst::StateChange::NullToReady { + let settings = self.settings.lock().unwrap(); + /* + * WebTransport requires a secure connection, fail the state change if + * no certificate paths were provided. + */ + if settings.certificate_file.is_none() || settings.private_key_file.is_none() { + gst::error!( + CAT, + imp = self, + "Certificate or private key file not provided for secure connection" + ); + return Err(gst::StateChangeError); + } + } + self.parent_change_state(transition) + } +} + +impl ObjectImpl for QuinnWebTransportServerSink { + fn constructed(&self) { + self.parent_constructed(); + } + + fn properties() -> &'static [glib::ParamSpec] { + static PROPERTIES: Lazy> = Lazy::new(|| { + vec![ + glib::ParamSpecString::builder("server-name") + .nick("QUIC server name") + .blurb("Name of the QUIC server which is in server certificate in case of server role") + .build(), + glib::ParamSpecString::builder("address") + .nick("QUIC server address") + .blurb("Address of the QUIC server e.g. 127.0.0.1") + .build(), + glib::ParamSpecUInt::builder("port") + .nick("QUIC server port") + .blurb("Port of the QUIC server e.g. 5000") + .maximum(65535) + .default_value(DEFAULT_PORT as u32) + .readwrite() + .build(), + glib::ParamSpecUInt::builder("timeout") + .nick("Timeout") + .blurb("Value in seconds to timeout QUIC endpoint requests (0 = No timeout).") + .maximum(3600) + .default_value(DEFAULT_TIMEOUT) + .readwrite() + .build(), + glib::ParamSpecString::builder("certificate-file") + .nick("Certificate file") + .blurb("Path to certificate chain in single file") + .build(), + glib::ParamSpecString::builder("private-key-file") + .nick("Private key file") + .blurb("Path to a PKCS8 or RSA private key file") + .build(), + glib::ParamSpecBoolean::builder("use-datagram") + .nick("Use datagram") + .blurb("Use datagram for lower latency, unreliable messaging") + .default_value(false) + .build(), + glib::ParamSpecUInt::builder("initial-mtu") + .nick("Initial MTU") + .blurb("Initial value to be used as the maximum UDP payload size") + .minimum(DEFAULT_INITIAL_MTU.into()) + .default_value(DEFAULT_INITIAL_MTU.into()) + .build(), + glib::ParamSpecUInt::builder("min-mtu") + .nick("Minimum MTU") + .blurb("Maximum UDP payload size guaranteed to be supported by the network, must be <= initial-mtu") + .minimum(DEFAULT_MINIMUM_MTU.into()) + .default_value(DEFAULT_MINIMUM_MTU.into()) + .build(), + glib::ParamSpecUInt::builder("upper-bound-mtu") + .nick("Upper bound MTU") + .blurb("Upper bound to the max UDP payload size that MTU discovery will search for") + .minimum(DEFAULT_UPPER_BOUND_MTU.into()) + .maximum(DEFAULT_MAX_UPPER_BOUND_MTU.into()) + .default_value(DEFAULT_UPPER_BOUND_MTU.into()) + .build(), + glib::ParamSpecUInt::builder("max-udp-payload-size") + .nick("Maximum UDP payload size") + .blurb("Maximum UDP payload size accepted from peers (excluding UDP and IP overhead)") + .minimum(DEFAULT_MIN_UDP_PAYLOAD_SIZE.into()) + .maximum(DEFAULT_MAX_UDP_PAYLOAD_SIZE.into()) + .default_value(DEFAULT_UDP_PAYLOAD_SIZE.into()) + .build(), + glib::ParamSpecUInt64::builder("datagram-receive-buffer-size") + .nick("Datagram Receiver Buffer Size") + .blurb("Maximum number of incoming application datagram bytes to buffer") + .build(), + glib::ParamSpecUInt64::builder("datagram-send-buffer-size") + .nick("Datagram Send Buffer Size") + .blurb("Maximum number of outgoing application datagram bytes to buffer") + .build(), + glib::ParamSpecBoxed::builder::("stats") + .nick("Connection statistics") + .blurb("Connection statistics") + .read_only() + .build(), + glib::ParamSpecBoolean::builder("drop-buffer-for-datagram") + .nick("Drop buffer for datagram") + .blurb("Drop buffers when using datagram if buffer size > max datagram size") + .default_value(DEFAULT_DROP_BUFFER_FOR_DATAGRAM) + .build(), + ] + }); + + PROPERTIES.as_ref() + } + + fn set_property(&self, _id: usize, value: &glib::Value, pspec: &glib::ParamSpec) { + let mut settings = self.settings.lock().unwrap(); + + match pspec.name() { + "server-name" => { + settings.server_name = value.get::().expect("type checked upstream"); + } + "address" => { + settings.address = value.get::().expect("type checked upstream"); + } + "port" => { + settings.port = value.get::().expect("type checked upstream") as u16; + } + "timeout" => { + settings.timeout = value.get().expect("type checked upstream"); + } + "certificate-file" => { + let value: String = value.get().unwrap(); + settings.certificate_file = Some(value.into()); + } + "private-key-file" => { + let value: String = value.get().unwrap(); + settings.private_key_file = Some(value.into()); + } + "use-datagram" => { + settings.use_datagram = value.get().expect("type checked upstream"); + } + "initial-mtu" => { + let value = value.get::().expect("type checked upstream"); + settings.transport_config.initial_mtu = + value.max(DEFAULT_INITIAL_MTU.into()) as u16; + } + "min-mtu" => { + let value = value.get::().expect("type checked upstream"); + let initial_mtu = settings.transport_config.initial_mtu; + settings.transport_config.min_mtu = value.min(initial_mtu.into()) as u16; + } + "upper-bound-mtu" => { + let value = value.get::().expect("type checked upstream"); + settings.transport_config.upper_bound_mtu = value as u16; + } + "max-udp-payload-size" => { + let value = value.get::().expect("type checked upstream"); + settings.transport_config.max_udp_payload_size = value as u16; + } + "datagram-receive-buffer-size" => { + let value = value.get::().expect("type checked upstream"); + settings.transport_config.datagram_receive_buffer_size = value as usize; + } + "datagram-send-buffer-size" => { + let value = value.get::().expect("type checked upstream"); + settings.transport_config.datagram_send_buffer_size = value as usize; + } + "drop-buffer-for-datagram" => { + settings.drop_buffer_for_datagram = value.get().expect("type checked upstream"); + } + _ => unimplemented!(), + } + } + + fn property(&self, _id: usize, pspec: &glib::ParamSpec) -> glib::Value { + let settings = self.settings.lock().unwrap(); + + match pspec.name() { + "server-name" => settings.server_name.to_value(), + "address" => settings.address.to_string().to_value(), + "port" => { + let port = settings.port as u32; + port.to_value() + } + "timeout" => settings.timeout.to_value(), + "certificate-file" => { + let certfile = settings.certificate_file.as_ref(); + certfile.and_then(|file| file.to_str()).to_value() + } + "private-key-file" => { + let privkey = settings.private_key_file.as_ref(); + privkey.and_then(|file| file.to_str()).to_value() + } + "use-datagram" => settings.use_datagram.to_value(), + "initial-mtu" => (settings.transport_config.initial_mtu as u32).to_value(), + "min-mtu" => (settings.transport_config.min_mtu as u32).to_value(), + "upper-bound-mtu" => (settings.transport_config.upper_bound_mtu as u32).to_value(), + "max-udp-payload-size" => { + (settings.transport_config.max_udp_payload_size as u32).to_value() + } + "datagram-receive-buffer-size" => { + (settings.transport_config.datagram_receive_buffer_size as u64).to_value() + } + "datagram-send-buffer-size" => { + (settings.transport_config.datagram_send_buffer_size as u64).to_value() + } + "stats" => { + let state = self.state.lock().unwrap(); + match *state { + State::Started(ref state) => get_stats(Some(state.session.stats())).to_value(), + State::Stopped => get_stats(None).to_value(), + } + } + "drop-buffer-for-datagram" => settings.drop_buffer_for_datagram.to_value(), + _ => unimplemented!(), + } + } +} + +#[glib::object_subclass] +impl ObjectSubclass for QuinnWebTransportServerSink { + const NAME: &'static str = "GstQuinnWebTransportServerSink"; + type Type = super::QuinnWebTransportServerSink; + type ParentType = gst_base::BaseSink; +} + +impl BaseSinkImpl for QuinnWebTransportServerSink { + fn start(&self) -> Result<(), gst::ErrorMessage> { + let settings = self.settings.lock().unwrap(); + let timeout = settings.timeout; + drop(settings); + + let mut state = self.state.lock().unwrap(); + + if let State::Started { .. } = *state { + unreachable!("QuinnWebTransportServerSink is already started"); + } + + match wait(&self.canceller, self.init_connection(), timeout) { + Ok(Ok((session, stream))) => { + *state = State::Started(Started { session, stream }); + gst::info!(CAT, imp = self, "Started"); + Ok(()) + } + Ok(Err(e)) => match e { + WaitError::FutureAborted => { + gst::warning!(CAT, imp = self, "Connection aborted"); + Ok(()) + } + WaitError::FutureError(err) => { + gst::error!(CAT, imp = self, "Connection request failed: {}", err); + Err(gst::error_msg!( + gst::ResourceError::Failed, + ["Connection request failed: {}", err] + )) + } + }, + Err(e) => { + gst::error!(CAT, imp = self, "Failed to establish a connection: {:?}", e); + Err(gst::error_msg!( + gst::ResourceError::Failed, + ["Failed to establish a connection: {:?}", e] + )) + } + } + } + + fn stop(&self) -> Result<(), gst::ErrorMessage> { + let settings = self.settings.lock().unwrap(); + let timeout = settings.timeout; + let use_datagram = settings.use_datagram; + drop(settings); + + let mut state = self.state.lock().unwrap(); + + if let State::Started(ref mut state) = *state { + let session = &state.session; + let mut close_msg = CONNECTION_CLOSE_MSG.to_string(); + + if !use_datagram { + let send = &mut state.stream.as_mut().unwrap(); + + // Shutdown stream gracefully + // send.finish() may fail, but the error is harmless. + let _ = send.finish(); + match wait(&self.canceller, send.stopped(), timeout) { + Ok(r) => { + if let Err(e) = r { + close_msg = format!("Stream finish request error: {}", e); + gst::error!(CAT, imp = self, "{}", close_msg); + } + } + Err(e) => match e { + WaitError::FutureAborted => { + close_msg = "Stream finish request aborted".to_string(); + gst::warning!(CAT, imp = self, "{}", close_msg); + } + WaitError::FutureError(e) => { + close_msg = format!("Stream finish request future error: {}", e); + gst::error!(CAT, imp = self, "{}", close_msg); + } + }, + }; + } + + session.close(CONNECTION_CLOSE_CODE.into(), close_msg.as_bytes()); + } + + *state = State::Stopped; + + gst::info!(CAT, imp = self, "Stopped"); + + Ok(()) + } + + fn render(&self, buffer: &gst::Buffer) -> Result { + if let State::Stopped = *self.state.lock().unwrap() { + gst::element_imp_error!(self, gst::CoreError::Failed, ["Not started yet"]); + return Err(gst::FlowError::Error); + } + + gst::trace!(CAT, imp = self, "Rendering {:?}", buffer); + + let map = buffer.map_readable().map_err(|_| { + gst::element_imp_error!(self, gst::CoreError::Failed, ["Failed to map buffer"]); + gst::FlowError::Error + })?; + + match self.send_buffer(&map) { + Ok(_) => Ok(gst::FlowSuccess::Ok), + Err(err) => match err { + Some(error_message) => { + gst::error!(CAT, imp = self, "Data sending failed: {}", error_message); + self.post_error_message(error_message); + Err(gst::FlowError::Error) + } + _ => { + gst::info!(CAT, imp = self, "Send interrupted. Flushing..."); + Err(gst::FlowError::Flushing) + } + }, + } + } + fn unlock(&self) -> Result<(), gst::ErrorMessage> { + let mut canceller = self.canceller.lock().unwrap(); + canceller.abort(); + Ok(()) + } + + fn unlock_stop(&self) -> Result<(), gst::ErrorMessage> { + let mut canceller = self.canceller.lock().unwrap(); + if matches!(&*canceller, utils::Canceller::Cancelled) { + *canceller = utils::Canceller::None; + } + Ok(()) + } +} + +impl QuinnWebTransportServerSink { + fn send_buffer(&self, src: &[u8]) -> Result<(), Option> { + let settings = self.settings.lock().unwrap(); + let timeout = settings.timeout; + let use_datagram = settings.use_datagram; + let drop_buffer_for_datagram = settings.drop_buffer_for_datagram; + drop(settings); + + let mut state = self.state.lock().unwrap(); + + let (session, stream) = match *state { + State::Started(Started { + ref session, + ref mut stream, + }) => (session, stream), + State::Stopped => { + return Err(Some(gst::error_msg!( + gst::LibraryError::Failed, + ["Cannot send before start()"] + ))); + } + }; + + if use_datagram { + let size = session.max_datagram_size(); + if src.len() > size { + if drop_buffer_for_datagram { + gst::warning!( + CAT, + imp = self, + "Buffer dropped, current max datagram size: {size} > buffer size: {}", + src.len() + ); + return Ok(()); + } else { + return Err(Some(gst::error_msg!( + gst::ResourceError::Failed, + ["Sending data failed, current max datagram size: {size}, buffer size: {}", src.len()] + ))); + } + } + + match session.send_datagram(Bytes::copy_from_slice(src)) { + Ok(_) => Ok(()), + Err(e) => Err(Some(gst::error_msg!( + gst::ResourceError::Failed, + ["Sending data failed: {}", e] + ))), + } + } else { + let send = &mut stream.as_mut().unwrap(); + + match wait(&self.canceller, send.write_all(src), timeout) { + Ok(Ok(_)) => Ok(()), + Ok(Err(e)) => Err(Some(gst::error_msg!( + gst::ResourceError::Failed, + ["Sending data failed: {}", e] + ))), + Err(e) => match e { + WaitError::FutureAborted => { + gst::warning!(CAT, imp = self, "Sending aborted"); + Ok(()) + } + WaitError::FutureError(e) => Err(Some(gst::error_msg!( + gst::ResourceError::Failed, + ["Sending data failed: {}", e] + ))), + }, + } + } + } + + async fn init_connection(&self) -> Result<(Session, Option), WaitError> { + let (use_datagram, endpoint_config) = { + let settings = self.settings.lock().unwrap(); + + let server_addr = + make_socket_addr(format!("{}:{}", settings.address, settings.port).as_str())?; + + ( + settings.use_datagram, + QuinnQuicEndpointConfig { + server_addr, + server_name: settings.server_name.clone(), + client_addr: None, + secure_conn: true, + alpns: vec![HTTP3_ALPN.to_string()], + certificate_file: settings.certificate_file.clone(), + private_key_file: settings.private_key_file.clone(), + keep_alive_interval: 0, + transport_config: settings.transport_config, + with_client_auth: false, + }, + ) + }; + + let endpoint = server_endpoint(&endpoint_config).map_err(|err| { + WaitError::FutureError(gst::error_msg!( + gst::ResourceError::Failed, + ["Failed to configure endpoint: {}", err] + )) + })?; + + let incoming_conn = endpoint.accept().await.unwrap(); + + let connection = incoming_conn.await.map_err(|err| { + WaitError::FutureError(gst::error_msg!( + gst::ResourceError::Failed, + ["Connection error: {}", err] + )) + })?; + + let request = web_transport_quinn::accept(connection) + .await + .map_err(|err| { + WaitError::FutureError(gst::error_msg!( + gst::ResourceError::Failed, + ["Connection error: {}", err] + )) + })?; + + gst::info!( + CAT, + imp = self, + "received WebTransport request: {}", + request.url() + ); + + // FIXME: We now accept all request without verifying the URL + let session = request.ok().await.unwrap(); + + gst::info!(CAT, imp = self, "accepted session"); + + let stream = if !use_datagram { + let (stream, _) = session.open_bi().await.map_err(|err| { + WaitError::FutureError(gst::error_msg!( + gst::ResourceError::Failed, + ["Failed to open stream: {}", err] + )) + })?; + Ok(Some(stream)) + } else { + let max_datagram_size = session.max_datagram_size(); + gst::info!( + CAT, + imp = self, + "Datagram size reported by peer: {max_datagram_size}" + ); + Ok(None) + }?; + Ok((session, stream)) + } +} diff --git a/net/quinn/src/quinnwtserversink/mod.rs b/net/quinn/src/quinnwtserversink/mod.rs new file mode 100644 index 00000000..58c72863 --- /dev/null +++ b/net/quinn/src/quinnwtserversink/mod.rs @@ -0,0 +1,41 @@ +// Copyright (C) 2024, Fluendo, SA +// Author: Ruben Gonzalez +// Author: Andoni Morales +// +// This Source Code Form is subject to the terms of the Mozilla Public License, v2.0. +// If a copy of the MPL was not distributed with this file, You can obtain one at +// . +// +// SPDX-License-Identifier: MPL-2.0 + +/** + * element-quinnwtserversink: + * @short-description: [WebTransport](https://www.w3.org/TR/webtransport/) server that + * sends data over the network. + * + * ## Example sender pipeline + * ```bash + * gst-launch-1.0 -v -e audiotestsrc num-buffers=512 ! \ + * audio/x-raw,format=S16LE,rate=48000,channels=2,layout=interleaved ! opusenc ! \ + * quinnwtserversink address="127.0.0.1" port=4443 \ + * certificate-file="certificates/fullchain.pem" \ + * private-key-file="certificates/privkey.pem" + * ``` + */ +use gst::glib; +use gst::prelude::*; + +pub mod imp; + +glib::wrapper! { + pub struct QuinnWebTransportServerSink(ObjectSubclass) @extends gst_base::BaseSink, gst::Element, gst::Object; +} + +pub fn register(plugin: &gst::Plugin) -> Result<(), glib::BoolError> { + gst::Element::register( + Some(plugin), + "quinnwtserversink", + gst::Rank::MARGINAL, + QuinnWebTransportServerSink::static_type(), + ) +}