mirror of
https://github.com/processone/ejabberd.git
synced 2024-06-02 21:17:12 +02:00
672c2f75d3
If set to `true`, all incoming XML packets are fully validated against known schemas. If an error occurs, the packet will be bounced with the corresponding error reason. The default value is `false`. The option might be useful to protect client software from sofisticated bugs related to XML validation as well as for client developers who want to catch validation errors at early stage of development. Note that the option might have slight performance impact, so use it with care on loaded machines.
385 lines
14 KiB
Erlang
385 lines
14 KiB
Erlang
%%%-------------------------------------------------------------------
|
|
%%% Created : 12 Dec 2016 by Evgeny Khramtsov <ekhramtsov@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2018 ProcessOne
|
|
%%%
|
|
%%% This program is free software; you can redistribute it and/or
|
|
%%% modify it under the terms of the GNU General Public License as
|
|
%%% published by the Free Software Foundation; either version 2 of the
|
|
%%% License, or (at your option) any later version.
|
|
%%%
|
|
%%% This program is distributed in the hope that it will be useful,
|
|
%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
%%% General Public License for more details.
|
|
%%%
|
|
%%% You should have received a copy of the GNU General Public License along
|
|
%%% with this program; if not, write to the Free Software Foundation, Inc.,
|
|
%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
%%%
|
|
%%%-------------------------------------------------------------------
|
|
-module(ejabberd_s2s_in).
|
|
-behaviour(xmpp_stream_in).
|
|
-behaviour(xmpp_socket).
|
|
|
|
%% xmpp_socket callbacks
|
|
-export([start/2, start_link/2, socket_type/0]).
|
|
%% ejabberd_listener callbacks
|
|
-export([listen_opt_type/1]).
|
|
%% xmpp_stream_in callbacks
|
|
-export([init/1, handle_call/3, handle_cast/2,
|
|
handle_info/2, terminate/2, code_change/3]).
|
|
-export([tls_options/1, tls_required/1, tls_verify/1, tls_enabled/1,
|
|
compress_methods/1,
|
|
unauthenticated_stream_features/1, authenticated_stream_features/1,
|
|
handle_stream_start/2, handle_stream_end/2,
|
|
handle_stream_established/1, handle_auth_success/4,
|
|
handle_auth_failure/4, handle_send/3, handle_recv/3, handle_cdata/2,
|
|
handle_unauthenticated_packet/2, handle_authenticated_packet/2]).
|
|
%% Hooks
|
|
-export([handle_unexpected_info/2, handle_unexpected_cast/2,
|
|
reject_unauthenticated_packet/2, process_closed/2]).
|
|
%% API
|
|
-export([stop/1, close/1, close/2, send/2, update_state/2, establish/1,
|
|
host_up/1, host_down/1]).
|
|
|
|
-include("ejabberd.hrl").
|
|
-include("xmpp.hrl").
|
|
-include("logger.hrl").
|
|
|
|
-type state() :: map().
|
|
-export_type([state/0]).
|
|
|
|
%%%===================================================================
|
|
%%% API
|
|
%%%===================================================================
|
|
start(SockData, Opts) ->
|
|
case proplists:get_value(supervisor, Opts, true) of
|
|
true ->
|
|
case supervisor:start_child(ejabberd_s2s_in_sup, [SockData, Opts]) of
|
|
{ok, undefined} -> ignore;
|
|
Res -> Res
|
|
end;
|
|
_ ->
|
|
xmpp_stream_in:start(?MODULE, [SockData, Opts],
|
|
ejabberd_config:fsm_limit_opts(Opts))
|
|
end.
|
|
|
|
start_link(SockData, Opts) ->
|
|
xmpp_stream_in:start_link(?MODULE, [SockData, Opts],
|
|
ejabberd_config:fsm_limit_opts(Opts)).
|
|
|
|
close(Ref) ->
|
|
xmpp_stream_in:close(Ref).
|
|
|
|
close(Ref, Reason) ->
|
|
xmpp_stream_in:close(Ref, Reason).
|
|
|
|
stop(Ref) ->
|
|
xmpp_stream_in:stop(Ref).
|
|
|
|
socket_type() ->
|
|
xml_stream.
|
|
|
|
-spec send(pid(), xmpp_element()) -> ok;
|
|
(state(), xmpp_element()) -> state().
|
|
send(Stream, Pkt) ->
|
|
xmpp_stream_in:send(Stream, Pkt).
|
|
|
|
-spec establish(state()) -> state().
|
|
establish(State) ->
|
|
xmpp_stream_in:establish(State).
|
|
|
|
-spec update_state(pid(), fun((state()) -> state()) |
|
|
{module(), atom(), list()}) -> ok.
|
|
update_state(Ref, Callback) ->
|
|
xmpp_stream_in:cast(Ref, {update_state, Callback}).
|
|
|
|
-spec host_up(binary()) -> ok.
|
|
host_up(Host) ->
|
|
ejabberd_hooks:add(s2s_in_closed, Host, ?MODULE,
|
|
process_closed, 100),
|
|
ejabberd_hooks:add(s2s_in_unauthenticated_packet, Host, ?MODULE,
|
|
reject_unauthenticated_packet, 100),
|
|
ejabberd_hooks:add(s2s_in_handle_info, Host, ?MODULE,
|
|
handle_unexpected_info, 100),
|
|
ejabberd_hooks:add(s2s_in_handle_cast, Host, ?MODULE,
|
|
handle_unexpected_cast, 100).
|
|
|
|
-spec host_down(binary()) -> ok.
|
|
host_down(Host) ->
|
|
ejabberd_hooks:delete(s2s_in_closed, Host, ?MODULE,
|
|
process_closed, 100),
|
|
ejabberd_hooks:delete(s2s_in_unauthenticated_packet, Host, ?MODULE,
|
|
reject_unauthenticated_packet, 100),
|
|
ejabberd_hooks:delete(s2s_in_handle_info, Host, ?MODULE,
|
|
handle_unexpected_info, 100),
|
|
ejabberd_hooks:delete(s2s_in_handle_cast, Host, ?MODULE,
|
|
handle_unexpected_cast, 100).
|
|
|
|
%%%===================================================================
|
|
%%% Hooks
|
|
%%%===================================================================
|
|
handle_unexpected_info(State, Info) ->
|
|
?WARNING_MSG("got unexpected info: ~p", [Info]),
|
|
State.
|
|
|
|
handle_unexpected_cast(State, Msg) ->
|
|
?WARNING_MSG("got unexpected cast: ~p", [Msg]),
|
|
State.
|
|
|
|
reject_unauthenticated_packet(State, _Pkt) ->
|
|
Err = xmpp:serr_not_authorized(),
|
|
send(State, Err).
|
|
|
|
process_closed(State, _Reason) ->
|
|
stop(State).
|
|
|
|
%%%===================================================================
|
|
%%% xmpp_stream_in callbacks
|
|
%%%===================================================================
|
|
tls_options(#{tls_options := TLSOpts, server_host := LServer}) ->
|
|
ejabberd_s2s:tls_options(LServer, TLSOpts).
|
|
|
|
tls_required(#{server_host := LServer}) ->
|
|
ejabberd_s2s:tls_required(LServer).
|
|
|
|
tls_verify(#{server_host := LServer}) ->
|
|
ejabberd_s2s:tls_verify(LServer).
|
|
|
|
tls_enabled(#{server_host := LServer}) ->
|
|
ejabberd_s2s:tls_enabled(LServer).
|
|
|
|
compress_methods(#{server_host := LServer}) ->
|
|
case ejabberd_s2s:zlib_enabled(LServer) of
|
|
true -> [<<"zlib">>];
|
|
false -> []
|
|
end.
|
|
|
|
unauthenticated_stream_features(#{server_host := LServer}) ->
|
|
ejabberd_hooks:run_fold(s2s_in_pre_auth_features, LServer, [], [LServer]).
|
|
|
|
authenticated_stream_features(#{server_host := LServer}) ->
|
|
ejabberd_hooks:run_fold(s2s_in_post_auth_features, LServer, [], [LServer]).
|
|
|
|
handle_stream_start(_StreamStart, #{lserver := LServer} = State) ->
|
|
case check_to(jid:make(LServer), State) of
|
|
false ->
|
|
send(State, xmpp:serr_host_unknown());
|
|
true ->
|
|
ServerHost = ejabberd_router:host_of_route(LServer),
|
|
Opts = ejabberd_config:codec_options(LServer),
|
|
State#{server_host => ServerHost, codec_options => Opts}
|
|
end.
|
|
|
|
handle_stream_end(Reason, #{server_host := LServer} = State) ->
|
|
State1 = State#{stop_reason => Reason},
|
|
ejabberd_hooks:run_fold(s2s_in_closed, LServer, State1, [Reason]).
|
|
|
|
handle_stream_established(State) ->
|
|
set_idle_timeout(State#{established => true}).
|
|
|
|
handle_auth_success(RServer, Mech, _AuthModule,
|
|
#{socket := Socket, ip := IP,
|
|
auth_domains := AuthDomains,
|
|
server_host := ServerHost,
|
|
lserver := LServer} = State) ->
|
|
?INFO_MSG("(~s) Accepted inbound s2s ~s authentication ~s -> ~s (~s)",
|
|
[xmpp_socket:pp(Socket), Mech, RServer, LServer,
|
|
ejabberd_config:may_hide_data(misc:ip_to_list(IP))]),
|
|
State1 = case ejabberd_s2s:allow_host(ServerHost, RServer) of
|
|
true ->
|
|
AuthDomains1 = sets:add_element(RServer, AuthDomains),
|
|
State0 = change_shaper(State, RServer),
|
|
State0#{auth_domains => AuthDomains1};
|
|
false ->
|
|
State
|
|
end,
|
|
ejabberd_hooks:run_fold(s2s_in_auth_result, ServerHost, State1, [true, RServer]).
|
|
|
|
handle_auth_failure(RServer, Mech, Reason,
|
|
#{socket := Socket, ip := IP,
|
|
server_host := ServerHost,
|
|
lserver := LServer} = State) ->
|
|
?INFO_MSG("(~s) Failed inbound s2s ~s authentication ~s -> ~s (~s): ~s",
|
|
[xmpp_socket:pp(Socket), Mech, RServer, LServer,
|
|
ejabberd_config:may_hide_data(misc:ip_to_list(IP)), Reason]),
|
|
ejabberd_hooks:run_fold(s2s_in_auth_result,
|
|
ServerHost, State, [false, RServer]).
|
|
|
|
handle_unauthenticated_packet(Pkt, #{server_host := LServer} = State) ->
|
|
ejabberd_hooks:run_fold(s2s_in_unauthenticated_packet,
|
|
LServer, State, [Pkt]).
|
|
|
|
handle_authenticated_packet(Pkt, #{server_host := LServer} = State) when not ?is_stanza(Pkt) ->
|
|
ejabberd_hooks:run_fold(s2s_in_authenticated_packet, LServer, State, [Pkt]);
|
|
handle_authenticated_packet(Pkt0, #{ip := {IP, _}} = State) ->
|
|
Pkt = xmpp:put_meta(Pkt0, ip, IP),
|
|
From = xmpp:get_from(Pkt),
|
|
To = xmpp:get_to(Pkt),
|
|
case check_from_to(From, To, State) of
|
|
ok ->
|
|
LServer = ejabberd_router:host_of_route(To#jid.lserver),
|
|
State1 = ejabberd_hooks:run_fold(s2s_in_authenticated_packet,
|
|
LServer, State, [Pkt]),
|
|
{Pkt1, State2} = ejabberd_hooks:run_fold(s2s_receive_packet, LServer,
|
|
{Pkt, State1}, []),
|
|
case Pkt1 of
|
|
drop -> ok;
|
|
_ -> ejabberd_router:route(Pkt1)
|
|
end,
|
|
State2;
|
|
{error, Err} ->
|
|
send(State, Err)
|
|
end.
|
|
|
|
handle_cdata(Data, #{server_host := LServer} = State) ->
|
|
ejabberd_hooks:run_fold(s2s_in_handle_cdata, LServer, State, [Data]).
|
|
|
|
handle_recv(El, Pkt, #{server_host := LServer} = State) ->
|
|
State1 = set_idle_timeout(State),
|
|
ejabberd_hooks:run_fold(s2s_in_handle_recv, LServer, State1, [El, Pkt]).
|
|
|
|
handle_send(Pkt, Result, #{server_host := LServer} = State) ->
|
|
ejabberd_hooks:run_fold(s2s_in_handle_send, LServer,
|
|
State, [Pkt, Result]).
|
|
|
|
init([State, Opts]) ->
|
|
Shaper = proplists:get_value(shaper, Opts, none),
|
|
TLSOpts1 = lists:filter(
|
|
fun({certfile, _}) -> true;
|
|
({ciphers, _}) -> true;
|
|
({dhfile, _}) -> true;
|
|
({cafile, _}) -> true;
|
|
({protocol_options, _}) -> true;
|
|
(_) -> false
|
|
end, Opts),
|
|
TLSOpts2 = case proplists:get_bool(tls_compression, Opts) of
|
|
false -> [compression_none | TLSOpts1];
|
|
true -> TLSOpts1
|
|
end,
|
|
State1 = State#{tls_options => TLSOpts2,
|
|
auth_domains => sets:new(),
|
|
xmlns => ?NS_SERVER,
|
|
lang => ?MYLANG,
|
|
server => ?MYNAME,
|
|
lserver => ?MYNAME,
|
|
server_host => ?MYNAME,
|
|
established => false,
|
|
shaper => Shaper},
|
|
ejabberd_hooks:run_fold(s2s_in_init, {ok, State1}, [Opts]).
|
|
|
|
handle_call(Request, From, #{server_host := LServer} = State) ->
|
|
ejabberd_hooks:run_fold(s2s_in_handle_call, LServer, State, [Request, From]).
|
|
|
|
handle_cast({update_state, Fun}, State) ->
|
|
case Fun of
|
|
{M, F, A} -> erlang:apply(M, F, [State|A]);
|
|
_ when is_function(Fun) -> Fun(State)
|
|
end;
|
|
handle_cast(Msg, #{server_host := LServer} = State) ->
|
|
ejabberd_hooks:run_fold(s2s_in_handle_cast, LServer, State, [Msg]).
|
|
|
|
handle_info(Info, #{server_host := LServer} = State) ->
|
|
ejabberd_hooks:run_fold(s2s_in_handle_info, LServer, State, [Info]).
|
|
|
|
terminate(Reason, #{auth_domains := AuthDomains,
|
|
socket := Socket} = State) ->
|
|
case maps:get(stop_reason, State, undefined) of
|
|
{tls, _} = Err ->
|
|
?WARNING_MSG("(~s) Failed to secure inbound s2s connection: ~s",
|
|
[xmpp_socket:pp(Socket), xmpp_stream_in:format_error(Err)]);
|
|
_ ->
|
|
ok
|
|
end,
|
|
case Reason of
|
|
{process_limit, _} ->
|
|
sets:fold(
|
|
fun(Host, _) ->
|
|
ejabberd_s2s:external_host_overloaded(Host)
|
|
end, ok, AuthDomains);
|
|
_ ->
|
|
ok
|
|
end.
|
|
|
|
code_change(_OldVsn, State, _Extra) ->
|
|
{ok, State}.
|
|
|
|
%%%===================================================================
|
|
%%% Internal functions
|
|
%%%===================================================================
|
|
-spec check_from_to(jid(), jid(), state()) -> ok | {error, stream_error()}.
|
|
check_from_to(From, To, State) ->
|
|
case check_from(From, State) of
|
|
true ->
|
|
case check_to(To, State) of
|
|
true ->
|
|
ok;
|
|
false ->
|
|
{error, xmpp:serr_host_unknown()}
|
|
end;
|
|
false ->
|
|
{error, xmpp:serr_invalid_from()}
|
|
end.
|
|
|
|
-spec check_from(jid(), state()) -> boolean().
|
|
check_from(#jid{lserver = S1}, #{auth_domains := AuthDomains}) ->
|
|
sets:is_element(S1, AuthDomains).
|
|
|
|
-spec check_to(jid(), state()) -> boolean().
|
|
check_to(#jid{lserver = LServer}, _State) ->
|
|
ejabberd_router:is_my_route(LServer).
|
|
|
|
-spec set_idle_timeout(state()) -> state().
|
|
set_idle_timeout(#{server_host := LServer,
|
|
established := true} = State) ->
|
|
Timeout = ejabberd_s2s:get_idle_timeout(LServer),
|
|
xmpp_stream_in:set_timeout(State, Timeout);
|
|
set_idle_timeout(State) ->
|
|
State.
|
|
|
|
-spec change_shaper(state(), binary()) -> state().
|
|
change_shaper(#{shaper := ShaperName, server_host := ServerHost} = State,
|
|
RServer) ->
|
|
Shaper = acl:match_rule(ServerHost, ShaperName, jid:make(RServer)),
|
|
xmpp_stream_in:change_shaper(State, Shaper).
|
|
|
|
-spec listen_opt_type(shaper) -> fun((any()) -> any());
|
|
(certfile) -> fun((binary()) -> binary());
|
|
(ciphers) -> fun((binary()) -> binary());
|
|
(dhfile) -> fun((binary()) -> binary());
|
|
(cafile) -> fun((binary()) -> binary());
|
|
(protocol_options) -> fun(([binary()]) -> binary());
|
|
(tls_compression) -> fun((boolean()) -> boolean());
|
|
(tls) -> fun((boolean()) -> boolean());
|
|
(supervisor) -> fun((boolean()) -> boolean());
|
|
(max_stanza_type) -> fun((timeout()) -> timeout());
|
|
(max_fsm_queue) -> fun((pos_integer()) -> pos_integer());
|
|
(atom()) -> [atom()].
|
|
listen_opt_type(shaper) -> fun acl:shaper_rules_validator/1;
|
|
listen_opt_type(certfile = Opt) ->
|
|
fun(S) ->
|
|
?WARNING_MSG("Listening option '~s' for ~s is deprecated, use "
|
|
"'certfiles' global option instead", [Opt, ?MODULE]),
|
|
ejabberd_pkix:add_certfile(S),
|
|
iolist_to_binary(S)
|
|
end;
|
|
listen_opt_type(ciphers) -> ejabberd_s2s:opt_type(s2s_ciphers);
|
|
listen_opt_type(dhfile) -> ejabberd_s2s:opt_type(s2s_dhfile);
|
|
listen_opt_type(cafile) -> ejabberd_s2s:opt_type(s2s_cafile);
|
|
listen_opt_type(protocol_options) -> ejabberd_s2s:opt_type(s2s_protocol_options);
|
|
listen_opt_type(tls_compression) -> ejabberd_s2s:opt_type(s2s_tls_compression);
|
|
listen_opt_type(tls) -> fun(B) when is_boolean(B) -> B end;
|
|
listen_opt_type(supervisor) -> fun(B) when is_boolean(B) -> B end;
|
|
listen_opt_type(max_stanza_size) ->
|
|
fun(I) when is_integer(I), I>0 -> I;
|
|
(unlimited) -> infinity;
|
|
(infinity) -> infinity
|
|
end;
|
|
listen_opt_type(max_fsm_queue) ->
|
|
fun(I) when is_integer(I), I>0 -> I end;
|
|
listen_opt_type(_) ->
|
|
[shaper, certfile, ciphers, dhfile, cafile, protocol_options,
|
|
tls_compression, tls, max_fsm_queue].
|