umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 04:10:24 +00:00
Code Issues Wiki Activity

Websocket: Allow setting the max_frame_size option dynamically

Browse source 
This can be used to limit the maximum frame size before
some authentication or other validation is completed.
This commit is contained in:
Loïc Hoguin 2025-01-16 14:40:37 +01:00
parent 818b448ae9
commit 81de580aee
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
4 changed files with 65 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

19
test/handlers/ws_set_options_commands_h.erl
View file

@ -11,10 +11,21 @@ init(Req, RunOrHibernate) ->
{cowboy_websocket, Req, RunOrHibernate,
#{idle_timeout => infinity}}.
websocket_handle(Frame={text, <<"idle_timeout_short">>}, State=run) ->
{[{set_options, #{idle_timeout => 500}}, Frame], State};
websocket_handle(Frame={text, <<"idle_timeout_short">>}, State=hibernate) ->
{[{set_options, #{idle_timeout => 500}}, Frame], State, hibernate}.
%% Set the idle_timeout option dynamically.
websocket_handle({text, <<"idle_timeout_short">>}, State=run) ->
{[{set_options, #{idle_timeout => 500}}], State};
websocket_handle({text, <<"idle_timeout_short">>}, State=hibernate) ->
{[{set_options, #{idle_timeout => 500}}], State, hibernate};
%% Set the max_frame_size option dynamically.
websocket_handle({text, <<"max_frame_size_small">>}, State=run) ->
{[{set_options, #{max_frame_size => 1000}}], State};
websocket_handle({text, <<"max_frame_size_small">>}, State=hibernate) ->
{[{set_options, #{max_frame_size => 1000}}], State, hibernate};
%% We just echo binary frames.
websocket_handle(Frame={binary, _}, State=run) ->
{[Frame], State};
websocket_handle(Frame={binary, _}, State=hibernate) ->
{[Frame], State, hibernate}.
websocket_info(_Info, State) ->
{[], State}.

35
test/ws_handler_SUITE.erl
View file

@ -296,6 +296,41 @@ websocket_set_options_idle_timeout(Config) ->
error(timeout)
end.
websocket_set_options_max_frame_size(Config) ->
doc("The max_frame_size option can be modified using the "
"command {set_options, Opts} at runtime."),
ConnPid = gun_open(Config),
StreamRef = gun:ws_upgrade(ConnPid, "/set_options"),
receive
{gun_upgrade, ConnPid, StreamRef, [<<"websocket">>], _} ->
ok;
{gun_response, ConnPid, _, _, Status, Headers} ->
exit({ws_upgrade_failed, Status, Headers});
{gun_error, ConnPid, StreamRef, Reason} ->
exit({ws_upgrade_failed, Reason})
after 1000 ->
error(timeout)
end,
%% We first send a 1MB frame to confirm that yes, we can
%% send a frame that large. The default max_frame_size is infinity.
gun:ws_send(ConnPid, StreamRef, {binary, <<0:8000000>>}),
{ws, {binary, <<0:8000000>>}} = gun:await(ConnPid, StreamRef),
%% Trigger the change in max_frame_size. From now on we will
%% only allow frames of up to 1000 bytes.
gun:ws_send(ConnPid, StreamRef, {text, <<"max_frame_size_small">>}),
%% Confirm that we can send frames of up to 1000 bytes.
gun:ws_send(ConnPid, StreamRef, {binary, <<0:8000>>}),
{ws, {binary, <<0:8000>>}} = gun:await(ConnPid, StreamRef),
%% Confirm that sending frames larger than 1000 bytes
%% results in the closing of the connection.
gun:ws_send(ConnPid, StreamRef, {binary, <<0:8008>>}),
receive
{gun_down, ConnPid, _, _, _} ->
ok
after 2000 ->
error(timeout)
end.
websocket_shutdown_reason(Config) ->
doc("The command {shutdown_reason, any()} can be used to "
"change the shutdown reason of a Websocket connection."),