0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00

Add Websocket option validate_utf8

This allows disabling the UTF-8 validation check
for text and close frames.
This commit is contained in:
Loïc Hoguin 2019-10-05 17:32:50 +02:00
parent c50d6aa09c
commit 3e23aff1d1
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
4 changed files with 61 additions and 8 deletions

View file

@ -0,0 +1,23 @@
%% This module disables UTF-8 validation.
-module(ws_dont_validate_utf8_h).
-behavior(cowboy_websocket).
-export([init/2]).
-export([websocket_handle/2]).
-export([websocket_info/2]).
init(Req, State) ->
{cowboy_websocket, Req, State, #{
validate_utf8 => false
}}.
websocket_handle({text, Data}, State) ->
{reply, {text, Data}, State};
websocket_handle({binary, Data}, State) ->
{reply, {binary, Data}, State};
websocket_handle(_, State) ->
{ok, State}.
websocket_info(_, State) ->
{ok, State}.

View file

@ -67,7 +67,8 @@ init_dispatch() ->
{"/ws_timeout_hibernate", ws_timeout_hibernate, []},
{"/ws_timeout_cancel", ws_timeout_cancel, []},
{"/ws_max_frame_size", ws_max_frame_size, []},
{"/ws_deflate_opts", ws_deflate_opts_h, []}
{"/ws_deflate_opts", ws_deflate_opts_h, []},
{"/ws_dont_validate_utf8", ws_dont_validate_utf8_h, []}
]}
]).
@ -304,6 +305,16 @@ do_ws_deflate_opts_z(Path, Config) ->
{error, closed} = gen_tcp:recv(Socket, 0, 6000),
ok.
ws_dont_validate_utf8(Config) ->
doc("Handler is configured with UTF-8 validation disabled."),
{ok, Socket, _} = do_handshake("/ws_dont_validate_utf8", Config),
%% Send an invalid UTF-8 text frame and receive it back.
Mask = 16#37fa213d,
MaskedInvalid = do_mask(<<255, 255, 255, 255>>, Mask, <<>>),
ok = gen_tcp:send(Socket, <<1:1, 0:3, 1:4, 1:1, 4:7, Mask:32, MaskedInvalid/binary>>),
{ok, <<1:1, 0:3, 1:4, 0:1, 4:7, 255, 255, 255, 255>>} = gen_tcp:recv(Socket, 0, 6000),
ok.
ws_first_frame_with_handshake(Config) ->
doc("Client sends the first frame immediately with the handshake. "
"This is invalid according to the protocol but we still want "