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
// Copyright 2023 Divy Srivastava <dj.srivastava23@gmail.com>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use tokio::io::AsyncReadExt;
use tokio::io::AsyncWriteExt;
macro_rules! repr_u8 {
($(#[$meta:meta])* $vis:vis enum $name:ident {
$($(#[$vmeta:meta])* $vname:ident $(= $val:expr)?,)*
}) => {
$(#[$meta])*
$vis enum $name {
$($(#[$vmeta])* $vname $(= $val)?,)*
}
#[derive(Debug)]
pub enum Error {
InvalidValue,
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Error::InvalidValue => write!(f, "invalid value"),
}
}
}
impl std::error::Error for Error {}
impl core::convert::TryFrom<u8> for $name {
type Error = Error;
fn try_from(v: u8) -> Result<Self, Self::Error> {
match v {
$(x if x == $name::$vname as u8 => Ok($name::$vname),)*
_ => Err(Error::InvalidValue),
}
}
}
}
}
/// Represents a WebSocket frame.
pub struct Frame {
/// Indicates if this is the final frame in a message.
pub fin: bool,
/// The opcode of the frame.
pub opcode: OpCode,
/// The masking key of the frame, if any.
mask: Option<[u8; 4]>,
/// The payload of the frame.
pub payload: Vec<u8>,
}
const MAX_HEAD_SIZE: usize = 16;
impl Frame {
/// Creates a new WebSocket `Frame`.
pub fn new(
fin: bool,
opcode: OpCode,
mask: Option<[u8; 4]>,
payload: Vec<u8>,
) -> Self {
Self {
fin,
opcode,
mask,
payload,
}
}
/// Create a new WebSocket text `Frame`.
///
/// This is a convenience method for `Frame::new(true, OpCode::Text, None, payload)`.
///
/// This method does not check if the payload is valid UTF-8.
pub fn text(payload: Vec<u8>) -> Self {
Self {
fin: true,
opcode: OpCode::Text,
mask: None,
payload,
}
}
/// Create a new WebSocket binary `Frame`.
///
/// This is a convenience method for `Frame::new(true, OpCode::Binary, None, payload)`.
pub fn binary(payload: Vec<u8>) -> Self {
Self {
fin: true,
opcode: OpCode::Binary,
mask: None,
payload,
}
}
/// Create a new WebSocket close `Frame`.
///
/// This is a convenience method for `Frame::new(true, OpCode::Close, None, payload)`.
///
/// This method does not check if `code` is a valid close code and `reason` is valid UTF-8.
pub fn close(code: u16, reason: &[u8]) -> Self {
let mut payload = Vec::with_capacity(2 + reason.len());
payload.extend_from_slice(&code.to_be_bytes());
payload.extend_from_slice(reason);
Self {
fin: true,
opcode: OpCode::Close,
mask: None,
payload,
}
}
/// Create a new WebSocket close `Frame` with a raw payload.
///
/// This is a convenience method for `Frame::new(true, OpCode::Close, None, payload)`.
///
/// This method does not check if `payload` is valid Close frame payload.
pub fn close_raw(payload: Vec<u8>) -> Self {
Self {
fin: true,
opcode: OpCode::Close,
mask: None,
payload,
}
}
/// Create a new WebSocket pong `Frame`.
///
/// This is a convenience method for `Frame::new(true, OpCode::Pong, None, payload)`.
pub fn pong(payload: Vec<u8>) -> Self {
Self {
fin: true,
opcode: OpCode::Pong,
mask: None,
payload,
}
}
/// Checks if the frame payload is valid UTF-8.
pub fn is_utf8(&self) -> bool {
#[cfg(feature = "simd")]
return simdutf8::basic::from_utf8(&self.payload).is_ok();
#[cfg(not(feature = "simd"))]
return std::str::from_utf8(&self.payload).is_ok();
}
pub fn mask(&mut self) {
if let Some(mask) = self.mask {
crate::mask::unmask(&mut self.payload, mask);
} else {
let mask: [u8; 4] = rand::random();
crate::mask::unmask(&mut self.payload, mask);
self.mask = Some(mask);
}
}
/// Unmasks the frame payload in-place. This method does nothing if the frame is not masked.
///
/// Note: By default, the frame payload is unmasked by `WebSocket::read_frame`.
pub fn unmask(&mut self) {
if let Some(mask) = self.mask {
crate::mask::unmask(&mut self.payload, mask);
}
}
/// Formats the frame header into the head buffer. Returns the size of the length field.
///
/// # Panics
///
/// This method panics if the head buffer is not at least n-bytes long, where n is the size of the length field (0, 2, 4, or 10)
pub fn fmt_head(&mut self, head: &mut [u8]) -> usize {
head[0] = (self.fin as u8) << 7 | (self.opcode as u8);
let len = self.payload.len();
let size = if len < 126 {
head[1] = len as u8;
2
} else if len < 65536 {
head[1] = 126;
head[2..4].copy_from_slice(&(len as u16).to_be_bytes());
4
} else {
head[1] = 127;
head[2..10].copy_from_slice(&(len as u64).to_be_bytes());
10
};
if let Some(mask) = self.mask {
head[1] |= 0x80;
head[size..size + 4].copy_from_slice(&mask);
size + 4
} else {
size
}
}
pub async fn writev<S>(
&mut self,
stream: &mut S,
) -> Result<(), std::io::Error>
where
S: AsyncReadExt + AsyncWriteExt + Unpin,
{
use std::io::IoSlice;
let mut head = [0; MAX_HEAD_SIZE];
let size = self.fmt_head(&mut head);
let total = size + self.payload.len();
let mut b = [IoSlice::new(&head[..size]), IoSlice::new(&self.payload)];
let mut n = stream.write_vectored(&b).await?;
if n == total {
return Ok(());
}
// Slighly more optimized than (unstable) write_all_vectored for 2 iovecs.
while n <= size {
b[0] = IoSlice::new(&head[n..size]);
n += stream.write_vectored(&b).await?;
}
// Header out of the way.
if n < total && n > size {
stream.write_all(&self.payload[n - size..]).await?;
}
Ok(())
}
/// Writes the frame to the buffer and returns a slice of the buffer containing the frame.
pub fn write<'a>(&mut self, buf: &'a mut Vec<u8>) -> &'a [u8] {
fn reserve_enough(buf: &mut Vec<u8>, len: usize) {
if buf.len() < len {
buf.resize(len, 0);
}
}
let len = self.payload.len();
reserve_enough(buf, len + MAX_HEAD_SIZE);
let size = self.fmt_head(buf);
buf[size..size + len].copy_from_slice(&self.payload);
&buf[..size + len]
}
}
repr_u8! {
#[repr(u8)]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum OpCode {
Continuation = 0x0,
Text = 0x1,
Binary = 0x2,
Close = 0x8,
Ping = 0x9,
Pong = 0xA,
}
}
#[inline]
pub fn is_control(opcode: OpCode) -> bool {
matches!(opcode, OpCode::Close | OpCode::Ping | OpCode::Pong)
}