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
use std::default::Default;
use std::fmt;
use std::io::{ErrorKind, Read, Write};
use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};
use bytes::Buf;
use rand;
use circular_buffer::CircularBuffer;
use protocol::{CloseCode, OpCode};
use result::{Error, Kind, Result};
fn apply_mask(buf: &mut [u8], mask: &[u8; 4]) {
let iter = buf.iter_mut().zip(mask.iter().cycle());
for (byte, &key) in iter {
*byte ^= key
}
}
#[derive(Debug, Clone)]
pub struct Frame {
finished: bool,
rsv1: bool,
rsv2: bool,
rsv3: bool,
opcode: OpCode,
mask: Option<[u8; 4]>,
payload: Vec<u8>,
}
impl Frame {
#[inline]
pub fn len(&self) -> usize {
let mut header_length = 2;
let payload_len = self.payload().len();
if payload_len > 125 {
if payload_len <= u16::max_value() as usize {
header_length += 2;
} else {
header_length += 8;
}
}
if self.is_masked() {
header_length += 4;
}
header_length + payload_len
}
#[inline]
pub fn is_empty(&self) -> bool {
false
}
#[inline]
pub fn is_final(&self) -> bool {
self.finished
}
#[inline]
pub fn has_rsv1(&self) -> bool {
self.rsv1
}
#[inline]
pub fn has_rsv2(&self) -> bool {
self.rsv2
}
#[inline]
pub fn has_rsv3(&self) -> bool {
self.rsv3
}
#[inline]
pub fn opcode(&self) -> OpCode {
self.opcode
}
#[inline]
pub fn is_control(&self) -> bool {
self.opcode.is_control()
}
#[inline]
pub fn payload(&self) -> &Vec<u8> {
&self.payload
}
#[doc(hidden)]
#[inline]
pub fn is_masked(&self) -> bool {
self.mask.is_some()
}
#[doc(hidden)]
#[allow(dead_code)]
#[inline]
pub fn mask(&self) -> Option<&[u8; 4]> {
self.mask.as_ref()
}
#[allow(dead_code)]
#[inline]
pub fn set_final(&mut self, is_final: bool) -> &mut Frame {
self.finished = is_final;
self
}
#[inline]
pub fn set_rsv1(&mut self, has_rsv1: bool) -> &mut Frame {
self.rsv1 = has_rsv1;
self
}
#[inline]
pub fn set_rsv2(&mut self, has_rsv2: bool) -> &mut Frame {
self.rsv2 = has_rsv2;
self
}
#[inline]
pub fn set_rsv3(&mut self, has_rsv3: bool) -> &mut Frame {
self.rsv3 = has_rsv3;
self
}
#[allow(dead_code)]
#[inline]
pub fn set_opcode(&mut self, opcode: OpCode) -> &mut Frame {
self.opcode = opcode;
self
}
#[allow(dead_code)]
#[inline]
pub fn payload_mut(&mut self) -> &mut Vec<u8> {
&mut self.payload
}
#[doc(hidden)]
#[inline]
pub fn set_mask(&mut self) -> &mut Frame {
self.mask = Some(rand::random());
self
}
#[doc(hidden)]
#[inline]
pub fn remove_mask(&mut self) -> &mut Frame {
self.mask
.take()
.map(|mask| apply_mask(&mut self.payload, &mask));
self
}
pub fn into_data(self) -> Vec<u8> {
self.payload
}
#[inline]
pub fn message(data: Vec<u8>, code: OpCode, finished: bool) -> Frame {
debug_assert!(
match code {
OpCode::Text | OpCode::Binary | OpCode::Continue => true,
_ => false,
},
"Invalid opcode for data frame."
);
Frame {
finished,
opcode: code,
payload: data,
..Frame::default()
}
}
#[inline]
pub fn pong(data: Vec<u8>) -> Frame {
Frame {
opcode: OpCode::Pong,
payload: data,
..Frame::default()
}
}
#[inline]
pub fn ping(data: Vec<u8>) -> Frame {
Frame {
opcode: OpCode::Ping,
payload: data,
..Frame::default()
}
}
#[inline]
pub fn close(code: CloseCode, reason: &str) -> Frame {
let payload = if let CloseCode::Empty = code {
Vec::new()
} else {
let u: u16 = code.into();
let raw = [(u >> 8) as u8, u as u8];
[&raw, reason.as_bytes()].concat()
};
Frame {
payload,
..Frame::default()
}
}
pub fn parse(cursor: &mut CircularBuffer, max_payload_length: u64) -> Result<Option<Frame>> {
let size = cursor.remaining();
let initial = cursor.read_cursor();
trace!("Position in buffer {:?}", initial);
let mut head = [0u8; 2];
if cursor.read(&mut head)? != 2 {
cursor.set_read_cursor(initial);
return Ok(None);
}
trace!("Parsed headers {:?}", head);
let first = head[0];
let second = head[1];
trace!("First: {:b}", first);
trace!("Second: {:b}", second);
let finished = first & 0x80 != 0;
let rsv1 = first & 0x40 != 0;
let rsv2 = first & 0x20 != 0;
let rsv3 = first & 0x10 != 0;
let opcode = OpCode::from(first & 0x0F);
trace!("Opcode: {:?}", opcode);
let masked = second & 0x80 != 0;
trace!("Masked: {:?}", masked);
let mut header_length = 2;
let mut length = u64::from(second & 0x7F);
if let Some(length_nbytes) = match length {
126 => Some(2),
127 => Some(8),
_ => None,
} {
match cursor.read_uint::<BigEndian>(length_nbytes) {
Err(ref err) if err.kind() == ErrorKind::UnexpectedEof => {
cursor.set_read_cursor(initial);
return Ok(None);
}
Err(err) => {
return Err(Error::from(err));
}
Ok(read) => {
length = read;
}
};
header_length += length_nbytes as u64;
}
trace!("Payload length: {}", length);
if length > max_payload_length {
return Err(Error::new(
Kind::Protocol,
format!(
"Rejected frame with payload length exceeding defined max: {}.",
max_payload_length
),
));
}
let mask = if masked {
let mut mask_bytes = [0u8; 4];
if cursor.read(&mut mask_bytes)? != 4 {
cursor.set_read_cursor(initial);
return Ok(None);
} else {
header_length += 4;
Some(mask_bytes)
}
} else {
None
};
match length.checked_add(header_length) {
Some(l) if (size as u64) < l => {
cursor.set_read_cursor(initial);
return Ok(None);
}
Some(_) => (),
None => return Ok(None),
};
let data = cursor.read_exact_into_vec(length as usize);
if let OpCode::Bad = opcode {
return Err(Error::new(
Kind::Protocol,
format!("Encountered invalid opcode: {}", first & 0x0F),
));
}
match opcode {
OpCode::Ping | OpCode::Pong if length > 125 => {
return Err(Error::new(
Kind::Protocol,
format!(
"Rejected WebSocket handshake.Received control frame with length: {}.",
length
),
))
}
OpCode::Close if length > 125 => {
debug!("Received close frame with payload length exceeding 125. Morphing to protocol close frame.");
return Ok(Some(Frame::close(
CloseCode::Protocol,
"Received close frame with payload length exceeding 125.",
)));
}
_ => (),
}
let frame = Frame {
finished,
rsv1,
rsv2,
rsv3,
opcode,
mask,
payload: data,
};
Ok(Some(frame))
}
pub fn format<W>(&mut self, w: &mut W) -> Result<()>
where
W: Write,
{
let mut one = 0u8;
let code: u8 = self.opcode.into();
if self.is_final() {
one |= 0x80;
}
if self.has_rsv1() {
one |= 0x40;
}
if self.has_rsv2() {
one |= 0x20;
}
if self.has_rsv3() {
one |= 0x10;
}
one |= code;
let mut two = 0u8;
if self.is_masked() {
two |= 0x80;
}
match self.payload.len() {
len if len < 126 => {
two |= len as u8;
}
len if len <= 65535 => {
two |= 126;
}
_ => {
two |= 127;
}
}
w.write_all(&[one, two])?;
if let Some(length_bytes) = match self.payload.len() {
len if len < 126 => None,
len if len <= 65535 => Some(2),
_ => Some(8),
} {
w.write_uint::<BigEndian>(self.payload.len() as u64, length_bytes)?;
}
if self.is_masked() {
let mask = self.mask.take().unwrap();
apply_mask(&mut self.payload, &mask);
w.write_all(&mask)?;
}
w.write_all(&self.payload)?;
Ok(())
}
}
impl Default for Frame {
fn default() -> Frame {
Frame {
finished: true,
rsv1: false,
rsv2: false,
rsv3: false,
opcode: OpCode::Close,
mask: None,
payload: Vec::new(),
}
}
}
impl fmt::Display for Frame {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"
<FRAME>
final: {}
reserved: {} {} {}
opcode: {}
length: {}
payload length: {}
payload: 0x{}
",
self.finished,
self.rsv1,
self.rsv2,
self.rsv3,
self.opcode,
self.len(),
self.payload.len(),
self.payload
.iter()
.map(|byte| format!("{:x}", byte))
.collect::<String>()
)
}
}
mod test {
#![allow(unused_imports, unused_variables, dead_code)]
use super::*;
use protocol::OpCode;
#[test]
fn display_frame() {
let f = Frame::message("hi there".into(), OpCode::Text, true);
let view = format!("{}", f);
view.contains("payload:");
}
}