mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-22 16:20:52 +01:00
301 lines
9.1 KiB
Erlang
301 lines
9.1 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : ejabberd_auth_mnesia.erl
|
|
%%% Author : Alexey Shchepin <alexey@process-one.net>
|
|
%%% Purpose : Authentification via mnesia
|
|
%%% Created : 12 Dec 2004 by Alexey Shchepin <alexey@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2017 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_mnesia).
|
|
|
|
-compile([{parse_transform, ejabberd_sql_pt}]).
|
|
|
|
-author('alexey@process-one.net').
|
|
|
|
-behaviour(ejabberd_auth).
|
|
|
|
-export([start/1, stop/1, set_password/3, try_register/3,
|
|
get_users/2, init_db/0,
|
|
count_users/2, get_password/2,
|
|
remove_user/2, store_type/1, export/1, import/2,
|
|
plain_password_required/1, use_cache/1]).
|
|
-export([need_transform/1, transform/1]).
|
|
|
|
-include("ejabberd.hrl").
|
|
-include("logger.hrl").
|
|
-include("ejabberd_sql_pt.hrl").
|
|
|
|
-record(passwd, {us = {<<"">>, <<"">>} :: {binary(), binary()} | '$1',
|
|
password = <<"">> :: binary() | scram() | '_'}).
|
|
|
|
-record(reg_users_counter, {vhost = <<"">> :: binary(),
|
|
count = 0 :: integer() | '$1'}).
|
|
|
|
%%%----------------------------------------------------------------------
|
|
%%% API
|
|
%%%----------------------------------------------------------------------
|
|
start(Host) ->
|
|
init_db(),
|
|
update_reg_users_counter_table(Host),
|
|
ok.
|
|
|
|
stop(_Host) ->
|
|
ok.
|
|
|
|
init_db() ->
|
|
ejabberd_mnesia:create(?MODULE, passwd,
|
|
[{disc_only_copies, [node()]},
|
|
{attributes, record_info(fields, passwd)}]),
|
|
ejabberd_mnesia:create(?MODULE, reg_users_counter,
|
|
[{ram_copies, [node()]},
|
|
{attributes, record_info(fields, reg_users_counter)}]).
|
|
|
|
update_reg_users_counter_table(Server) ->
|
|
Set = get_users(Server, []),
|
|
Size = length(Set),
|
|
LServer = jid:nameprep(Server),
|
|
F = fun () ->
|
|
mnesia:write(#reg_users_counter{vhost = LServer,
|
|
count = Size})
|
|
end,
|
|
mnesia:sync_dirty(F).
|
|
|
|
use_cache(Host) ->
|
|
case mnesia:table_info(passwd, storage_type) of
|
|
disc_only_copies ->
|
|
ejabberd_config:get_option(
|
|
{auth_use_cache, Host},
|
|
ejabberd_config:use_cache(Host));
|
|
_ ->
|
|
false
|
|
end.
|
|
|
|
plain_password_required(Server) ->
|
|
store_type(Server) == scram.
|
|
|
|
store_type(Server) ->
|
|
ejabberd_auth:password_format(Server).
|
|
|
|
set_password(User, Server, Password) ->
|
|
US = {User, Server},
|
|
F = fun () ->
|
|
mnesia:write(#passwd{us = US, password = Password})
|
|
end,
|
|
case mnesia:transaction(F) of
|
|
{atomic, ok} ->
|
|
ok;
|
|
{aborted, Reason} ->
|
|
?ERROR_MSG("Mnesia transaction failed: ~p", [Reason]),
|
|
{error, db_failure}
|
|
end.
|
|
|
|
try_register(User, Server, Password) ->
|
|
US = {User, Server},
|
|
F = fun () ->
|
|
case mnesia:read({passwd, US}) of
|
|
[] ->
|
|
mnesia:write(#passwd{us = US, password = Password}),
|
|
mnesia:dirty_update_counter(reg_users_counter, Server, 1),
|
|
ok;
|
|
[_] ->
|
|
{error, exists}
|
|
end
|
|
end,
|
|
case mnesia:transaction(F) of
|
|
{atomic, Res} ->
|
|
Res;
|
|
{aborted, Reason} ->
|
|
?ERROR_MSG("Mnesia transaction failed: ~p", [Reason]),
|
|
{error, db_failure}
|
|
end.
|
|
|
|
get_users(Server, []) ->
|
|
mnesia:dirty_select(passwd,
|
|
[{#passwd{us = '$1', _ = '_'},
|
|
[{'==', {element, 2, '$1'}, Server}], ['$1']}]);
|
|
get_users(Server, [{from, Start}, {to, End}])
|
|
when is_integer(Start) and is_integer(End) ->
|
|
get_users(Server, [{limit, End - Start + 1}, {offset, Start}]);
|
|
get_users(Server, [{limit, Limit}, {offset, Offset}])
|
|
when is_integer(Limit) and is_integer(Offset) ->
|
|
case get_users(Server, []) of
|
|
[] ->
|
|
[];
|
|
Users ->
|
|
Set = lists:keysort(1, Users),
|
|
L = length(Set),
|
|
Start = if Offset < 1 -> 1;
|
|
Offset > L -> L;
|
|
true -> Offset
|
|
end,
|
|
lists:sublist(Set, Start, Limit)
|
|
end;
|
|
get_users(Server, [{prefix, Prefix}]) when is_binary(Prefix) ->
|
|
Set = [{U, S} || {U, S} <- get_users(Server, []), str:prefix(Prefix, U)],
|
|
lists:keysort(1, Set);
|
|
get_users(Server, [{prefix, Prefix}, {from, Start}, {to, End}])
|
|
when is_binary(Prefix) and is_integer(Start) and is_integer(End) ->
|
|
get_users(Server, [{prefix, Prefix}, {limit, End - Start + 1},
|
|
{offset, Start}]);
|
|
get_users(Server, [{prefix, Prefix}, {limit, Limit}, {offset, Offset}])
|
|
when is_binary(Prefix) and is_integer(Limit) and is_integer(Offset) ->
|
|
case [{U, S} || {U, S} <- get_users(Server, []), str:prefix(Prefix, U)] of
|
|
[] ->
|
|
[];
|
|
Users ->
|
|
Set = lists:keysort(1, Users),
|
|
L = length(Set),
|
|
Start = if Offset < 1 -> 1;
|
|
Offset > L -> L;
|
|
true -> Offset
|
|
end,
|
|
lists:sublist(Set, Start, Limit)
|
|
end;
|
|
get_users(Server, _) ->
|
|
get_users(Server, []).
|
|
|
|
count_users(Server, []) ->
|
|
case mnesia:dirty_select(
|
|
reg_users_counter,
|
|
[{#reg_users_counter{vhost = Server, count = '$1'},
|
|
[], ['$1']}]) of
|
|
[Count] -> Count;
|
|
_ -> 0
|
|
end;
|
|
count_users(Server, [{prefix, Prefix}]) when is_binary(Prefix) ->
|
|
Set = [{U, S} || {U, S} <- get_users(Server, []), str:prefix(Prefix, U)],
|
|
length(Set);
|
|
count_users(Server, _) ->
|
|
count_users(Server, []).
|
|
|
|
get_password(User, Server) ->
|
|
case mnesia:dirty_read(passwd, {User, Server}) of
|
|
[#passwd{password = Password}] ->
|
|
{ok, Password};
|
|
_ ->
|
|
error
|
|
end.
|
|
|
|
remove_user(User, Server) ->
|
|
US = {User, Server},
|
|
F = fun () ->
|
|
mnesia:delete({passwd, US}),
|
|
mnesia:dirty_update_counter(reg_users_counter, Server, -1),
|
|
ok
|
|
end,
|
|
case mnesia:transaction(F) of
|
|
{atomic, ok} ->
|
|
ok;
|
|
{aborted, Reason} ->
|
|
?ERROR_MSG("Mnesia transaction failed: ~p", [Reason]),
|
|
{error, db_failure}
|
|
end.
|
|
|
|
need_transform(#reg_users_counter{}) ->
|
|
false;
|
|
need_transform(#passwd{us = {U, S}, password = Pass}) ->
|
|
if is_binary(Pass) ->
|
|
case store_type(S) of
|
|
scram ->
|
|
?INFO_MSG("Passwords in Mnesia table 'passwd' "
|
|
"will be SCRAM'ed", []),
|
|
true;
|
|
plain ->
|
|
false
|
|
end;
|
|
is_record(Pass, scram) ->
|
|
case store_type(S) of
|
|
scram ->
|
|
false;
|
|
plain ->
|
|
?WARNING_MSG("Some passwords were stored in the database "
|
|
"as SCRAM, but 'auth_password_format' "
|
|
"is not configured as 'scram': some "
|
|
"authentication mechanisms such as DIGEST-MD5 "
|
|
"would *fail*", []),
|
|
false
|
|
end;
|
|
is_list(U) orelse is_list(S) orelse is_list(Pass) ->
|
|
?INFO_MSG("Mnesia table 'passwd' will be converted to binary", []),
|
|
true
|
|
end.
|
|
|
|
transform(#passwd{us = {U, S}, password = Pass} = R)
|
|
when is_list(U) orelse is_list(S) orelse is_list(Pass) ->
|
|
NewUS = {iolist_to_binary(U), iolist_to_binary(S)},
|
|
NewPass = case Pass of
|
|
#scram{storedkey = StoredKey,
|
|
serverkey = ServerKey,
|
|
salt = Salt} ->
|
|
Pass#scram{
|
|
storedkey = iolist_to_binary(StoredKey),
|
|
serverkey = iolist_to_binary(ServerKey),
|
|
salt = iolist_to_binary(Salt)};
|
|
_ ->
|
|
iolist_to_binary(Pass)
|
|
end,
|
|
transform(R#passwd{us = NewUS, password = NewPass});
|
|
transform(#passwd{us = {U, S}, password = Password} = P)
|
|
when is_binary(Password) ->
|
|
case store_type(S) of
|
|
scram ->
|
|
case jid:resourceprep(Password) of
|
|
error ->
|
|
?ERROR_MSG("SASLprep failed for password of user ~s@~s",
|
|
[U, S]),
|
|
P;
|
|
_ ->
|
|
Scram = ejabberd_auth:password_to_scram(Password),
|
|
P#passwd{password = Scram}
|
|
end;
|
|
plain ->
|
|
P
|
|
end;
|
|
transform(#passwd{password = Password} = P)
|
|
when is_record(Password, scram) ->
|
|
P.
|
|
|
|
export(_Server) ->
|
|
[{passwd,
|
|
fun(Host, #passwd{us = {LUser, LServer}, password = Password})
|
|
when LServer == Host,
|
|
is_binary(Password) ->
|
|
[?SQL("delete from users where username=%(LUser)s;"),
|
|
?SQL("insert into users(username, password) "
|
|
"values (%(LUser)s, %(Password)s);")];
|
|
(Host, #passwd{us = {LUser, LServer}, password = #scram{} = Scram})
|
|
when LServer == Host ->
|
|
StoredKey = Scram#scram.storedkey,
|
|
ServerKey = Scram#scram.serverkey,
|
|
Salt = Scram#scram.salt,
|
|
IterationCount = Scram#scram.iterationcount,
|
|
[?SQL("delete from users where username=%(LUser)s;"),
|
|
?SQL("insert into users(username, password, serverkey, salt, "
|
|
"iterationcount) "
|
|
"values (%(LUser)s, %(StoredKey)s, %(ServerKey)s,"
|
|
" %(Salt)s, %(IterationCount)d);")];
|
|
(_Host, _R) ->
|
|
[]
|
|
end}].
|
|
|
|
import(LServer, [LUser, Password, _TimeStamp]) ->
|
|
mnesia:dirty_write(
|
|
#passwd{us = {LUser, LServer}, password = Password}).
|