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
#![allow(clippy::unusual_byte_groupings)]
use crate::*;
use std::io::{IoSlice, Result};
use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt};
/// WebSocket implementation for both client and server
#[derive(Debug)]
pub struct WebSocket<Stream> {
/// it is a low-level abstraction that represents the underlying byte stream over which WebSocket messages are exchanged.
pub stream: Stream,
/// Maximum allowed payload length in bytes.
///
/// Default: 16 MB
pub max_payload_len: usize,
role: Role,
is_closed: bool,
fragment: Option<MessageType>,
}
impl<IO> WebSocket<IO> {
/// Create a new websocket client instance.
#[inline]
pub fn client(stream: IO) -> Self {
Self::from((stream, Role::Client))
}
/// Create a websocket server instance.
#[inline]
pub fn server(stream: IO) -> Self {
Self::from((stream, Role::Server))
}
}
impl<W> WebSocket<W>
where
W: Unpin + AsyncWrite,
{
#[doc(hidden)]
pub async fn send_raw(&mut self, frame: Frame<'_>) -> Result<()> {
let buf = match self.role {
Role::Server => {
if self.stream.is_write_vectored() {
let mut head = [0; 10];
let head_len = unsafe { frame.encode_header_unchecked(head.as_mut_ptr(), 0) };
let total_len = head_len + frame.data.len();
let mut bufs = [IoSlice::new(&head[..head_len]), IoSlice::new(frame.data)];
let mut amt = self.stream.write_vectored(&bufs).await?;
if amt == total_len {
return Ok(());
}
while amt < head_len {
bufs[0] = IoSlice::new(&head[amt..head_len]);
amt += self.stream.write_vectored(&bufs).await?;
}
if amt < total_len {
self.stream.write_all(&frame.data[amt - head_len..]).await?;
}
return Ok(());
}
frame.encode_without_mask()
}
Role::Client => frame.encode_with_mask(),
};
self.stream.write_all(&buf).await
}
/// Send message to a endpoint.
pub async fn send(&mut self, data: impl Into<Frame<'_>>) -> Result<()> {
self.send_raw(data.into()).await
}
/// - The Close frame MAY contain a body that indicates a reason for closing.
pub async fn close<T>(mut self, reason: T) -> Result<()>
where
T: CloseReason,
T::Bytes: AsRef<[u8]>,
{
self.send_raw(Frame {
fin: true,
opcode: 8,
data: reason.to_bytes().as_ref(),
})
.await?;
self.stream.flush().await
}
/// A Ping frame may serve either as a keepalive or as a means to verify that the remote endpoint is still responsive.
///
/// It is used to send ping frame.
///
/// ### Example
///
/// ```no_run
/// # use web_socket::*;
/// # async {
/// let writer = Vec::new();
/// let mut ws = WebSocket::client(writer);
/// ws.send_ping("Hello!").await;
/// # };
/// ```
pub async fn send_ping(&mut self, data: impl AsRef<[u8]>) -> Result<()> {
self.send_raw(Frame {
fin: true,
opcode: 9,
data: data.as_ref(),
})
.await
}
/// A Pong frame sent in response to a Ping frame must have identical
/// "Application data" as found in the message body of the Ping frame being replied to.
///
/// A Pong frame MAY be sent unsolicited. This serves as a unidirectional heartbeat. A response to an unsolicited Pong frame is not expected.
pub async fn send_pong(&mut self, data: impl AsRef<[u8]>) -> Result<()> {
self.send_raw(Frame {
fin: true,
opcode: 10,
data: data.as_ref(),
})
.await
}
/// Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.
pub async fn flash(&mut self) -> Result<()> {
self.stream.flush().await
}
}
// ------------------------------------------------------------------------
macro_rules! err { [$msg: expr] => { return Ok(Event::Error($msg)) }; }
#[inline]
pub async fn read_buf<const N: usize, R>(stream: &mut R) -> Result<[u8; N]>
where
R: Unpin + AsyncRead,
{
let mut buf = [0; N];
stream.read_exact(&mut buf).await?;
Ok(buf)
}
impl<R> WebSocket<R>
where
R: Unpin + AsyncRead,
{
/// reads [Event] from websocket stream.
pub async fn recv(&mut self) -> Result<Event> {
if self.is_closed {
return Err(std::io::Error::new(
std::io::ErrorKind::NotConnected,
"read after close",
));
}
let event = self.recv_event().await;
if let Ok(Event::Close { .. } | Event::Error(..)) | Err(..) = event {
self.is_closed = true;
}
event
}
// ### WebSocket Frame Header
//
// ```txt
// 0 1 2 3
// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
// +-+-+-+-+-------+-+-------------+-------------------------------+
// |F|R|R|R| opcode|M| Payload len | Extended payload length |
// |I|S|S|S| (4) |A| (7) | (16/64) |
// |N|V|V|V| |S| | (if payload len==126/127) |
// | |1|2|3| |K| | |
// +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
// | Extended payload length continued, if payload len == 127 |
// + - - - - - - - - - - - - - - - +-------------------------------+
// | |Masking-key, if MASK set to 1 |
// +-------------------------------+-------------------------------+
// | Masking-key (continued) | Payload Data |
// +-------------------------------- - - - - - - - - - - - - - - - +
// : Payload Data continued ... :
// + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
// | Payload Data continued ... |
// +---------------------------------------------------------------+
// ```
/// reads [Event] from websocket stream.
pub async fn recv_event(&mut self) -> Result<Event> {
let [b1, b2] = read_buf(&mut self.stream).await?;
let fin = b1 & 0b_1000_0000 != 0;
let rsv = b1 & 0b_111_0000;
let opcode = b1 & 0b_1111;
let len = (b2 & 0b_111_1111) as usize;
// Defines whether the "Payload data" is masked. If set to 1, a
// masking key is present in masking-key, and this is used to unmask
// the "Payload data" as per [Section 5.3](https://datatracker.ietf.org/doc/html/rfc6455#section-5.3). All frames sent from
// client to server have this bit set to 1.
let is_masked = b2 & 0b_1000_0000 != 0;
if rsv != 0 {
// MUST be `0` unless an extension is negotiated that defines meanings
// for non-zero values. If a nonzero value is received and none of
// the negotiated extensions defines the meaning of such a nonzero
// value, the receiving endpoint MUST _Fail the WebSocket Connection_.
err!("reserve bit must be `0`");
}
// A client MUST mask all frames that it sends to the server. (Note
// that masking is done whether or not the WebSocket Protocol is running
// over TLS.) The server MUST close the connection upon receiving a
// frame that is not masked.
//
// A server MUST NOT mask any frames that it sends to the client.
if let Role::Server = self.role {
if !is_masked {
err!("expected masked frame");
}
} else if is_masked {
err!("expected unmasked frame");
}
// 3-7 are reserved for further non-control frames.
if opcode >= 8 {
if !fin {
err!("control frame must not be fragmented");
}
if len > 125 {
err!("control frame must have a payload length of 125 bytes or less");
}
let msg = self.read_payload(len).await?;
match opcode {
8 => Ok(on_close(&msg)),
9 => Ok(Event::Ping(msg)),
10 => Ok(Event::Pong(msg)),
// 11-15 are reserved for further control frames
_ => err!("unknown opcode"),
}
} else {
let ty = match (opcode, fin, self.fragment) {
(2, true, None) => DataType::Complete(MessageType::Binary),
(1, true, None) => DataType::Complete(MessageType::Text),
(2, false, None) => {
self.fragment = Some(MessageType::Binary);
DataType::Stream(Stream::Start(MessageType::Binary))
}
(1, false, None) => {
self.fragment = Some(MessageType::Text);
DataType::Stream(Stream::Start(MessageType::Text))
}
(0, false, Some(ty)) => DataType::Stream(Stream::Next(ty)),
(0, true, Some(ty)) => {
self.fragment = None;
DataType::Stream(Stream::End(ty))
}
_ => err!("invalid data frame"),
};
let len = match len {
126 => u16::from_be_bytes(read_buf(&mut self.stream).await?) as usize,
127 => u64::from_be_bytes(read_buf(&mut self.stream).await?) as usize,
len => len,
};
if len > self.max_payload_len {
err!("payload too large");
}
let data = self.read_payload(len).await?;
Ok(Event::Data { ty, data })
}
}
async fn read_payload(&mut self, len: usize) -> Result<Box<[u8]>> {
let mut data = vec![0; len].into_boxed_slice();
match self.role {
Role::Server => {
let mask: [u8; 4] = read_buf(&mut self.stream).await?;
self.stream.read_exact(&mut data).await?;
// TODO: Use SIMD wherever possible for best performance
for i in 0..data.len() {
data[i] ^= mask[i & 3];
}
}
Role::Client => {
self.stream.read_exact(&mut data).await?;
}
}
Ok(data)
}
}
/// - If there is a body, the first two bytes of the body MUST be a 2-byte unsigned integer (in network byte order: Big Endian)
/// representing a status code with value /code/ defined in [Section 7.4](https:///datatracker.ietf.org/doc/html/rfc6455#section-7.4).
/// Following the 2-byte integer,
///
/// - The application MUST NOT send any more data frames after sending a `Close` frame.
///
/// - If an endpoint receives a Close frame and did not previously send a
/// Close frame, the endpoint MUST send a Close frame in response. (When
/// sending a Close frame in response, the endpoint typically echos the
/// status code it received.) It SHOULD do so as soon as practical. An
/// endpoint MAY delay sending a Close frame until its current message is
/// sent
///
/// - After both sending and receiving a Close message, an endpoint
/// considers the WebSocket connection closed and MUST close the
/// underlying TCP connection.
fn on_close(msg: &[u8]) -> Event {
let code = msg
.get(..2)
.map(|bytes| u16::from_be_bytes([bytes[0], bytes[1]]))
.unwrap_or(1000);
match code {
1000..=1003 | 1007..=1011 | 1015 | 3000..=3999 | 4000..=4999 => {
match msg.get(2..).map(|data| String::from_utf8(data.to_vec())) {
Some(Ok(msg)) => Event::Close {
code,
reason: msg.into_boxed_str(),
},
None => Event::Close {
code,
reason: "".into(),
},
Some(Err(_)) => Event::Error("invalid utf-8 payload"),
}
}
_ => Event::Error("invalid close code"),
}
}
impl<IO> From<(IO, Role)> for WebSocket<IO> {
#[inline]
fn from((stream, role): (IO, Role)) -> Self {
Self {
stream,
max_payload_len: 16 * 1024 * 1024,
role,
is_closed: false,
fragment: None,
}
}
}