plugins/mod_auth_internal_hashed.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 Waqas Hussain
   4 -- Copyright (C) 2010 Jeff Mitchell
   5 --
   6 -- This project is MIT/X11 licensed. Please see the
   7 -- COPYING file in the source package for more information.
   8 --
   9
  10 local datamanager = require "util.datamanager";
  11 local log = require "util.logger".init("usermanager");
  12 local type = type;
  13 local error = error;
  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;
  23 local hosts = hosts;
  24
  25 -- TODO: remove these two lines in near future
  26 local hmac_sha1 = require "util.hmac".sha1;
  27 local sha1 = require "util.hashes".sha1;
  28
  29 local prosody = _G.prosody;
  30
  31 local is_cyrus = usermanager.is_cyrus;
  32
  33 -- Default; can be set per-user
  34 local iteration_count = 4096;
  35
  36 function new_hashpass_provider(host)
  37         local provider = { name = "internal_hashed" };
  38         log("debug", "initializing hashpass authentication provider for host '%s'", host);
  39
  40         function provider.test_password(username, password)
  41                 if is_cyrus(host) then return nil, "Legacy auth not supported with Cyrus SASL."; end
  42                 local credentials = datamanager.load(username, host, "accounts") or {};
  43
  44                 if credentials.password ~= nil and string.len(credentials.password) ~= 0 then
  45                         if credentials.password ~= password then
  46                                 return nil, "Auth failed. Provided password is incorrect.";
  47                         end
  48
  49                         if provider.set_password(username, credentials.password) == nil then
  50                                 return nil, "Auth failed. Could not set hashed password from plaintext.";
  51                         else
  52                                 return true;
  53                         end
  54                 end
  55
  56                 if credentials.iteration_count == nil or credentials.salt == nil or string.len(credentials.salt) == 0 then
  57                         return nil, "Auth failed. Stored salt and iteration count information is not complete.";
  58                 end
  59
  60                 -- convert hexpass to stored_key and server_key
  61                 -- TODO: remove this in near future
  62                 if credentials.hashpass then
  63                         local salted_password = credentials.hashpass:gsub("..", function(x) return string.char(tonumber(x, 16)); end);
  64                         credentials.stored_key = sha1(hmac_sha1(salted_password, "Client Key")):gsub(".", function (c) return ("%02x"):format(c:byte()); end);
  65                         credentials.server_key = hmac_sha1(salted_password, "Server Key"):gsub(".", function (c) return ("%02x"):format(c:byte()); end);
  66                         credentials.hashpass = nil
  67                         datamanager.store(username, host, "accounts", credentials);
  68                 end
  69
  70                 local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, credentials.salt, credentials.iteration_count);
  71
  72                 local stored_key_hex = stored_key:gsub(".", function (c) return ("%02x"):format(c:byte()); end);
  73                 local server_key_hex = server_key:gsub(".", function (c) return ("%02x"):format(c:byte()); end);
  74
  75                 if valid and stored_key_hex == credentials.stored_key and server_key_hex == credentials.server_key then
  76                         return true;
  77                 else
  78                         return nil, "Auth failed. Invalid username, password, or password hash information.";
  79                 end
  80         end
  81
  82         function provider.set_password(username, password)
  83                 if is_cyrus(host) then return nil, "Passwords unavailable for Cyrus SASL."; end
  84                 local account = datamanager.load(username, host, "accounts");
  85                 if account then
  86                         account.salt = account.salt or generate_uuid();
  87                         account.iteration_count = account.iteration_count or iteration_count;
  88                         local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, account.salt, account.iteration_count);
  89                         local stored_key_hex = stored_key:gsub(".", function (c) return ("%02x"):format(c:byte()); end);
  90                         local server_key_hex = server_key:gsub(".", function (c) return ("%02x"):format(c:byte()); end);
  91
  92                         account.stored_key = stored_key_hex
  93                         account.server_key = server_key_hex
  94
  95                         account.password = nil;
  96                         return datamanager.store(username, host, "accounts", account);
  97                 end
  98                 return nil, "Account not available.";
  99         end
 100
 101         function provider.user_exists(username)
 102                 if is_cyrus(host) then return true; end
 103                 local account = datamanager.load(username, host, "accounts");
 104                 if not account then
 105                         log("debug", "account not found for username '%s' at host '%s'", username, module.host);
 106                         return nil, "Auth failed. Invalid username";
 107                 end
 108                 if (account.hashpass == nil or string.len(account.hashpass) == 0) and (account.password == nil or string.len(account.password) == 0) then
 109                         log("debug", "account password not set or zero-length for username '%s' at host '%s'", username, module.host);
 110                         return nil, "Auth failed. Password invalid.";
 111                 end
 112                 return true;
 113         end
 114
 115         function provider.create_user(username, password)
 116                 if is_cyrus(host) then return nil, "Account creation/modification not available with Cyrus SASL."; end
 117                 local salt = generate_uuid();
 118                 local valid, stored_key, server_key = getAuthenticationDatabaseSHA1(password, salt, iteration_count);
 119                 local stored_key_hex = stored_key:gsub(".", function (c) return ("%02x"):format(c:byte()); end);
 120                 local server_key_hex = server_key:gsub(".", function (c) return ("%02x"):format(c:byte()); end);
 121                 return datamanager.store(username, host, "accounts", {stored_key = stored_key_hex, server_key = server_key_hex, salt = salt, iteration_count = iteration_count});
 122         end
 123
 124         function provider.get_sasl_handler()
 125                 local realm = module:get_option("sasl_realm") or module.host;
 126                 local testpass_authentication_profile = {
 127                         plain_test = function(username, password, realm)
 128                                 local prepped_username = nodeprep(username);
 129                                 if not prepped_username then
 130                                         log("debug", "NODEprep failed on username: %s", username);
 131                                         return "", nil;
 132                                 end
 133                                 return usermanager.test_password(prepped_username, password, realm), true;
 134                         end,
 135                         scram_sha_1 = function(username, realm)
 136                                 local credentials = datamanager.load(username, host, "accounts") or {};
 137                                 if credentials.password then
 138                                         usermanager.set_password(username, credentials.password, host);
 139                                         credentials = datamanager.load(username, host, "accounts") or {};
 140                                 end
 141
 142                                 -- convert hexpass to stored_key and server_key
 143                                 -- TODO: remove this in near future
 144                                 if credentials.hashpass then
 145                                         local salted_password = credentials.hashpass:gsub("..", function(x) return string.char(tonumber(x, 16)); end);
 146                                         credentials.stored_key = sha1(hmac_sha1(salted_password, "Client Key")):gsub(".", function (c) return ("%02x"):format(c:byte()); end);
 147                                         credentials.server_key = hmac_sha1(salted_password, "Server Key"):gsub(".", function (c) return ("%02x"):format(c:byte()); end);
 148                                         credentials.hashpass = nil
 149                                         datamanager.store(username, host, "accounts", credentials);
 150                                 end
 151
 152                                 local stored_key, server_key, iteration_count, salt = credentials.stored_key, credentials.server_key, credentials.iteration_count, credentials.salt;
 153                                 stored_key = stored_key and stored_key:gsub("..", function(x) return string.char(tonumber(x, 16)); end);
 154                                 server_key = server_key and server_key:gsub("..", function(x) return string.char(tonumber(x, 16)); end);
 155                                 return stored_key, server_key, iteration_count, salt, true;
 156                         end
 157                 };
 158                 return new_sasl(realm, testpass_authentication_profile);
 159         end
 160
 161         function provider.is_admin(jid)
 162                 local admins = module:get_option_array("admins");
 163                 if admins ~= config.get("*", "core", "admins") and type(admins) == "table" then
 164                         jid = jid_bare(jid);
 165                         for _,admin in ipairs(admins) do
 166                                 if admin == jid then return true; end
 167                         end
 168                 end
 169         end
 170         return provider;
 171 end
 172
 173 module:add_item("auth-provider", new_hashpass_provider(module.host));
 174