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
//! Websocket data frame.
//!
//! [RFC-6455 Section5](https://datatracker.ietf.org/doc/html/rfc6455#section-5)
//!
//! ```text
//! 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 ... |
//! +---------------------------------------------------------------+
//! ```
//!
pub mod flag;
pub mod length;
pub mod mask;
pub use flag::{Fin, OpCode};
pub use length::PayloadLen;
pub use mask::{Mask, new_mask_key, apply_mask4};
/// Websocket frame head.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FrameHead {
pub fin: Fin,
pub opcode: OpCode,
pub mask: Mask,
pub length: PayloadLen,
}
use crate::bleed::Writer;
use crate::bleed::{slice, slice_to_array};
use crate::error::FrameError;
impl FrameHead {
/// Constructor.
#[inline]
pub const fn new(fin: Fin, opcode: OpCode, mask: Mask, length: PayloadLen) -> Self {
Self {
fin,
opcode,
mask,
length,
}
}
/// Encode to provided buffer, return the count of written bytes.
///
/// Caller should ensure there is enough space to write,
/// otherwise a [`FrameError::NotEnoughCapacity`] error will be returned.
pub fn encode(&self, buf: &mut [u8]) -> Result<usize, FrameError> {
if buf.len() < 2 {
return Err(FrameError::NotEnoughCapacity);
}
let mut writer = Writer::new(buf);
macro_rules! writex {
($dst: expr) => {
if writer.remaining() < $dst.len() {
return Err(FrameError::NotEnoughCapacity);
} else {
unsafe {
writer.write_unchecked($dst);
}
}
};
}
// fin, opcode
let b1 = self.fin as u8 | self.opcode as u8;
// mask, payload length
let b2 = self.mask.to_flag() | self.length.to_flag();
writex!(&[b1, b2]);
// extended payload length
match &self.length {
PayloadLen::Standard(_) => {}
PayloadLen::Extended1(v) => writex!(&v.to_be_bytes()),
PayloadLen::Extended2(v) => writex!(&v.to_be_bytes()),
};
// mask key
match &self.mask {
Mask::Key(k) => writex!(k),
Mask::Skip => writex!(&[0u8; 4]),
Mask::None => {}
};
Ok(writer.pos())
}
/// Unchecked version of [`encode`](Self::encode).
///
/// # Safety
///
/// Caller must ensure there is enough space to write,
/// otherwise it is **Undefined Behavior!**
pub unsafe fn encode_unchecked(&self, buf: &mut [u8]) -> usize {
let mut writer = Writer::new(buf);
macro_rules! writex {
($dst: expr) => {{
writer.write_unchecked($dst);
}};
}
// fin, opcode
let b1 = self.fin as u8 | self.opcode as u8;
// mask, payload length
let b2 = self.mask.to_flag() | self.length.to_flag();
writex!(&[b1, b2]);
// extended payload length
match &self.length {
PayloadLen::Standard(_) => {}
PayloadLen::Extended1(v) => writex!(&v.to_be_bytes()),
PayloadLen::Extended2(v) => writex!(&v.to_be_bytes()),
};
// mask key
match &self.mask {
Mask::Key(k) => writex!(k),
Mask::Skip => writex!(&[0u8; 4]),
Mask::None => {}
};
writer.pos()
}
/// Parse from provided buffer, returns [`FrameHead`] and the count of read bytes.
///
/// If there is not enough data to parse, a [`FrameError::NotEnoughData`] error
/// will be returned.
pub fn decode(buf: &[u8]) -> Result<(Self, usize), FrameError> {
if buf.len() < 2 {
return Err(FrameError::NotEnoughData);
}
let mut n: usize = 2;
// fin, opcode
let b1 = unsafe { *buf.get_unchecked(0) };
// mask, payload length
let b2 = unsafe { *buf.get_unchecked(1) };
let fin = Fin::from_flag(b1)?;
let opcode = OpCode::from_flag(b1)?;
let mut mask = Mask::from_flag(b2)?;
let mut length = PayloadLen::from_flag(b2);
match length {
PayloadLen::Standard(_) => {}
PayloadLen::Extended1(_) => {
if buf.len() - n < 2 {
return Err(FrameError::NotEnoughData);
}
length =
PayloadLen::from_byte2(unsafe { *slice_to_array::<_, 2>(slice(buf, 2, 4)) });
n += 2;
}
PayloadLen::Extended2(_) => {
if buf.len() - n < 8 {
return Err(FrameError::NotEnoughData);
}
length =
PayloadLen::from_byte8(unsafe { *slice_to_array::<_, 8>(slice(buf, 2, 10)) });
n += 8;
}
};
match mask {
Mask::None => {}
_ => {
if buf.len() - n < 4 {
return Err(FrameError::NotEnoughData);
}
let key = *unsafe { slice_to_array::<_, 4>(slice(buf, n, n + 4)) };
if key.into_iter().all(|b| b == 0) {
mask = Mask::Skip
} else {
mask = Mask::Key(key)
}
n += 4;
}
}
Ok((
FrameHead {
fin,
opcode,
mask,
length,
},
n,
))
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn frame_head() {
let head = FrameHead {
fin: Fin::Y,
opcode: OpCode::Binary,
mask: Mask::Key(mask::new_mask_key()),
length: PayloadLen::from_num(4096),
};
let head2 = FrameHead {
fin: Fin::N,
opcode: OpCode::Binary,
mask: Mask::Key(mask::new_mask_key()),
length: PayloadLen::from_num(64),
};
for head in [head, head2] {
let mut buf = vec![0; 1024];
let encode_n = head.encode(&mut buf).unwrap();
assert!(encode_n + 128 <= buf.len());
let (head2, decode_n) = FrameHead::decode(&buf[0..encode_n + 128]).unwrap();
assert_eq!(encode_n, decode_n);
assert_eq!(head, head2);
let mut buf2 = vec![0; 1024];
let encode_n2 = unsafe { head2.encode_unchecked(&mut buf2) };
assert_eq!(encode_n2, encode_n);
assert_eq!(&buf[0..encode_n], &buf2[0..encode_n2]);
}
}
}