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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
use std::io::{Read, Write};

use http;
use crate::{
    codec::{apply_mask, FrameConfig, Split},
    errors::{ProtocolError, WsError},
    frame::{ctor_header, OpCode, OwnedFrame, SimplifiedHeader},
    protocol::standard_handshake_resp_check,
};
use bytes::BytesMut;
use rand::random;

use super::{DeflateReadState, DeflateWriteState, PMDConfig};

impl DeflateWriteState {
    /// send a read frame, **this method will not check validation of frame and do not fragment**
    pub fn send_owned_frame<S: Write>(
        &mut self,
        stream: &mut S,
        mut frame: OwnedFrame,
    ) -> Result<(), WsError> {
        if !frame.header().opcode().is_data() {
            return self
                .write_state
                .send_owned_frame(stream, frame)
                .map_err(WsError::IOError);
        }
        let prev_mask = frame.unmask();
        let header = frame.header();
        let frame: Result<OwnedFrame, WsError> = header
            .opcode()
            .is_data()
            .then(|| self.com.as_mut())
            .flatten()
            .map(|handler| {
                let mut compressed = Vec::with_capacity(frame.payload().len());
                handler
                    .com
                    .compress(&[frame.payload()], &mut compressed)
                    .map_err(|code| WsError::CompressFailed(code.to_string()))?;
                compressed.truncate(compressed.len() - 4);
                let mut new = OwnedFrame::new(header.opcode(), prev_mask, &compressed);
                let header = new.header_mut();
                header.set_rsv1(true);
                header.set_fin(header.fin());

                if (self.is_server && handler.config.server_no_context_takeover)
                    || (!self.is_server && handler.config.client_no_context_takeover)
                {
                    handler
                        .com
                        .reset()
                        .map_err(|code| WsError::CompressFailed(code.to_string()))?;
                    tracing::trace!("reset compressor");
                }
                Ok(new)
            })
            .unwrap_or_else(|| {
                if let Some(mask) = prev_mask {
                    frame.mask(mask);
                }
                Ok(frame)
            });
        self.write_state
            .send_owned_frame(stream, frame?)
            .map_err(WsError::IOError)
    }

    /// send payload
    ///
    /// will auto fragment **before compression** if auto_fragment_size > 0
    pub fn send<S: Write>(
        &mut self,
        stream: &mut S,
        code: OpCode,
        payload: &[u8],
    ) -> Result<(), WsError> {
        let mask_send = self.config.mask_send_frame;
        let mask_fn = || {
            if mask_send {
                Some(random())
            } else {
                None
            }
        };
        if payload.is_empty() {
            let mask = mask_fn();
            let frame = OwnedFrame::new(code, mask, &[]);
            return self.send_owned_frame(stream, frame);
        }

        let chunk_size = if self.config.auto_fragment_size > 0 {
            self.config.auto_fragment_size
        } else {
            payload.len()
        };
        let parts: Vec<&[u8]> = payload.chunks(chunk_size).collect();
        let total = parts.len();
        for (idx, chunk) in parts.into_iter().enumerate() {
            let fin = idx + 1 == total;
            let mask = mask_fn();
            match (self.com.as_mut(), code.is_data()) {
                (Some(handler), true) => {
                    let mut output = vec![];
                    handler
                        .com
                        .compress(&[chunk], &mut output)
                        .map_err(|code| WsError::CompressFailed(code.to_string()))?;
                    output.truncate(output.len() - 4);
                    let header = ctor_header(
                        &mut self.header_buf,
                        fin,
                        true,
                        false,
                        false,
                        mask,
                        code,
                        output.len() as u64,
                    );
                    stream.write_all(header)?;
                    if let Some(mask) = mask {
                        apply_mask(&mut output, mask)
                    };
                    stream.write_all(&output)?;
                    if (self.is_server && handler.config.server_no_context_takeover)
                        || (!self.is_server && handler.config.client_no_context_takeover)
                    {
                        handler
                            .com
                            .reset()
                            .map_err(|code| WsError::CompressFailed(code.to_string()))?;
                        tracing::trace!("reset compressor");
                    }
                }
                _ => {
                    let header = ctor_header(
                        &mut self.header_buf,
                        fin,
                        false,
                        false,
                        false,
                        mask,
                        code,
                        chunk.len() as u64,
                    );
                    stream.write_all(header)?;
                    if let Some(mask) = mask {
                        let mut data = BytesMut::from_iter(chunk);
                        apply_mask(&mut data, mask);
                        stream.write_all(&data)?;
                    } else {
                        stream.write_all(chunk)?;
                    }
                }
            }
        }
        Ok(())
    }
}

impl DeflateReadState {
    fn receive_one<S: Read>(
        &mut self,
        stream: &mut S,
    ) -> Result<(SimplifiedHeader, Vec<u8>), WsError> {
        let (mut header, data) = self.read_state.receive(stream)?;
        let data = data.to_vec();
        let compressed = header.rsv1;
        let is_data_frame = header.code.is_data();
        if compressed && !is_data_frame {
            return Err(WsError::ProtocolError {
                close_code: 1002,
                error: ProtocolError::CompressedControlFrame,
            });
        }
        if !is_data_frame || !compressed {
            return Ok((header, data));
        }
        let frame = match self.de.as_mut() {
            Some(handler) => {
                let mut de_data = vec![];
                handler
                    .de
                    .de_compress(&[&data, &[0, 0, 255, 255]], &mut de_data)
                    .map_err(|code| WsError::DeCompressFailed(code.to_string()))?;
                if (self.is_server && handler.config.server_no_context_takeover)
                    || (!self.is_server && handler.config.client_no_context_takeover)
                {
                    handler
                        .de
                        .reset()
                        .map_err(|code| WsError::DeCompressFailed(code.to_string()))?;
                    tracing::trace!("reset decompressor state");
                }
                de_data
            }
            None => {
                if header.rsv1 {
                    return Err(WsError::DeCompressFailed(
                        "extension not enabled but got compressed frame".into(),
                    ));
                } else {
                    data
                }
            }
        };
        header.rsv1 = false;
        Ok((header, frame))
    }

    /// receive a message
    pub fn receive<S: Read>(
        &mut self,
        stream: &mut S,
    ) -> Result<(SimplifiedHeader, &[u8]), WsError> {
        loop {
            let (mut header, mut data) = self.receive_one(stream)?;
            if !self.config.merge_frame {
                self.fragmented_data.clear();
                self.fragmented_data.append(&mut data);
                break Ok((header, &self.fragmented_data));
            }
            match header.code {
                OpCode::Continue => {
                    if !self.fragmented {
                        return Err(WsError::ProtocolError {
                            close_code: 1002,
                            error: ProtocolError::MissInitialFragmentedFrame,
                        });
                    }
                    let fin = header.fin;
                    self.fragmented_data.extend_from_slice(&data);
                    if fin {
                        self.fragmented = false;
                        header.code = self.fragmented_type;
                        break Ok((header, &self.fragmented_data));
                    } else {
                        continue;
                    }
                }
                OpCode::Text | OpCode::Binary => {
                    if self.fragmented {
                        return Err(WsError::ProtocolError {
                            close_code: 1002,
                            error: ProtocolError::NotContinueFrameAfterFragmented,
                        });
                    }
                    if !header.fin {
                        self.fragmented = true;
                        self.fragmented_type = header.code;
                        if header.code == OpCode::Text
                            && self.config.validate_utf8.is_fast_fail()
                            && simdutf8::basic::from_utf8(&data).is_err()
                        {
                            return Err(WsError::ProtocolError {
                                close_code: 1007,
                                error: ProtocolError::InvalidUtf8,
                            });
                        }
                        self.fragmented_data.clear();
                        self.fragmented_data.extend_from_slice(&data);
                        continue;
                    } else {
                        if header.code == OpCode::Text
                            && self.config.validate_utf8.should_check()
                            && simdutf8::basic::from_utf8(&data).is_err()
                        {
                            return Err(WsError::ProtocolError {
                                close_code: 1007,
                                error: ProtocolError::InvalidUtf8,
                            });
                        }
                        self.fragmented_data.clear();
                        self.fragmented_data.extend_from_slice(&data);
                        break Ok((header, &self.fragmented_data));
                    }
                }
                OpCode::Close | OpCode::Ping | OpCode::Pong => {
                    self.control_buf = data;
                    break Ok((header, &self.control_buf));
                }
                _ => break Err(WsError::UnsupportedFrame(header.code)),
            }
        }
    }
}

/// recv/send deflate message
pub struct DeflateCodec<S: Read + Write> {
    read_state: DeflateReadState,
    write_state: DeflateWriteState,
    stream: S,
}

impl<S: Read + Write> DeflateCodec<S> {
    /// construct method
    pub fn new(
        stream: S,
        frame_config: FrameConfig,
        pmd_config: Option<PMDConfig>,
        is_server: bool,
    ) -> Self {
        let read_state =
            DeflateReadState::with_config(frame_config.clone(), pmd_config.clone(), is_server);
        let write_state = DeflateWriteState::with_config(frame_config, pmd_config, is_server);
        Self {
            read_state,
            write_state,
            stream,
        }
    }

    /// used for server side to construct a new server
    pub fn factory(req: http::Request<()>, stream: S) -> Result<Self, WsError> {
        let mut pmd_confs: Vec<PMDConfig> = vec![];
        for (k, v) in req.headers() {
            if k.as_str().to_lowercase() == "sec-websocket-extensions" {
                if let Ok(s) = v.to_str() {
                    match PMDConfig::parse_str(s) {
                        Ok(mut conf) => {
                            pmd_confs.append(&mut conf);
                        }
                        Err(e) => return Err(WsError::HandShakeFailed(e)),
                    }
                }
            }
        }
        let mut pmd_conf = pmd_confs.pop();
        if let Some(conf) = pmd_conf.as_mut() {
            let min = conf.client_max_window_bits.min(conf.server_max_window_bits);
            conf.client_max_window_bits = min;
            conf.server_max_window_bits = min;
        }
        tracing::debug!("use deflate config {:?}", pmd_conf);

        let frame_conf = FrameConfig {
            mask_send_frame: false,
            ..Default::default()
        };
        let codec = DeflateCodec::new(stream, frame_conf, pmd_conf, true);
        Ok(codec)
    }

    /// used for client side to construct a new client
    pub fn check_fn(key: String, resp: http::Response<()>, stream: S) -> Result<Self, WsError> {
        standard_handshake_resp_check(key.as_bytes(), &resp)?;
        let mut pmd_confs: Vec<PMDConfig> = vec![];
        for (k, v) in resp.headers() {
            if k.as_str().to_lowercase() == "sec-websocket-extensions" {
                if let Ok(s) = v.to_str() {
                    match PMDConfig::parse_str(s) {
                        Ok(mut conf) => {
                            pmd_confs.append(&mut conf);
                        }
                        Err(e) => return Err(WsError::HandShakeFailed(e)),
                    }
                }
            }
        }
        let mut pmd_conf = pmd_confs.pop();
        if let Some(conf) = pmd_conf.as_mut() {
            let min = conf.client_max_window_bits.min(conf.server_max_window_bits);
            conf.client_max_window_bits = min;
            conf.server_max_window_bits = min;
        }
        tracing::debug!("use deflate config: {:?}", pmd_conf);
        let codec = DeflateCodec::new(stream, Default::default(), pmd_conf, false);
        Ok(codec)
    }

    /// get mutable underlying stream
    pub fn stream_mut(&mut self) -> &mut S {
        &mut self.stream
    }

    /// receive a message
    pub fn receive(&mut self) -> Result<(SimplifiedHeader, &[u8]), WsError> {
        self.read_state.receive(&mut self.stream)
    }

    /// send a read frame, **this method will not check validation of frame and do not fragment**
    pub fn send_owned_frame(&mut self, frame: OwnedFrame) -> Result<(), WsError> {
        self.write_state.send_owned_frame(&mut self.stream, frame)
    }

    /// send payload
    ///
    /// will auto fragment **before compression** if auto_fragment_size > 0
    pub fn send(&mut self, code: OpCode, payload: &[u8]) -> Result<(), WsError> {
        self.write_state.send(&mut self.stream, code, payload)
    }

    /// helper function to send text message
    pub fn text(&mut self, text: &str) -> Result<(), WsError> {
        self.write_state
            .send(&mut self.stream, OpCode::Text, text.as_bytes())
    }

    /// helper function to send binary message
    pub fn binary(&mut self, data: &[u8]) -> Result<(), WsError> {
        self.send(OpCode::Binary, data)
    }

    /// helper function to send ping message
    pub fn ping(&mut self, data: &[u8]) -> Result<(), WsError> {
        self.send(OpCode::Ping, data)
    }

    /// helper function to send ping message
    pub fn pong(&mut self, data: &[u8]) -> Result<(), WsError> {
        self.send(OpCode::Pong, data)
    }

    /// helper method to send close message
    pub fn close(&mut self, code: u16, msg: &[u8]) -> Result<(), WsError> {
        let mut data = code.to_be_bytes().to_vec();
        data.extend_from_slice(msg);
        self.send(OpCode::Close, &data)
    }

    /// flush stream to ensure all data are send
    pub fn flush(&mut self) -> Result<(), WsError> {
        self.stream.flush().map_err(WsError::IOError)
    }
}

/// recv part of deflate message
pub struct DeflateRecv<S: Read> {
    stream: S,
    read_state: DeflateReadState,
}

impl<S: Read> DeflateRecv<S> {
    /// construct method
    pub fn new(stream: S, read_state: DeflateReadState) -> Self {
        Self { stream, read_state }
    }

    /// get mutable underlying stream
    pub fn stream_mut(&mut self) -> &mut S {
        &mut self.stream
    }

    /// receive a frame
    pub fn receive(&mut self) -> Result<(SimplifiedHeader, &[u8]), WsError> {
        self.read_state.receive(&mut self.stream)
    }
}

/// send part of deflate message
pub struct DeflateSend<S: Write> {
    stream: S,
    write_state: DeflateWriteState,
}

impl<S: Write> DeflateSend<S> {
    /// construct method
    pub fn new(stream: S, write_state: DeflateWriteState) -> Self {
        Self {
            stream,
            write_state,
        }
    }

    /// get mutable underlying stream
    pub fn stream_mut(&mut self) -> &mut S {
        &mut self.stream
    }

    /// send a read frame, **this method will not check validation of frame and do not fragment**
    pub fn send_owned_frame(&mut self, frame: OwnedFrame) -> Result<(), WsError> {
        self.write_state.send_owned_frame(&mut self.stream, frame)
    }

    /// send payload
    ///
    /// will auto fragment **before compression** if auto_fragment_size > 0
    pub fn send(&mut self, code: OpCode, payload: &[u8]) -> Result<(), WsError> {
        self.write_state.send(&mut self.stream, code, payload)
    }

    /// helper function to send text message
    pub fn text(&mut self, text: &str) -> Result<(), WsError> {
        self.write_state
            .send(&mut self.stream, OpCode::Text, text.as_bytes())
    }

    /// helper function to send binary message
    pub fn binary(&mut self, data: &[u8]) -> Result<(), WsError> {
        self.send(OpCode::Binary, data)
    }

    /// helper function to send ping message
    pub fn ping(&mut self, data: &[u8]) -> Result<(), WsError> {
        self.send(OpCode::Ping, data)
    }

    /// helper function to send ping message
    pub fn pong(&mut self, data: &[u8]) -> Result<(), WsError> {
        self.send(OpCode::Pong, data)
    }

    /// helper method to send close message
    pub fn close(&mut self, code: u16, msg: &[u8]) -> Result<(), WsError> {
        let mut data = code.to_be_bytes().to_vec();
        data.extend_from_slice(msg);
        self.send(OpCode::Close, &data)
    }

    /// flush stream to ensure all data are send
    pub fn flush(&mut self) -> Result<(), WsError> {
        self.stream.flush().map_err(WsError::IOError)
    }
}

impl<R, W, S> DeflateCodec<S>
where
    R: Read,
    W: Write,
    S: Read + Write + Split<R = R, W = W>,
{
    /// split codec to recv and send parts
    pub fn split(self) -> (DeflateRecv<R>, DeflateSend<W>) {
        let DeflateCodec {
            stream,
            read_state,
            write_state,
        } = self;
        let (read, write) = stream.split();
        (
            DeflateRecv::new(read, read_state),
            DeflateSend::new(write, write_state),
        )
    }
}