ws-framer 0.3.0

Simple no-std framer for websockets (with alloc feature)
Documentation
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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
use crate::{crypto::Base64Pad, WsFrame, WsFrameHeader};
#[cfg(feature = "http")]
use httparse::Header;

/// Framer used to retrieve data (websocket frames and http responses)
pub struct WsRxFramer<'a> {
    /// Internal buffer
    buf: &'a mut [u8],

    /// Header for frame that is currently parsed
    current_header: Option<WsFrameHeader>,

    /// Offset in internal buffer (for writing responses from server)
    write_offset: usize,

    /// Calculated current frame packet end offset
    current_packet_end: usize,

    /// If old frame should be disposed from internal buffer in next call
    shift: bool,
}

impl<'a> WsRxFramer<'a> {
    pub fn new(buf: &'a mut [u8]) -> Self {
        Self {
            buf,

            current_header: None,
            write_offset: 0,
            current_packet_end: 0,
            shift: false,
        }
    }

    #[cfg(feature = "http")]
    pub fn process_http_response<'b>(&'b mut self, n: usize) -> Option<u16> {
        self.write_offset += n;

        let mut headers = [httparse::EMPTY_HEADER; 16];
        let mut resp = httparse::Response::new(&mut headers);
        let res = resp.parse(&self.buf[..self.write_offset]).ok()?;

        if res.is_complete() {
            let code = resp.code.clone();
            let mut offset = res.unwrap();
            for header in resp.headers {
                if header.name == "Content-Length" {
                    let content_length =
                        usize::from_str_radix(core::str::from_utf8(header.value).ok()?, 10).ok()?;

                    offset += content_length;
                }
            }

            unsafe {
                core::ptr::copy(
                    self.buf.as_ptr().offset(offset as isize),
                    self.buf.as_mut_ptr(),
                    self.write_offset - offset,
                );
            }

            self.write_offset -= offset;
            return code;
        }

        None
    }

    pub fn process_data<'b>(&'b mut self) -> Option<WsFrame<'b>> {
        if self.shift {
            // shift all data left (dispose parsed frame data)
            unsafe {
                core::ptr::copy(
                    self.buf.as_ptr().offset(self.current_packet_end as isize),
                    self.buf.as_mut_ptr(),
                    self.write_offset - self.current_packet_end,
                );
            }

            self.shift = false;
            self.write_offset -= self.current_packet_end;
            self.current_packet_end = 0;
        }

        if self.current_header.is_none() {
            let tmp_buf = self.buf[0..self.write_offset].as_mut();
            let fin = (tmp_buf.get(0)? & 0b10000000) >> 7;
            let rsv1 = (tmp_buf.get(0)? & 0b01000000) >> 6;
            let rsv2 = (tmp_buf.get(0)? & 0b00100000) >> 5;
            let rsv3 = (tmp_buf.get(0)? & 0b00010000) >> 4;
            let opcode = tmp_buf.get(0)? & 0b00001111;
            let mask = (tmp_buf.get(1)? & 0b10000000) >> 7;
            let mut payload_len = (tmp_buf.get(1)? & 0b01111111) as usize;

            let mut offset = 2;
            if payload_len == 126 {
                payload_len = u16::from_be_bytes(tmp_buf.get(2..4)?.try_into().unwrap()) as usize;
                offset += 2;
            } else if payload_len == 127 {
                payload_len = u64::from_be_bytes(tmp_buf.get(2..10)?.try_into().unwrap()) as usize;
                offset += 8;
            }

            let mut masking_key = [0; 4];
            if mask == 1 {
                masking_key.copy_from_slice(&tmp_buf.get(offset..offset + 4)?);
                offset += 4;
            }

            self.current_header = Some(WsFrameHeader {
                fin: fin == 1,
                rsv1: rsv1 == 1,
                rsv2: rsv2 == 1,
                rsv3: rsv3 == 1,
                opcode,
                mask: mask == 1,
                masking_key,
                payload_len,
                offset,
            });

            self.current_packet_end = offset + payload_len;
        }

        // if frame fully received
        if self.write_offset >= self.current_packet_end && self.current_header.is_some() {
            let header = self.current_header.take().unwrap();
            self.shift = true; // shift on next invocation of process_data

            return Some(WsFrame::from_data(
                &header,
                &mut self.buf[header.offset..header.offset + header.payload_len],
            ));
        }

        None
    }

    pub fn mut_buf<'b>(&'b mut self) -> &'b mut [u8] {
        self.buf[self.write_offset..].as_mut()
    }

    pub fn revolve_write_offset(&mut self, n: usize) {
        self.write_offset += n;
    }
}

/// Framer used to send data (websocket frames and http upgrade requests)
pub struct WsTxFramer<'a> {
    /// Internal buffer
    buf: &'a mut [u8],

    /// Boolean indicating if frames sent should be masked
    mask: bool,
}

impl<'a> WsTxFramer<'a> {
    pub fn new(mask: bool, buf: &'a mut [u8]) -> Self {
        Self { buf, mask }
    }

    #[cfg(feature = "http")]
    pub fn generate_http_upgrade<'b>(
        &'b mut self,
        host: &str,
        path: &str,
        additional_headers: Option<&[Header]>,
    ) -> &'b [u8] {
        let mut ws_key = [0u8; 16];
        crate::rng_fill(&mut ws_key);

        let mut ws_key_b64 = [0u8; crate::consts::WS_KEY_B64_LEN];
        Base64Pad::encode_slice(&ws_key, &mut ws_key_b64);

        self.buf[0..4].copy_from_slice(b"GET ");
        let mut offset = 4 + path.as_bytes().len();
        self.buf[4..offset].copy_from_slice(path.as_bytes());
        self.buf[offset..offset + 11].copy_from_slice(b" HTTP/1.1\r\n");
        offset += 11;

        let headers = [
            Header {
                name: "Host",
                value: host.as_bytes(),
            },
            Header {
                name: "Sec-WebSocket-Key",
                value: &ws_key_b64,
            },
        ];

        self.append_headers(&crate::consts::WS_DEFAULT_CONNECT_HEADERS, &mut offset);
        self.append_headers(&headers, &mut offset);
        if let Some(additional) = additional_headers {
            self.append_headers(&additional, &mut offset);
        }

        self.buf[offset..offset + 2].copy_from_slice(b"\r\n");
        &self.buf[0..offset + 2]
    }

    #[cfg(feature = "http")]
    pub fn generate_http_response<'b>(
        &'b mut self,
        status_code: u16,
        status_text: &str,
        headers: &[Header],
    ) -> &'b [u8] {
        self.buf[..9].copy_from_slice(b"HTTP/1.1 ");
        let mut itoa = itoa::Buffer::new();
        let status_code = itoa.format(status_code);

        self.buf[9..9 + status_code.len()].copy_from_slice(status_code.as_bytes());
        let mut offset = 9 + status_code.len();
        self.buf[offset] = b' ';
        self.buf[offset + 1..offset + 1 + status_text.len()]
            .copy_from_slice(status_text.as_bytes());
        offset += 1 + status_text.len();
        self.buf[offset..offset + 2].copy_from_slice(b"\r\n");
        offset += 2;

        self.append_headers(&headers, &mut offset);
        self.buf[offset..offset + 2].copy_from_slice(b"\r\n");
        &self.buf[0..offset + 2]
    }

    fn append_headers<'b>(&'b mut self, headers: &[Header], offset: &mut usize) {
        for header in headers {
            self.buf[*offset..*offset + header.name.len()].copy_from_slice(header.name.as_bytes());
            *offset += header.name.len();

            self.buf[*offset..*offset + 2].copy_from_slice(b": ");
            *offset += 2;

            self.buf[*offset..*offset + header.value.len()].copy_from_slice(header.value);
            *offset += header.value.len();

            self.buf[*offset..*offset + 2].copy_from_slice(b"\r\n");
            *offset += 2;
        }
    }

    pub fn generate_packet<'b>(&'b mut self, header: &WsFrameHeader, data: &[u8]) -> &'b [u8] {
        let first_byte = (header.fin as u8) << 7
            | (header.rsv1 as u8) << 6
            | (header.rsv2 as u8) << 5
            | (header.rsv3 as u8) << 4
            | header.opcode & 0x0F;
        self.buf[0] = first_byte;

        let mut offset = 1;
        match header.payload_len {
            0..=125 => {
                self.buf[offset] = (header.mask as u8) << 7 | header.payload_len as u8;
                offset += 1;
            }
            126..crate::consts::U16_MAX => {
                self.buf[offset] = (header.mask as u8) << 7 | 126;
                self.buf[offset + 1..offset + 1 + 2]
                    .copy_from_slice(&(header.payload_len as u16).to_be_bytes());

                offset += 3;
            }
            crate::consts::U16_MAX.. => {
                self.buf[offset] = (header.mask as u8) << 7 | 127;
                self.buf[offset + 1..offset + 1 + 8]
                    .copy_from_slice(&(header.payload_len as u64).to_be_bytes());

                offset += 9;
            }
        }

        if header.mask {
            self.buf[offset..offset + 4].copy_from_slice(&header.masking_key);
            offset += 4;

            for d in data
                .iter()
                .enumerate()
                .map(|(i, &x)| x ^ header.masking_key[i % 4])
            {
                self.buf[offset] = d;
                offset += 1;
            }
        } else {
            self.buf[offset..offset + data.len()].copy_from_slice(data);
            offset += data.len();
        }

        &self.buf[..offset]
    }

    fn append_packet_data<'b>(
        &'b mut self,
        header: &WsFrameHeader,
        data: &[u8],
        mut offset: usize,
    ) -> &'b [u8] {
        if header.mask {
            for d in data
                .iter()
                .enumerate()
                .map(|(i, &x)| x ^ header.masking_key[i % 4])
            {
                self.buf[offset] = d;
                offset += 1;
            }
        } else {
            self.buf[offset..offset + data.len()].copy_from_slice(data);
            offset += data.len();
        }

        &self.buf[..offset]
    }

    pub fn frame<'b>(&'b mut self, frame: WsFrame<'_>) -> &'b [u8] {
        let mut masking_key = [0; 4];
        if self.mask {
            crate::rng_fill(&mut masking_key);
        }

        let (payload, size) = match frame {
            WsFrame::Text(data) => (data.as_bytes(), data.as_bytes().len()),
            WsFrame::Binary(data) => (data, data.len()),
            WsFrame::Close(code, reason) => (&code.to_be_bytes()[..], 2 + reason.as_bytes().len()),
            WsFrame::Ping(data) => (data, data.len()),
            WsFrame::Pong(data) => (data, data.len()),
            WsFrame::Unknown => todo!(),
        };

        let header = WsFrameHeader {
            fin: true,
            rsv1: false,
            rsv2: false,
            rsv3: false,
            opcode: frame.opcode(),
            mask: self.mask,
            masking_key,
            payload_len: size,
            offset: 0,
        };

        let data = if let WsFrame::Close(_, reason) = frame {
            let data = self.generate_packet(&header, payload);
            let data_len = data.len();

            self.append_packet_data(&header, reason.as_bytes(), data_len)
        } else {
            self.generate_packet(&header, payload)
        };

        data
    }

    pub fn partial_frame<'b>(
        &'b mut self,
        frame: &WsFrame<'_>,
        offset: &mut usize,
    ) -> (&'b [u8], bool) {
        let mut masking_key = [0; 4];
        if self.mask {
            crate::rng_fill(&mut masking_key);
        }

        let (payload, size) = match frame {
            WsFrame::Text(data) => (data.as_bytes(), data.as_bytes().len()),
            WsFrame::Binary(data) => (*data, data.len()),
            WsFrame::Close(code, reason) => (&code.to_be_bytes()[..], 2 + reason.as_bytes().len()),
            WsFrame::Ping(data) => (*data, data.len()),
            WsFrame::Pong(data) => (*data, data.len()),
            WsFrame::Unknown => todo!(),
        };

        let payload = &payload[*offset..];
        let mut size = size.saturating_sub(*offset);
        let splitted = size + 16 > self.buf.len();

        let mut header = WsFrameHeader {
            fin: true,
            rsv1: false,
            rsv2: false,
            rsv3: false,
            opcode: frame.opcode(),
            mask: self.mask,
            masking_key,
            payload_len: size,
            offset: 0,
        };

        if splitted {
            if *offset != 0 {
                header.opcode = 0;
            }

            size = size.min(self.buf.len() - 16);
            header.fin = false;
            header.payload_len = size;
        } else if *offset > 0 {
            header.opcode = 0;
            header.fin = true;
        }

        *offset += size;
        let data = if let WsFrame::Close(_, reason) = frame {
            // BUG: close frames shouldnt be spllited
            let data = self.generate_packet(&header, &payload[..size]);
            let data_len = data.len();

            self.append_packet_data(&header, reason.as_bytes(), data_len)
        } else {
            self.generate_packet(&header, &payload[..size])
        };

        (data, splitted)
    }

    #[cfg(feature = "alloc")]
    pub fn frame_owned<'b>(&'b mut self, frame: crate::WsFrameOwned) -> &'b [u8] {
        self.frame(frame.into_ref())
    }

    pub fn text<'b>(&'b mut self, data: &str) -> &'b [u8] {
        self.frame(WsFrame::Text(data))
    }

    pub fn binary<'b>(&'b mut self, data: &[u8]) -> &'b [u8] {
        self.frame(WsFrame::Binary(data))
    }

    pub fn close<'b>(&'b mut self, code: u16, reason: &str) -> &'b [u8] {
        self.frame(WsFrame::Close(code, reason))
    }

    pub fn ping<'b>(&'b mut self, data: &[u8]) -> &'b [u8] {
        self.frame(WsFrame::Ping(data))
    }

    pub fn pong<'b>(&'b mut self, data: &[u8]) -> &'b [u8] {
        self.frame(WsFrame::Pong(data))
    }
}