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
|
%% Copyright (c) 2015, Loïc Hoguin <[email protected]>
%%
%% Permission to use, copy, modify, and/or distribute this software for any
%% purpose with or without fee is hereby granted, provided that the above
%% copyright notice and this permission notice appear in all copies.
%%
%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-module(spdy_SUITE).
-compile(export_all).
-import(ct_helper, [doc/1]).
%% ct.
all() -> [{group, spdy31}].
groups() -> [{spdy31, [parallel], ct_helper:all(?MODULE)}].
%% Helper functions.
wait() ->
receive after 500 -> ok end.
down() ->
receive {gun_down, _, _, _, _, _} ->
ok
after 5000 ->
exit(timeout)
end.
not_down() ->
receive {gun_down, _, _, _, _, _} ->
exit(down)
after 0 ->
ok
end.
do_req_resp(ConnPid, ServerPid, ServerStreamID) ->
StreamRef = gun:get(ConnPid, "/"),
spdy_server:send(ServerPid, [
{syn_reply, ServerStreamID, false, <<"200">>, <<"HTTP/1.1">>, []},
{data, ServerStreamID, true, <<"Hello world!">>}
]),
receive {gun_response, _, StreamRef, _, _, _} ->
ok
after 5000 ->
exit(timeout)
end,
ok.
%% SPDY/3.1 test suite.
goaway_on_close(_) ->
doc("Send a GOAWAY when the client closes the connection (spdy-protocol-draft3-1 2.1)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
gun:close(ConnPid),
wait(),
[{goaway, 0, ok}] = spdy_server:stop(ServerPid),
down().
goaway_on_shutdown(_) ->
doc("Send a GOAWAY when the client closes the connection (spdy-protocol-draft3-1 2.1)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
gun:shutdown(ConnPid),
wait(),
[{goaway, 0, ok}] = spdy_server:stop(ServerPid),
down().
%% @todo This probably applies to HEADERS frame or SYN_STREAM from server push.
reject_data_on_non_existing_stream(_) ->
doc("DATA frames received for non-existing streams must be rejected with "
"an INVALID_STREAM stream error. (spdy-protocol-draft3-1 2.2.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
spdy_server:send(ServerPid, [
{data, 1, true, <<"Hello world!">>}
]),
wait(),
[{rst_stream, 1, invalid_stream}] = spdy_server:stop(ServerPid).
%% @todo This probably applies to HEADERS frame or SYN_STREAM from server push.
ignore_data_on_non_existing_stream_after_goaway(_) ->
%% Note: this is not explicitly written in the specification.
%% However the HTTP/2 draft tells us that we can discard frames
%% with identifiers higher than the identified last stream,
%% which falls under this case. (draft-ietf-httpbis-http2-17 6.8)
doc("DATA frames received for non-existing streams after a GOAWAY has been "
"sent must be ignored. (spdy-protocol-draft3-1 2.2.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
gun:shutdown(ConnPid),
spdy_server:send(ServerPid, [
{data, 1, true, <<"Hello world!">>}
]),
wait(),
[{goaway, 0, ok}] = spdy_server:stop(ServerPid),
down().
%% @todo This probably applies to HEADERS frame or SYN_STREAM from server push.
reject_data_before_syn_reply(_) ->
doc("A DATA frame received before a SYN_REPLY must be rejected "
"with a PROTOCOL_ERROR stream error. (spdy-protocol-draft3-1 2.2.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
spdy_server:send(ServerPid, [
{data, 1, true, <<"Hello world!">>},
{syn_reply, 1, false, <<"200">>, <<"HTTP/1.1">>, []}
]),
wait(),
[_, {rst_stream, 1, protocol_error}] = spdy_server:stop(ServerPid).
streamid_is_odd(_) ->
doc("Client-initiated Stream-ID must be an odd number. (spdy-protocol-draft3-1 2.3.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
[do_req_resp(ConnPid, ServerPid, N) || N <- lists:seq(1, 5, 2)],
Rec = spdy_server:stop(ServerPid),
true = length(Rec) =:= length([ok || {syn_stream, StreamID, _, _, _, _, _, _, _, _, _, _} <- Rec, StreamID rem 2 =:= 1]).
reject_streamid_0(_) ->
doc("The Stream-ID 0 is not valid and must be rejected with a PROTOCOL_ERROR session error. (spdy-protocol-draft3-1 2.3.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
spdy_server:send(ServerPid, [
{syn_stream, 0, 1, true, true, 0, <<"GET">>, <<"https">>, ["localhost:", integer_to_binary(Port)], "/a", <<"HTTP/1.1">>, []},
{syn_reply, 1, true, <<"200">>, <<"HTTP/1.1">>, []}
]),
wait(),
[_, {goaway, 0, protocol_error}] = spdy_server:stop(ServerPid),
down().
streamid_increases_monotonically(_) ->
doc("The Stream-ID must increase monotonically. (spdy-protocol-draft3-1 2.3.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
Expected = [1, 3, 5, 7, 9],
[do_req_resp(ConnPid, ServerPid, N) || N <- Expected],
wait(),
Rec = spdy_server:stop(ServerPid),
Expected = [StreamID || {syn_stream, StreamID, _, _, _, _, _, _, _, _, _, _} <- Rec].
streamid_does_not_wrap(_) ->
doc("Stream-ID must not wrap. Reconnect when all Stream-IDs are exhausted. (spdy-protocol-draft3-1 2.3.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
MaxClientStreamID = 2147483647,
sys:replace_state(ConnPid, fun({loop, State}) ->
%% Replace the next stream_id value to the maximum allowed value.
{loop, setelement(11, State, setelement(9, element(11, State), MaxClientStreamID))}
end),
do_req_resp(ConnPid, ServerPid, MaxClientStreamID),
%% Gun has exhausted all Stream-IDs and should now reconnect.
{ok, spdy} = gun:await_up(ConnPid),
%% Check that the next request is on a new connection.
_ = gun:get(ConnPid, "/"),
[{syn_stream, 1, _, _, _, _, _, _, _, _, _, _}] = spdy_server:stop(ServerPid).
reject_syn_stream_decreasing_streamid(_) ->
doc("Reject a decreasing Stream-ID with a PROTOCOL_ERROR session error. (spdy-protocol-draft3-1 2.3.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
Host = ["localhost:", integer_to_binary(Port)],
spdy_server:send(ServerPid, [
{syn_stream, 2, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/a", <<"HTTP/1.1">>, []},
{syn_stream, 6, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/b", <<"HTTP/1.1">>, []},
{syn_stream, 4, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/c", <<"HTTP/1.1">>, []},
{syn_reply, 1, true, <<"200">>, <<"HTTP/1.1">>, []}
]),
wait(),
[_, {goaway, 0, protocol_error}] = spdy_server:stop(ServerPid),
down().
reject_stream_duplicate_streamid(_) ->
doc("Reject duplicate Stream-ID with a PROTOCOL_ERROR session error. (spdy-protocol-draft3-1 2.3.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
Host = ["localhost:", integer_to_binary(Port)],
spdy_server:send(ServerPid, [
{syn_stream, 2, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/a", <<"HTTP/1.1">>, []},
{syn_stream, 2, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/b", <<"HTTP/1.1">>, []},
{syn_reply, 1, true, <<"200">>, <<"HTTP/1.1">>, []}
]),
wait(),
[_, {goaway, 2, protocol_error}] = spdy_server:stop(ServerPid),
down().
dont_send_frames_after_flag_fin(_) ->
doc("Do not send frames after sending FLAG_FIN. (spdy-protocol-draft3-1 2.3.6)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
%% Send a POST frame with no content header so that Gun sets FLAG_FIN,
%% then try sending data. Gun should reject this second call.
StreamRef = gun:post(ConnPid, "/", []),
gun:data(ConnPid, StreamRef, false, <<"Hello world!">>),
receive {gun_error, ConnPid, StreamRef, _} ->
ok
after 5000 ->
exit(timeout)
end,
wait(),
[{syn_stream, _, _, _, _, _, _, _, _, _, _, _}] = spdy_server:stop(ServerPid).
allow_window_update_after_flag_fin(_) ->
doc("WINDOW_UPDATE is allowed when the stream is half-closed. (spdy-protocol-draft3-1 2.3.6)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
spdy_server:send(ServerPid, [
{window_update, 1, 1024}
]),
wait(),
[{syn_stream, _, _, _, _, _, _, _, _, _, _, _}] = spdy_server:stop(ServerPid).
%% @todo This probably applies to HEADERS frame or SYN_STREAM from server push.
reject_data_on_half_closed_stream(_) ->
doc("Data frames sent on a half-closed stream must be rejected "
"with a STREAM_ALREADY_CLOSED stream error. (spdy-protocol-draft3-1 2.3.6)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
%% Send a POST frame with a content header so that Gun leaves this
%% stream alive after the server sends the reply.
_ = gun:post(ConnPid, "/", [{<<"content-length">>, <<"5">>}]),
spdy_server:send(ServerPid, [
{syn_reply, 1, true, <<"200">>, <<"HTTP/1.1">>, []},
{data, 1, true, <<"Hello world!">>}
]),
wait(),
[_, {rst_stream, 1, stream_already_closed}] = spdy_server:stop(ServerPid).
%% @todo This probably applies to HEADERS frame or SYN_STREAM from server push.
reject_data_on_closed_stream(_) ->
doc("Data frames sent on a closed stream must be rejected "
"with a PROTOCOL_ERROR stream error. (spdy-protocol-draft3-1 2.3.7)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
%% Send a GET frame so that the stream is closed when the server replies.
_ = gun:get(ConnPid, "/"),
spdy_server:send(ServerPid, [
{syn_reply, 1, true, <<"200">>, <<"HTTP/1.1">>, []},
{data, 1, true, <<"Hello world!">>}
]),
wait(),
[_, {rst_stream, 1, protocol_error}] = spdy_server:stop(ServerPid).
%% @todo We need to test that we do the right thing when the server sends a GOAWAY.
goaway_last_good_streamid(_) ->
doc("The GOAWAY frame must contain the Stream-ID of the last recently "
"received stream from the remote endpoint. (spdy-protocol-draft3-1 2.4.1)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
Host = ["localhost:", integer_to_binary(Port)],
spdy_server:send(ServerPid, [
{syn_stream, 2, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/a", <<"HTTP/1.1">>, []},
{syn_stream, 4, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/c", <<"HTTP/1.1">>, []},
{syn_stream, 6, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/b", <<"HTTP/1.1">>, []},
{syn_reply, 0, true, <<"200">>, <<"HTTP/1.1">>, []}
]),
wait(),
[_, {goaway, 6, protocol_error}] = spdy_server:stop(ServerPid),
down().
dont_send_rst_stream_on_rst_stream(_) ->
doc("An endpoint must not send an RST_STREAM in response to an RST_STREAM. (spdy-protocol-draft3-1 2.4.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
spdy_server:send(ServerPid, [
{rst_stream, 1, refused_stream}
]),
wait(),
%% No RST_STREAM was received; only SYN_STREAM.
[_] = spdy_server:stop(ServerPid),
not_down().
coalesce_multiple_identical_rst_stream(_) ->
doc("Do not send multiple identical RST_STREAM in succession. (spdy-protocol-draft3-1 2.4.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
spdy_server:send(ServerPid, [
{data, 1, true, <<"Hello ">>},
{data, 1, true, <<"world!">>}
]),
wait(),
[{rst_stream, 1, invalid_stream}] = spdy_server:stop(ServerPid).
%% @todo I am not sure how to adequately test that we don't send bad flags.
syn_stream_ignore_unknown_flags(_) ->
%% Note: this is not explicitly written in the specification.
%% However the HTTP/2 draft tells us to ignore unknown flags.
%% (draft-ietf-httpbis-http2-17 4.1)
doc("Unknown flags must be ignored. (spdy-protocol-draft3-1 2.6.1)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
%% Build a SYN_STREAM frame with all flag bits set to 1.
<< Before:32/bits, _:8, After/bits >> = iolist_to_binary(cow_spdy:syn_stream(cow_spdy:deflate_init(),
2, 1, true, true, 0, <<"GET">>, <<"https">>, ["localhost:", integer_to_binary(Port)], "/a", <<"HTTP/1.1">>, [])),
Frame = << Before/bits, 1:1, 1:1, 1:1, 1:1, 1:1, 1:1, 1:1, 1:1, After/bits >>,
spdy_server:send_raw(ServerPid, Frame),
wait(),
[_] = spdy_server:stop(ServerPid).
reject_associated_to_streamid_0(_) ->
doc("A non-zero Associated-To-Stream-ID sent by the server must "
"be rejected with a PROTOCOL_ERROR session error. (spdy-protocol-draft3-1 2.6.1)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
Host = ["localhost:", integer_to_binary(Port)],
spdy_server:send(ServerPid, [
{syn_stream, 2, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/a", <<"HTTP/1.1">>, []},
{syn_stream, 4, 1, true, true, 0, <<"GET">>, <<"https">>, Host, "/c", <<"HTTP/1.1">>, []},
{syn_stream, 6, 0, true, true, 0, <<"GET">>, <<"https">>, Host, "/b", <<"HTTP/1.1">>, []},
{syn_reply, 1, true, <<"200">>, <<"HTTP/1.1">>, []}
]),
wait(),
[_, {goaway, 4, protocol_error}] = spdy_server:stop(ServerPid),
down().
syn_reply_ignore_unknown_flags(_) ->
%% Note: this is not explicitly written in the specification.
%% However the HTTP/2 draft tells us to ignore unknown flags.
%% (draft-ietf-httpbis-http2-17 4.1)
doc("Unknown flags must be ignored. (spdy-protocol-draft3-1 2.6.2)"),
{ok, ServerPid, Port} = spdy_server:start_link(),
{ok, ConnPid} = gun:open("localhost", Port, #{transport=>ssl}),
{ok, spdy} = gun:await_up(ConnPid),
_ = gun:get(ConnPid, "/"),
%% Build a SYN_REPLY frame with all flag bits set to 1.
<< Before:32/bits, _:8, After/bits >> = iolist_to_binary(cow_spdy:syn_reply(cow_spdy:deflate_init(),
1, true, <<"200">>, <<"HTTP/1.1">>, [])),
Frame = << Before/bits, 1:1, 1:1, 1:1, 1:1, 1:1, 1:1, 1:1, 1:1, After/bits >>,
spdy_server:send_raw(ServerPid, Frame),
wait(),
[_] = spdy_server:stop(ServerPid).
|
