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
|
import pickle
import random
import struct
import zlib
from unittest import mock
import pytest
import aiohttp
from aiohttp import http_websocket
from aiohttp.http import WebSocketError, WSCloseCode, WSMessage, WSMsgType
from aiohttp.http_websocket import (
_WS_DEFLATE_TRAILING,
PACK_CLOSE_CODE,
PACK_LEN1,
PACK_LEN2,
PACK_LEN3,
WebSocketReader,
_websocket_mask,
)
def build_frame(
message, opcode, use_mask=False, noheader=False, is_fin=True, compress=False
):
# Send a frame over the websocket with message as its payload.
if compress:
compressobj = zlib.compressobj(wbits=-9)
message = compressobj.compress(message)
message = message + compressobj.flush(zlib.Z_SYNC_FLUSH)
if message.endswith(_WS_DEFLATE_TRAILING):
message = message[:-4]
msg_length = len(message)
if use_mask: # pragma: no cover
mask_bit = 0x80
else:
mask_bit = 0
if is_fin:
header_first_byte = 0x80 | opcode
else:
header_first_byte = opcode
if compress:
header_first_byte |= 0x40
if msg_length < 126:
header = PACK_LEN1(header_first_byte, msg_length | mask_bit)
elif msg_length < (1 << 16): # pragma: no cover
header = PACK_LEN2(header_first_byte, 126 | mask_bit, msg_length)
else:
header = PACK_LEN3(header_first_byte, 127 | mask_bit, msg_length)
if use_mask: # pragma: no cover
mask = random.randrange(0, 0xFFFFFFFF)
mask = mask.to_bytes(4, "big")
message = bytearray(message)
_websocket_mask(mask, message)
if noheader:
return message
else:
return header + mask + message
else:
if noheader:
return message
else:
return header + message
def build_close_frame(code=1000, message=b"", noheader=False):
# Close the websocket, sending the specified code and message.
if isinstance(message, str): # pragma: no cover
message = message.encode("utf-8")
return build_frame(
PACK_CLOSE_CODE(code) + message, opcode=WSMsgType.CLOSE, noheader=noheader
)
@pytest.fixture()
def out(loop):
return aiohttp.DataQueue(loop)
@pytest.fixture()
def parser(out):
return WebSocketReader(out, 4 * 1024 * 1024)
def test_parse_frame(parser) -> None:
parser.parse_frame(struct.pack("!BB", 0b00000001, 0b00000001))
res = parser.parse_frame(b"1")
fin, opcode, payload, compress = res[0]
assert (0, 1, b"1", False) == (fin, opcode, payload, not not compress)
def test_parse_frame_length0(parser) -> None:
fin, opcode, payload, compress = parser.parse_frame(
struct.pack("!BB", 0b00000001, 0b00000000)
)[0]
assert (0, 1, b"", False) == (fin, opcode, payload, not not compress)
def test_parse_frame_length2(parser) -> None:
parser.parse_frame(struct.pack("!BB", 0b00000001, 126))
parser.parse_frame(struct.pack("!H", 4))
res = parser.parse_frame(b"1234")
fin, opcode, payload, compress = res[0]
assert (0, 1, b"1234", False) == (fin, opcode, payload, not not compress)
def test_parse_frame_length4(parser) -> None:
parser.parse_frame(struct.pack("!BB", 0b00000001, 127))
parser.parse_frame(struct.pack("!Q", 4))
fin, opcode, payload, compress = parser.parse_frame(b"1234")[0]
assert (0, 1, b"1234", False) == (fin, opcode, payload, not not compress)
def test_parse_frame_mask(parser) -> None:
parser.parse_frame(struct.pack("!BB", 0b00000001, 0b10000001))
parser.parse_frame(b"0001")
fin, opcode, payload, compress = parser.parse_frame(b"1")[0]
assert (0, 1, b"\x01", False) == (fin, opcode, payload, not not compress)
def test_parse_frame_header_reversed_bits(out, parser) -> None:
with pytest.raises(WebSocketError):
parser.parse_frame(struct.pack("!BB", 0b01100000, 0b00000000))
raise out.exception()
def test_parse_frame_header_control_frame(out, parser) -> None:
with pytest.raises(WebSocketError):
parser.parse_frame(struct.pack("!BB", 0b00001000, 0b00000000))
raise out.exception()
def _test_parse_frame_header_new_data_err(out, parser):
with pytest.raises(WebSocketError):
parser.parse_frame(struct.pack("!BB", 0b000000000, 0b00000000))
raise out.exception()
def test_parse_frame_header_payload_size(out, parser) -> None:
with pytest.raises(WebSocketError):
parser.parse_frame(struct.pack("!BB", 0b10001000, 0b01111110))
raise out.exception()
def test_ping_frame(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [(1, WSMsgType.PING, b"data", False)]
parser.feed_data(b"")
res = out._buffer[0]
assert res == ((WSMsgType.PING, b"data", ""), 4)
def test_pong_frame(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [(1, WSMsgType.PONG, b"data", False)]
parser.feed_data(b"")
res = out._buffer[0]
assert res == ((WSMsgType.PONG, b"data", ""), 4)
def test_close_frame(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [(1, WSMsgType.CLOSE, b"", False)]
parser.feed_data(b"")
res = out._buffer[0]
assert res == ((WSMsgType.CLOSE, 0, ""), 0)
def test_close_frame_info(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [(1, WSMsgType.CLOSE, b"0112345", False)]
parser.feed_data(b"")
res = out._buffer[0]
assert res == (WSMessage(WSMsgType.CLOSE, 12337, "12345"), 0)
def test_close_frame_invalid(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [(1, WSMsgType.CLOSE, b"1", False)]
parser.feed_data(b"")
assert isinstance(out.exception(), WebSocketError)
assert out.exception().code == WSCloseCode.PROTOCOL_ERROR
def test_close_frame_invalid_2(out, parser) -> None:
data = build_close_frame(code=1)
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(data)
assert ctx.value.code == WSCloseCode.PROTOCOL_ERROR
def test_close_frame_unicode_err(parser) -> None:
data = build_close_frame(code=1000, message=b"\xf4\x90\x80\x80")
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(data)
assert ctx.value.code == WSCloseCode.INVALID_TEXT
def test_unknown_frame(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [(1, WSMsgType.CONTINUATION, b"", False)]
with pytest.raises(WebSocketError):
parser.feed_data(b"")
raise out.exception()
def test_simple_text(out, parser) -> None:
data = build_frame(b"text", WSMsgType.TEXT)
parser._feed_data(data)
res = out._buffer[0]
assert res == ((WSMsgType.TEXT, "text", ""), 4)
def test_simple_text_unicode_err(parser) -> None:
data = build_frame(b"\xf4\x90\x80\x80", WSMsgType.TEXT)
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(data)
assert ctx.value.code == WSCloseCode.INVALID_TEXT
def test_simple_binary(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [(1, WSMsgType.BINARY, b"binary", False)]
parser.feed_data(b"")
res = out._buffer[0]
assert res == ((WSMsgType.BINARY, b"binary", ""), 6)
def test_fragmentation_header(out, parser) -> None:
data = build_frame(b"a", WSMsgType.TEXT)
parser._feed_data(data[:1])
parser._feed_data(data[1:])
res = out._buffer[0]
assert res == (WSMessage(WSMsgType.TEXT, "a", ""), 1)
def test_continuation(out, parser) -> None:
data1 = build_frame(b"line1", WSMsgType.TEXT, is_fin=False)
parser._feed_data(data1)
data2 = build_frame(b"line2", WSMsgType.CONTINUATION)
parser._feed_data(data2)
res = out._buffer[0]
assert res == (WSMessage(WSMsgType.TEXT, "line1line2", ""), 10)
def test_continuation_with_ping(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [
(0, WSMsgType.TEXT, b"line1", False),
(0, WSMsgType.PING, b"", False),
(1, WSMsgType.CONTINUATION, b"line2", False),
]
data1 = build_frame(b"line1", WSMsgType.TEXT, is_fin=False)
parser._feed_data(data1)
data2 = build_frame(b"", WSMsgType.PING)
parser._feed_data(data2)
data3 = build_frame(b"line2", WSMsgType.CONTINUATION)
parser._feed_data(data3)
res = out._buffer[0]
assert res == (WSMessage(WSMsgType.PING, b"", ""), 0)
res = out._buffer[1]
assert res == (WSMessage(WSMsgType.TEXT, "line1line2", ""), 10)
def test_continuation_err(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [
(0, WSMsgType.TEXT, b"line1", False),
(1, WSMsgType.TEXT, b"line2", False),
]
with pytest.raises(WebSocketError):
parser._feed_data(b"")
def test_continuation_with_close(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [
(0, WSMsgType.TEXT, b"line1", False),
(0, WSMsgType.CLOSE, build_close_frame(1002, b"test", noheader=True), False),
(1, WSMsgType.CONTINUATION, b"line2", False),
]
parser.feed_data(b"")
res = out._buffer[0]
assert res, (WSMessage(WSMsgType.CLOSE, 1002, "test"), 0)
res = out._buffer[1]
assert res == (WSMessage(WSMsgType.TEXT, "line1line2", ""), 10)
def test_continuation_with_close_unicode_err(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [
(0, WSMsgType.TEXT, b"line1", False),
(
0,
WSMsgType.CLOSE,
build_close_frame(1000, b"\xf4\x90\x80\x80", noheader=True),
False,
),
(1, WSMsgType.CONTINUATION, b"line2", False),
]
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(b"")
assert ctx.value.code == WSCloseCode.INVALID_TEXT
def test_continuation_with_close_bad_code(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [
(0, WSMsgType.TEXT, b"line1", False),
(0, WSMsgType.CLOSE, build_close_frame(1, b"test", noheader=True), False),
(1, WSMsgType.CONTINUATION, b"line2", False),
]
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(b"")
assert ctx.value.code == WSCloseCode.PROTOCOL_ERROR
def test_continuation_with_close_bad_payload(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [
(0, WSMsgType.TEXT, b"line1", False),
(0, WSMsgType.CLOSE, b"1", False),
(1, WSMsgType.CONTINUATION, b"line2", False),
]
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(b"")
assert ctx.value.code, WSCloseCode.PROTOCOL_ERROR
def test_continuation_with_close_empty(out, parser) -> None:
parser.parse_frame = mock.Mock()
parser.parse_frame.return_value = [
(0, WSMsgType.TEXT, b"line1", False),
(0, WSMsgType.CLOSE, b"", False),
(1, WSMsgType.CONTINUATION, b"line2", False),
]
parser.feed_data(b"")
res = out._buffer[0]
assert res, (WSMessage(WSMsgType.CLOSE, 0, ""), 0)
res = out._buffer[1]
assert res == (WSMessage(WSMsgType.TEXT, "line1line2", ""), 10)
websocket_mask_data = b"some very long data for masking by websocket"
websocket_mask_mask = b"1234"
websocket_mask_masked = (
b"B]^Q\x11DVFH\x12_[_U\x13PPFR\x14W]A\x14\\S@_X" b"\\T\x14SK\x13CTP@[RYV@"
)
def test_websocket_mask_python() -> None:
message = bytearray(websocket_mask_data)
http_websocket._websocket_mask_python(websocket_mask_mask, message)
assert message == websocket_mask_masked
@pytest.mark.skipif(
not hasattr(http_websocket, "_websocket_mask_cython"), reason="Requires Cython"
)
def test_websocket_mask_cython() -> None:
message = bytearray(websocket_mask_data)
http_websocket._websocket_mask_cython(websocket_mask_mask, message)
assert message == websocket_mask_masked
def test_websocket_mask_python_empty() -> None:
message = bytearray()
http_websocket._websocket_mask_python(websocket_mask_mask, message)
assert message == bytearray()
@pytest.mark.skipif(
not hasattr(http_websocket, "_websocket_mask_cython"), reason="Requires Cython"
)
def test_websocket_mask_cython_empty() -> None:
message = bytearray()
http_websocket._websocket_mask_cython(websocket_mask_mask, message)
assert message == bytearray()
def test_msgtype_aliases() -> None:
assert aiohttp.WSMsgType.TEXT == aiohttp.WSMsgType.text
assert aiohttp.WSMsgType.BINARY == aiohttp.WSMsgType.binary
assert aiohttp.WSMsgType.PING == aiohttp.WSMsgType.ping
assert aiohttp.WSMsgType.PONG == aiohttp.WSMsgType.pong
assert aiohttp.WSMsgType.CLOSE == aiohttp.WSMsgType.close
assert aiohttp.WSMsgType.CLOSED == aiohttp.WSMsgType.closed
assert aiohttp.WSMsgType.ERROR == aiohttp.WSMsgType.error
def test_parse_compress_frame_single(parser) -> None:
parser.parse_frame(struct.pack("!BB", 0b11000001, 0b00000001))
res = parser.parse_frame(b"1")
fin, opcode, payload, compress = res[0]
assert (1, 1, b"1", True) == (fin, opcode, payload, not not compress)
def test_parse_compress_frame_multi(parser) -> None:
parser.parse_frame(struct.pack("!BB", 0b01000001, 126))
parser.parse_frame(struct.pack("!H", 4))
res = parser.parse_frame(b"1234")
fin, opcode, payload, compress = res[0]
assert (0, 1, b"1234", True) == (fin, opcode, payload, not not compress)
parser.parse_frame(struct.pack("!BB", 0b10000001, 126))
parser.parse_frame(struct.pack("!H", 4))
res = parser.parse_frame(b"1234")
fin, opcode, payload, compress = res[0]
assert (1, 1, b"1234", True) == (fin, opcode, payload, not not compress)
parser.parse_frame(struct.pack("!BB", 0b10000001, 126))
parser.parse_frame(struct.pack("!H", 4))
res = parser.parse_frame(b"1234")
fin, opcode, payload, compress = res[0]
assert (1, 1, b"1234", False) == (fin, opcode, payload, not not compress)
def test_parse_compress_error_frame(parser) -> None:
parser.parse_frame(struct.pack("!BB", 0b01000001, 0b00000001))
parser.parse_frame(b"1")
with pytest.raises(WebSocketError) as ctx:
parser.parse_frame(struct.pack("!BB", 0b11000001, 0b00000001))
parser.parse_frame(b"1")
assert ctx.value.code == WSCloseCode.PROTOCOL_ERROR
def test_parse_no_compress_frame_single() -> None:
parser_no_compress = WebSocketReader(out, 0, compress=False)
with pytest.raises(WebSocketError) as ctx:
parser_no_compress.parse_frame(struct.pack("!BB", 0b11000001, 0b00000001))
parser_no_compress.parse_frame(b"1")
assert ctx.value.code == WSCloseCode.PROTOCOL_ERROR
def test_msg_too_large(out) -> None:
parser = WebSocketReader(out, 256, compress=False)
data = build_frame(b"text" * 256, WSMsgType.TEXT)
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(data)
assert ctx.value.code == WSCloseCode.MESSAGE_TOO_BIG
def test_msg_too_large_not_fin(out) -> None:
parser = WebSocketReader(out, 256, compress=False)
data = build_frame(b"text" * 256, WSMsgType.TEXT, is_fin=False)
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(data)
assert ctx.value.code == WSCloseCode.MESSAGE_TOO_BIG
def test_compressed_msg_too_large(out) -> None:
parser = WebSocketReader(out, 256, compress=True)
data = build_frame(b"aaa" * 256, WSMsgType.TEXT, compress=True)
with pytest.raises(WebSocketError) as ctx:
parser._feed_data(data)
assert ctx.value.code == WSCloseCode.MESSAGE_TOO_BIG
class TestWebSocketError:
def test_ctor(self) -> None:
err = WebSocketError(WSCloseCode.PROTOCOL_ERROR, "Something invalid")
assert err.code == WSCloseCode.PROTOCOL_ERROR
assert str(err) == "Something invalid"
def test_pickle(self) -> None:
err = WebSocketError(WSCloseCode.PROTOCOL_ERROR, "Something invalid")
err.foo = "bar"
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
pickled = pickle.dumps(err, proto)
err2 = pickle.loads(pickled)
assert err2.code == WSCloseCode.PROTOCOL_ERROR
assert str(err2) == "Something invalid"
assert err2.foo == "bar"
|