Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the value of the upgrade header the same as the RFC. #187

Merged
merged 3 commits into from
Dec 23, 2023
Merged

Make the value of the upgrade header the same as the RFC. #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4abc452
Make the value of the upgrade header the same as the RFC.
Dec 11, 2023
a5ee036
move the upgrade header value into a constant
palkeo Dec 17, 2023
9cbbde8
formatting
palkeo Dec 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions src/wsproto/handshake.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
# RFC6455, Section 4.2.1/6 - Reading the Client's Opening Handshake
WEBSOCKET_VERSION = b"13"

# RFC6455, Section 4.2.1/3 - Value of the Upgrade header
WEBSOCKET_UPGRADE = b"websocket"


class H11Handshake:
"""A Handshake implementation for HTTP/1.1 connections."""
Expand Down Expand Up @@ -233,9 +236,10 @@ def _process_connection_request( # noqa: MC0001
raise RemoteProtocolError(
"Missing header, 'Sec-WebSocket-Key'", event_hint=RejectConnection()
)
if upgrade.lower() != b"websocket":
if upgrade.lower() != WEBSOCKET_UPGRADE:
raise RemoteProtocolError(
"Missing header, 'Upgrade: WebSocket'", event_hint=RejectConnection()
f"Missing header, 'Upgrade: {WEBSOCKET_UPGRADE.decode()}'",
event_hint=RejectConnection(),
)
if host is None:
raise RemoteProtocolError(
Expand All @@ -260,7 +264,7 @@ def _accept(self, event: AcceptConnection) -> bytes:
accept_token = generate_accept_token(nonce)

headers = [
(b"Upgrade", b"WebSocket"),
(b"Upgrade", WEBSOCKET_UPGRADE),
(b"Connection", b"Upgrade"),
(b"Sec-WebSocket-Accept", accept_token),
]
Expand Down Expand Up @@ -327,7 +331,7 @@ def _initiate_connection(self, request: Request) -> bytes:

headers = [
(b"Host", request.host.encode("idna")),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", WEBSOCKET_UPGRADE),
(b"Connection", b"Upgrade"),
(b"Sec-WebSocket-Key", self._nonce),
(b"Sec-WebSocket-Version", WEBSOCKET_VERSION),
Expand Down Expand Up @@ -402,9 +406,10 @@ def _establish_client_connection(
raise RemoteProtocolError(
"Missing header, 'Connection: Upgrade'", event_hint=RejectConnection()
)
if upgrade.lower() != b"websocket":
if upgrade.lower() != WEBSOCKET_UPGRADE:
raise RemoteProtocolError(
"Missing header, 'Upgrade: WebSocket'", event_hint=RejectConnection()
f"Missing header, 'Upgrade: {WEBSOCKET_UPGRADE.decode()}'",
event_hint=RejectConnection(),
)
accept_token = generate_accept_token(self._nonce)
if accept != accept_token:
Expand Down
24 changes: 12 additions & 12 deletions test/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def test_connection_request() -> None:
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 headers[b"upgrade"] == b"websocket"
assert b"sec-websocket-key" in headers


Expand Down Expand Up @@ -119,7 +119,7 @@ def test_connection_send_state() -> None:
status_code=101,
headers=[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"upgrade", b"websocket"),
(
b"Sec-WebSocket-Accept",
generate_accept_token(headers[b"sec-websocket-key"]),
Expand Down Expand Up @@ -178,14 +178,14 @@ def _make_handshake(

def test_handshake() -> None:
events = _make_handshake(
101, [(b"connection", b"Upgrade"), (b"upgrade", b"WebSocket")]
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")]
102, [(b"connection", b"Upgrade"), (b"upgrade", b"websocket")]
)
assert isinstance(events[0], RejectConnection)
assert events[0].status_code == 102
Expand All @@ -194,30 +194,30 @@ def test_broken_handshake() -> None:
def test_handshake_extra_accept_headers() -> None:
events = _make_handshake(
101,
[(b"connection", b"Upgrade"), (b"upgrade", b"WebSocket"), (b"X-Foo", b"bar")],
[(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)
_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'"
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")],
[(b"connection", b"Upgrade"), (b"upgrade", b"websocket")],
auto_accept_key=False,
)
assert str(excinfo.value) == "Bad accept token"
Expand All @@ -228,7 +228,7 @@ def test_handshake_with_subprotocol() -> None:
101,
[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"upgrade", b"websocket"),
(b"sec-websocket-protocol", b"one"),
],
subprotocols=["one", "two"],
Expand All @@ -242,7 +242,7 @@ def test_handshake_bad_subprotocol() -> None:
101,
[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"upgrade", b"websocket"),
(b"sec-websocket-protocol", b"new"),
],
)
Expand All @@ -255,7 +255,7 @@ def test_handshake_with_extension() -> None:
101,
[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"upgrade", b"websocket"),
(b"sec-websocket-extensions", b"fake"),
],
extensions=[extension],
Expand All @@ -269,7 +269,7 @@ def test_handshake_bad_extension() -> None:
101,
[
(b"connection", b"Upgrade"),
(b"upgrade", b"WebSocket"),
(b"upgrade", b"websocket"),
(b"sec-websocket-extensions", b"bad, foo"),
],
)
Expand Down
2 changes: 1 addition & 1 deletion test/test_handshake.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def test_rejected_handshake(http: bytes) -> None:
with pytest.raises(RemoteProtocolError):
server.receive_data(
b"GET / " + http + b"\r\n"
b"Upgrade: WebSocket\r\n"
b"Upgrade: websocket\r\n"
b"Connection: Upgrade\r\n"
b"Sec-WebSocket-Key: VQr8cvwwZ1fEk62PDq8J3A==\r\n"
b"Sec-WebSocket-Version: 13\r\n"
Expand Down
26 changes: 13 additions & 13 deletions test/test_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def test_connection_request() -> None:
[
(b"Host", b"localhost"),
(b"Connection", b"Keep-Alive, Upgrade"),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", b"websocket"),
(b"Sec-WebSocket-Version", b"13"),
(b"Sec-WebSocket-Key", generate_nonce()),
(b"X-Foo", b"bar"),
Expand All @@ -50,7 +50,7 @@ def test_connection_request() -> None:
assert b"sec-websocket-protocol" not in headers
assert headers[b"connection"] == b"Keep-Alive, Upgrade"
assert headers[b"sec-websocket-version"] == b"13"
assert headers[b"upgrade"] == b"WebSocket"
assert headers[b"upgrade"] == b"websocket"
assert headers[b"x-foo"] == b"bar"


Expand All @@ -60,7 +60,7 @@ def test_connection_request_bad_method() -> None:
[
(b"Host", b"localhost"),
(b"Connection", b"Keep-Alive, Upgrade"),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", b"websocket"),
(b"Sec-WebSocket-Version", b"13"),
(b"Sec-WebSocket-Key", generate_nonce()),
],
Expand All @@ -75,7 +75,7 @@ def test_connection_request_bad_connection_header() -> None:
[
(b"Host", b"localhost"),
(b"Connection", b"Keep-Alive, No-Upgrade"),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", b"websocket"),
(b"Sec-WebSocket-Version", b"13"),
(b"Sec-WebSocket-Key", generate_nonce()),
]
Expand All @@ -94,7 +94,7 @@ def test_connection_request_bad_upgrade_header() -> None:
(b"Sec-WebSocket-Key", generate_nonce()),
]
)
assert str(excinfo.value) == "Missing header, 'Upgrade: WebSocket'"
assert str(excinfo.value) == "Missing header, 'Upgrade: websocket'"


@pytest.mark.parametrize("version", [b"12", b"not-a-digit"])
Expand All @@ -104,7 +104,7 @@ def test_connection_request_bad_version_header(version: bytes) -> None:
[
(b"Host", b"localhost"),
(b"Connection", b"Keep-Alive, Upgrade"),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", b"websocket"),
(b"Sec-WebSocket-Version", version),
(b"Sec-WebSocket-Key", generate_nonce()),
]
Expand All @@ -121,7 +121,7 @@ def test_connection_request_key_header() -> None:
[
(b"Host", b"localhost"),
(b"Connection", b"Keep-Alive, Upgrade"),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", b"websocket"),
(b"Sec-WebSocket-Version", b"13"),
]
)
Expand All @@ -134,7 +134,7 @@ def test_upgrade_request() -> None:
[
(b"Host", b"localhost"),
(b"Connection", b"Keep-Alive, Upgrade"),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", b"websocket"),
(b"Sec-WebSocket-Version", b"13"),
(b"Sec-WebSocket-Key", generate_nonce()),
(b"X-Foo", b"bar"),
Expand All @@ -154,7 +154,7 @@ def test_upgrade_request() -> None:
assert b"sec-websocket-protocol" not in headers
assert headers[b"connection"] == b"Keep-Alive, Upgrade"
assert headers[b"sec-websocket-version"] == b"13"
assert headers[b"upgrade"] == b"WebSocket"
assert headers[b"upgrade"] == b"websocket"
assert headers[b"x-foo"] == b"bar"


Expand All @@ -175,7 +175,7 @@ def _make_handshake(
headers=[
(b"Host", b"localhost"),
(b"Connection", b"Keep-Alive, Upgrade"),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", b"websocket"),
(b"Sec-WebSocket-Version", b"13"),
(b"Sec-WebSocket-Key", nonce),
]
Expand Down Expand Up @@ -203,7 +203,7 @@ def test_handshake() -> None:
assert sorted(response.headers) == [
(b"connection", b"Upgrade"),
(b"sec-websocket-accept", generate_accept_token(nonce)),
(b"upgrade", b"WebSocket"),
(b"upgrade", b"websocket"),
]


Expand All @@ -214,7 +214,7 @@ def test_handshake_extra_headers() -> None:
assert sorted(response.headers) == [
(b"connection", b"Upgrade"),
(b"sec-websocket-accept", generate_accept_token(nonce)),
(b"upgrade", b"WebSocket"),
(b"upgrade", b"websocket"),
(b"x-foo", b"bar"),
]

Expand Down Expand Up @@ -298,7 +298,7 @@ def _make_handshake_rejection(
headers=[
(b"Host", b"localhost"),
(b"Connection", b"Keep-Alive, Upgrade"),
(b"Upgrade", b"WebSocket"),
(b"Upgrade", b"websocket"),
(b"Sec-WebSocket-Version", b"13"),
(b"Sec-WebSocket-Key", nonce),
],
Expand Down
Loading