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");
12 local getAuthenticationDatabaseSHA1 = require "util.sasl.scram".getAuthenticationDatabaseSHA1;
13 local usermanager = require "core.usermanager";
14 local generate_uuid = require "util.uuid".generate;
15 local new_sasl = require "util.sasl".new;
16 local nodeprep = require "util.encodings".stringprep.nodeprep;
20 local function replace_byte_with_hex(byte)
21 return ("%02x"):format(byte:byte());
23 function to_hex(binary_string)
24 return binary_string:gsub(".", replace_byte_with_hex);
30 local function replace_hex_with_byte(hex)
31 return string.char(tonumber(hex, 16));
33 function from_hex(hex_string)
34 return hex_string:gsub("..", replace_hex_with_byte);
39 -- Default; can be set per-user
40 local iteration_count = 4096;
42 function new_hashpass_provider(host)
43 local provider = { name = "internal_hashed" };
44 log("debug", "initializing internal_hashed authentication provider for host '%s'", host);
46 function provider.test_password(username, password)
47 local credentials = datamanager.load(username, host, "accounts") or {};
49 if credentials.password ~= nil and string.len(credentials.password) ~= 0 then
50 if credentials.password ~= password then
51 return nil, "Auth failed. Provided password is incorrect.";
54 if provider.set_password(username, credentials.password) == nil then
55 return nil, "Auth failed. Could not set hashed password from plaintext.";
61 if credentials.iteration_count == nil or credentials.salt == nil or string.len(credentials.salt) == 0 then
62 return nil, "Auth failed. Stored salt and iteration count information is not complete.";
65 local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, credentials.salt, credentials.iteration_count);
67 local stored_key_hex = to_hex(stored_key);
68 local server_key_hex = to_hex(server_key);
70 if valid and stored_key_hex == credentials.stored_key and server_key_hex == credentials.server_key then
73 return nil, "Auth failed. Invalid username, password, or password hash information.";
77 function provider.set_password(username, password)
78 local account = datamanager.load(username, host, "accounts");
80 account.salt = account.salt or generate_uuid();
81 account.iteration_count = account.iteration_count or iteration_count;
82 local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, account.salt, account.iteration_count);
83 local stored_key_hex = to_hex(stored_key);
84 local server_key_hex = to_hex(server_key);
86 account.stored_key = stored_key_hex
87 account.server_key = server_key_hex
89 account.password = nil;
90 return datamanager.store(username, host, "accounts", account);
92 return nil, "Account not available.";
95 function provider.user_exists(username)
96 local account = datamanager.load(username, host, "accounts");
98 log("debug", "account not found for username '%s' at host '%s'", username, module.host);
99 return nil, "Auth failed. Invalid username";
104 function provider.create_user(username, password)
105 if password == nil then
106 return datamanager.store(username, host, "accounts", {});
108 local salt = generate_uuid();
109 local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, salt, iteration_count);
110 local stored_key_hex = to_hex(stored_key);
111 local server_key_hex = to_hex(server_key);
112 return datamanager.store(username, host, "accounts", {stored_key = stored_key_hex, server_key = server_key_hex, salt = salt, iteration_count = iteration_count});
115 function provider.delete_user(username)
116 return datamanager.store(username, host, "accounts", nil);
119 function provider.get_sasl_handler()
120 local testpass_authentication_profile = {
121 plain_test = function(sasl, username, password, realm)
122 local prepped_username = nodeprep(username);
123 if not prepped_username then
124 log("debug", "NODEprep failed on username: %s", username);
127 return usermanager.test_password(prepped_username, realm, password), true;
129 scram_sha_1 = function(sasl, username, realm)
130 local credentials = datamanager.load(username, host, "accounts");
131 if not credentials then return; end
132 if credentials.password then
133 usermanager.set_password(username, credentials.password, host);
134 credentials = datamanager.load(username, host, "accounts");
135 if not credentials then return; end
138 local stored_key, server_key, iteration_count, salt = credentials.stored_key, credentials.server_key, credentials.iteration_count, credentials.salt;
139 stored_key = stored_key and from_hex(stored_key);
140 server_key = server_key and from_hex(server_key);
141 return stored_key, server_key, iteration_count, salt, true;
144 return new_sasl(module.host, testpass_authentication_profile);
150 module:add_item("auth-provider", new_hashpass_provider(module.host));