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
|
from typing import cast, List, Optional
import h11
import pytest
from wsproto import WSConnection
from wsproto.connection import CLIENT, ConnectionState
from wsproto.events import (
AcceptConnection,
Event,
RejectConnection,
RejectData,
Request,
)
from wsproto.extensions import Extension
from wsproto.typing import Headers
from wsproto.utilities import (
generate_accept_token,
LocalProtocolError,
normed_header_dict,
RemoteProtocolError,
)
from .helpers import FakeExtension
def _make_connection_request(request: Request) -> h11.Request:
client = WSConnection(CLIENT)
server = h11.Connection(h11.SERVER)
server.receive_data(client.send(request))
return cast(h11.Request, server.next_event())
def test_connection_request() -> None:
request = _make_connection_request(Request(host="localhost", target="/"))
assert request.http_version == b"1.1"
assert request.method == b"GET"
assert request.target == b"/"
headers = normed_header_dict(request.headers)
assert headers[b"connection"] == b"Upgrade"
assert headers[b"host"] == b"localhost"
assert headers[b"sec-websocket-version"] == b"13"
assert headers[b"upgrade"] == b"WebSocket"
assert b"sec-websocket-key" in headers
def test_connection_request_additional_headers() -> None:
request = _make_connection_request(
Request(
host="localhost",
target="/",
extra_headers=[(b"X-Foo", b"Bar"), (b"X-Bar", b"Foo")],
)
)
headers = normed_header_dict(request.headers)
assert headers[b"x-foo"] == b"Bar"
assert headers[b"x-bar"] == b"Foo"
def test_connection_request_simple_extension() -> None:
extension = FakeExtension(offer_response=True)
request = _make_connection_request(
Request(host="localhost", target="/", extensions=[extension])
)
headers = normed_header_dict(request.headers)
assert headers[b"sec-websocket-extensions"] == extension.name.encode("ascii")
def test_connection_request_simple_extension_no_offer() -> None:
extension = FakeExtension(offer_response=False)
request = _make_connection_request(
Request(host="localhost", target="/", extensions=[extension])
)
headers = normed_header_dict(request.headers)
assert b"sec-websocket-extensions" not in headers
def test_connection_request_parametrised_extension() -> None:
offer_response = "parameter1=value1; parameter2=value2"
extension = FakeExtension(offer_response=offer_response)
request = _make_connection_request(
Request(host="localhost", target="/", extensions=[extension])
)
headers = normed_header_dict(request.headers)
assert headers[b"sec-websocket-extensions"] == b"%s; %s" % (
extension.name.encode("ascii"),
offer_response.encode("ascii"),
)
def test_connection_request_subprotocols() -> None:
request = _make_connection_request(
Request(host="localhost", target="/", subprotocols=["one", "two"])
)
headers = normed_header_dict(request.headers)
assert headers[b"sec-websocket-protocol"] == b"one, two"
def test_connection_send_state() -> None:
client = WSConnection(CLIENT)
assert client.state is ConnectionState.CONNECTING
server = h11.Connection(h11.SERVER)
server.receive_data(
client.send(
Request(
host="localhost",
target="/",
)
)
)
headers = normed_header_dict(cast(h11.Request, server.next_event()).headers)
response = h11.InformationalResponse(
status_code=101,
headers=[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(
b"Sec-WebSocket-Accept",
generate_accept_token(headers[b"sec-websocket-key"]),
),
],
)
client.receive_data(server.send(response))
assert len(list(client.events())) == 1
assert client.state is ConnectionState.OPEN # type: ignore # https://github.com/python/mypy/issues/9005
with pytest.raises(LocalProtocolError):
client.send(Request(host="localhost", target="/"))
client.receive_data(b"foobar")
assert len(list(client.events())) == 1
def _make_handshake(
response_status: int,
response_headers: Headers,
subprotocols: Optional[List[str]] = None,
extensions: Optional[List[Extension]] = None,
auto_accept_key: bool = True,
) -> List[Event]:
client = WSConnection(CLIENT)
assert client.state is ConnectionState.CONNECTING
server = h11.Connection(h11.SERVER)
server.receive_data(
client.send(
Request(
host="localhost",
target="/",
subprotocols=subprotocols or [],
extensions=extensions or [],
)
)
)
request = cast(h11.Request, server.next_event())
if auto_accept_key:
full_request_headers = normed_header_dict(request.headers)
response_headers.append(
(
b"Sec-WebSocket-Accept",
generate_accept_token(full_request_headers[b"sec-websocket-key"]),
)
)
response = h11.InformationalResponse(
status_code=response_status, headers=response_headers
)
client.receive_data(server.send(response))
assert client.state is not ConnectionState.CONNECTING
return list(client.events())
def test_handshake() -> None:
events = _make_handshake(
101, [(b"connection", b"Upgrade"), (b"upgrade", b"WebSocket")]
)
assert events == [AcceptConnection()]
def test_broken_handshake() -> None:
events = _make_handshake(
102, [(b"connection", b"Upgrade"), (b"upgrade", b"WebSocket")]
)
assert isinstance(events[0], RejectConnection)
assert events[0].status_code == 102
def test_handshake_extra_accept_headers() -> None:
events = _make_handshake(
101,
[(b"connection", b"Upgrade"), (b"upgrade", b"WebSocket"), (b"X-Foo", b"bar")],
)
assert events == [AcceptConnection(extra_headers=[(b"x-foo", b"bar")])]
@pytest.mark.parametrize("extra_headers", [[], [(b"connection", b"Keep-Alive")]])
def test_handshake_response_broken_connection_header(extra_headers: Headers) -> None:
with pytest.raises(RemoteProtocolError) as excinfo:
_make_handshake(101, [(b"upgrade", b"WebSocket")] + extra_headers)
assert str(excinfo.value) == "Missing header, 'Connection: Upgrade'"
@pytest.mark.parametrize("extra_headers", [[], [(b"upgrade", b"h2")]])
def test_handshake_response_broken_upgrade_header(extra_headers: Headers) -> None:
with pytest.raises(RemoteProtocolError) as excinfo:
_make_handshake(101, [(b"connection", b"Upgrade")] + extra_headers)
assert str(excinfo.value) == "Missing header, 'Upgrade: WebSocket'"
def test_handshake_response_missing_websocket_key_header() -> None:
with pytest.raises(RemoteProtocolError) as excinfo:
_make_handshake(
101,
[(b"connection", b"Upgrade"), (b"upgrade", b"WebSocket")],
auto_accept_key=False,
)
assert str(excinfo.value) == "Bad accept token"
def test_handshake_with_subprotocol() -> None:
events = _make_handshake(
101,
[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"sec-websocket-protocol", b"one"),
],
subprotocols=["one", "two"],
)
assert events == [AcceptConnection(subprotocol="one")]
def test_handshake_bad_subprotocol() -> None:
with pytest.raises(RemoteProtocolError) as excinfo:
_make_handshake(
101,
[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"sec-websocket-protocol", b"new"),
],
)
assert str(excinfo.value) == "unrecognized subprotocol new"
def test_handshake_with_extension() -> None:
extension = FakeExtension(offer_response=True)
events = _make_handshake(
101,
[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"sec-websocket-extensions", b"fake"),
],
extensions=[extension],
)
assert events == [AcceptConnection(extensions=[extension])]
def test_handshake_bad_extension() -> None:
with pytest.raises(RemoteProtocolError) as excinfo:
_make_handshake(
101,
[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"sec-websocket-extensions", b"bad, foo"),
],
)
assert str(excinfo.value) == "unrecognized extension bad"
def test_protocol_error() -> None:
client = WSConnection(CLIENT)
client.send(Request(host="localhost", target="/"))
with pytest.raises(RemoteProtocolError) as excinfo:
client.receive_data(b"broken nonsense\r\n\r\n")
assert str(excinfo.value) == "Bad HTTP message"
def _make_handshake_rejection(
status_code: int, body: Optional[bytes] = None
) -> List[Event]:
client = WSConnection(CLIENT)
server = h11.Connection(h11.SERVER)
server.receive_data(client.send(Request(host="localhost", target="/")))
headers = []
if body is not None:
headers.append(("Content-Length", str(len(body))))
client.receive_data(
server.send(h11.Response(status_code=status_code, headers=headers))
)
if body is not None:
client.receive_data(server.send(h11.Data(data=body)))
client.receive_data(server.send(h11.EndOfMessage()))
return list(client.events())
def test_handshake_rejection() -> None:
events = _make_handshake_rejection(400)
assert events == [
RejectConnection(
headers=[(b"connection", b"close")], has_body=True, status_code=400
),
RejectData(body_finished=True, data=b""),
]
def test_handshake_rejection_with_body() -> None:
events = _make_handshake_rejection(400, b"Hello")
assert events == [
RejectConnection(
headers=[(b"content-length", b"5")], has_body=True, status_code=400
),
RejectData(body_finished=False, data=b"Hello"),
RejectData(body_finished=True, data=b""),
]
|