%%%---------------------------------------------------------------------- %%% File : ejabberd_websocket.erl %%% Author : Eric Cestari %%% Purpose : XMPP Websocket support %%% Created : 09-10-2010 by Eric Cestari %%% %%% Some code lifted from MISULTIN - WebSocket misultin_websocket.erl - >-|-|-(°> %%% (http://github.com/ostinelli/misultin/blob/master/src/misultin_websocket.erl) %%% Copyright (C) 2010, Roberto Ostinelli , Joe Armstrong. %%% All rights reserved. %%% %%% Code portions from Joe Armstrong have been originally taken under MIT license at the address: %%% %%% %%% BSD License %%% %%% Redistribution and use in source and binary forms, with or without modification, are permitted provided %%% that the following conditions are met: %%% %%% * Redistributions of source code must retain the above copyright notice, this list of conditions and the %%% following disclaimer. %%% * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and %%% the following disclaimer in the documentation and/or other materials provided with the distribution. %%% * Neither the name of the authors nor the names of its contributors may be used to endorse or promote %%% products derived from this software without specific prior written permission. %%% %%% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED %%% WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A %%% PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR %%% ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED %%% TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) %%% HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING %%% NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE %%% POSSIBILITY OF SUCH DAMAGE. %%% ========================================================================================================== %%% ejabberd, Copyright (C) 2002-2024 ProcessOne %%%---------------------------------------------------------------------- -module(ejabberd_websocket). -protocol({rfc, 6455}). -protocol({rfc, 7395}). -author('ecestari@process-one.net'). -export([socket_handoff/5]). -include("logger.hrl"). -include_lib("xmpp/include/xmpp.hrl"). -include("ejabberd_http.hrl"). -define(CT_XML, {<<"Content-Type">>, <<"text/xml; charset=utf-8">>}). -define(CT_PLAIN, {<<"Content-Type">>, <<"text/plain">>}). -define(AC_ALLOW_ORIGIN, {<<"Access-Control-Allow-Origin">>, <<"*">>}). -define(AC_ALLOW_METHODS, {<<"Access-Control-Allow-Methods">>, <<"GET, OPTIONS">>}). -define(AC_ALLOW_HEADERS, {<<"Access-Control-Allow-Headers">>, <<"Content-Type">>}). -define(AC_MAX_AGE, {<<"Access-Control-Max-Age">>, <<"86400">>}). -define(OPTIONS_HEADER, [?CT_PLAIN, ?AC_ALLOW_ORIGIN, ?AC_ALLOW_METHODS, ?AC_ALLOW_HEADERS, ?AC_MAX_AGE]). -define(HEADER, [?CT_XML, ?AC_ALLOW_ORIGIN, ?AC_ALLOW_HEADERS]). is_valid_websocket_upgrade(_Path, Headers) -> HeadersToValidate = [{'Upgrade', <<"websocket">>}, {'Connection', ignore}, {'Host', ignore}, {<<"Sec-Websocket-Key">>, ignore}, {<<"Sec-Websocket-Version">>, <<"13">>}], Res = lists:all( fun({Tag, Val}) -> case lists:keyfind(Tag, 1, Headers) of false -> false; {_, _} when Val == ignore -> true; {_, HVal} -> str:to_lower(HVal) == Val end end, HeadersToValidate), case {Res, lists:keyfind(<<"Origin">>, 1, Headers), get_origin()} of {false, _, _} -> false; {true, _, []} -> true; {true, {_, HVal}, Origins} -> HValLow = str:to_lower(HVal), case lists:any(fun(V) -> V == HValLow end, Origins) of true -> true; _ -> invalid_origin end; {true, false, _} -> true end. socket_handoff(LocalPath, #request{method = 'GET', ip = IP, q = Q, path = Path, headers = Headers, host = Host, port = Port, socket = Socket, sockmod = SockMod, data = Buf, opts = HOpts}, _Opts, HandlerModule, InfoMsgFun) -> case is_valid_websocket_upgrade(LocalPath, Headers) of true -> WS = #ws{socket = Socket, sockmod = SockMod, ip = IP, q = Q, host = Host, port = Port, path = Path, headers = Headers, local_path = LocalPath, buf = Buf, http_opts = HOpts}, connect(WS, HandlerModule); false -> {200, ?HEADER, InfoMsgFun()}; invalid_origin -> {403, ?HEADER, #xmlel{name = <<"h1">>, children = [{xmlcdata, <<"403 Bad Request - Invalid origin">>}]}} end; socket_handoff(_, #request{method = 'OPTIONS'}, _, _, _) -> {200, ?OPTIONS_HEADER, []}; socket_handoff(_, #request{method = 'HEAD'}, _, _, _) -> {200, ?HEADER, []}; socket_handoff(_, _, _, _, _) -> {400, ?HEADER, #xmlel{name = <<"h1">>, children = [{xmlcdata, <<"400 Bad Request">>}]}}. connect(#ws{socket = Socket, sockmod = SockMod} = Ws, WsLoop) -> {NewWs, HandshakeResponse} = handshake(Ws), SockMod:send(Socket, HandshakeResponse), ?DEBUG("Sent handshake response : ~p", [HandshakeResponse]), Ws0 = {Ws, self()}, {ok, WsHandleLoopPid} = WsLoop:start_link(Ws0), erlang:monitor(process, WsHandleLoopPid), case NewWs#ws.buf of <<>> -> ok; Data -> self() ! {raw, Socket, Data} end, % set opts case SockMod of gen_tcp -> inet:setopts(Socket, [{packet, 0}, {active, true}]); _ -> SockMod:setopts(Socket, [{packet, 0}, {active, true}]) end, ws_loop(ejabberd_websocket_codec:new_server(), Socket, WsHandleLoopPid, SockMod, none). handshake(#ws{headers = Headers} = State) -> {_, Key} = lists:keyfind(<<"Sec-Websocket-Key">>, 1, Headers), SubProtocolHeader = case find_subprotocol(Headers) of false -> []; V -> [<<"Sec-Websocket-Protocol:">>, V, <<"\r\n">>] end, Hash = base64:encode( crypto:hash(sha, <>)), {State, [<<"HTTP/1.1 101 Switching Protocols\r\n">>, <<"Upgrade: websocket\r\n">>, <<"Connection: Upgrade\r\n">>, SubProtocolHeader, <<"Sec-WebSocket-Accept: ">>, Hash, <<"\r\n\r\n">>]}. find_subprotocol(Headers) -> case lists:keysearch(<<"Sec-Websocket-Protocol">>, 1, Headers) of false -> case lists:keysearch(<<"Websocket-Protocol">>, 1, Headers) of false -> false; {value, {_, Protocol2}} -> Protocol2 end; {value, {_, Protocol}} -> Protocol end. ws_loop(Codec, Socket, WsHandleLoopPid, SockMod, Shaper) -> receive {DataType, _Socket, Data} when DataType =:= tcp orelse DataType =:= raw -> case handle_data(DataType, Codec, Data, Socket, WsHandleLoopPid, SockMod, Shaper) of {error, tls, Error} -> ?DEBUG("TLS decode error ~p", [Error]), websocket_close(Codec, Socket, WsHandleLoopPid, SockMod, 1002); % protocol error {error, protocol, Error} -> ?DEBUG("Websocket decode error ~p", [Error]), websocket_close(Codec, Socket, WsHandleLoopPid, SockMod, 1002); % protocol error {NewCodec, ToSend, NewShaper} -> lists:foreach(fun(Pkt) -> SockMod:send(Socket, Pkt) end, ToSend), ws_loop(NewCodec, Socket, WsHandleLoopPid, SockMod, NewShaper) end; {new_shaper, NewShaper} -> NewShaper = case NewShaper of none when Shaper /= none -> activate(Socket, SockMod, true), none; _ -> NewShaper end, ws_loop(Codec, Socket, WsHandleLoopPid, SockMod, NewShaper); {tcp_closed, _Socket} -> ?DEBUG("TCP connection was closed, exit", []), websocket_close(Codec, Socket, WsHandleLoopPid, SockMod, 0); {tcp_error, Socket, Reason} -> ?DEBUG("TCP connection error: ~ts", [inet:format_error(Reason)]), websocket_close(Codec, Socket, WsHandleLoopPid, SockMod, 0); {'DOWN', Ref, process, WsHandleLoopPid, Reason} -> Code = case Reason of normal -> 1000; % normal close _ -> ?ERROR_MSG("Linked websocket controlling loop crashed " "with reason: ~p", [Reason]), 1011 % internal error end, erlang:demonitor(Ref), websocket_close(Codec, Socket, WsHandleLoopPid, SockMod, Code); {text_with_reply, Data, Sender} -> SockMod:send(Socket, ejabberd_websocket_codec:encode(Codec, 1, Data)), Sender ! {text_reply, self()}, ws_loop(Codec, Socket, WsHandleLoopPid, SockMod, Shaper); {data_with_reply, Data, Sender} -> SockMod:send(Socket, ejabberd_websocket_codec:encode(Codec, 2, Data)), Sender ! {data_reply, self()}, ws_loop(Codec, Socket, WsHandleLoopPid, SockMod, Shaper); {text, Data} -> SockMod:send(Socket, ejabberd_websocket_codec:encode(Codec, 1, Data)), ws_loop(Codec, Socket, WsHandleLoopPid, SockMod, Shaper); {data, Data} -> SockMod:send(Socket, ejabberd_websocket_codec:encode(Codec, 2, Data)), ws_loop(Codec, Socket, WsHandleLoopPid, SockMod, Shaper); {ping, Data} -> SockMod:send(Socket, ejabberd_websocket_codec:encode(Codec, 9, Data)), ws_loop(Codec, Socket, WsHandleLoopPid, SockMod, Shaper); shutdown -> ?DEBUG("Shutdown request received, closing websocket " "with pid ~p", [self()]), websocket_close(Codec, Socket, WsHandleLoopPid, SockMod, 1001); % going away _Ignored -> ?WARNING_MSG("Received unexpected message, ignoring: ~p", [_Ignored]), ws_loop(Codec, Socket, WsHandleLoopPid, SockMod, Shaper) end. handle_data(tcp, Codec, Data, Socket, WsHandleLoopPid, fast_tls, Shaper) -> case fast_tls:recv_data(Socket, Data) of {ok, NewData} -> handle_data_int(Codec, NewData, Socket, WsHandleLoopPid, fast_tls, Shaper); {error, Error} -> {error, tls, Error} end; handle_data(_, Codec, Data, Socket, WsHandleLoopPid, SockMod, Shaper) -> handle_data_int(Codec, Data, Socket, WsHandleLoopPid, SockMod, Shaper). handle_data_int(Codec, Data, Socket, WsHandleLoopPid, SockMod, Shaper) -> {Type, NewCodec, Recv} = ejabberd_websocket_codec:decode(Codec, Data), Send = lists:filtermap( fun({Op, Payload}) when Op == 1; Op == 2 -> WsHandleLoopPid ! {received, Payload}, false; ({8, Payload}) -> CloseCode = case Payload of <> -> ?DEBUG("WebSocket close op: ~p ~ts", [Code, Message]), Code; <> -> ?DEBUG("WebSocket close op: ~p", [Code]), Code; _ -> ?DEBUG("WebSocket close op unknown: ~p", [Payload]), 1000 end, Frame = ejabberd_websocket_codec:encode(Codec, 8, <>), {true, Frame}; ({9, Payload}) -> WsHandleLoopPid ! ping, Frame = ejabberd_websocket_codec:encode(Codec, 10, Payload), {true, Frame}; ({10, _Payload}) -> WsHandleLoopPid ! pong, false end, Recv), case Type of error -> {error, protocol, NewCodec}; _ -> {NewCodec, Send, handle_shaping(Data, Socket, SockMod, Shaper)} end. websocket_close(Codec, Socket, WsHandleLoopPid, SockMod, CloseCode) when CloseCode > 0 -> Frame = ejabberd_websocket_codec:encode(Codec, 8, <>), SockMod:send(Socket, Frame), websocket_close(Codec, Socket, WsHandleLoopPid, SockMod, 0); websocket_close(_Codec, Socket, WsHandleLoopPid, SockMod, _CloseCode) -> WsHandleLoopPid ! closed, SockMod:close(Socket). get_origin() -> ejabberd_option:websocket_origin(). handle_shaping(_Data, _Socket, _SockMod, none) -> none; handle_shaping(Data, Socket, SockMod, Shaper) -> {NewShaper, Pause} = ejabberd_shaper:update(Shaper, byte_size(Data)), if Pause > 0 -> activate_after(Socket, self(), Pause); true -> activate(Socket, SockMod, once) end, NewShaper. activate(Socket, SockMod, ActiveState) -> case SockMod of gen_tcp -> inet:setopts(Socket, [{active, ActiveState}]); _ -> SockMod:setopts(Socket, [{active, ActiveState}]) end. activate_after(Socket, Pid, Pause) -> if Pause > 0 -> erlang:send_after(Pause, Pid, {tcp, Socket, <<>>}); true -> Pid ! {tcp, Socket, <<>>} end, ok.