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
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
|
"""
Tests that we handle closed streams correctly.
"""
from __future__ import annotations
import pytest
import h2.config
import h2.connection
import h2.errors
import h2.events
import h2.exceptions
class TestClosedStreams:
example_request_headers = [
(":authority", "example.com"),
(":path", "/"),
(":scheme", "https"),
(":method", "GET"),
]
example_response_headers = [
(":status", "200"),
("server", "fake-serv/0.1.0"),
]
server_config = h2.config.H2Configuration(client_side=False)
def test_can_receive_multiple_rst_stream_frames(self, frame_factory) -> None:
"""
Multiple RST_STREAM frames can be received, either at once or well
after one another. Only the first fires an event.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(1, self.example_request_headers, end_stream=True)
f = frame_factory.build_rst_stream_frame(stream_id=1)
events = c.receive_data(f.serialize() * 3)
# Force an iteration over all the streams to remove them.
c.open_outbound_streams
# Receive more data.
events += c.receive_data(f.serialize() * 3)
assert len(events) == 1
event = events[0]
assert isinstance(event, h2.events.StreamReset)
def test_receiving_low_stream_id_causes_goaway(self, frame_factory) -> None:
"""
The remote peer creating a stream with a lower ID than one we've seen
causes a GOAWAY frame.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.receive_data(frame_factory.preamble())
c.initiate_connection()
f = frame_factory.build_headers_frame(
self.example_request_headers,
stream_id=3,
)
c.receive_data(f.serialize())
c.clear_outbound_data_buffer()
f = frame_factory.build_headers_frame(
self.example_request_headers,
stream_id=1,
)
with pytest.raises(h2.exceptions.StreamIDTooLowError) as e:
c.receive_data(f.serialize())
assert e.value.stream_id == 1
assert e.value.max_stream_id == 3
f = frame_factory.build_goaway_frame(
last_stream_id=3,
error_code=h2.errors.ErrorCodes.PROTOCOL_ERROR,
)
assert c.data_to_send() == f.serialize()
def test_closed_stream_not_present_in_streams_dict(self, frame_factory) -> None:
"""
When streams have been closed, they get removed from the streams
dictionary the next time we count the open streams.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.receive_data(frame_factory.preamble())
c.initiate_connection()
f = frame_factory.build_headers_frame(self.example_request_headers)
c.receive_data(f.serialize())
c.push_stream(1, 2, self.example_request_headers)
c.reset_stream(1)
c.clear_outbound_data_buffer()
f = frame_factory.build_rst_stream_frame(stream_id=2)
c.receive_data(f.serialize())
# Force a count of the streams.
assert not c.open_outbound_streams
# The streams dictionary should be empty.
assert not c.streams
def test_receive_rst_stream_on_closed_stream(self, frame_factory) -> None:
"""
RST_STREAM frame should be ignored if stream is in a closed state.
See RFC 7540 Section 5.1 (closed state)
"""
c = h2.connection.H2Connection()
c.initiate_connection()
# Client sends request
c.send_headers(1, self.example_request_headers)
# Some time passes and client sends DATA frame and closes stream,
# so it is in a half-closed state
c.send_data(1, b"some data", end_stream=True)
# Server received HEADERS frame but DATA frame is still on the way.
# Stream is in open state on the server-side. In this state server is
# allowed to end stream and reset it - this trick helps immediately
# close stream on the server-side.
headers_frame = frame_factory.build_headers_frame(
[(":status", "200")],
flags=["END_STREAM"],
stream_id=1,
)
events = c.receive_data(headers_frame.serialize())
assert len(events) == 2
response_received, stream_ended = events
assert isinstance(response_received, h2.events.ResponseReceived)
assert isinstance(stream_ended, h2.events.StreamEnded)
rst_stream_frame = frame_factory.build_rst_stream_frame(stream_id=1)
events = c.receive_data(rst_stream_frame.serialize())
assert not events
def test_receive_window_update_on_closed_stream(self, frame_factory) -> None:
"""
WINDOW_UPDATE frame should be ignored if stream is in a closed state.
See RFC 7540 Section 5.1 (closed state)
"""
c = h2.connection.H2Connection()
c.initiate_connection()
# Client sends request
c.send_headers(1, self.example_request_headers)
# Some time passes and client sends DATA frame and closes stream,
# so it is in a half-closed state
c.send_data(1, b"some data", end_stream=True)
# Server received HEADERS frame but DATA frame is still on the way.
# Stream is in open state on the server-side. In this state server is
# allowed to end stream and after that acknowledge received data by
# sending WINDOW_UPDATE frames.
headers_frame = frame_factory.build_headers_frame(
[(":status", "200")],
flags=["END_STREAM"],
stream_id=1,
)
events = c.receive_data(headers_frame.serialize())
assert len(events) == 2
response_received, stream_ended = events
assert isinstance(response_received, h2.events.ResponseReceived)
assert isinstance(stream_ended, h2.events.StreamEnded)
window_update_frame = frame_factory.build_window_update_frame(
stream_id=1,
increment=1,
)
events = c.receive_data(window_update_frame.serialize())
assert not events
# Getting open_inbound_streams property will trigger stream accounting
# which results in removing closed streams.
c.open_inbound_streams
# Another window_update_frame is received for stream 1
events = c.receive_data(window_update_frame.serialize())
assert not events
class TestStreamsClosedByEndStream:
example_request_headers = [
(":authority", "example.com"),
(":path", "/"),
(":scheme", "https"),
(":method", "GET"),
]
example_response_headers = [
(":status", "200"),
("server", "fake-serv/0.1.0"),
]
server_config = h2.config.H2Configuration(client_side=False)
@pytest.mark.parametrize(
"frame",
[
lambda self, ff: ff.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"]),
lambda self, ff: ff.build_headers_frame(
self.example_request_headers),
],
)
@pytest.mark.parametrize("clear_streams", [True, False])
def test_frames_after_recv_end_will_error(self,
frame_factory,
frame,
clear_streams) -> None:
"""
A stream that is closed by receiving END_STREAM raises
ProtocolError when it receives an unexpected frame.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.receive_data(frame_factory.preamble())
c.initiate_connection()
f = frame_factory.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"],
)
c.receive_data(f.serialize())
c.send_headers(
stream_id=1,
headers=self.example_response_headers,
end_stream=True,
)
if clear_streams:
# Call open_inbound_streams to force the connection to clean
# closed streams.
c.open_inbound_streams
c.clear_outbound_data_buffer()
f = frame(self, frame_factory)
with pytest.raises(h2.exceptions.ProtocolError):
c.receive_data(f.serialize())
f = frame_factory.build_goaway_frame(
last_stream_id=1,
error_code=h2.errors.ErrorCodes.STREAM_CLOSED,
)
assert c.data_to_send() == f.serialize()
@pytest.mark.parametrize(
"frame",
[
lambda self, ff: ff.build_headers_frame(
self.example_response_headers, flags=["END_STREAM"]),
lambda self, ff: ff.build_headers_frame(
self.example_response_headers),
],
)
@pytest.mark.parametrize("clear_streams", [True, False])
def test_frames_after_send_end_will_error(self,
frame_factory,
frame,
clear_streams) -> None:
"""
A stream that is closed by sending END_STREAM raises
ProtocolError when it receives an unexpected frame.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=self.example_request_headers,
end_stream=True)
f = frame_factory.build_headers_frame(
self.example_response_headers, flags=["END_STREAM"],
)
c.receive_data(f.serialize())
if clear_streams:
# Call open_outbound_streams to force the connection to clean
# closed streams.
c.open_outbound_streams
c.clear_outbound_data_buffer()
f = frame(self, frame_factory)
with pytest.raises(h2.exceptions.ProtocolError):
c.receive_data(f.serialize())
f = frame_factory.build_goaway_frame(
last_stream_id=0,
error_code=h2.errors.ErrorCodes.STREAM_CLOSED,
)
assert c.data_to_send() == f.serialize()
@pytest.mark.parametrize(
"frame",
[
lambda self, ff: ff.build_window_update_frame(1, 1),
lambda self, ff: ff.build_rst_stream_frame(1),
],
)
def test_frames_after_send_end_will_be_ignored(self,
frame_factory,
frame) -> None:
"""
A stream that is closed by sending END_STREAM will raise
ProtocolError when received unexpected frame.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.receive_data(frame_factory.preamble())
c.initiate_connection()
f = frame_factory.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"],
)
c.receive_data(f.serialize())
c.send_headers(
stream_id=1,
headers=self.example_response_headers,
end_stream=True,
)
c.clear_outbound_data_buffer()
f = frame(self, frame_factory)
events = c.receive_data(f.serialize())
assert not events
class TestStreamsClosedByRstStream:
example_request_headers = [
(":authority", "example.com"),
(":path", "/"),
(":scheme", "https"),
(":method", "GET"),
]
example_response_headers = [
(":status", "200"),
("server", "fake-serv/0.1.0"),
]
server_config = h2.config.H2Configuration(client_side=False)
@pytest.mark.parametrize(
"frame",
[
lambda self, ff: ff.build_headers_frame(
self.example_request_headers),
lambda self, ff: ff.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"]),
],
)
def test_resets_further_frames_after_recv_reset(self,
frame_factory,
frame) -> None:
"""
A stream that is closed by receive RST_STREAM can receive further
frames: it simply sends RST_STREAM for it, and additionally
WINDOW_UPDATE for DATA frames.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.receive_data(frame_factory.preamble())
c.initiate_connection()
header_frame = frame_factory.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"],
)
c.receive_data(header_frame.serialize())
c.send_headers(
stream_id=1,
headers=self.example_response_headers,
end_stream=False,
)
rst_frame = frame_factory.build_rst_stream_frame(
1, h2.errors.ErrorCodes.STREAM_CLOSED,
)
c.receive_data(rst_frame.serialize())
c.clear_outbound_data_buffer()
f = frame(self, frame_factory)
events = c.receive_data(f.serialize())
rst_frame = frame_factory.build_rst_stream_frame(
1, h2.errors.ErrorCodes.STREAM_CLOSED,
)
assert not events
assert c.data_to_send() == rst_frame.serialize()
events = c.receive_data(f.serialize() * 3)
assert not events
assert c.data_to_send() == rst_frame.serialize() * 3
# Iterate over the streams to make sure it's gone, then confirm the
# behaviour is unchanged.
c.open_outbound_streams
events = c.receive_data(f.serialize() * 3)
assert not events
assert c.data_to_send() == rst_frame.serialize() * 3
def test_resets_further_data_frames_after_recv_reset(self,
frame_factory) -> None:
"""
A stream that is closed by receive RST_STREAM can receive further
DATA frames: it simply sends WINDOW_UPDATE for the connection flow
window, and RST_STREAM for the stream.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.receive_data(frame_factory.preamble())
c.initiate_connection()
header_frame = frame_factory.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"],
)
c.receive_data(header_frame.serialize())
c.send_headers(
stream_id=1,
headers=self.example_response_headers,
end_stream=False,
)
rst_frame = frame_factory.build_rst_stream_frame(
1, h2.errors.ErrorCodes.STREAM_CLOSED,
)
c.receive_data(rst_frame.serialize())
c.clear_outbound_data_buffer()
f = frame_factory.build_data_frame(
data=b"some data",
)
events = c.receive_data(f.serialize())
assert not events
expected = frame_factory.build_rst_stream_frame(
stream_id=1,
error_code=h2.errors.ErrorCodes.STREAM_CLOSED,
).serialize()
assert c.data_to_send() == expected
events = c.receive_data(f.serialize() * 3)
assert not events
assert c.data_to_send() == expected * 3
# Iterate over the streams to make sure it's gone, then confirm the
# behaviour is unchanged.
c.open_outbound_streams
events = c.receive_data(f.serialize() * 3)
assert not events
assert c.data_to_send() == expected * 3
@pytest.mark.parametrize(
"frame",
[
lambda self, ff: ff.build_headers_frame(
self.example_request_headers),
lambda self, ff: ff.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"]),
],
)
def test_resets_further_frames_after_send_reset(self,
frame_factory,
frame) -> None:
"""
A stream that is closed by sent RST_STREAM can receive further frames:
it simply sends RST_STREAM for it.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.receive_data(frame_factory.preamble())
c.initiate_connection()
header_frame = frame_factory.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"],
)
c.receive_data(header_frame.serialize())
c.send_headers(
stream_id=1,
headers=self.example_response_headers,
end_stream=False,
)
c.reset_stream(1, h2.errors.ErrorCodes.INTERNAL_ERROR)
rst_frame = frame_factory.build_rst_stream_frame(
1, h2.errors.ErrorCodes.STREAM_CLOSED,
)
c.clear_outbound_data_buffer()
f = frame(self, frame_factory)
events = c.receive_data(f.serialize())
rst_frame = frame_factory.build_rst_stream_frame(
1, h2.errors.ErrorCodes.STREAM_CLOSED,
)
assert not events
assert c.data_to_send() == rst_frame.serialize()
events = c.receive_data(f.serialize() * 3)
assert not events
assert c.data_to_send() == rst_frame.serialize() * 3
# Iterate over the streams to make sure it's gone, then confirm the
# behaviour is unchanged.
c.open_outbound_streams
events = c.receive_data(f.serialize() * 3)
assert not events
assert c.data_to_send() == rst_frame.serialize() * 3
def test_resets_further_data_frames_after_send_reset(self,
frame_factory) -> None:
"""
A stream that is closed by sent RST_STREAM can receive further
data frames: it simply sends WINDOW_UPDATE and RST_STREAM for it.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.receive_data(frame_factory.preamble())
c.initiate_connection()
header_frame = frame_factory.build_headers_frame(
self.example_request_headers, flags=["END_STREAM"],
)
c.receive_data(header_frame.serialize())
c.send_headers(
stream_id=1,
headers=self.example_response_headers,
end_stream=False,
)
c.reset_stream(1, h2.errors.ErrorCodes.INTERNAL_ERROR)
c.clear_outbound_data_buffer()
f = frame_factory.build_data_frame(
data=b"some data",
)
events = c.receive_data(f.serialize())
assert not events
expected = frame_factory.build_rst_stream_frame(
stream_id=1,
error_code=h2.errors.ErrorCodes.STREAM_CLOSED,
).serialize()
assert c.data_to_send() == expected
events = c.receive_data(f.serialize() * 3)
assert not events
assert c.data_to_send() == expected * 3
# Iterate over the streams to make sure it's gone, then confirm the
# behaviour is unchanged.
c.open_outbound_streams
events = c.receive_data(f.serialize() * 3)
assert not events
assert c.data_to_send() == expected * 3
|
