processone / ejabberd / 598

Committed 16 Oct 2023 12:44PM UTC coverage: 32.974% (+0.005%) from 32.969%

Build # 598

Build Type

push

github

Committed by

weiss

Commit Message

Example configuration: Specify s2s shaper

Specify a shaper for incoming s2s connections (got lost in commit
91a74e3e2).

Thanks to Paul Menzel for noting that it was missing.

Run Details

13495 of 40926 relevant lines covered (32.97%)

653.84 hits per line

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

55.32

/src/ejabberd_auth_anonymous.erl

%%%----------------------------------------------------------------------
%%% File    : ejabberd_auth_anonymous.erl
%%% Author  : Mickael Remond <mickael.remond@process-one.net>
%%% Purpose : Anonymous feature support in ejabberd
%%% Created : 17 Feb 2006 by Mickael Remond <mremond@process-one.net>
%%%
%%%
%%% ejabberd, Copyright (C) 2002-2023   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_auth_anonymous).

-behaviour(ejabberd_auth).
-author('mickael.remond@process-one.net').

-export([start/1,
         stop/1,
         use_cache/1,
         allow_anonymous/1,
         is_sasl_anonymous_enabled/1,
         is_login_anonymous_enabled/1,
         anonymous_user_exist/2,
         allow_multiple_connections/1,
         register_connection/3,
         unregister_connection/3
        ]).

-export([login/2, check_password/4, user_exists/2,
         get_users/2, count_users/2, store_type/1,
         plain_password_required/1]).

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

start(Host) ->
    ejabberd_hooks:add(sm_register_connection_hook, Host,
                       ?MODULE, register_connection, 100),
    ejabberd_hooks:add(sm_remove_connection_hook, Host,
                       ?MODULE, unregister_connection, 100),
    ok.

stop(Host) ->
    ejabberd_hooks:delete(sm_register_connection_hook, Host,
                          ?MODULE, register_connection, 100),
    ejabberd_hooks:delete(sm_remove_connection_hook, Host,
                          ?MODULE, unregister_connection, 100).

use_cache(_) ->
    false.

%% Return true if anonymous is allowed for host or false otherwise
allow_anonymous(Host) ->
    lists:member(?MODULE, ejabberd_auth:auth_modules(Host)).

%% Return true if anonymous mode is enabled and if anonymous protocol is SASL
%% anonymous protocol can be: sasl_anon|login_anon|both
is_sasl_anonymous_enabled(Host) ->
    case allow_anonymous(Host) of
      false -> false;
      true ->
          case anonymous_protocol(Host) of
            sasl_anon -> true;
            both -> true;
            _Other -> false
          end
    end.

%% Return true if anonymous login is enabled on the server
%% anonymous login can be use using standard authentication method (i.e. with
%% clients that do not support anonymous login)
is_login_anonymous_enabled(Host) ->
    case allow_anonymous(Host) of
      false -> false;
      true ->
          case anonymous_protocol(Host) of
            login_anon -> true;
            both -> true;
            _Other -> false
          end
    end.

%% Return the anonymous protocol to use: sasl_anon|login_anon|both
%% defaults to login_anon
anonymous_protocol(Host) ->
    ejabberd_option:anonymous_protocol(Host).

%% Return true if multiple connections have been allowed in the config file
%% defaults to false
allow_multiple_connections(Host) ->
    ejabberd_option:allow_multiple_connections(Host).

anonymous_user_exist(User, Server) ->
    lists:any(
      fun({_LResource, Info}) ->
              proplists:get_value(auth_module, Info) == ?MODULE
      end, ejabberd_sm:get_user_info(User, Server)).

%% Register connection
-spec register_connection(ejabberd_sm:sid(), jid(), ejabberd_sm:info()) -> ok.
register_connection(_SID,
                    #jid{luser = LUser, lserver = LServer, lresource = LResource}, Info) ->
    case proplists:get_value(auth_module, Info) of
        ?MODULE ->
            % Register user only if we are first resource
            case ejabberd_sm:get_user_resources(LUser, LServer) of
                [LResource] ->
                    ejabberd_hooks:run(register_user, LServer, [LUser, LServer]);
                _ ->
                    ok
            end;
        _ ->
            ok
    end.

%% Remove an anonymous user from the anonymous users table
-spec unregister_connection(ejabberd_sm:sid(), jid(), ejabberd_sm:info()) -> any().
unregister_connection(_SID,
                      #jid{luser = LUser, lserver = LServer}, Info) ->
    case proplists:get_value(auth_module, Info) of
        ?MODULE ->
            % Remove user data only if there is no more resources around
            case ejabberd_sm:get_user_resources(LUser, LServer) of
                [] ->
                    ejabberd_hooks:run(remove_user, LServer, [LUser, LServer]);
                _ ->
                    ok
            end;
        _ ->
            ok
    end.

%% ---------------------------------
%% Specific anonymous auth functions
%% ---------------------------------
check_password(User, _AuthzId, Server, _Password) ->
    {nocache,
     case ejabberd_auth:user_exists_in_other_modules(?MODULE, User, Server) of
         %% If user exists in other module, reject anonnymous authentication
         true -> false;
         %% If we are not sure whether the user exists in other module, reject anon auth
         maybe -> false;
         false -> login(User, Server)
     end}.

login(User, Server) ->
    case is_login_anonymous_enabled(Server) of
      false -> false;
      true ->
          case anonymous_user_exist(User, Server) of
            %% Reject the login if an anonymous user with the same login
            %% is already logged and if multiple login has not been enable
            %% in the config file.
            true -> allow_multiple_connections(Server);
            %% Accept login and add user to the anonymous table
            false -> true
          end
    end.

get_users(Server, _) ->
    [{U, S} || {U, S, _R} <- ejabberd_sm:get_vh_session_list(Server)].

count_users(Server, Opts) ->
    length(get_users(Server, Opts)).

user_exists(User, Server) ->
    {nocache, anonymous_user_exist(User, Server)}.

plain_password_required(_) ->
    false.

store_type(_) ->
    external.

1	%%%----------------------------------------------------------------------
2	%%% File : ejabberd_auth_anonymous.erl
3	%%% Author : Mickael Remond <mickael.remond@process-one.net>
4	%%% Purpose : Anonymous feature support in ejabberd
5	%%% Created : 17 Feb 2006 by Mickael Remond <mremond@process-one.net>
6	%%%
7	%%%
8	%%% ejabberd, Copyright (C) 2002-2023 ProcessOne
9	%%%
10	%%% This program is free software; you can redistribute it and/or
11	%%% modify it under the terms of the GNU General Public License as
12	%%% published by the Free Software Foundation; either version 2 of the
13	%%% License, or (at your option) any later version.
14	%%%
15	%%% This program is distributed in the hope that it will be useful,
16	%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
17	%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18	%%% General Public License for more details.
19	%%%
20	%%% You should have received a copy of the GNU General Public License along
21	%%% with this program; if not, write to the Free Software Foundation, Inc.,
22	%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23	%%%
24	%%%----------------------------------------------------------------------
25
26	-module(ejabberd_auth_anonymous).
27
28	-behaviour(ejabberd_auth).
29	-author('mickael.remond@process-one.net').
30
31	-export([start/1,
32	stop/1,
33	use_cache/1,
34	allow_anonymous/1,
35	is_sasl_anonymous_enabled/1,
36	is_login_anonymous_enabled/1,
37	anonymous_user_exist/2,
38	allow_multiple_connections/1,
39	register_connection/3,
40	unregister_connection/3
41	]).
42
43	-export([login/2, check_password/4, user_exists/2,
44	get_users/2, count_users/2, store_type/1,
45	plain_password_required/1]).
46
47	-include("logger.hrl").
48	-include_lib("xmpp/include/jid.hrl").
49
50	start(Host) ->
51	ejabberd_hooks:add(sm_register_connection_hook, Host,	1✔
52	?MODULE, register_connection, 100),
53	ejabberd_hooks:add(sm_remove_connection_hook, Host,	1✔
54	?MODULE, unregister_connection, 100),
55	ok.	1✔
56
57	stop(Host) ->
58	ejabberd_hooks:delete(sm_register_connection_hook, Host,	×
59	?MODULE, register_connection, 100),
60	ejabberd_hooks:delete(sm_remove_connection_hook, Host,	×
61	?MODULE, unregister_connection, 100).
62
63	use_cache(_) ->
64	false.	213✔
65
66	%% Return true if anonymous is allowed for host or false otherwise
67	allow_anonymous(Host) ->
68	lists:member(?MODULE, ejabberd_auth:auth_modules(Host)).	2,515✔
69
70	%% Return true if anonymous mode is enabled and if anonymous protocol is SASL
71	%% anonymous protocol can be: sasl_anon\|login_anon\|both
72	is_sasl_anonymous_enabled(Host) ->
73	case allow_anonymous(Host) of	2,514✔
74	false -> false;	2,236✔
75	true ->
76	case anonymous_protocol(Host) of	278✔
77	sasl_anon -> true;	278✔
78	both -> true;	×
79	_Other -> false	×
80	end
81	end.
82
83	%% Return true if anonymous login is enabled on the server
84	%% anonymous login can be use using standard authentication method (i.e. with
85	%% clients that do not support anonymous login)
86	is_login_anonymous_enabled(Host) ->
87	case allow_anonymous(Host) of	1✔
88	false -> false;	×
89	true ->
90	case anonymous_protocol(Host) of	1✔
91	login_anon -> true;	×
92	both -> true;	×
93	_Other -> false	1✔
94	end
95	end.
96
97	%% Return the anonymous protocol to use: sasl_anon\|login_anon\|both
98	%% defaults to login_anon
99	anonymous_protocol(Host) ->
100	ejabberd_option:anonymous_protocol(Host).	279✔
101
102	%% Return true if multiple connections have been allowed in the config file
103	%% defaults to false
104	allow_multiple_connections(Host) ->
105	ejabberd_option:allow_multiple_connections(Host).	×
106
107	anonymous_user_exist(User, Server) ->
108	lists:any(	105✔
109	fun({_LResource, Info}) ->
110	proplists:get_value(auth_module, Info) == ?MODULE	×
111	end, ejabberd_sm:get_user_info(User, Server)).
112
113	%% Register connection
114	-spec register_connection(ejabberd_sm:sid(), jid(), ejabberd_sm:info()) -> ok.
115	register_connection(_SID,
116	#jid{luser = LUser, lserver = LServer, lresource = LResource}, Info) ->
117	case proplists:get_value(auth_module, Info) of	121✔
118	?MODULE ->
119	% Register user only if we are first resource
120	case ejabberd_sm:get_user_resources(LUser, LServer) of	×
121	[LResource] ->
122	ejabberd_hooks:run(register_user, LServer, [LUser, LServer]);	×
123	_ ->
124	ok	×
125	end;
126	_ ->
127	ok	121✔
128	end.
129
130	%% Remove an anonymous user from the anonymous users table
131	-spec unregister_connection(ejabberd_sm:sid(), jid(), ejabberd_sm:info()) -> any().
132	unregister_connection(_SID,
133	#jid{luser = LUser, lserver = LServer}, Info) ->
134	case proplists:get_value(auth_module, Info) of	121✔
135	?MODULE ->
136	% Remove user data only if there is no more resources around
137	case ejabberd_sm:get_user_resources(LUser, LServer) of	×
138	[] ->
139	ejabberd_hooks:run(remove_user, LServer, [LUser, LServer]);	×
140	_ ->
141	ok	×
142	end;
143	_ ->
144	ok	121✔
145	end.
146
147	%% ---------------------------------
148	%% Specific anonymous auth functions
149	%% ---------------------------------
150	check_password(User, _AuthzId, Server, _Password) ->
151	{nocache,	1✔
152	case ejabberd_auth:user_exists_in_other_modules(?MODULE, User, Server) of
153	%% If user exists in other module, reject anonnymous authentication
154	true -> false;	×
155	%% If we are not sure whether the user exists in other module, reject anon auth
156	maybe -> false;	×
157	false -> login(User, Server)	1✔
158	end}.
159
160	login(User, Server) ->
161	case is_login_anonymous_enabled(Server) of	1✔
162	false -> false;	1✔
163	true ->
164	case anonymous_user_exist(User, Server) of	×
165	%% Reject the login if an anonymous user with the same login
166	%% is already logged and if multiple login has not been enable
167	%% in the config file.
168	true -> allow_multiple_connections(Server);	×
169	%% Accept login and add user to the anonymous table
170	false -> true	×
171	end
172	end.
173
174	get_users(Server, _) ->
175	[{U, S} \|\| {U, S, _R} <- ejabberd_sm:get_vh_session_list(Server)].	2✔
176
177	count_users(Server, Opts) ->
178	length(get_users(Server, Opts)).	2✔
179
180	user_exists(User, Server) ->
181	{nocache, anonymous_user_exist(User, Server)}.	105✔
182
183	plain_password_required(_) ->
184	false.	×
185
186	store_type(_) ->
187	external.	106✔

processone / ejabberd / 598

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