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
|
"""
Test the RFC 7838 ALTSVC support.
"""
from __future__ import annotations
import pytest
import h2.config
import h2.connection
import h2.events
import h2.exceptions
class TestRFC7838Client:
"""
Tests that the client supports receiving the RFC 7838 AltSvc frame.
"""
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"),
]
example_response_headers = [
(":status", "200"),
("server", "fake-serv/0.1.0"),
]
def test_receiving_altsvc_stream_zero(self, frame_factory) -> None:
"""
An ALTSVC frame received on stream zero correctly transposes all the
fields from the frames.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=0, origin=b"example.com", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 1
event = events[0]
assert isinstance(event, h2.events.AlternativeServiceAvailable)
assert event.origin == b"example.com"
assert event.field_value == b'h2=":8000"; ma=60'
# No data gets sent.
assert not c.data_to_send()
def test_receiving_altsvc_stream_zero_no_origin(self, frame_factory) -> None:
"""
An ALTSVC frame received on stream zero without an origin field is
ignored.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=0, origin=b"", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert not events
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_receiving_altsvc_on_stream(self, frame_factory, request_headers) -> None:
"""
An ALTSVC frame received on a stream correctly transposes all the
fields from the frame and attaches the expected origin.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=1, origin=b"", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 1
event = events[0]
assert isinstance(event, h2.events.AlternativeServiceAvailable)
assert event.origin == b"example.com"
assert event.field_value == b'h2=":8000"; ma=60'
# No data gets sent.
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_receiving_altsvc_on_stream_with_origin(self, frame_factory, request_headers) -> None:
"""
An ALTSVC frame received on a stream with an origin field present gets
ignored.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=1, origin=b"example.com", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 0
assert not c.data_to_send()
def test_receiving_altsvc_on_stream_not_yet_opened(self, frame_factory) -> None:
"""
When an ALTSVC frame is received on a stream the client hasn't yet
opened, the frame is ignored.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.clear_outbound_data_buffer()
# We'll test this twice, once on a client-initiated stream ID and once
# on a server initiated one.
f1 = frame_factory.build_alt_svc_frame(
stream_id=1, origin=b"", field=b'h2=":8000"; ma=60',
)
f2 = frame_factory.build_alt_svc_frame(
stream_id=2, origin=b"", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f1.serialize() + f2.serialize())
assert len(events) == 0
assert not c.data_to_send()
def test_receiving_altsvc_before_sending_headers(self, frame_factory) -> None:
"""
When an ALTSVC frame is received but the client hasn't sent headers yet
it gets ignored.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
# We need to create the idle stream. We have to do it by calling
# a private API. While this can't naturally happen in hyper-h2 (we
# don't currently have a mechanism by which this could occur), it could
# happen in the future and we defend against it.
c._begin_new_stream(
stream_id=1, allowed_ids=h2.connection.AllowedStreamIDs.ODD,
)
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=1, origin=b"", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 0
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_receiving_altsvc_after_receiving_headers(self, frame_factory, request_headers) -> None:
"""
When an ALTSVC frame is received but the server has already sent
headers it gets ignored.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
f = frame_factory.build_headers_frame(
headers=self.example_response_headers,
)
c.receive_data(f.serialize())
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=1, origin=b"", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 0
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_receiving_altsvc_on_closed_stream(self, frame_factory, request_headers) -> None:
"""
When an ALTSVC frame is received on a closed stream, we ignore it.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(
stream_id=1, headers=request_headers, end_stream=True,
)
f = frame_factory.build_headers_frame(
headers=self.example_response_headers,
flags=["END_STREAM"],
)
c.receive_data(f.serialize())
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=1, origin=b"", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 0
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_receiving_altsvc_on_pushed_stream(self, frame_factory, request_headers) -> None:
"""
When an ALTSVC frame is received on a stream that the server pushed,
the frame is accepted.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
f = frame_factory.build_push_promise_frame(
stream_id=1,
promised_stream_id=2,
headers=request_headers,
)
c.receive_data(f.serialize())
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=2, origin=b"", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 1
event = events[0]
assert isinstance(event, h2.events.AlternativeServiceAvailable)
assert event.origin == b"example.com"
assert event.field_value == b'h2=":8000"; ma=60'
# No data gets sent.
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_cannot_send_explicit_alternative_service(self, frame_factory, request_headers) -> None:
"""
A client cannot send an explicit alternative service.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.advertise_alternative_service(
field_value=b'h2=":8000"; ma=60',
origin=b"example.com",
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_cannot_send_implicit_alternative_service(self, frame_factory, request_headers) -> None:
"""
A client cannot send an implicit alternative service.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.advertise_alternative_service(
field_value=b'h2=":8000"; ma=60',
stream_id=1,
)
class TestRFC7838Server:
"""
Tests that the server supports sending the RFC 7838 AltSvc frame.
"""
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"),
]
example_response_headers = [
(":status", "200"),
("server", "fake-serv/0.1.0"),
]
server_config = h2.config.H2Configuration(client_side=False)
def test_receiving_altsvc_as_server_stream_zero(self, frame_factory) -> None:
"""
When an ALTSVC frame is received on stream zero and we are a server,
we ignore it.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=0, origin=b"example.com", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 0
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_receiving_altsvc_as_server_on_stream(self, frame_factory, request_headers) -> None:
"""
When an ALTSVC frame is received on a stream and we are a server, we
ignore it.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
f = frame_factory.build_headers_frame(
headers=request_headers,
)
c.receive_data(f.serialize())
c.clear_outbound_data_buffer()
f = frame_factory.build_alt_svc_frame(
stream_id=1, origin=b"", field=b'h2=":8000"; ma=60',
)
events = c.receive_data(f.serialize())
assert len(events) == 0
assert not c.data_to_send()
def test_sending_explicit_alternative_service(self, frame_factory) -> None:
"""
A server can send an explicit alternative service.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
c.advertise_alternative_service(
field_value=b'h2=":8000"; ma=60',
origin=b"example.com",
)
f = frame_factory.build_alt_svc_frame(
stream_id=0, origin=b"example.com", field=b'h2=":8000"; ma=60',
)
assert c.data_to_send() == f.serialize()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_sending_implicit_alternative_service(self, frame_factory, request_headers) -> None:
"""
A server can send an implicit alternative service.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
f = frame_factory.build_headers_frame(
headers=request_headers,
)
c.receive_data(f.serialize())
c.clear_outbound_data_buffer()
c.advertise_alternative_service(
field_value=b'h2=":8000"; ma=60',
stream_id=1,
)
f = frame_factory.build_alt_svc_frame(
stream_id=1, origin=b"", field=b'h2=":8000"; ma=60',
)
assert c.data_to_send() == f.serialize()
def test_no_implicit_alternative_service_before_headers(self,
frame_factory) -> None:
"""
If headers haven't been received yet, the server forbids sending an
implicit alternative service.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.advertise_alternative_service(
field_value=b'h2=":8000"; ma=60',
stream_id=1,
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_no_implicit_alternative_service_after_response(self,
frame_factory,
request_headers) -> None:
"""
If the server has sent response headers, hyper-h2 forbids sending an
implicit alternative service.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
f = frame_factory.build_headers_frame(
headers=request_headers,
)
c.receive_data(f.serialize())
c.send_headers(stream_id=1, headers=self.example_response_headers)
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.advertise_alternative_service(
field_value=b'h2=":8000"; ma=60',
stream_id=1,
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_cannot_provide_origin_and_stream_id(self, frame_factory, request_headers) -> None:
"""
The user cannot provide both the origin and stream_id arguments when
advertising alternative services.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
f = frame_factory.build_headers_frame(
headers=request_headers,
)
c.receive_data(f.serialize())
with pytest.raises(ValueError):
c.advertise_alternative_service(
field_value=b'h2=":8000"; ma=60',
origin=b"example.com",
stream_id=1,
)
def test_cannot_provide_unicode_altsvc_field(self, frame_factory) -> None:
"""
The user cannot provide the field value for alternative services as a
unicode string.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
with pytest.raises(ValueError):
c.advertise_alternative_service(
field_value='h2=":8000"; ma=60',
origin=b"example.com",
)
|
