aboutsummaryrefslogtreecommitdiff
path: root/src/ejabberd_auth_external.erl
diff options
context:
space:
mode:
Diffstat (limited to 'src/ejabberd_auth_external.erl')
-rw-r--r--src/ejabberd_auth_external.erl263
1 files changed, 21 insertions, 242 deletions
diff --git a/src/ejabberd_auth_external.erl b/src/ejabberd_auth_external.erl
index 5bdd704a0..5b2b26c1a 100644
--- a/src/ejabberd_auth_external.erl
+++ b/src/ejabberd_auth_external.erl
@@ -32,14 +32,8 @@
-behaviour(ejabberd_auth).
-export([start/1, stop/1, set_password/3, check_password/4,
- check_password/6, try_register/3,
- dirty_get_registered_users/0, get_vh_registered_users/1,
- get_vh_registered_users/2,
- get_vh_registered_users_number/1,
- get_vh_registered_users_number/2, get_password/2,
- get_password_s/2, is_user_exists/2, remove_user/2,
- remove_user/3, store_type/0, plain_password_required/0,
- opt_type/1]).
+ try_register/3, is_user_exists/2, remove_user/2,
+ store_type/1, plain_password_required/1, opt_type/1]).
-include("ejabberd.hrl").
-include("logger.hrl").
@@ -49,275 +43,60 @@
%%%----------------------------------------------------------------------
start(Host) ->
Cmd = ejabberd_config:get_option({extauth_program, Host}, "extauth"),
- extauth:start(Host, Cmd),
- check_cache_last_options(Host),
- ejabberd_auth_mnesia:start(Host).
+ extauth:start(Host, Cmd).
stop(Host) ->
- extauth:stop(Host),
- ejabberd_auth_mnesia:stop(Host).
+ extauth:stop(Host).
-check_cache_last_options(Server) ->
- case get_cache_option(Server) of
- false -> no_cache;
- {true, _CacheTime} ->
- case get_mod_last_configured(Server) of
- no_mod_last ->
- ?ERROR_MSG("In host ~p extauth is used, extauth_cache "
- "is enabled but mod_last is not enabled.",
- [Server]),
- no_cache;
- _ -> cache
- end
- end.
-
-plain_password_required() -> true.
+plain_password_required(_) -> true.
-store_type() -> external.
+store_type(_) -> external.
check_password(User, AuthzId, Server, Password) ->
if AuthzId /= <<>> andalso AuthzId /= User ->
false;
true ->
- case get_cache_option(Server) of
- false ->
- check_password_extauth(User, AuthzId, Server, Password);
- {true, CacheTime} ->
- check_password_cache(User, AuthzId, Server, Password,
- CacheTime)
- end
+ check_password_extauth(User, AuthzId, Server, Password)
end.
-check_password(User, AuthzId, Server, Password, _Digest,
- _DigestGen) ->
- check_password(User, AuthzId, Server, Password).
-
set_password(User, Server, Password) ->
case extauth:set_password(User, Server, Password) of
- true ->
- set_password_mnesia(User, Server, Password), ok;
- _ -> {error, unknown_problem}
+ true -> ok;
+ _ -> {error, db_failure}
end.
try_register(User, Server, Password) ->
- case get_cache_option(Server) of
- false -> try_register_extauth(User, Server, Password);
- {true, _CacheTime} ->
- try_register_external_cache(User, Server, Password)
- end.
-
-dirty_get_registered_users() ->
- ejabberd_auth_mnesia:dirty_get_registered_users().
-
-get_vh_registered_users(Server) ->
- ejabberd_auth_mnesia:get_vh_registered_users(Server).
-
-get_vh_registered_users(Server, Data) ->
- ejabberd_auth_mnesia:get_vh_registered_users(Server,
- Data).
-
-get_vh_registered_users_number(Server) ->
- ejabberd_auth_mnesia:get_vh_registered_users_number(Server).
-
-get_vh_registered_users_number(Server, Data) ->
- ejabberd_auth_mnesia:get_vh_registered_users_number(Server,
- Data).
-
-%% The password can only be returned if cache is enabled, cached info exists and is fresh enough.
-get_password(User, Server) ->
- case get_cache_option(Server) of
- false -> false;
- {true, CacheTime} ->
- get_password_cache(User, Server, CacheTime)
- end.
-
-get_password_s(User, Server) ->
- case get_password(User, Server) of
- false -> <<"">>;
- Other -> Other
- end.
+ extauth:try_register(User, Server, Password).
-%% @spec (User, Server) -> true | false | {error, Error}
is_user_exists(User, Server) ->
try extauth:is_user_exists(User, Server) of
- Res -> Res
+ Res -> Res
catch
- _:Error -> {error, Error}
+ _:Error ->
+ ?ERROR_MSG("external authentication program failure: ~p",
+ [Error]),
+ {error, db_failure}
end.
remove_user(User, Server) ->
case extauth:remove_user(User, Server) of
- false -> false;
- true ->
- case get_cache_option(Server) of
- false -> false;
- {true, _CacheTime} ->
- ejabberd_auth_mnesia:remove_user(User, Server)
- end
+ false -> {error, not_allowed};
+ true -> ok
end.
-remove_user(User, Server, Password) ->
- case extauth:remove_user(User, Server, Password) of
- false -> false;
- true ->
- case get_cache_option(Server) of
- false -> false;
- {true, _CacheTime} ->
- ejabberd_auth_mnesia:remove_user(User, Server,
- Password)
- end
- end.
-
-%%%
-%%% Extauth cache management
-%%%
-
-%% @spec (Host::string()) -> false | {true, CacheTime::integer()}
-get_cache_option(Host) ->
- case ejabberd_config:get_option({extauth_cache, Host}, false) of
- false -> false;
- CacheTime -> {true, CacheTime}
- end.
-
-%% @spec (User, AuthzId, Server, Password) -> true | false
check_password_extauth(User, _AuthzId, Server, Password) ->
extauth:check_password(User, Server, Password) andalso
Password /= <<"">>.
-%% @spec (User, Server, Password) -> true | false
-try_register_extauth(User, Server, Password) ->
- extauth:try_register(User, Server, Password).
-
-check_password_cache(User, AuthzId, Server, Password, 0) ->
- check_password_external_cache(User, AuthzId, Server, Password);
-check_password_cache(User, AuthzId, Server, Password,
- CacheTime) ->
- case get_last_access(User, Server) of
- online ->
- check_password_mnesia(User, AuthzId, Server, Password);
- never ->
- check_password_external_cache(User, AuthzId, Server, Password);
- mod_last_required ->
- ?ERROR_MSG("extauth is used, extauth_cache is enabled "
- "but mod_last is not enabled in that "
- "host",
- []),
- check_password_external_cache(User, AuthzId, Server, Password);
- TimeStamp ->
- case is_fresh_enough(TimeStamp, CacheTime) of
- %% If no need to refresh, check password against Mnesia
- true ->
- case check_password_mnesia(User, AuthzId, Server, Password) of
- %% If password valid in Mnesia, accept it
- true -> true;
- %% Else (password nonvalid in Mnesia), check in extauth and cache result
- false ->
- check_password_external_cache(User, AuthzId, Server, Password)
- end;
- %% Else (need to refresh), check in extauth and cache result
- false ->
- check_password_external_cache(User, AuthzId, Server, Password)
- end
- end.
-
-get_password_mnesia(User, Server) ->
- ejabberd_auth_mnesia:get_password(User, Server).
-
--spec get_password_cache(User::binary(), Server::binary(), CacheTime::integer()) -> Password::string() | false.
-get_password_cache(User, Server, CacheTime) ->
- case get_last_access(User, Server) of
- online -> get_password_mnesia(User, Server);
- never -> false;
- mod_last_required ->
- ?ERROR_MSG("extauth is used, extauth_cache is enabled "
- "but mod_last is not enabled in that "
- "host",
- []),
- false;
- TimeStamp ->
- case is_fresh_enough(TimeStamp, CacheTime) of
- true -> get_password_mnesia(User, Server);
- false -> false
- end
- end.
-
-%% Check the password using extauth; if success then cache it
-check_password_external_cache(User, AuthzId, Server, Password) ->
- case check_password_extauth(User, AuthzId, Server, Password) of
- true ->
- set_password_mnesia(User, Server, Password), true;
- false -> false
- end.
-
-%% Try to register using extauth; if success then cache it
-try_register_external_cache(User, Server, Password) ->
- case try_register_extauth(User, Server, Password) of
- {atomic, ok} = R ->
- set_password_mnesia(User, Server, Password), R;
- _ -> {error, not_allowed}
- end.
-
-%% @spec (User, AuthzId, Server, Password) -> true | false
-check_password_mnesia(User, AuthzId, Server, Password) ->
- ejabberd_auth_mnesia:check_password(User, AuthzId, Server,
- Password).
-
-%% @spec (User, Server, Password) -> ok | {error, invalid_jid}
-set_password_mnesia(User, Server, Password) ->
-%% @spec (TimeLast, CacheTime) -> true | false
-%% TimeLast = online | never | integer()
-%% CacheTime = integer() | false
- ejabberd_auth_mnesia:set_password(User, Server,
- Password).
-
-is_fresh_enough(TimeStampLast, CacheTime) ->
- Now = p1_time_compat:system_time(seconds),
- TimeStampLast + CacheTime > Now.
-
-%% Code copied from mod_configure.erl
-%% Code copied from web/ejabberd_web_admin.erl
-%% TODO: Update time format to XEP-0202: Entity Time
--spec(get_last_access(User::binary(), Server::binary()) -> (online | never | mod_last_required | integer())).
-get_last_access(User, Server) ->
- case ejabberd_sm:get_user_resources(User, Server) of
- [] ->
- case get_last_info(User, Server) of
- mod_last_required -> mod_last_required;
- not_found -> never;
- {ok, Timestamp, _Status} -> Timestamp
- end;
- _ -> online
- end.
-%% @spec (User, Server) -> {ok, Timestamp, Status} | not_found | mod_last_required
-
-get_last_info(User, Server) ->
- case get_mod_last_enabled(Server) of
- mod_last -> mod_last:get_last_info(User, Server);
- no_mod_last -> mod_last_required
- end.
-
-%% @spec (Server) -> mod_last | no_mod_last
-get_mod_last_enabled(Server) ->
- case gen_mod:is_loaded(Server, mod_last) of
- true -> mod_last;
- false -> no_mod_last
- end.
-
-get_mod_last_configured(Server) ->
- case is_configured(Server, mod_last) of
- true -> mod_last;
- false -> no_mod_last
- end.
-
-is_configured(Host, Module) ->
- Os = ejabberd_config:get_option({modules, Host}, []),
- lists:keymember(Module, 1, Os).
-
-spec opt_type(extauth_cache) -> fun((false | non_neg_integer()) ->
false | non_neg_integer());
(extauth_program) -> fun((binary()) -> string());
(atom()) -> [atom()].
opt_type(extauth_cache) ->
+ ?WARNING_MSG("option 'extauth_cache' is deprecated and has no effect, "
+ "use authentication or global cache configuration "
+ "options: auth_use_cache, auth_cache_life_time, "
+ "use_cache, cache_life_time, and so on", []),
fun (false) -> false;
(I) when is_integer(I), I >= 0 -> I
end;
generated by cgit v1.2.3 (git 2.25.1) at 2025-09-10 21:08:41 +0000