#![deny(missing_docs)] #![cfg_attr(docsrs, feature(doc_cfg))] //! A library for easily creating [Wisp] clients and servers. //! //! [Wisp]: https://github.com/MercuryWorkshop/wisp-protocol pub mod extensions; #[cfg(feature = "fastwebsockets")] #[cfg_attr(docsrs, doc(cfg(feature = "fastwebsockets")))] mod fastwebsockets; mod packet; mod sink_unfold; mod stream; pub mod ws; pub use crate::{packet::*, stream::*}; use bytes::{Bytes, BytesMut}; use dashmap::DashMap; use event_listener::Event; use extensions::{udp::UdpProtocolExtension, AnyProtocolExtension, ProtocolExtensionBuilder}; use flume as mpsc; use futures::{channel::oneshot, select, Future, FutureExt}; use futures_timer::Delay; use std::{ sync::{ atomic::{AtomicBool, AtomicU32, Ordering}, Arc, }, time::Duration, }; use ws::{AppendingWebSocketRead, LockedWebSocketWrite, Payload}; /// Wisp version supported by this crate. pub const WISP_VERSION: WispVersion = WispVersion { major: 2, minor: 0 }; /// The role of the multiplexor. #[derive(Debug, PartialEq, Copy, Clone)] pub enum Role { /// Client side, can create new channels to proxy. Client, /// Server side, can listen for channels to proxy. Server, } /// Errors the Wisp implementation can return. #[derive(Debug)] pub enum WispError { /// The packet received did not have enough data. PacketTooSmall, /// The packet received had an invalid type. InvalidPacketType, /// The stream had an invalid ID. InvalidStreamId, /// The close packet had an invalid reason. InvalidCloseReason, /// The URI received was invalid. InvalidUri, /// The URI received had no host. UriHasNoHost, /// The URI received had no port. UriHasNoPort, /// The max stream count was reached. MaxStreamCountReached, /// The Wisp protocol version was incompatible. IncompatibleProtocolVersion, /// The stream had already been closed. StreamAlreadyClosed, /// The websocket frame received had an invalid type. WsFrameInvalidType, /// The websocket frame received was not finished. WsFrameNotFinished, /// Error specific to the websocket implementation. WsImplError(Box), /// The websocket implementation socket closed. WsImplSocketClosed, /// The websocket implementation did not support the action. WsImplNotSupported, /// Error specific to the protocol extension implementation. ExtensionImplError(Box), /// The protocol extension implementation did not support the action. ExtensionImplNotSupported, /// The specified protocol extensions are not supported by the server. ExtensionsNotSupported(Vec), /// The string was invalid UTF-8. Utf8Error(std::str::Utf8Error), /// The integer failed to convert. TryFromIntError(std::num::TryFromIntError), /// Other error. Other(Box), /// Failed to send message to multiplexor task. MuxMessageFailedToSend, /// Failed to receive message from multiplexor task. MuxMessageFailedToRecv, /// Multiplexor task ended. MuxTaskEnded, } impl From for WispError { fn from(err: std::str::Utf8Error) -> Self { Self::Utf8Error(err) } } impl From for WispError { fn from(value: std::num::TryFromIntError) -> Self { Self::TryFromIntError(value) } } impl std::fmt::Display for WispError { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> { match self { Self::PacketTooSmall => write!(f, "Packet too small"), Self::InvalidPacketType => write!(f, "Invalid packet type"), Self::InvalidStreamId => write!(f, "Invalid stream id"), Self::InvalidCloseReason => write!(f, "Invalid close reason"), Self::InvalidUri => write!(f, "Invalid URI"), Self::UriHasNoHost => write!(f, "URI has no host"), Self::UriHasNoPort => write!(f, "URI has no port"), Self::MaxStreamCountReached => write!(f, "Maximum stream count reached"), Self::IncompatibleProtocolVersion => write!(f, "Incompatible Wisp protocol version"), Self::StreamAlreadyClosed => write!(f, "Stream already closed"), Self::WsFrameInvalidType => write!(f, "Invalid websocket frame type"), Self::WsFrameNotFinished => write!(f, "Unfinished websocket frame"), Self::WsImplError(err) => write!(f, "Websocket implementation error: {}", err), Self::WsImplSocketClosed => { write!(f, "Websocket implementation error: websocket closed") } Self::WsImplNotSupported => { write!(f, "Websocket implementation error: unsupported feature") } Self::ExtensionImplError(err) => { write!(f, "Protocol extension implementation error: {}", err) } Self::ExtensionImplNotSupported => { write!( f, "Protocol extension implementation error: unsupported feature" ) } Self::ExtensionsNotSupported(list) => { write!(f, "Protocol extensions {:?} not supported", list) } Self::Utf8Error(err) => write!(f, "UTF-8 error: {}", err), Self::TryFromIntError(err) => write!(f, "Integer conversion error: {}", err), Self::Other(err) => write!(f, "Other error: {}", err), Self::MuxMessageFailedToSend => write!(f, "Failed to send multiplexor message"), Self::MuxMessageFailedToRecv => write!(f, "Failed to receive multiplexor message"), Self::MuxTaskEnded => write!(f, "Multiplexor task ended"), } } } impl std::error::Error for WispError {} struct MuxMapValue { stream: mpsc::Sender, stream_type: StreamType, flow_control: Arc, flow_control_event: Arc, is_closed: Arc, is_closed_event: Arc, } struct MuxInner { tx: ws::LockedWebSocketWrite, stream_map: DashMap, buffer_size: u32, fut_exited: Arc, } impl MuxInner { pub async fn server_into_future( self, rx: R, extensions: Vec, close_rx: mpsc::Receiver, muxstream_sender: mpsc::Sender<(ConnectPacket, MuxStream)>, close_tx: mpsc::Sender, ) -> Result<(), WispError> where R: ws::WebSocketRead + Send, { self.as_future( close_rx, close_tx.clone(), self.server_loop(rx, extensions, muxstream_sender, close_tx), ) .await } pub async fn client_into_future( self, rx: R, extensions: Vec, close_rx: mpsc::Receiver, close_tx: mpsc::Sender, ) -> Result<(), WispError> where R: ws::WebSocketRead + Send, { self.as_future(close_rx, close_tx, self.client_loop(rx, extensions)) .await } async fn as_future( &self, close_rx: mpsc::Receiver, close_tx: mpsc::Sender, wisp_fut: impl Future>, ) -> Result<(), WispError> { let ret = futures::select! { _ = self.stream_loop(close_rx, close_tx).fuse() => Ok(()), x = wisp_fut.fuse() => x, }; self.fut_exited.store(true, Ordering::Release); for x in self.stream_map.iter_mut() { x.is_closed.store(true, Ordering::Release); x.is_closed_event.notify(usize::MAX); } self.stream_map.clear(); let _ = self.tx.close().await; ret } async fn create_new_stream( &self, stream_id: u32, stream_type: StreamType, role: Role, stream_tx: mpsc::Sender, tx: LockedWebSocketWrite, target_buffer_size: u32, ) -> Result<(MuxMapValue, MuxStream), WispError> { let (ch_tx, ch_rx) = mpsc::bounded(self.buffer_size as usize); let flow_control_event: Arc = Event::new().into(); let flow_control: Arc = AtomicU32::new(self.buffer_size).into(); let is_closed: Arc = AtomicBool::new(false).into(); let is_closed_event: Arc = Event::new().into(); Ok(( MuxMapValue { stream: ch_tx, stream_type, flow_control: flow_control.clone(), flow_control_event: flow_control_event.clone(), is_closed: is_closed.clone(), is_closed_event: is_closed_event.clone(), }, MuxStream::new( stream_id, role, stream_type, ch_rx, stream_tx, tx, is_closed, is_closed_event, flow_control, flow_control_event, target_buffer_size, ), )) } async fn stream_loop( &self, stream_rx: mpsc::Receiver, stream_tx: mpsc::Sender, ) { let mut next_free_stream_id: u32 = 1; while let Ok(msg) = stream_rx.recv_async().await { match msg { WsEvent::CreateStream(stream_type, host, port, channel) => { let ret: Result = async { let stream_id = next_free_stream_id; let next_stream_id = next_free_stream_id .checked_add(1) .ok_or(WispError::MaxStreamCountReached)?; let (map_value, stream) = self .create_new_stream( stream_id, stream_type, Role::Client, stream_tx.clone(), self.tx.clone(), 0, ) .await?; self.tx .write_frame( Packet::new_connect(stream_id, stream_type, port, host).into(), ) .await?; self.stream_map.insert(stream_id, map_value); next_free_stream_id = next_stream_id; Ok(stream) } .await; let _ = channel.send(ret); } WsEvent::Close(packet, channel) => { if let Some((_, stream)) = self.stream_map.remove(&packet.stream_id) { let _ = channel.send(self.tx.write_frame(packet.into()).await); drop(stream.stream) } else { let _ = channel.send(Err(WispError::InvalidStreamId)); } } WsEvent::EndFut(x) => { if let Some(reason) = x { let _ = self .tx .write_frame(Packet::new_close(0, reason).into()) .await; } break; } } } } fn close_stream(&self, packet: Packet) { if let Some((_, stream)) = self.stream_map.remove(&packet.stream_id) { stream.is_closed.store(true, Ordering::Release); stream.is_closed_event.notify(usize::MAX); stream.flow_control.store(u32::MAX, Ordering::Release); stream.flow_control_event.notify(usize::MAX); drop(stream.stream) } } async fn server_loop( &self, mut rx: R, mut extensions: Vec, muxstream_sender: mpsc::Sender<(ConnectPacket, MuxStream)>, stream_tx: mpsc::Sender, ) -> Result<(), WispError> where R: ws::WebSocketRead + Send, { // will send continues once flow_control is at 10% of max let target_buffer_size = ((self.buffer_size as u64 * 90) / 100) as u32; loop { let (mut frame, optional_frame) = rx.wisp_read_split(&self.tx).await?; if frame.opcode == ws::OpCode::Close { break Ok(()); } if let Some(ref extra_frame) = optional_frame { if frame.payload[0] != PacketType::Data(Payload::Bytes(BytesMut::new())).as_u8() { let mut payload = BytesMut::from(frame.payload); payload.extend_from_slice(&extra_frame.payload); frame.payload = Payload::Bytes(payload); } } if let Some(packet) = Packet::maybe_handle_extension(frame, &mut extensions, &mut rx, &self.tx).await? { use PacketType::*; match packet.packet_type { Continue(_) | Info(_) => break Err(WispError::InvalidPacketType), Connect(inner_packet) => { let (map_value, stream) = self .create_new_stream( packet.stream_id, inner_packet.stream_type, Role::Server, stream_tx.clone(), self.tx.clone(), target_buffer_size, ) .await?; muxstream_sender .send_async((inner_packet, stream)) .await .map_err(|_| WispError::MuxMessageFailedToSend)?; self.stream_map.insert(packet.stream_id, map_value); } Data(data) => { let mut data = BytesMut::from(data); if let Some(stream) = self.stream_map.get(&packet.stream_id) { if let Some(extra_frame) = optional_frame { if data.is_empty() { data = extra_frame.payload.into(); } else { data.extend_from_slice(&extra_frame.payload); } } let _ = stream.stream.try_send(data.freeze()); if stream.stream_type == StreamType::Tcp { stream.flow_control.store( stream .flow_control .load(Ordering::Acquire) .saturating_sub(1), Ordering::Release, ); } } } Close(_) => { if packet.stream_id == 0 { break Ok(()); } self.close_stream(packet) } } } } } async fn client_loop( &self, mut rx: R, mut extensions: Vec, ) -> Result<(), WispError> where R: ws::WebSocketRead + Send, { loop { let (mut frame, optional_frame) = rx.wisp_read_split(&self.tx).await?; if frame.opcode == ws::OpCode::Close { break Ok(()); } if let Some(ref extra_frame) = optional_frame { if frame.payload[0] != PacketType::Data(Payload::Bytes(BytesMut::new())).as_u8() { let mut payload = BytesMut::from(frame.payload); payload.extend_from_slice(&extra_frame.payload); frame.payload = Payload::Bytes(payload); } } if let Some(packet) = Packet::maybe_handle_extension(frame, &mut extensions, &mut rx, &self.tx).await? { use PacketType::*; match packet.packet_type { Connect(_) | Info(_) => break Err(WispError::InvalidPacketType), Data(data) => { let mut data = BytesMut::from(data); if let Some(stream) = self.stream_map.get(&packet.stream_id) { if let Some(extra_frame) = optional_frame { if data.is_empty() { data = extra_frame.payload.into(); } else { data.extend_from_slice(&extra_frame.payload); } } let _ = stream.stream.send_async(data.freeze()).await; } } Continue(inner_packet) => { if let Some(stream) = self.stream_map.get(&packet.stream_id) { if stream.stream_type == StreamType::Tcp { stream .flow_control .store(inner_packet.buffer_remaining, Ordering::Release); let _ = stream.flow_control_event.notify(u32::MAX); } } } Close(_) => { if packet.stream_id == 0 { break Ok(()); } self.close_stream(packet) } } } } } } async fn maybe_wisp_v2( read: &mut R, write: &LockedWebSocketWrite, builders: &[Box], ) -> Result<(Vec, Option>, bool), WispError> where R: ws::WebSocketRead + Send, { let mut supported_extensions = Vec::new(); let mut extra_packet: Option> = None; let mut downgraded = true; let extension_ids: Vec<_> = builders.iter().map(|x| x.get_id()).collect(); if let Some(frame) = select! { x = read.wisp_read_frame(write).fuse() => Some(x?), _ = Delay::new(Duration::from_secs(5)).fuse() => None } { let packet = Packet::maybe_parse_info(frame, Role::Client, builders)?; if let PacketType::Info(info) = packet.packet_type { supported_extensions = info .extensions .into_iter() .filter(|x| extension_ids.contains(&x.get_id())) .collect(); downgraded = false; } else { extra_packet.replace(ws::Frame::from(packet).clone()); } } for extension in supported_extensions.iter_mut() { extension.handle_handshake(read, write).await?; } Ok((supported_extensions, extra_packet, downgraded)) } /// Server-side multiplexor. /// /// # Example /// ``` /// use wisp_mux::ServerMux; /// /// let (mux, fut) = ServerMux::new(rx, tx, 128, Some([])); /// tokio::spawn(async move { /// if let Err(e) = fut.await { /// println!("error in multiplexor: {:?}", e); /// } /// }); /// while let Some((packet, stream)) = mux.server_new_stream().await { /// tokio::spawn(async move { /// let url = format!("{}:{}", packet.destination_hostname, packet.destination_port); /// // do something with `url` and `packet.stream_type` /// }); /// } /// ``` pub struct ServerMux { /// Whether the connection was downgraded to Wisp v1. /// /// If this variable is true you must assume no extensions are supported. pub downgraded: bool, /// Extensions that are supported by both sides. pub supported_extension_ids: Vec, close_tx: mpsc::Sender, muxstream_recv: mpsc::Receiver<(ConnectPacket, MuxStream)>, tx: ws::LockedWebSocketWrite, fut_exited: Arc, } impl ServerMux { /// Create a new server-side multiplexor. /// /// If `extension_builders` is None a Wisp v1 connection is created otherwise a Wisp v2 connection is created. /// **It is not guaranteed that all extensions you specify are available.** You must manually check /// if the extensions you need are available after the multiplexor has been created. pub async fn create( mut read: R, write: W, buffer_size: u32, extension_builders: Option<&[Box]>, ) -> Result> + Send>, WispError> where R: ws::WebSocketRead + Send, W: ws::WebSocketWrite + Send + 'static, { let (close_tx, close_rx) = mpsc::bounded::(256); let (tx, rx) = mpsc::unbounded::<(ConnectPacket, MuxStream)>(); let write = ws::LockedWebSocketWrite::new(Box::new(write)); let fut_exited = Arc::new(AtomicBool::new(false)); write .write_frame(Packet::new_continue(0, buffer_size).into()) .await?; let (supported_extensions, extra_packet, downgraded) = if let Some(builders) = extension_builders { write .write_frame( Packet::new_info( builders .iter() .map(|x| x.build_to_extension(Role::Client)) .collect(), ) .into(), ) .await?; maybe_wisp_v2(&mut read, &write, builders).await? } else { (Vec::new(), None, true) }; Ok(ServerMuxResult( Self { muxstream_recv: rx, close_tx: close_tx.clone(), downgraded, supported_extension_ids: supported_extensions.iter().map(|x| x.get_id()).collect(), tx: write.clone(), fut_exited: fut_exited.clone(), }, MuxInner { tx: write, stream_map: DashMap::new(), buffer_size, fut_exited, } .server_into_future( AppendingWebSocketRead(extra_packet, read), supported_extensions, close_rx, tx, close_tx, ), )) } /// Wait for a stream to be created. pub async fn server_new_stream(&self) -> Option<(ConnectPacket, MuxStream)> { if self.fut_exited.load(Ordering::Acquire) { return None; } self.muxstream_recv.recv_async().await.ok() } async fn close_internal(&self, reason: Option) -> Result<(), WispError> { if self.fut_exited.load(Ordering::Acquire) { return Err(WispError::MuxTaskEnded); } self.close_tx .send_async(WsEvent::EndFut(reason)) .await .map_err(|_| WispError::MuxMessageFailedToSend) } /// Close all streams. /// /// Also terminates the multiplexor future. pub async fn close(&self) -> Result<(), WispError> { self.close_internal(None).await } /// Close all streams and send an extension incompatibility error to the client. /// /// Also terminates the multiplexor future. pub async fn close_extension_incompat(&self) -> Result<(), WispError> { self.close_internal(Some(CloseReason::IncompatibleExtensions)) .await } /// Get a protocol extension stream for sending packets with stream id 0. pub fn get_protocol_extension_stream(&self) -> MuxProtocolExtensionStream { MuxProtocolExtensionStream { stream_id: 0, tx: self.tx.clone(), is_closed: self.fut_exited.clone(), } } } impl Drop for ServerMux { fn drop(&mut self) { let _ = self.close_tx.send(WsEvent::EndFut(None)); } } /// Result of `ServerMux::new`. pub struct ServerMuxResult(ServerMux, F) where F: Future> + Send; impl ServerMuxResult where F: Future> + Send, { /// Require no protocol extensions. pub fn with_no_required_extensions(self) -> (ServerMux, F) { (self.0, self.1) } /// Require protocol extensions by their ID. Will close the multiplexor connection if /// extensions are not supported. pub async fn with_required_extensions( self, extensions: &[u8], ) -> Result<(ServerMux, F), WispError> { let mut unsupported_extensions = Vec::new(); for extension in extensions { if !self.0.supported_extension_ids.contains(extension) { unsupported_extensions.push(*extension); } } if unsupported_extensions.is_empty() { Ok((self.0, self.1)) } else { self.0.close_extension_incompat().await?; self.1.await?; Err(WispError::ExtensionsNotSupported(unsupported_extensions)) } } /// Shorthand for `with_required_extensions(&[UdpProtocolExtension::ID])` pub async fn with_udp_extension_required(self) -> Result<(ServerMux, F), WispError> { self.with_required_extensions(&[UdpProtocolExtension::ID]) .await } } /// Client side multiplexor. /// /// # Example /// ``` /// use wisp_mux::{ClientMux, StreamType}; /// /// let (mux, fut) = ClientMux::new(rx, tx, Some([])).await?; /// tokio::spawn(async move { /// if let Err(e) = fut.await { /// println!("error in multiplexor: {:?}", e); /// } /// }); /// let stream = mux.client_new_stream(StreamType::Tcp, "google.com", 80); /// ``` pub struct ClientMux { /// Whether the connection was downgraded to Wisp v1. /// /// If this variable is true you must assume no extensions are supported. pub downgraded: bool, /// Extensions that are supported by both sides. pub supported_extension_ids: Vec, stream_tx: mpsc::Sender, tx: ws::LockedWebSocketWrite, fut_exited: Arc, } impl ClientMux { /// Create a new client side multiplexor. /// /// If `extension_builders` is None a Wisp v1 connection is created otherwise a Wisp v2 connection is created. /// **It is not guaranteed that all extensions you specify are available.** You must manually check /// if the extensions you need are available after the multiplexor has been created. pub async fn create( mut read: R, write: W, extension_builders: Option<&[Box]>, ) -> Result> + Send>, WispError> where R: ws::WebSocketRead + Send, W: ws::WebSocketWrite + Send + 'static, { let write = ws::LockedWebSocketWrite::new(Box::new(write)); let first_packet = Packet::try_from(read.wisp_read_frame(&write).await?)?; let fut_exited = Arc::new(AtomicBool::new(false)); if first_packet.stream_id != 0 { return Err(WispError::InvalidStreamId); } if let PacketType::Continue(packet) = first_packet.packet_type { let (supported_extensions, extra_packet, downgraded) = if let Some(builders) = extension_builders { let x = maybe_wisp_v2(&mut read, &write, builders).await?; // if not downgraded if !x.2 { write .write_frame( Packet::new_info( builders .iter() .map(|x| x.build_to_extension(Role::Client)) .collect(), ) .into(), ) .await?; } x } else { (Vec::new(), None, true) }; let (tx, rx) = mpsc::bounded::(256); Ok(ClientMuxResult( Self { stream_tx: tx.clone(), downgraded, supported_extension_ids: supported_extensions .iter() .map(|x| x.get_id()) .collect(), tx: write.clone(), fut_exited: fut_exited.clone(), }, MuxInner { tx: write, stream_map: DashMap::new(), buffer_size: packet.buffer_remaining, fut_exited, } .client_into_future( AppendingWebSocketRead(extra_packet, read), supported_extensions, rx, tx, ), )) } else { Err(WispError::InvalidPacketType) } } /// Create a new stream, multiplexed through Wisp. pub async fn client_new_stream( &self, stream_type: StreamType, host: String, port: u16, ) -> Result { if self.fut_exited.load(Ordering::Acquire) { return Err(WispError::MuxTaskEnded); } if stream_type == StreamType::Udp && !self .supported_extension_ids .iter() .any(|x| *x == UdpProtocolExtension::ID) { return Err(WispError::ExtensionsNotSupported(vec![ UdpProtocolExtension::ID, ])); } let (tx, rx) = oneshot::channel(); self.stream_tx .send_async(WsEvent::CreateStream(stream_type, host, port, tx)) .await .map_err(|_| WispError::MuxMessageFailedToSend)?; rx.await.map_err(|_| WispError::MuxMessageFailedToRecv)? } async fn close_internal(&self, reason: Option) -> Result<(), WispError> { if self.fut_exited.load(Ordering::Acquire) { return Err(WispError::MuxTaskEnded); } self.stream_tx .send_async(WsEvent::EndFut(reason)) .await .map_err(|_| WispError::MuxMessageFailedToSend) } /// Close all streams. /// /// Also terminates the multiplexor future. pub async fn close(&self) -> Result<(), WispError> { self.close_internal(None).await } /// Close all streams and send an extension incompatibility error to the client. /// /// Also terminates the multiplexor future. pub async fn close_extension_incompat(&self) -> Result<(), WispError> { self.close_internal(Some(CloseReason::IncompatibleExtensions)) .await } /// Get a protocol extension stream for sending packets with stream id 0. pub fn get_protocol_extension_stream(&self) -> MuxProtocolExtensionStream { MuxProtocolExtensionStream { stream_id: 0, tx: self.tx.clone(), is_closed: self.fut_exited.clone(), } } } impl Drop for ClientMux { fn drop(&mut self) { let _ = self.stream_tx.send(WsEvent::EndFut(None)); } } /// Result of `ClientMux::new`. pub struct ClientMuxResult(ClientMux, F) where F: Future> + Send; impl ClientMuxResult where F: Future> + Send, { /// Require no protocol extensions. pub fn with_no_required_extensions(self) -> (ClientMux, F) { (self.0, self.1) } /// Require protocol extensions by their ID. pub async fn with_required_extensions( self, extensions: &[u8], ) -> Result<(ClientMux, F), WispError> { let mut unsupported_extensions = Vec::new(); for extension in extensions { if !self.0.supported_extension_ids.contains(extension) { unsupported_extensions.push(*extension); } } if unsupported_extensions.is_empty() { Ok((self.0, self.1)) } else { self.0.close_extension_incompat().await?; self.1.await?; Err(WispError::ExtensionsNotSupported(unsupported_extensions)) } } /// Shorthand for `with_required_extensions(&[UdpProtocolExtension::ID])` pub async fn with_udp_extension_required(self) -> Result<(ClientMux, F), WispError> { self.with_required_extensions(&[UdpProtocolExtension::ID]) .await } }