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
|
"""
Tests that exercise the HTTP Upgrade functionality of
hyper-h2, ensuring that clients and servers can upgrade their plaintext
HTTP/1.1 connections to HTTP/2.
"""
from __future__ import annotations
import base64
import pytest
import h2.config
import h2.connection
import h2.errors
import h2.events
import h2.exceptions
from h2.utilities import utf8_encode_headers
EXAMPLE_REQUEST_HEADERS = [
(":authority", "example.com"),
(":path", "/"),
(":scheme", "https"),
(":method", "GET"),
]
EXAMPLE_REQUEST_HEADERS_BYTES = [
(b":authority", b"example.com"),
(b":path", b"/"),
(b":scheme", b"https"),
(b":method", b"GET"),
]
class TestClientUpgrade:
"""
Tests of the client-side of the HTTP/2 upgrade dance.
"""
example_response_headers = [
(b":status", b"200"),
(b"server", b"fake-serv/0.1.0"),
]
def test_returns_http2_settings(self, frame_factory) -> None:
"""
Calling initiate_upgrade_connection returns a base64url encoded
Settings frame with the settings used by the connection.
"""
conn = h2.connection.H2Connection()
data = conn.initiate_upgrade_connection()
# The base64 encoding must not be padded.
assert not data.endswith(b"=")
# However, SETTINGS frames should never need to be padded.
decoded_frame = base64.urlsafe_b64decode(data)
expected_frame = frame_factory.build_settings_frame(
settings=conn.local_settings,
)
assert decoded_frame == expected_frame.serialize_body()
def test_emits_preamble(self, frame_factory) -> None:
"""
Calling initiate_upgrade_connection emits the connection preamble.
"""
conn = h2.connection.H2Connection()
conn.initiate_upgrade_connection()
data = conn.data_to_send()
assert data.startswith(frame_factory.preamble())
data = data[len(frame_factory.preamble()):]
expected_frame = frame_factory.build_settings_frame(
settings=conn.local_settings,
)
assert data == expected_frame.serialize()
def test_can_receive_response(self, frame_factory) -> None:
"""
After upgrading, we can safely receive a response.
"""
c = h2.connection.H2Connection()
c.initiate_upgrade_connection()
c.clear_outbound_data_buffer()
f1 = frame_factory.build_headers_frame(
stream_id=1,
headers=self.example_response_headers,
)
f2 = frame_factory.build_data_frame(
stream_id=1,
data=b"some data",
flags=["END_STREAM"],
)
events = c.receive_data(f1.serialize() + f2.serialize())
assert len(events) == 3
assert isinstance(events[0], h2.events.ResponseReceived)
assert isinstance(events[1], h2.events.DataReceived)
assert isinstance(events[2], h2.events.StreamEnded)
assert events[0].headers == self.example_response_headers
assert events[1].data == b"some data"
assert all(e.stream_id == 1 for e in events)
assert not c.data_to_send()
@pytest.mark.parametrize("headers", [EXAMPLE_REQUEST_HEADERS, EXAMPLE_REQUEST_HEADERS_BYTES])
def test_can_receive_pushed_stream(self, frame_factory, headers) -> None:
"""
After upgrading, we can safely receive a pushed stream.
"""
c = h2.connection.H2Connection()
c.initiate_upgrade_connection()
c.clear_outbound_data_buffer()
f = frame_factory.build_push_promise_frame(
stream_id=1,
promised_stream_id=2,
headers=headers,
)
events = c.receive_data(f.serialize())
assert len(events) == 1
assert isinstance(events[0], h2.events.PushedStreamReceived)
assert events[0].headers == utf8_encode_headers(headers)
assert events[0].parent_stream_id == 1
assert events[0].pushed_stream_id == 2
@pytest.mark.parametrize("headers", [EXAMPLE_REQUEST_HEADERS, EXAMPLE_REQUEST_HEADERS_BYTES])
def test_cannot_send_headers_stream_1(self, frame_factory, headers) -> None:
"""
After upgrading, we cannot send headers on stream 1.
"""
c = h2.connection.H2Connection()
c.initiate_upgrade_connection()
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.send_headers(stream_id=1, headers=headers)
def test_cannot_send_data_stream_1(self, frame_factory) -> None:
"""
After upgrading, we cannot send data on stream 1.
"""
c = h2.connection.H2Connection()
c.initiate_upgrade_connection()
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.send_data(stream_id=1, data=b"some data")
class TestServerUpgrade:
"""
Tests of the server-side of the HTTP/2 upgrade dance.
"""
example_response_headers = [
(b":status", b"200"),
(b"server", b"fake-serv/0.1.0"),
]
server_config = h2.config.H2Configuration(client_side=False)
def test_returns_nothing(self, frame_factory) -> None:
"""
Calling initiate_upgrade_connection returns nothing.
"""
conn = h2.connection.H2Connection(config=self.server_config)
curl_header = b"AAMAAABkAAQAAP__"
data = conn.initiate_upgrade_connection(curl_header)
assert data is None
def test_emits_preamble(self, frame_factory) -> None:
"""
Calling initiate_upgrade_connection emits the connection preamble.
"""
conn = h2.connection.H2Connection(config=self.server_config)
conn.initiate_upgrade_connection()
data = conn.data_to_send()
expected_frame = frame_factory.build_settings_frame(
settings=conn.local_settings,
)
assert data == expected_frame.serialize()
def test_can_send_response(self, frame_factory) -> None:
"""
After upgrading, we can safely send a response.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_upgrade_connection()
c.clear_outbound_data_buffer()
c.send_headers(stream_id=1, headers=self.example_response_headers)
c.send_data(stream_id=1, data=b"some data", end_stream=True)
f1 = frame_factory.build_headers_frame(
stream_id=1,
headers=self.example_response_headers,
)
f2 = frame_factory.build_data_frame(
stream_id=1,
data=b"some data",
flags=["END_STREAM"],
)
expected_data = f1.serialize() + f2.serialize()
assert c.data_to_send() == expected_data
@pytest.mark.parametrize("headers", [EXAMPLE_REQUEST_HEADERS, EXAMPLE_REQUEST_HEADERS_BYTES])
def test_can_push_stream(self, frame_factory, headers) -> None:
"""
After upgrading, we can safely push a stream.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_upgrade_connection()
c.clear_outbound_data_buffer()
c.push_stream(
stream_id=1,
promised_stream_id=2,
request_headers=headers,
)
f = frame_factory.build_push_promise_frame(
stream_id=1,
promised_stream_id=2,
headers=headers,
)
assert c.data_to_send() == f.serialize()
@pytest.mark.parametrize("headers", [EXAMPLE_REQUEST_HEADERS, EXAMPLE_REQUEST_HEADERS_BYTES])
def test_cannot_receive_headers_stream_1(self, frame_factory, headers) -> None:
"""
After upgrading, we cannot receive headers on stream 1.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_upgrade_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
f = frame_factory.build_headers_frame(
stream_id=1,
headers=headers,
)
c.receive_data(f.serialize())
expected_frame = frame_factory.build_rst_stream_frame(
stream_id=1,
error_code=h2.errors.ErrorCodes.STREAM_CLOSED,
)
assert c.data_to_send() == expected_frame.serialize()
def test_cannot_receive_data_stream_1(self, frame_factory) -> None:
"""
After upgrading, we cannot receive data on stream 1.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_upgrade_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
f = frame_factory.build_data_frame(
stream_id=1,
data=b"some data",
)
c.receive_data(f.serialize())
expected = frame_factory.build_rst_stream_frame(
stream_id=1,
error_code=h2.errors.ErrorCodes.STREAM_CLOSED,
).serialize()
assert c.data_to_send() == expected
def test_client_settings_are_applied(self, frame_factory) -> None:
"""
The settings provided by the client are applied and immediately
ACK'ed.
"""
server = h2.connection.H2Connection(config=self.server_config)
client = h2.connection.H2Connection()
# As a precaution, let's confirm that the server and client, at the
# start of the connection, do not agree on their initial settings
# state.
assert (
client.local_settings != server.remote_settings
)
# Get the client header data and pass it to the server.
header_data = client.initiate_upgrade_connection()
server.initiate_upgrade_connection(header_data)
# This gets complex, but here we go.
# RFC 7540 ยง 3.2.1 says that "explicit acknowledgement" of the settings
# in the header is "not necessary". That's annoyingly vague, but we
# interpret that to mean "should not be sent". So to test that this
# worked we need to test that the server has only sent the preamble,
# and has not sent a SETTINGS ack, and also that the server has the
# correct settings.
expected_frame = frame_factory.build_settings_frame(
server.local_settings,
)
assert server.data_to_send() == expected_frame.serialize()
assert (
client.local_settings == server.remote_settings
)
|
