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
use crate::errors::ProtocolError;
use crate::frame::{get_bit, parse_opcode, parse_payload_len, Frame, OpCode};
use bytes::{Buf, BytesMut};
use std::io::{Error as IOError, ErrorKind::InvalidData};
use std::{fmt::Debug, ops::Deref};
use tokio_util::codec::{Decoder, Encoder};
#[derive(Debug, Clone)]
pub struct FrameEncoder {}
impl Default for FrameEncoder {
fn default() -> Self {
Self {}
}
}
impl Encoder<Frame> for FrameEncoder {
type Error = IOError;
fn encode(&mut self, item: Frame, dst: &mut BytesMut) -> Result<(), Self::Error> {
dst.extend_from_slice(&item.0);
Ok(())
}
}
#[derive(Debug, Clone)]
pub struct FrameDecoder {
pub check_rsv: bool,
pub fragmented: bool,
pub fragmented_data: BytesMut,
pub fragmented_type: OpCode,
}
impl Default for FrameDecoder {
fn default() -> Self {
Self {
check_rsv: true,
fragmented: false,
fragmented_data: Default::default(),
fragmented_type: OpCode::Text,
}
}
}
impl FrameDecoder {
fn decode_single(&mut self, src: &mut BytesMut) -> Result<Option<Frame>, IOError> {
if src.len() < 2 {
return Ok(None);
}
let leading_bits = src[0] >> 4;
if self.check_rsv && !(leading_bits == 0b00001000 || leading_bits == 0b00000000) {
return Err(IOError::new(
InvalidData,
ProtocolError::InvalidLeadingBits(leading_bits),
));
}
parse_opcode(src[0])
.map_err(|e| IOError::new(InvalidData, ProtocolError::InvalidOpcode(e)))?;
let (payload_len, len_occ_bytes) =
parse_payload_len(src.deref()).map_err(|e| IOError::new(InvalidData, e))?;
let mut expected_len = 1 + len_occ_bytes + payload_len;
let mask = get_bit(&src, 1, 0);
if mask {
expected_len += 4;
}
if expected_len > src.len() {
src.reserve(expected_len - src.len() + 1);
Ok(None)
} else {
let mut data = BytesMut::with_capacity(expected_len);
data.extend_from_slice(&src[..expected_len]);
src.advance(expected_len);
Ok(Some(Frame(data)))
}
}
}
impl Decoder for FrameDecoder {
type Item = Frame;
type Error = IOError;
fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
let maybe_frame = self.decode_single(src)?;
if let Some(frame) = maybe_frame {
let opcode = frame.opcode();
match opcode {
OpCode::Continue => {
if !self.fragmented {
let reason = ProtocolError::MissInitialFragmentedFrame;
return Err(IOError::new(InvalidData, reason));
}
self.fragmented_data
.extend_from_slice(&frame.payload_data_unmask());
if frame.fin() {
if String::from_utf8(self.fragmented_data.to_vec()).is_err() {
let reason = ProtocolError::InvalidUtf8;
return Err(IOError::new(InvalidData, reason));
}
let completed_frame = Frame::new_with_payload(
self.fragmented_type.clone(),
&self.fragmented_data,
);
return Ok(Some(completed_frame));
} else {
Ok(None)
}
}
OpCode::Text | OpCode::Binary => {
if self.fragmented {
let reason = ProtocolError::NotContinueFrameAfterFragmented;
return Err(IOError::new(InvalidData, reason));
}
if !frame.fin() {
self.fragmented = true;
self.fragmented_type = opcode.clone();
let payload = frame.payload_data_unmask();
self.fragmented_data.extend_from_slice(&payload);
Ok(None)
} else {
if opcode == OpCode::Text
&& String::from_utf8(frame.payload_data_unmask().to_vec()).is_err()
{
let reason = ProtocolError::InvalidUtf8;
return Err(IOError::new(InvalidData, reason));
}
return Ok(Some(frame));
}
}
OpCode::Close | OpCode::Ping | OpCode::Pong => {
if !frame.fin() {
let reason = ProtocolError::FragmentedControlFrame;
return Err(IOError::new(InvalidData, reason));
}
let payload_len = frame.payload_len();
if payload_len > 125 {
let reason = ProtocolError::ControlFrameTooBig(payload_len as usize);
return Err(IOError::new(InvalidData, reason));
}
if opcode == OpCode::Close {
if payload_len == 1 {
let reason = ProtocolError::InvalidCloseFramePayload;
return Err(IOError::new(InvalidData, reason));
}
if payload_len >= 2 {
let payload = frame.payload_data_unmask();
log::debug!("{:?}", payload);
let mut code_byte = [0u8; 2];
code_byte.copy_from_slice(&payload[..2]);
let code = u16::from_be_bytes(code_byte);
if code < 1000
|| (1004..=1006).contains(&code)
|| (1015..=2999).contains(&code)
|| code >= 5000
{
let reason = ProtocolError::InvalidCloseCode(code);
return Err(IOError::new(InvalidData, reason));
}
if String::from_utf8(payload[2..].to_vec()).is_err() {
let reason = ProtocolError::InvalidUtf8;
return Err(IOError::new(InvalidData, reason));
}
}
}
if opcode == OpCode::Close || !self.fragmented {
return Ok(Some(frame));
} else {
log::debug!("{:?} frame between self.fragmented data", opcode);
return Ok(Some(frame));
}
}
OpCode::ReservedNonControl | OpCode::ReservedControl => {
return Err(IOError::new(
InvalidData,
format!("unsupported frame {:?}", opcode),
));
}
}
} else {
Ok(None)
}
}
}
#[derive(Debug, Clone)]
pub struct FrameCodec {
pub encoder: FrameEncoder,
pub decoder: FrameDecoder,
}
impl Default for FrameCodec {
fn default() -> Self {
Self {
encoder: Default::default(),
decoder: Default::default(),
}
}
}
impl Encoder<Frame> for FrameCodec {
type Error = IOError;
fn encode(&mut self, item: Frame, dst: &mut BytesMut) -> Result<(), Self::Error> {
self.encoder.encode(item, dst)
}
}
impl Decoder for FrameCodec {
type Item = Frame;
type Error = IOError;
fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
self.decoder.decode(src)
}
}