Copy scram.erl from upstream, renamed to scram2.erl

This commit is contained in:
Badlop 2015-06-26 17:51:24 +02:00
parent ff61b1a2e1
commit db91c97614
1 changed files with 191 additions and 0 deletions

View File

@ -0,0 +1,191 @@
%%%----------------------------------------------------------------------
%%% File : scram.erl
%%% Author : Stephen Röttger <stephen.roettger@googlemail.com>
%%% Purpose : SCRAM (RFC 5802)
%%% Created : 7 Aug 2011 by Stephen Röttger <stephen.roettger@googlemail.com>
%%%
%%%
%%% ejabberd, Copyright (C) 2002-2013 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., 59 Temple Place, Suite 330, Boston, MA
%%% 02111-1307 USA
%%%
%%%----------------------------------------------------------------------
-module(scram).
-author('stephen.roettger@googlemail.com').
-include("ejabberd.hrl").
%% External exports
%% ejabberd doesn't implement SASLPREP, so we use the similar RESOURCEPREP instead
-export([ % Core SCRAM functions
salted_password/3,
stored_key/1,
server_key/1,
server_signature/2,
client_signature/2,
client_key/1,
client_key/2]).
-export([
enabled/1,
iterations/0,
iterations/1,
password_to_scram/1,
password_to_scram/2,
check_password/2,
check_digest/4
]).
-export([serialize/1, deserialize/1]).
-export([scram_to_tuple/1]).
-define(SALT_LENGTH, 16).
-define(SCRAM_DEFAULT_ITERATION_COUNT, 4096).
-define(SCRAM_SERIAL_PREFIX, "==SCRAM==,").
-spec salted_password(binary(), binary(), non_neg_integer()) -> binary().
salted_password(Password, Salt, IterationCount) ->
hi(jlib:resourceprep(Password), Salt, IterationCount).
-spec client_key(binary()) -> binary().
client_key(SaltedPassword) ->
crypto_hmac(sha, SaltedPassword, <<"Client Key">>).
-spec stored_key(binary()) -> binary().
stored_key(ClientKey) -> crypto:hash(sha, ClientKey).
-spec server_key(binary()) -> binary().
server_key(SaltedPassword) ->
crypto_hmac(sha, SaltedPassword, <<"Server Key">>).
-spec client_signature(binary(), binary()) -> binary().
client_signature(StoredKey, AuthMessage) ->
crypto_hmac(sha, StoredKey, AuthMessage).
-spec client_key(binary(), binary()) -> binary().
client_key(ClientProof, ClientSignature) ->
list_to_binary(lists:zipwith(fun (X, Y) -> X bxor Y end,
binary_to_list(ClientProof),
binary_to_list(ClientSignature))).
-spec server_signature(binary(), binary()) -> binary().
server_signature(ServerKey, AuthMessage) ->
crypto_hmac(sha, ServerKey, AuthMessage).
hi(Password, Salt, IterationCount) ->
U1 = crypto_hmac(sha, Password, <<Salt/binary, 0, 0, 0, 1>>),
list_to_binary(lists:zipwith(fun (X, Y) -> X bxor Y end,
binary_to_list(U1),
binary_to_list(hi_round(Password, U1,
IterationCount - 1)))).
hi_round(Password, UPrev, 1) ->
crypto_hmac(sha, Password, UPrev);
hi_round(Password, UPrev, IterationCount) ->
U = crypto_hmac(sha, Password, UPrev),
list_to_binary(lists:zipwith(fun (X, Y) -> X bxor Y end,
binary_to_list(U),
binary_to_list(hi_round(Password, U,
IterationCount - 1)))).
enabled(Host) ->
case ejabberd_config:get_local_option(auth_opts, Host) of
undefined ->
false;
AuthOpts ->
{password_format, scram} == lists:keyfind(password_format, 1, AuthOpts)
end.
iterations() -> ?SCRAM_DEFAULT_ITERATION_COUNT.
iterations(Host) ->
case ejabberd_config:get_local_option(auth_opts, Host) of
undefined ->
iterations();
AuthOpts ->
case lists:keyfind(scram_iterations, 1, AuthOpts) of
false -> iterations();
{_, Iterations} -> Iterations
end
end.
password_to_scram(Password) ->
password_to_scram(Password, ?SCRAM_DEFAULT_ITERATION_COUNT).
password_to_scram(#scram{} = Password, _) ->
Password;
password_to_scram(Password, IterationCount) ->
Salt = crypto:rand_bytes(?SALT_LENGTH),
SaltedPassword = salted_password(Password, Salt, IterationCount),
StoredKey = stored_key(scram:client_key(SaltedPassword)),
ServerKey = server_key(SaltedPassword),
#scram{storedkey = base64:encode(StoredKey),
serverkey = base64:encode(ServerKey),
salt = base64:encode(Salt),
iterationcount = IterationCount}.
check_password(Password, Scram) ->
IterationCount = Scram#scram.iterationcount,
Salt = base64:decode(Scram#scram.salt),
SaltedPassword = salted_password(Password, Salt, IterationCount),
StoredKey = stored_key(client_key(SaltedPassword)),
(base64:decode(Scram#scram.storedkey) == StoredKey).
serialize(#scram{storedkey = StoredKey, serverkey = ServerKey,
salt = Salt, iterationcount = IterationCount})->
IterationCountBin = integer_to_binary(IterationCount),
<< <<?SCRAM_SERIAL_PREFIX>>/binary,
StoredKey/binary,$,,ServerKey/binary,
$,,Salt/binary,$,,IterationCountBin/binary>>.
deserialize(<<?SCRAM_SERIAL_PREFIX, Serialized/binary>>) ->
case catch binary:split(Serialized, <<",">>, [global]) of
[StoredKey, ServerKey,Salt,IterationCount] ->
{ok, #scram{storedkey = StoredKey,
serverkey = ServerKey,
salt = Salt,
iterationcount = binary_to_integer(IterationCount)}};
_ ->
?WARNING_MSG("Incorrect serialized SCRAM: ~p, ~p", [Serialized]),
{error, incorrect_scram}
end;
deserialize(Bin) ->
?WARNING_MSG("Corrupted serialized SCRAM: ~p, ~p", [Bin]),
{error, corrupted_scram}.
-spec scram_to_tuple(scram()) -> {binary(), binary(), binary(), non_neg_integer()}.
scram_to_tuple(Scram) ->
{base64:decode(Scram#scram.storedkey),
base64:decode(Scram#scram.serverkey),
base64:decode(Scram#scram.salt),
Scram#scram.iterationcount}.
-spec check_digest(scram(), binary(), fun(), binary()) -> boolean().
check_digest(#scram{storedkey = StoredKey}, Digest, DigestGen, Password) ->
Passwd = base64:decode(StoredKey),
ejabberd_auth:check_digest(Digest, DigestGen, Password, Passwd).
-ifdef(no_crypto_hmac).
crypto_hmac(sha, Key, Data) ->
crypto:sha_mac(Key, Data).
-else.
crypto_hmac(sha, Key, Data) ->
crypto:hmac(sha, Key, Data).
-endif.