2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
4 -- Copyright (C) 2010 Jeff Mitchell
6 -- This project is MIT/X11 licensed. Please see the
7 -- COPYING file in the source package for more information.
10 local datamanager = require "util.datamanager";
11 local log = require "util.logger".init("auth_internal_hashed");
14 local ipairs = ipairs;
15 local hashes = require "util.hashes";
16 local jid_bare = require "util.jid".bare;
17 local getAuthenticationDatabaseSHA1 = require "util.sasl.scram".getAuthenticationDatabaseSHA1;
18 local config = require "core.configmanager";
19 local usermanager = require "core.usermanager";
20 local generate_uuid = require "util.uuid".generate;
21 local new_sasl = require "util.sasl".new;
22 local nodeprep = require "util.encodings".stringprep.nodeprep;
25 -- COMPAT w/old trunk: remove these two lines before 0.8 release
26 local hmac_sha1 = require "util.hmac".sha1;
27 local sha1 = require "util.hashes".sha1;
31 local function replace_byte_with_hex(byte)
32 return ("%02x"):format(byte:byte());
34 function to_hex(binary_string)
35 return binary_string:gsub(".", replace_byte_with_hex);
41 local function replace_hex_with_byte(hex)
42 return string.char(tonumber(hex, 16));
44 function from_hex(hex_string)
45 return hex_string:gsub("..", replace_hex_with_byte);
50 local prosody = _G.prosody;
52 -- Default; can be set per-user
53 local iteration_count = 4096;
55 function new_hashpass_provider(host)
56 local provider = { name = "internal_hashed" };
57 log("debug", "initializing hashpass authentication provider for host '%s'", host);
59 function provider.test_password(username, password)
60 local credentials = datamanager.load(username, host, "accounts") or {};
62 if credentials.password ~= nil and string.len(credentials.password) ~= 0 then
63 if credentials.password ~= password then
64 return nil, "Auth failed. Provided password is incorrect.";
67 if provider.set_password(username, credentials.password) == nil then
68 return nil, "Auth failed. Could not set hashed password from plaintext.";
74 if credentials.iteration_count == nil or credentials.salt == nil or string.len(credentials.salt) == 0 then
75 return nil, "Auth failed. Stored salt and iteration count information is not complete.";
78 -- convert hexpass to stored_key and server_key
79 -- COMPAT w/old trunk: remove before 0.8 release
80 if credentials.hashpass then
81 local salted_password = from_hex(credentials.hashpass);
82 credentials.stored_key = sha1(hmac_sha1(salted_password, "Client Key"), true);
83 credentials.server_key = to_hex(hmac_sha1(salted_password, "Server Key"));
84 credentials.hashpass = nil
85 datamanager.store(username, host, "accounts", credentials);
88 local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, credentials.salt, credentials.iteration_count);
90 local stored_key_hex = to_hex(stored_key);
91 local server_key_hex = to_hex(server_key);
93 if valid and stored_key_hex == credentials.stored_key and server_key_hex == credentials.server_key then
96 return nil, "Auth failed. Invalid username, password, or password hash information.";
100 function provider.set_password(username, password)
101 local account = datamanager.load(username, host, "accounts");
103 account.salt = account.salt or generate_uuid();
104 account.iteration_count = account.iteration_count or iteration_count;
105 local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, account.salt, account.iteration_count);
106 local stored_key_hex = to_hex(stored_key);
107 local server_key_hex = to_hex(server_key);
109 account.stored_key = stored_key_hex
110 account.server_key = server_key_hex
112 account.password = nil;
113 return datamanager.store(username, host, "accounts", account);
115 return nil, "Account not available.";
118 function provider.user_exists(username)
119 local account = datamanager.load(username, host, "accounts");
121 log("debug", "account not found for username '%s' at host '%s'", username, module.host);
122 return nil, "Auth failed. Invalid username";
127 function provider.create_user(username, password)
128 if password == nil then
129 return datamanager.store(username, host, "accounts", {});
131 local salt = generate_uuid();
132 local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, salt, iteration_count);
133 local stored_key_hex = to_hex(stored_key);
134 local server_key_hex = to_hex(server_key);
135 return datamanager.store(username, host, "accounts", {stored_key = stored_key_hex, server_key = server_key_hex, salt = salt, iteration_count = iteration_count});
138 function provider.delete_user(username)
139 return datamanager.store(username, host, "accounts", nil);
142 function provider.get_sasl_handler()
143 local realm = module:get_option("sasl_realm") or module.host;
144 local testpass_authentication_profile = {
145 plain_test = function(sasl, username, password, realm)
146 local prepped_username = nodeprep(username);
147 if not prepped_username then
148 log("debug", "NODEprep failed on username: %s", username);
151 return usermanager.test_password(prepped_username, realm, password), true;
153 scram_sha_1 = function(sasl, username, realm)
154 local credentials = datamanager.load(username, host, "accounts");
155 if not credentials then return; end
156 if credentials.password then
157 usermanager.set_password(username, credentials.password, host);
158 credentials = datamanager.load(username, host, "accounts");
159 if not credentials then return; end
162 -- convert hexpass to stored_key and server_key
163 -- COMPAT w/old trunk: remove before 0.8 release
164 if credentials.hashpass then
165 local salted_password = from_hex(credentials.hashpass);
166 credentials.stored_key = sha1(hmac_sha1(salted_password, "Client Key"), true);
167 credentials.server_key = to_hex(hmac_sha1(salted_password, "Server Key"));
168 credentials.hashpass = nil
169 datamanager.store(username, host, "accounts", credentials);
172 local stored_key, server_key, iteration_count, salt = credentials.stored_key, credentials.server_key, credentials.iteration_count, credentials.salt;
173 stored_key = stored_key and from_hex(stored_key);
174 server_key = server_key and from_hex(server_key);
175 return stored_key, server_key, iteration_count, salt, true;
178 return new_sasl(realm, testpass_authentication_profile);
184 module:add_item("auth-provider", new_hashpass_provider(module.host));