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
|
import zlib
from typing import cast, Optional, Sequence, TYPE_CHECKING
import pytest
from wsproto import extensions as wpext, frame_protocol as fp
if TYPE_CHECKING:
from mypy_extensions import TypedDict
class Params(TypedDict, total=False):
client_no_context_takeover: bool
client_max_window_bits: Optional[int]
server_no_context_takeover: bool
server_max_window_bits: Optional[int]
else:
Params = dict
class TestPerMessageDeflate:
parameter_sets: Sequence[Params] = [
{
"client_no_context_takeover": False,
"client_max_window_bits": 15,
"server_no_context_takeover": False,
"server_max_window_bits": 15,
},
{
"client_no_context_takeover": True,
"client_max_window_bits": 9,
"server_no_context_takeover": False,
"server_max_window_bits": 15,
},
{
"client_no_context_takeover": False,
"client_max_window_bits": 15,
"server_no_context_takeover": True,
"server_max_window_bits": 9,
},
{
"client_no_context_takeover": True,
"client_max_window_bits": 9,
"server_no_context_takeover": True,
"server_max_window_bits": 9,
},
{"client_no_context_takeover": True, "server_max_window_bits": 9},
{"server_no_context_takeover": True, "client_max_window_bits": 9},
{"client_max_window_bits": None, "server_max_window_bits": None},
{},
]
def make_offer_string(self, params: Params) -> str:
offer = ["permessage-deflate"]
if "client_max_window_bits" in params:
if params["client_max_window_bits"] is None:
offer.append("client_max_window_bits")
else:
offer.append(
"client_max_window_bits=%d" % params["client_max_window_bits"]
)
if "server_max_window_bits" in params:
if params["server_max_window_bits"] is None:
offer.append("server_max_window_bits")
else:
offer.append(
"server_max_window_bits=%d" % params["server_max_window_bits"]
)
if params.get("client_no_context_takeover", False):
offer.append("client_no_context_takeover")
if params.get("server_no_context_takeover", False):
offer.append("server_no_context_takeover")
return "; ".join(offer)
def compare_params_to_string(
self, params: Params, ext: wpext.PerMessageDeflate, param_string: str
) -> None:
if "client_max_window_bits" in params:
if params["client_max_window_bits"] is None:
bits = ext.client_max_window_bits
else:
bits = params["client_max_window_bits"]
assert "client_max_window_bits=%d" % bits in param_string
if "server_max_window_bits" in params:
if params["server_max_window_bits"] is None:
bits = ext.server_max_window_bits
else:
bits = params["server_max_window_bits"]
assert "server_max_window_bits=%d" % bits in param_string
if params.get("client_no_context_takeover", False):
assert "client_no_context_takeover" in param_string
if params.get("server_no_context_takeover", False):
assert "server_no_context_takeover" in param_string
@pytest.mark.parametrize("params", parameter_sets)
def test_offer(self, params: Params) -> None:
ext = wpext.PerMessageDeflate(**params)
offer = ext.offer()
offer = cast(str, offer)
self.compare_params_to_string(params, ext, offer)
@pytest.mark.parametrize("params", parameter_sets)
def test_finalize(self, params: Params) -> None:
ext = wpext.PerMessageDeflate()
assert not ext.enabled()
if "client_max_window_bits" in params:
if params["client_max_window_bits"] is None:
del params["client_max_window_bits"]
if "server_max_window_bits" in params:
if params["server_max_window_bits"] is None:
del params["server_max_window_bits"]
offer = self.make_offer_string(params)
ext.finalize(offer)
if params.get("client_max_window_bits", None):
assert ext.client_max_window_bits == params["client_max_window_bits"]
if params.get("server_max_window_bits", None):
assert ext.server_max_window_bits == params["server_max_window_bits"]
assert ext.client_no_context_takeover is params.get(
"client_no_context_takeover", False
)
assert ext.server_no_context_takeover is params.get(
"server_no_context_takeover", False
)
assert ext.enabled()
def test_finalize_ignores_rubbish(self) -> None:
ext = wpext.PerMessageDeflate()
assert not ext.enabled()
ext.finalize("i am the lizard queen; worship me")
assert ext.enabled()
@pytest.mark.parametrize("params", parameter_sets)
def test_accept(self, params: Params) -> None:
ext = wpext.PerMessageDeflate()
assert not ext.enabled()
offer = self.make_offer_string(params)
response = ext.accept(offer)
response = cast(str, response)
if ext.client_no_context_takeover:
assert "client_no_context_takeover" in response
if ext.server_no_context_takeover:
assert "server_no_context_takeover" in response
if "client_max_window_bits" in params:
if params["client_max_window_bits"] is None:
bits = ext.client_max_window_bits
else:
bits = params["client_max_window_bits"]
assert ext.client_max_window_bits == bits
assert "client_max_window_bits=%d" % bits in response
if "server_max_window_bits" in params:
if params["server_max_window_bits"] is None:
bits = ext.server_max_window_bits
else:
bits = params["server_max_window_bits"]
assert ext.server_max_window_bits == bits
assert "server_max_window_bits=%d" % bits in response
def test_accept_ignores_rubbish(self) -> None:
ext = wpext.PerMessageDeflate()
assert not ext.enabled()
ext.accept("i am the lizard queen; worship me")
assert ext.enabled()
def test_inbound_uncompressed_control_frame(self) -> None:
payload = b"x" * 23
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=True, extensions=[ext])
result = ext.frame_inbound_header(
proto, fp.Opcode.PING, fp.RsvBits(False, False, False), len(payload)
)
assert isinstance(result, fp.RsvBits)
assert result.rsv1
data = ext.frame_inbound_payload_data(proto, payload)
assert data == payload
assert ext.frame_inbound_complete(proto, True) is None
def test_inbound_compressed_control_frame(self) -> None:
payload = b"x" * 23
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=True, extensions=[ext])
result = ext.frame_inbound_header(
proto, fp.Opcode.PING, fp.RsvBits(True, False, False), len(payload)
)
assert result == fp.CloseReason.PROTOCOL_ERROR
def test_inbound_compressed_continuation_frame(self) -> None:
payload = b"x" * 23
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=True, extensions=[ext])
result = ext.frame_inbound_header(
proto, fp.Opcode.CONTINUATION, fp.RsvBits(True, False, False), len(payload)
)
assert result == fp.CloseReason.PROTOCOL_ERROR
def test_inbound_uncompressed_data_frame(self) -> None:
payload = b"x" * 23
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=True, extensions=[ext])
result = ext.frame_inbound_header(
proto, fp.Opcode.BINARY, fp.RsvBits(False, False, False), len(payload)
)
assert isinstance(result, fp.RsvBits)
assert result.rsv1
data = ext.frame_inbound_payload_data(proto, payload)
assert data == payload
assert ext.frame_inbound_complete(proto, True) is None
@pytest.mark.parametrize("client", [True, False])
def test_client_inbound_compressed_single_data_frame(self, client: bool) -> None:
payload = b"x" * 23
compressed_payload = b"\xaa\xa8\xc0\n\x00\x00"
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=client, extensions=[ext])
result = ext.frame_inbound_header(
proto,
fp.Opcode.BINARY,
fp.RsvBits(True, False, False),
len(compressed_payload),
)
assert isinstance(result, fp.RsvBits)
assert result.rsv1
data = ext.frame_inbound_payload_data(proto, compressed_payload)
assert isinstance(data, bytes)
data2 = ext.frame_inbound_complete(proto, True)
assert isinstance(data2, bytes)
assert data + data2 == payload
@pytest.mark.parametrize("client", [True, False])
def test_client_inbound_compressed_multiple_data_frames(self, client: bool) -> None:
payload = b"x" * 23
compressed_payload = b"\xaa\xa8\xc0\n\x00\x00"
split = 3
data = b""
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=client, extensions=[ext])
result = ext.frame_inbound_header(
proto, fp.Opcode.BINARY, fp.RsvBits(True, False, False), split
)
assert isinstance(result, fp.RsvBits)
assert result.rsv1
result2 = ext.frame_inbound_payload_data(proto, compressed_payload[:split])
assert not isinstance(result2, fp.CloseReason)
data += result2
assert ext.frame_inbound_complete(proto, False) is None
result3 = ext.frame_inbound_header(
proto,
fp.Opcode.CONTINUATION,
fp.RsvBits(False, False, False),
len(compressed_payload) - split,
)
assert isinstance(result3, fp.RsvBits)
assert result3.rsv1
result4 = ext.frame_inbound_payload_data(proto, compressed_payload[split:])
assert not isinstance(result4, fp.CloseReason)
data += result4
result5 = ext.frame_inbound_complete(proto, True)
assert isinstance(result5, bytes)
data += result5
assert data == payload
@pytest.mark.parametrize("client", [True, False])
def test_client_decompress_after_uncompressible_frame(self, client: bool) -> None:
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=client, extensions=[ext])
# A PING frame
ext.frame_inbound_header(
proto, fp.Opcode.PING, fp.RsvBits(False, False, False), 0
)
result2 = ext.frame_inbound_payload_data(proto, b"")
assert not isinstance(result2, fp.CloseReason)
assert ext.frame_inbound_complete(proto, True) is None
# A compressed TEXT frame
payload = b"x" * 23
compressed_payload = b"\xaa\xa8\xc0\n\x00\x00"
result3 = ext.frame_inbound_header(
proto,
fp.Opcode.TEXT,
fp.RsvBits(True, False, False),
len(compressed_payload),
)
assert isinstance(result3, fp.RsvBits)
assert result3.rsv1
result4 = ext.frame_inbound_payload_data(proto, compressed_payload)
assert result4 == payload
result5 = ext.frame_inbound_complete(proto, True)
assert not isinstance(result5, fp.CloseReason)
def test_inbound_bad_zlib_payload(self) -> None:
compressed_payload = b"x" * 23
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=True, extensions=[ext])
result = ext.frame_inbound_header(
proto,
fp.Opcode.BINARY,
fp.RsvBits(True, False, False),
len(compressed_payload),
)
assert isinstance(result, fp.RsvBits)
assert result.rsv1
result2 = ext.frame_inbound_payload_data(proto, compressed_payload)
assert result2 is fp.CloseReason.INVALID_FRAME_PAYLOAD_DATA
def test_inbound_bad_zlib_decoder_end_state(self) -> None:
compressed_payload = b"x" * 23
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=True, extensions=[ext])
result = ext.frame_inbound_header(
proto,
fp.Opcode.BINARY,
fp.RsvBits(True, False, False),
len(compressed_payload),
)
assert isinstance(result, fp.RsvBits)
assert result.rsv1
class FailDecompressor:
def decompress(self, data: bytes) -> bytes:
return b""
def flush(self) -> None:
raise zlib.error()
ext._decompressor = cast("zlib._Decompress", FailDecompressor())
result2 = ext.frame_inbound_complete(proto, True)
assert result2 is fp.CloseReason.INVALID_FRAME_PAYLOAD_DATA
@pytest.mark.parametrize(
"client,no_context_takeover",
[(True, True), (True, False), (False, True), (False, False)],
)
def test_decompressor_reset(self, client: bool, no_context_takeover: bool) -> None:
if client:
args = {"server_no_context_takeover": no_context_takeover}
else:
args = {"client_no_context_takeover": no_context_takeover}
ext = wpext.PerMessageDeflate(**args)
ext._enabled = True
proto = fp.FrameProtocol(client=client, extensions=[ext])
result = ext.frame_inbound_header(
proto, fp.Opcode.BINARY, fp.RsvBits(True, False, False), 0
)
assert isinstance(result, fp.RsvBits)
assert result.rsv1
assert ext._decompressor is not None
result2 = ext.frame_inbound_complete(proto, True)
assert not isinstance(result2, fp.CloseReason)
if no_context_takeover:
assert ext._decompressor is None
else:
assert ext._decompressor is not None
result3 = ext.frame_inbound_header(
proto, fp.Opcode.BINARY, fp.RsvBits(True, False, False), 0
)
assert isinstance(result3, fp.RsvBits)
assert result3.rsv1
assert ext._decompressor is not None
def test_outbound_uncompressible_opcode(self) -> None:
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=True, extensions=[ext])
rsv = fp.RsvBits(False, False, False)
payload = b"x" * 23
rsv, data = ext.frame_outbound(proto, fp.Opcode.PING, rsv, payload, True)
assert rsv.rsv1 is False
assert data == payload
@pytest.mark.parametrize("client", [True, False])
def test_outbound_compress_single_frame(self, client: bool) -> None:
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=client, extensions=[ext])
rsv = fp.RsvBits(False, False, False)
payload = b"x" * 23
compressed_payload = b"\xaa\xa8\xc0\n\x00\x00"
rsv, data = ext.frame_outbound(proto, fp.Opcode.BINARY, rsv, payload, True)
assert rsv.rsv1 is True
assert data == compressed_payload
@pytest.mark.parametrize("client", [True, False])
def test_outbound_compress_multiple_frames(self, client: bool) -> None:
ext = wpext.PerMessageDeflate()
ext._enabled = True
proto = fp.FrameProtocol(client=client, extensions=[ext])
rsv = fp.RsvBits(False, False, False)
payload = b"x" * 23
split = 12
compressed_payload = b"\xaa\xa8\xc0\n\x00\x00"
rsv, data = ext.frame_outbound(
proto, fp.Opcode.BINARY, rsv, payload[:split], False
)
assert rsv.rsv1 is True
rsv = fp.RsvBits(False, False, False)
rsv, more_data = ext.frame_outbound(
proto, fp.Opcode.CONTINUATION, rsv, payload[split:], True
)
assert rsv.rsv1 is False
assert data + more_data == compressed_payload
@pytest.mark.parametrize(
"client,no_context_takeover",
[(True, True), (True, False), (False, True), (False, False)],
)
def test_compressor_reset(self, client: bool, no_context_takeover: bool) -> None:
if client:
args = {"client_no_context_takeover": no_context_takeover}
else:
args = {"server_no_context_takeover": no_context_takeover}
ext = wpext.PerMessageDeflate(**args)
ext._enabled = True
proto = fp.FrameProtocol(client=client, extensions=[ext])
rsv = fp.RsvBits(False, False, False)
rsv, data = ext.frame_outbound(proto, fp.Opcode.BINARY, rsv, b"", False)
assert rsv.rsv1 is True
assert ext._compressor is not None
rsv = fp.RsvBits(False, False, False)
rsv, data = ext.frame_outbound(proto, fp.Opcode.CONTINUATION, rsv, b"", True)
assert rsv.rsv1 is False
if no_context_takeover:
assert ext._compressor is None
else:
assert ext._compressor is not None
rsv = fp.RsvBits(False, False, False)
rsv, data = ext.frame_outbound(proto, fp.Opcode.BINARY, rsv, b"", False)
assert rsv.rsv1 is True
assert ext._compressor is not None
@pytest.mark.parametrize("params", parameter_sets)
def test_repr(self, params: Params) -> None:
ext = wpext.PerMessageDeflate(**params)
self.compare_params_to_string(params, ext, repr(ext))
|
