processone / ejabberd / 747

Committed 27 Jun 2024 01:43PM UTC coverage: 32.123% (+0.8%) from 31.276%

Build # 747

Build Type

push

github

Committed by

badlop

Commit Message

Set version to 24.06

Run Details

14119 of 43953 relevant lines covered (32.12%)

614.73 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/mod_privilege.erl

%%%-------------------------------------------------------------------
%%% File    : mod_privilege.erl
%%% Author  : Anna Mukharram <amuhar3@gmail.com>
%%% Purpose : XEP-0356: Privileged Entity
%%%
%%%
%%% ejabberd, Copyright (C) 2002-2024   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(mod_privilege).

-author('amuhar3@gmail.com').

-protocol({xep, 356, '0.2.1', '16.09', "", ""}).

-behaviour(gen_server).
-behaviour(gen_mod).

%% API
-export([start/2, stop/1, reload/3, mod_opt_type/1, mod_options/1, depends/2]).
-export([mod_doc/0]).
%% gen_server callbacks
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
         terminate/2, code_change/3]).
-export([component_connected/1, component_disconnected/2,
         roster_access/2, process_message/1,
         process_presence_out/1, process_presence_in/1]).

-include("logger.hrl").
-include_lib("xmpp/include/xmpp.hrl").
-include("translate.hrl").

-type roster_permission() :: both | get | set.
-type presence_permission() :: managed_entity | roster.
-type message_permission() :: outgoing.
-type roster_permissions() :: [{roster_permission(), acl:acl()}].
-type presence_permissions() :: [{presence_permission(), acl:acl()}].
-type message_permissions() :: [{message_permission(), acl:acl()}].
-type access() :: [{roster, roster_permissions()} |
                   {presence, presence_permissions()} |
                   {message, message_permissions()}].
-type permissions() :: #{binary() => access()}.
-record(state, {server_host = <<"">> :: binary()}).

%%%===================================================================
%%% API
%%%===================================================================
start(Host, Opts) ->
    gen_mod:start_child(?MODULE, Host, Opts).

stop(Host) ->
    gen_mod:stop_child(?MODULE, Host).

reload(_Host, _NewOpts, _OldOpts) ->
    ok.

mod_opt_type(roster) ->
    econf:options(
      #{both => econf:acl(), get => econf:acl(), set => econf:acl()});
mod_opt_type(message) ->
    econf:options(
      #{outgoing => econf:acl()});
mod_opt_type(presence) ->
    econf:options(
      #{managed_entity => econf:acl(), roster => econf:acl()}).

mod_options(_) ->
    [{roster, [{both, none}, {get, none}, {set, none}]},
     {presence, [{managed_entity, none}, {roster, none}]},
     {message, [{outgoing,none}]}].

mod_doc() ->
    #{desc =>
          [?T("This module is an implementation of "
              "https://xmpp.org/extensions/xep-0356.html"
              "[XEP-0356: Privileged Entity]. This extension "
              "allows components to have privileged access to "
              "other entity data (send messages on behalf of the "
              "server or on behalf of a user, get/set user roster, "
              "access presence information, etc.). This may be used "
              "to write powerful external components, for example "
              "implementing an external "
              "https://xmpp.org/extensions/xep-0163.html[PEP] or "
              "https://xmpp.org/extensions/xep-0313.html[MAM] service."), "",
           ?T("By default a component does not have any privileged access. "
              "It is worth noting that the permissions grant access to "
              "the component to a specific data type for all users of "
              "the virtual host on which 'mod_privilege' is loaded."), "",
           ?T("Make sure you have a listener configured to connect your "
              "component. Check the section about listening ports for more "
              "information."), "",
           ?T("WARNING: Security issue: Privileged access gives components "
              "access to sensitive data, so permission should be granted "
              "carefully, only if you trust a component."), "",
           ?T("NOTE: This module is complementary to _`mod_delegation`_, "
              "but can also be used separately.")],
      opts =>
          [{roster,
            #{value => ?T("Options"),
              desc =>
                  ?T("This option defines roster permissions. "
                     "By default no permissions are given. "
                     "The 'Options' are:")},
            [{both,
              #{value => ?T("AccessName"),
                desc =>
                    ?T("Sets read/write access to a user's roster. "
                       "The default value is 'none'.")}},
             {get,
              #{value => ?T("AccessName"),
                desc =>
                    ?T("Sets read access to a user's roster. "
                       "The default value is 'none'.")}},
             {set,
              #{value => ?T("AccessName"),
                desc =>
                    ?T("Sets write access to a user's roster. "
                       "The default value is 'none'.")}}]},
           {message,
            #{value => ?T("Options"),
              desc =>
                  ?T("This option defines permissions for messages. "
                     "By default no permissions are given. "
                     "The 'Options' are:")},
            [{outgoing,
              #{value => ?T("AccessName"),
                desc =>
                    ?T("The option defines an access rule for sending "
                       "outgoing messages by the component. "
                       "The default value is 'none'.")}}]},
           {presence,
            #{value => ?T("Options"),
              desc =>
                  ?T("This option defines permissions for presences. "
                     "By default no permissions are given. "
                     "The 'Options' are:")},
            [{managed_entity,
              #{value => ?T("AccessName"),
                desc =>
                    ?T("An access rule that gives permissions to "
                       "the component to receive server presences. "
                       "The default value is 'none'.")}},
             {roster,
              #{value => ?T("AccessName"),
                desc =>
                    ?T("An access rule that gives permissions to "
                       "the component to receive the presence of both "
                       "the users and the contacts in their roster. "
                       "The default value is 'none'.")}}]}],
      example =>
          ["modules:",
           "  mod_privilege:",
           "    roster:",
           "      get: all",
           "    presence:",
           "      managed_entity: all",
           "    message:",
           "      outgoing: all"]}.

depends(_, _) ->
    [].

-spec component_connected(binary()) -> ok.
component_connected(Host) ->
    lists:foreach(
      fun(ServerHost) ->
              Proc = gen_mod:get_module_proc(ServerHost, ?MODULE),
              gen_server:cast(Proc, {component_connected, Host})
      end, ejabberd_option:hosts()).

-spec component_disconnected(binary(), binary()) -> ok.
component_disconnected(Host, _Reason) ->
    lists:foreach(
      fun(ServerHost) ->
              Proc = gen_mod:get_module_proc(ServerHost, ?MODULE),
              gen_server:cast(Proc, {component_disconnected, Host})
      end, ejabberd_option:hosts()).

-spec process_message(stanza()) -> stop | ok.
process_message(#message{from = #jid{luser = <<"">>, lresource = <<"">>} = From,
                         to = #jid{lresource = <<"">>} = To,
                         lang = Lang, type = T} = Msg) when T /= error ->
    Host = From#jid.lserver,
    ServerHost = To#jid.lserver,
    Permissions = get_permissions(ServerHost),
    case maps:find(Host, Permissions) of
        {ok, Access} ->
            case proplists:get_value(message, Access, none) of
                outgoing ->
                    forward_message(Msg);
                _ ->
                    Txt = ?T("Insufficient privilege"),
                    Err = xmpp:err_forbidden(Txt, Lang),
                    ejabberd_router:route_error(Msg, Err)
            end,
            stop;
        error ->
            %% Component is disconnected
            ok
    end;
process_message(_Stanza) ->
    ok.

-spec roster_access({true, iq()} | false, iq()) -> {true, iq()} | false.
roster_access({true, _IQ} = Acc, _) ->
    Acc;
roster_access(false, #iq{from = From, to = To, type = Type} = IQ) ->
    Host = From#jid.lserver,
    ServerHost = To#jid.lserver,
    Permissions = get_permissions(ServerHost),
    case maps:find(Host, Permissions) of
        {ok, Access} ->
            Permission = proplists:get_value(roster, Access, none),
            case (Permission == both)
                     orelse (Permission == get andalso Type == get)
                     orelse (Permission == set andalso Type == set) of
                true ->
                    {true, xmpp:put_meta(IQ, privilege_from, To)};
                false ->
                    false
            end;
        error ->
            %% Component is disconnected
            false
    end.

-spec process_presence_out({stanza(), ejabberd_c2s:state()}) -> {stanza(), ejabberd_c2s:state()}.
process_presence_out({#presence{
                         from = #jid{luser = LUser, lserver = LServer} = From,
                         to = #jid{luser = LUser, lserver = LServer, lresource = <<"">>},
                         type = Type} = Pres, C2SState})
  when Type == available; Type == unavailable ->
    %% Self-presence processing
    Permissions = get_permissions(LServer),
    lists:foreach(
      fun({Host, Access}) ->
              Permission = proplists:get_value(presence, Access, none),
              if Permission == roster; Permission == managed_entity ->
                      To = jid:make(Host),
                      ejabberd_router:route(
                        xmpp:set_from_to(Pres, From, To));
                 true ->
                      ok
              end
      end, maps:to_list(Permissions)),
    {Pres, C2SState};
process_presence_out(Acc) ->
    Acc.

-spec process_presence_in({stanza(), ejabberd_c2s:state()}) -> {stanza(), ejabberd_c2s:state()}.
process_presence_in({#presence{
                        from = #jid{luser = U, lserver = S} = From,
                        to = #jid{luser = LUser, lserver = LServer},
                        type = Type} = Pres, C2SState})
  when {U, S} /= {LUser, LServer} andalso
       (Type == available orelse Type == unavailable) ->
    Permissions = get_permissions(LServer),
    lists:foreach(
      fun({Host, Access}) ->
              case proplists:get_value(presence, Access, none) of
                  roster ->
                      Permission = proplists:get_value(roster, Access, none),
                      if Permission == both; Permission == get ->
                              To = jid:make(Host),
                              ejabberd_router:route(
                                xmpp:set_from_to(Pres, From, To));
                         true ->
                              ok
                      end;
                 _ ->
                      ok
              end
      end, maps:to_list(Permissions)),
    {Pres, C2SState};
process_presence_in(Acc) ->
    Acc.

%%%===================================================================
%%% gen_server callbacks
%%%===================================================================
init([Host|_]) ->
    process_flag(trap_exit, true),
    catch ets:new(?MODULE,
                  [named_table, public,
                   {heir, erlang:group_leader(), none}]),
    ejabberd_hooks:add(component_connected, ?MODULE,
                       component_connected, 50),
    ejabberd_hooks:add(component_disconnected, ?MODULE,
                       component_disconnected, 50),
    ejabberd_hooks:add(local_send_to_resource_hook, Host, ?MODULE,
                       process_message, 50),
    ejabberd_hooks:add(roster_remote_access, Host, ?MODULE,
                       roster_access, 50),
    ejabberd_hooks:add(user_send_packet, Host, ?MODULE,
                       process_presence_out, 50),
    ejabberd_hooks:add(user_receive_packet, Host, ?MODULE,
                       process_presence_in, 50),
    {ok, #state{server_host = Host}}.

handle_call(Request, From, State) ->
    ?WARNING_MSG("Unexpected call from ~p: ~p", [From, Request]),
    {noreply, State}.

handle_cast({component_connected, Host}, State) ->
    ServerHost = State#state.server_host,
    From = jid:make(ServerHost),
    To = jid:make(Host),
    RosterPerm = get_roster_permission(ServerHost, Host),
    PresencePerm = get_presence_permission(ServerHost, Host),
    MessagePerm = get_message_permission(ServerHost, Host),
    if RosterPerm /= none; PresencePerm /= none; MessagePerm /= none ->
            Priv = #privilege{perms = [#privilege_perm{access = message,
                                                       type = MessagePerm},
                                       #privilege_perm{access = roster,
                                                       type = RosterPerm},
                                       #privilege_perm{access = presence,
                                                       type = PresencePerm}]},
            ?INFO_MSG("Granting permissions to external "
                      "component '~ts': roster = ~ts, presence = ~ts, "
                      "message = ~ts",
                      [Host, RosterPerm, PresencePerm, MessagePerm]),
            Msg = #message{from = From, to = To,  sub_els = [Priv]},
            ejabberd_router:route(Msg),
            Permissions = maps:put(Host, [{roster, RosterPerm},
                                          {presence, PresencePerm},
                                          {message, MessagePerm}],
                                   get_permissions(ServerHost)),
            ets:insert(?MODULE, {ServerHost, Permissions}),
            {noreply, State};
       true ->
            ?INFO_MSG("Granting no permissions to external component '~ts'",
                      [Host]),
            {noreply, State}
    end;
handle_cast({component_disconnected, Host}, State) ->
    ServerHost = State#state.server_host,
    Permissions = maps:remove(Host, get_permissions(ServerHost)),
    case maps:size(Permissions) of
        0 -> ets:delete(?MODULE, ServerHost);
        _ -> ets:insert(?MODULE, {ServerHost, Permissions})
    end,
    {noreply, State};
handle_cast(Msg, State) ->
    ?WARNING_MSG("Unexpected cast: ~p", [Msg]),
    {noreply, State}.

handle_info(Info, State) ->
    ?WARNING_MSG("Unexpected info: ~p", [Info]),
    {noreply, State}.

terminate(_Reason, State) ->
    Host = State#state.server_host,
    case gen_mod:is_loaded_elsewhere(Host, ?MODULE) of
        false ->
            ejabberd_hooks:delete(component_connected, ?MODULE,
                                  component_connected, 50),
            ejabberd_hooks:delete(component_disconnected, ?MODULE,
                                  component_disconnected, 50);
        true ->
            ok
    end,
    ejabberd_hooks:delete(local_send_to_resource_hook, Host, ?MODULE,
                          process_message, 50),
    ejabberd_hooks:delete(roster_remote_access, Host, ?MODULE,
                          roster_access, 50),
    ejabberd_hooks:delete(user_send_packet, Host, ?MODULE,
                          process_presence_out, 50),
    ejabberd_hooks:delete(user_receive_packet, Host, ?MODULE,
                          process_presence_in, 50),
    ets:delete(?MODULE, Host).

code_change(_OldVsn, State, _Extra) ->
    {ok, State}.

%%%===================================================================
%%% Internal functions
%%%===================================================================
-spec get_permissions(binary()) -> permissions().
get_permissions(ServerHost) ->
    try ets:lookup_element(?MODULE, ServerHost, 2)
    catch _:badarg -> #{}
    end.

-spec forward_message(message()) -> ok.
forward_message(#message{to = To} = Msg) ->
    ServerHost = To#jid.lserver,
    Lang = xmpp:get_lang(Msg),
    CodecOpts = ejabberd_config:codec_options(),
    try xmpp:try_subtag(Msg, #privilege{}) of
        #privilege{forwarded = #forwarded{sub_els = [SubEl]}} ->
            try xmpp:decode(SubEl, ?NS_CLIENT, CodecOpts) of
                #message{} = NewMsg ->
                    case NewMsg#message.from of
                        #jid{lresource = <<"">>, lserver = ServerHost} ->
                            FromJID = NewMsg#message.from,
                            State = #{jid => FromJID},
                            ejabberd_hooks:run_fold(user_send_packet, FromJID#jid.lserver, {NewMsg, State}, []),
                            ejabberd_router:route(NewMsg);
                        _ ->
                            Lang = xmpp:get_lang(Msg),
                            Txt = ?T("Invalid 'from' attribute in forwarded message"),
                            Err = xmpp:err_forbidden(Txt, Lang),
                            ejabberd_router:route_error(Msg, Err)
                    end;
                _ ->
                    Txt = ?T("Message not found in forwarded payload"),
                    Err = xmpp:err_bad_request(Txt, Lang),
                    ejabberd_router:route_error(Msg, Err)
            catch _:{xmpp_codec, Why} ->
                    Txt = xmpp:io_format_error(Why),
                    Err = xmpp:err_bad_request(Txt, Lang),
                    ejabberd_router:route_error(Msg, Err)
            end;
        _ ->
            Txt = ?T("No <forwarded/> element found"),
            Err = xmpp:err_bad_request(Txt, Lang),
            ejabberd_router:route_error(Msg, Err)
    catch _:{xmpp_codec, Why} ->
            Txt = xmpp:io_format_error(Why),
            Err = xmpp:err_bad_request(Txt, Lang),
            ejabberd_router:route_error(Msg, Err)
    end.

-spec get_roster_permission(binary(), binary()) -> roster_permission() | none.
get_roster_permission(ServerHost, Host) ->
    Perms = mod_privilege_opt:roster(ServerHost),
    case match_rule(ServerHost, Host, Perms, both) of
        allow ->
            both;
        deny ->
            Get = match_rule(ServerHost, Host, Perms, get),
            Set = match_rule(ServerHost, Host, Perms, set),
            if Get == allow, Set == allow -> both;
               Get == allow -> get;
               Set == allow -> set;
               true -> none
            end
    end.

-spec get_message_permission(binary(), binary()) -> message_permission() | none.
get_message_permission(ServerHost, Host) ->
    Perms = mod_privilege_opt:message(ServerHost),
    case match_rule(ServerHost, Host, Perms, outgoing) of
        allow -> outgoing;
        deny -> none
    end.

-spec get_presence_permission(binary(), binary()) -> presence_permission() | none.
get_presence_permission(ServerHost, Host) ->
    Perms = mod_privilege_opt:presence(ServerHost),
    case match_rule(ServerHost, Host, Perms, roster) of
        allow ->
            roster;
        deny ->
            case match_rule(ServerHost, Host, Perms, managed_entity) of
                allow -> managed_entity;
                deny -> none
            end
    end.

-spec match_rule(binary(), binary(), roster_permissions(), roster_permission()) -> allow | deny;
                (binary(), binary(), presence_permissions(), presence_permission()) -> allow | deny;
                (binary(), binary(), message_permissions(), message_permission()) -> allow | deny.
match_rule(ServerHost, Host, Perms, Type) ->
    Access = proplists:get_value(Type, Perms, none),
    acl:match_rule(ServerHost, Access, jid:make(Host)).

1	%%%-------------------------------------------------------------------
2	%%% File : mod_privilege.erl
3	%%% Author : Anna Mukharram <amuhar3@gmail.com>
4	%%% Purpose : XEP-0356: Privileged Entity
5	%%%
6	%%%
7	%%% ejabberd, Copyright (C) 2002-2024 ProcessOne
8	%%%
9	%%% This program is free software; you can redistribute it and/or
10	%%% modify it under the terms of the GNU General Public License as
11	%%% published by the Free Software Foundation; either version 2 of the
12	%%% License, or (at your option) any later version.
13	%%%
14	%%% This program is distributed in the hope that it will be useful,
15	%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
16	%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17	%%% General Public License for more details.
18	%%%
19	%%% You should have received a copy of the GNU General Public License along
20	%%% with this program; if not, write to the Free Software Foundation, Inc.,
21	%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22	%%%
23	%%%-------------------------------------------------------------------
24	-module(mod_privilege).
25
26	-author('amuhar3@gmail.com').
27
28	-protocol({xep, 356, '0.2.1', '16.09', "", ""}).
29
30	-behaviour(gen_server).
31	-behaviour(gen_mod).
32
33	%% API
34	-export([start/2, stop/1, reload/3, mod_opt_type/1, mod_options/1, depends/2]).
35	-export([mod_doc/0]).
36	%% gen_server callbacks
37	-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
38	terminate/2, code_change/3]).
39	-export([component_connected/1, component_disconnected/2,
40	roster_access/2, process_message/1,
41	process_presence_out/1, process_presence_in/1]).
42
43	-include("logger.hrl").
44	-include_lib("xmpp/include/xmpp.hrl").
45	-include("translate.hrl").
46
47	-type roster_permission() :: both \| get \| set.
48	-type presence_permission() :: managed_entity \| roster.
49	-type message_permission() :: outgoing.
50	-type roster_permissions() :: [{roster_permission(), acl:acl()}].
51	-type presence_permissions() :: [{presence_permission(), acl:acl()}].
52	-type message_permissions() :: [{message_permission(), acl:acl()}].
53	-type access() :: [{roster, roster_permissions()} \|
54	{presence, presence_permissions()} \|
55	{message, message_permissions()}].
56	-type permissions() :: #{binary() => access()}.
57	-record(state, {server_host = <<"">> :: binary()}).
58
59	%%%===================================================================
60	%%% API
61	%%%===================================================================
62	start(Host, Opts) ->
63	gen_mod:start_child(?MODULE, Host, Opts).	×
64
65	stop(Host) ->
66	gen_mod:stop_child(?MODULE, Host).	×
67
68	reload(_Host, _NewOpts, _OldOpts) ->
69	ok.	×
70
71	mod_opt_type(roster) ->
72	econf:options(	×
73	#{both => econf:acl(), get => econf:acl(), set => econf:acl()});
74	mod_opt_type(message) ->
75	econf:options(	×
76	#{outgoing => econf:acl()});
77	mod_opt_type(presence) ->
78	econf:options(	×
79	#{managed_entity => econf:acl(), roster => econf:acl()}).
80
81	mod_options(_) ->
82	[{roster, [{both, none}, {get, none}, {set, none}]},	×
83	{presence, [{managed_entity, none}, {roster, none}]},
84	{message, [{outgoing,none}]}].
85
86	mod_doc() ->
87	#{desc =>	×
88	[?T("This module is an implementation of "
89	"https://xmpp.org/extensions/xep-0356.html"
90	"[XEP-0356: Privileged Entity]. This extension "
91	"allows components to have privileged access to "
92	"other entity data (send messages on behalf of the "
93	"server or on behalf of a user, get/set user roster, "
94	"access presence information, etc.). This may be used "
95	"to write powerful external components, for example "
96	"implementing an external "
97	"https://xmpp.org/extensions/xep-0163.html[PEP] or "
98	"https://xmpp.org/extensions/xep-0313.html[MAM] service."), "",
99	?T("By default a component does not have any privileged access. "
100	"It is worth noting that the permissions grant access to "
101	"the component to a specific data type for all users of "
102	"the virtual host on which 'mod_privilege' is loaded."), "",
103	?T("Make sure you have a listener configured to connect your "
104	"component. Check the section about listening ports for more "
105	"information."), "",
106	?T("WARNING: Security issue: Privileged access gives components "
107	"access to sensitive data, so permission should be granted "
108	"carefully, only if you trust a component."), "",
109	?T("NOTE: This module is complementary to _`mod_delegation`_, "
110	"but can also be used separately.")],
111	opts =>
112	[{roster,
113	#{value => ?T("Options"),
114	desc =>
115	?T("This option defines roster permissions. "
116	"By default no permissions are given. "
117	"The 'Options' are:")},
118	[{both,
119	#{value => ?T("AccessName"),
120	desc =>
121	?T("Sets read/write access to a user's roster. "
122	"The default value is 'none'.")}},
123	{get,
124	#{value => ?T("AccessName"),
125	desc =>
126	?T("Sets read access to a user's roster. "
127	"The default value is 'none'.")}},
128	{set,
129	#{value => ?T("AccessName"),
130	desc =>
131	?T("Sets write access to a user's roster. "
132	"The default value is 'none'.")}}]},
133	{message,
134	#{value => ?T("Options"),
135	desc =>
136	?T("This option defines permissions for messages. "
137	"By default no permissions are given. "
138	"The 'Options' are:")},
139	[{outgoing,
140	#{value => ?T("AccessName"),
141	desc =>
142	?T("The option defines an access rule for sending "
143	"outgoing messages by the component. "
144	"The default value is 'none'.")}}]},
145	{presence,
146	#{value => ?T("Options"),
147	desc =>
148	?T("This option defines permissions for presences. "
149	"By default no permissions are given. "
150	"The 'Options' are:")},
151	[{managed_entity,
152	#{value => ?T("AccessName"),
153	desc =>
154	?T("An access rule that gives permissions to "
155	"the component to receive server presences. "
156	"The default value is 'none'.")}},
157	{roster,
158	#{value => ?T("AccessName"),
159	desc =>
160	?T("An access rule that gives permissions to "
161	"the component to receive the presence of both "
162	"the users and the contacts in their roster. "
163	"The default value is 'none'.")}}]}],
164	example =>
165	["modules:",
166	" mod_privilege:",
167	" roster:",
168	" get: all",
169	" presence:",
170	" managed_entity: all",
171	" message:",
172	" outgoing: all"]}.
173
174	depends(_, _) ->
175	[].	×
176
177	-spec component_connected(binary()) -> ok.
178	component_connected(Host) ->
179	lists:foreach(	×
180	fun(ServerHost) ->
181	Proc = gen_mod:get_module_proc(ServerHost, ?MODULE),	×
182	gen_server:cast(Proc, {component_connected, Host})	×
183	end, ejabberd_option:hosts()).
184
185	-spec component_disconnected(binary(), binary()) -> ok.
186	component_disconnected(Host, _Reason) ->
187	lists:foreach(	×
188	fun(ServerHost) ->
189	Proc = gen_mod:get_module_proc(ServerHost, ?MODULE),	×
190	gen_server:cast(Proc, {component_disconnected, Host})	×
191	end, ejabberd_option:hosts()).
192
193	-spec process_message(stanza()) -> stop \| ok.
194	process_message(#message{from = #jid{luser = <<"">>, lresource = <<"">>} = From,
195	to = #jid{lresource = <<"">>} = To,
196	lang = Lang, type = T} = Msg) when T /= error ->
197	Host = From#jid.lserver,	×
198	ServerHost = To#jid.lserver,	×
199	Permissions = get_permissions(ServerHost),	×
200	case maps:find(Host, Permissions) of	×
201	{ok, Access} ->
202	case proplists:get_value(message, Access, none) of	×
203	outgoing ->
204	forward_message(Msg);	×
205	_ ->
206	Txt = ?T("Insufficient privilege"),	×
207	Err = xmpp:err_forbidden(Txt, Lang),	×
208	ejabberd_router:route_error(Msg, Err)	×
209	end,
210	stop;	×
211	error ->
212	%% Component is disconnected
213	ok	×
214	end;
215	process_message(_Stanza) ->
216	ok.	×
217
218	-spec roster_access({true, iq()} \| false, iq()) -> {true, iq()} \| false.
219	roster_access({true, _IQ} = Acc, _) ->
220	Acc;	×
221	roster_access(false, #iq{from = From, to = To, type = Type} = IQ) ->
222	Host = From#jid.lserver,	×
223	ServerHost = To#jid.lserver,	×
224	Permissions = get_permissions(ServerHost),	×
225	case maps:find(Host, Permissions) of	×
226	{ok, Access} ->
227	Permission = proplists:get_value(roster, Access, none),	×
228	case (Permission == both)	×
229	orelse (Permission == get andalso Type == get)	×
230	orelse (Permission == set andalso Type == set) of	×
231	true ->
232	{true, xmpp:put_meta(IQ, privilege_from, To)};	×
233	false ->
234	false	×
235	end;
236	error ->
237	%% Component is disconnected
238	false	×
239	end.
240
241	-spec process_presence_out({stanza(), ejabberd_c2s:state()}) -> {stanza(), ejabberd_c2s:state()}.
242	process_presence_out({#presence{
243	from = #jid{luser = LUser, lserver = LServer} = From,
244	to = #jid{luser = LUser, lserver = LServer, lresource = <<"">>},
245	type = Type} = Pres, C2SState})
246	when Type == available; Type == unavailable ->
247	%% Self-presence processing
248	Permissions = get_permissions(LServer),	×
249	lists:foreach(	×
250	fun({Host, Access}) ->
251	Permission = proplists:get_value(presence, Access, none),	×
252	if Permission == roster; Permission == managed_entity ->	×
253	To = jid:make(Host),	×
254	ejabberd_router:route(	×
255	xmpp:set_from_to(Pres, From, To));
256	true ->
257	ok	×
258	end
259	end, maps:to_list(Permissions)),
260	{Pres, C2SState};	×
261	process_presence_out(Acc) ->
262	Acc.	×
263
264	-spec process_presence_in({stanza(), ejabberd_c2s:state()}) -> {stanza(), ejabberd_c2s:state()}.
265	process_presence_in({#presence{
266	from = #jid{luser = U, lserver = S} = From,
267	to = #jid{luser = LUser, lserver = LServer},
268	type = Type} = Pres, C2SState})
269	when {U, S} /= {LUser, LServer} andalso
270	(Type == available orelse Type == unavailable) ->
271	Permissions = get_permissions(LServer),	×
272	lists:foreach(	×
273	fun({Host, Access}) ->
274	case proplists:get_value(presence, Access, none) of	×
275	roster ->
276	Permission = proplists:get_value(roster, Access, none),	×
277	if Permission == both; Permission == get ->	×
278	To = jid:make(Host),	×
279	ejabberd_router:route(	×
280	xmpp:set_from_to(Pres, From, To));
281	true ->
282	ok	×
283	end;
284	_ ->
285	ok	×
286	end
287	end, maps:to_list(Permissions)),
288	{Pres, C2SState};	×
289	process_presence_in(Acc) ->
290	Acc.	×
291
292	%%%===================================================================
293	%%% gen_server callbacks
294	%%%===================================================================
295	init([Host\|_]) ->
296	process_flag(trap_exit, true),	×
297	catch ets:new(?MODULE,	×
298	[named_table, public,
299	{heir, erlang:group_leader(), none}]),
300	ejabberd_hooks:add(component_connected, ?MODULE,	×
301	component_connected, 50),
302	ejabberd_hooks:add(component_disconnected, ?MODULE,	×
303	component_disconnected, 50),
304	ejabberd_hooks:add(local_send_to_resource_hook, Host, ?MODULE,	×
305	process_message, 50),
306	ejabberd_hooks:add(roster_remote_access, Host, ?MODULE,	×
307	roster_access, 50),
308	ejabberd_hooks:add(user_send_packet, Host, ?MODULE,	×
309	process_presence_out, 50),
310	ejabberd_hooks:add(user_receive_packet, Host, ?MODULE,	×
311	process_presence_in, 50),
312	{ok, #state{server_host = Host}}.	×
313
314	handle_call(Request, From, State) ->
315	?WARNING_MSG("Unexpected call from ~p: ~p", [From, Request]),	×
316	{noreply, State}.	×
317
318	handle_cast({component_connected, Host}, State) ->
319	ServerHost = State#state.server_host,	×
320	From = jid:make(ServerHost),	×
321	To = jid:make(Host),	×
322	RosterPerm = get_roster_permission(ServerHost, Host),	×
323	PresencePerm = get_presence_permission(ServerHost, Host),	×
324	MessagePerm = get_message_permission(ServerHost, Host),	×
325	if RosterPerm /= none; PresencePerm /= none; MessagePerm /= none ->	×
326	Priv = #privilege{perms = [#privilege_perm{access = message,	×
327	type = MessagePerm},
328	#privilege_perm{access = roster,
329	type = RosterPerm},
330	#privilege_perm{access = presence,
331	type = PresencePerm}]},
332	?INFO_MSG("Granting permissions to external "	×
333	"component '~ts': roster = ~ts, presence = ~ts, "
334	"message = ~ts",
335	[Host, RosterPerm, PresencePerm, MessagePerm]),	×
336	Msg = #message{from = From, to = To, sub_els = [Priv]},	×
337	ejabberd_router:route(Msg),	×
338	Permissions = maps:put(Host, [{roster, RosterPerm},	×
339	{presence, PresencePerm},
340	{message, MessagePerm}],
341	get_permissions(ServerHost)),
342	ets:insert(?MODULE, {ServerHost, Permissions}),	×
343	{noreply, State};	×
344	true ->
345	?INFO_MSG("Granting no permissions to external component '~ts'",	×
346	[Host]),	×
347	{noreply, State}	×
348	end;
349	handle_cast({component_disconnected, Host}, State) ->
350	ServerHost = State#state.server_host,	×
351	Permissions = maps:remove(Host, get_permissions(ServerHost)),	×
352	case maps:size(Permissions) of	×
353	0 -> ets:delete(?MODULE, ServerHost);	×
354	_ -> ets:insert(?MODULE, {ServerHost, Permissions})	×
355	end,
356	{noreply, State};	×
357	handle_cast(Msg, State) ->
358	?WARNING_MSG("Unexpected cast: ~p", [Msg]),	×
359	{noreply, State}.	×
360
361	handle_info(Info, State) ->
362	?WARNING_MSG("Unexpected info: ~p", [Info]),	×
363	{noreply, State}.	×
364
365	terminate(_Reason, State) ->
366	Host = State#state.server_host,	×
367	case gen_mod:is_loaded_elsewhere(Host, ?MODULE) of	×
368	false ->
369	ejabberd_hooks:delete(component_connected, ?MODULE,	×
370	component_connected, 50),
371	ejabberd_hooks:delete(component_disconnected, ?MODULE,	×
372	component_disconnected, 50);
373	true ->
374	ok	×
375	end,
376	ejabberd_hooks:delete(local_send_to_resource_hook, Host, ?MODULE,	×
377	process_message, 50),
378	ejabberd_hooks:delete(roster_remote_access, Host, ?MODULE,	×
379	roster_access, 50),
380	ejabberd_hooks:delete(user_send_packet, Host, ?MODULE,	×
381	process_presence_out, 50),
382	ejabberd_hooks:delete(user_receive_packet, Host, ?MODULE,	×
383	process_presence_in, 50),
384	ets:delete(?MODULE, Host).	×
385
386	code_change(_OldVsn, State, _Extra) ->
387	{ok, State}.	×
388
389	%%%===================================================================
390	%%% Internal functions
391	%%%===================================================================
392	-spec get_permissions(binary()) -> permissions().
393	get_permissions(ServerHost) ->
394	try ets:lookup_element(?MODULE, ServerHost, 2)	×
395	catch _:badarg -> #{}	×
396	end.
397
398	-spec forward_message(message()) -> ok.
399	forward_message(#message{to = To} = Msg) ->
400	ServerHost = To#jid.lserver,	×
401	Lang = xmpp:get_lang(Msg),	×
402	CodecOpts = ejabberd_config:codec_options(),	×
403	try xmpp:try_subtag(Msg, #privilege{}) of	×
404	#privilege{forwarded = #forwarded{sub_els = [SubEl]}} ->
405	try xmpp:decode(SubEl, ?NS_CLIENT, CodecOpts) of	×
406	#message{} = NewMsg ->
407	case NewMsg#message.from of	×
408	#jid{lresource = <<"">>, lserver = ServerHost} ->
409	FromJID = NewMsg#message.from,	×
410	State = #{jid => FromJID},	×
411	ejabberd_hooks:run_fold(user_send_packet, FromJID#jid.lserver, {NewMsg, State}, []),	×
412	ejabberd_router:route(NewMsg);	×
413	_ ->
414	Lang = xmpp:get_lang(Msg),	×
415	Txt = ?T("Invalid 'from' attribute in forwarded message"),	×
416	Err = xmpp:err_forbidden(Txt, Lang),	×
417	ejabberd_router:route_error(Msg, Err)	×
418	end;
419	_ ->
420	Txt = ?T("Message not found in forwarded payload"),	×
421	Err = xmpp:err_bad_request(Txt, Lang),	×
422	ejabberd_router:route_error(Msg, Err)	×
423	catch _:{xmpp_codec, Why} ->
424	Txt = xmpp:io_format_error(Why),	×
425	Err = xmpp:err_bad_request(Txt, Lang),	×
426	ejabberd_router:route_error(Msg, Err)	×
427	end;
428	_ ->
429	Txt = ?T("No <forwarded/> element found"),	×
430	Err = xmpp:err_bad_request(Txt, Lang),	×
431	ejabberd_router:route_error(Msg, Err)	×
432	catch _:{xmpp_codec, Why} ->
433	Txt = xmpp:io_format_error(Why),	×
434	Err = xmpp:err_bad_request(Txt, Lang),	×
435	ejabberd_router:route_error(Msg, Err)	×
436	end.
437
438	-spec get_roster_permission(binary(), binary()) -> roster_permission() \| none.
439	get_roster_permission(ServerHost, Host) ->
440	Perms = mod_privilege_opt:roster(ServerHost),	×
441	case match_rule(ServerHost, Host, Perms, both) of	×
442	allow ->
443	both;	×
444	deny ->
445	Get = match_rule(ServerHost, Host, Perms, get),	×
446	Set = match_rule(ServerHost, Host, Perms, set),	×
447	if Get == allow, Set == allow -> both;	×
448	Get == allow -> get;	×
449	Set == allow -> set;	×
450	true -> none	×
451	end
452	end.
453
454	-spec get_message_permission(binary(), binary()) -> message_permission() \| none.
455	get_message_permission(ServerHost, Host) ->
456	Perms = mod_privilege_opt:message(ServerHost),	×
457	case match_rule(ServerHost, Host, Perms, outgoing) of	×
458	allow -> outgoing;	×
459	deny -> none	×
460	end.
461
462	-spec get_presence_permission(binary(), binary()) -> presence_permission() \| none.
463	get_presence_permission(ServerHost, Host) ->
464	Perms = mod_privilege_opt:presence(ServerHost),	×
465	case match_rule(ServerHost, Host, Perms, roster) of	×
466	allow ->
467	roster;	×
468	deny ->
469	case match_rule(ServerHost, Host, Perms, managed_entity) of	×
470	allow -> managed_entity;	×
471	deny -> none	×
472	end
473	end.
474
475	-spec match_rule(binary(), binary(), roster_permissions(), roster_permission()) -> allow \| deny;
476	(binary(), binary(), presence_permissions(), presence_permission()) -> allow \| deny;
477	(binary(), binary(), message_permissions(), message_permission()) -> allow \| deny.
478	match_rule(ServerHost, Host, Perms, Type) ->
479	Access = proplists:get_value(Type, Perms, none),	×
480	acl:match_rule(ServerHost, Access, jid:make(Host)).	×

processone / ejabberd / 747

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous