aboutsummaryrefslogtreecommitdiffstats
path: root/test
diff options
context:
space:
mode:
authorKirill Kinduk <[email protected]>2017-08-25 12:08:26 +0300
committerLoïc Hoguin <[email protected]>2018-03-28 16:58:02 +0200
commit4c34774b7eb787e37892399f2daddba68ec277e3 (patch)
tree8640e0950bb363acde6f87f1f7a2977d3185c852 /test
parent288deb5b88dd8e0aae57c9858d16c19ca9f186f9 (diff)
downloadcowboy-4c34774b7eb787e37892399f2daddba68ec277e3.tar.gz
cowboy-4c34774b7eb787e37892399f2daddba68ec277e3.tar.bz2
cowboy-4c34774b7eb787e37892399f2daddba68ec277e3.zip
Add max_frame_size option for websocket handlers
Option allows to limit a frame by size before decoding its payload. LH: I have added a test for when the limit is reached on a nofin fragmented frame (the last commit addressed that case but it had no test). I have fixed formatting and other, and changed the default value to infinity since it might otherwise be incompatible with existing code. I also added documentation and a bunch of other minor changes.
Diffstat (limited to 'test')
-rw-r--r--test/ws_SUITE.erl45
-rw-r--r--test/ws_SUITE_data/ws_max_frame_size.erl22
2 files changed, 64 insertions, 3 deletions
diff --git a/test/ws_SUITE.erl b/test/ws_SUITE.erl
index 99307d8..b86c595 100644
--- a/test/ws_SUITE.erl
+++ b/test/ws_SUITE.erl
@@ -82,7 +82,8 @@ init_dispatch() ->
{"/ws_subprotocol", ws_subprotocol, []},
{"/terminate", ws_terminate_h, []},
{"/ws_timeout_hibernate", ws_timeout_hibernate, []},
- {"/ws_timeout_cancel", ws_timeout_cancel, []}
+ {"/ws_timeout_cancel", ws_timeout_cancel, []},
+ {"/ws_max_frame_size", ws_max_frame_size, []}
]}
]).
@@ -302,6 +303,44 @@ ws_init_shutdown_before_handshake(Config) ->
{ok, {http_response, {1, 1}, 403, _}, _Rest} = erlang:decode_packet(http, Handshake, []),
ok.
+ws_max_frame_size_close(Config) ->
+ doc("Server closes connection when frame size exceeds max_frame_size option"),
+ %% max_frame_size is set to 8 bytes in ws_max_frame_size.
+ {ok, Socket, _} = do_handshake("/ws_max_frame_size", Config),
+ Mask = 16#11223344,
+ MaskedHello = do_mask(<<"HelloHello">>, Mask, <<>>),
+ ok = gen_tcp:send(Socket, << 1:1, 0:3, 2:4, 1:1, 10:7, Mask:32, MaskedHello/binary >>),
+ {ok, << 1:1, 0:3, 8:4, 0:1, 2:7, 1009:16 >>} = gen_tcp:recv(Socket, 0, 6000),
+ {error, closed} = gen_tcp:recv(Socket, 0, 6000),
+ ok.
+
+ws_max_frame_size_final_fragment_close(Config) ->
+ doc("Server closes connection when final fragmented frame "
+ "exceeds max_frame_size option"),
+ %% max_frame_size is set to 8 bytes in ws_max_frame_size.
+ {ok, Socket, _} = do_handshake("/ws_max_frame_size", Config),
+ Mask = 16#11223344,
+ MaskedHello = do_mask(<<"Hello">>, Mask, <<>>),
+ ok = gen_tcp:send(Socket, << 0:1, 0:3, 2:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>),
+ ok = gen_tcp:send(Socket, << 1:1, 0:3, 0:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>),
+ {ok, << 1:1, 0:3, 8:4, 0:1, 2:7, 1009:16 >>} = gen_tcp:recv(Socket, 0, 6000),
+ {error, closed} = gen_tcp:recv(Socket, 0, 6000),
+ ok.
+
+ws_max_frame_size_intermediate_fragment_close(Config) ->
+ doc("Server closes connection when intermediate fragmented frame "
+ "exceeds max_frame_size option"),
+ %% max_frame_size is set to 8 bytes in ws_max_frame_size.
+ {ok, Socket, _} = do_handshake("/ws_max_frame_size", Config),
+ Mask = 16#11223344,
+ MaskedHello = do_mask(<<"Hello">>, Mask, <<>>),
+ ok = gen_tcp:send(Socket, << 0:1, 0:3, 2:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>),
+ ok = gen_tcp:send(Socket, << 0:1, 0:3, 0:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>),
+ ok = gen_tcp:send(Socket, << 1:1, 0:3, 0:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>),
+ {ok, << 1:1, 0:3, 8:4, 0:1, 2:7, 1009:16 >>} = gen_tcp:recv(Socket, 0, 6000),
+ {error, closed} = gen_tcp:recv(Socket, 0, 6000),
+ ok.
+
ws_send_close(Config) ->
doc("Server-initiated close frame ends the connection."),
{ok, Socket, _} = do_handshake("/ws_send_close", Config),
@@ -402,8 +441,8 @@ ws_text_fragments(Config) ->
%% Send three "Hello" over three fragments and one send.
ok = gen_tcp:send(Socket, [
<< 0:1, 0:3, 1:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>,
- << 0:1, 0:3, 0:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>,
- << 1:1, 0:3, 0:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>]),
+ << 0:1, 0:3, 0:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>,
+ << 1:1, 0:3, 0:4, 1:1, 5:7, Mask:32, MaskedHello/binary >>]),
{ok, << 1:1, 0:3, 1:4, 0:1, 15:7, "HelloHelloHello" >>} = gen_tcp:recv(Socket, 0, 6000),
ok.
diff --git a/test/ws_SUITE_data/ws_max_frame_size.erl b/test/ws_SUITE_data/ws_max_frame_size.erl
new file mode 100644
index 0000000..2d34218
--- /dev/null
+++ b/test/ws_SUITE_data/ws_max_frame_size.erl
@@ -0,0 +1,22 @@
+-module(ws_max_frame_size).
+
+-export([init/2]).
+-export([websocket_init/1]).
+-export([websocket_handle/2]).
+-export([websocket_info/2]).
+
+init(Req, State) ->
+ {cowboy_websocket, Req, State, #{max_frame_size => 8}}.
+
+websocket_init(State) ->
+ {ok, State}.
+
+websocket_handle({text, Data}, State) ->
+ {reply, {text, Data}, State};
+websocket_handle({binary, Data}, State) ->
+ {reply, {binary, Data}, State};
+websocket_handle(_Frame, State) ->
+ {ok, State}.
+
+websocket_info(_Info, State) ->
+ {ok, State}.