util.sasl.scram: Rename variable to avoid name clash [luacheck]

[prosody.git] / util / sasl / scram.lua

diff --git a/util/sasl/scram.lua b/util/sasl/scram.lua
index 11fa4e7c8fe0d8589b65cc62931831f886fe2be1..b3c4edc8f090ab6287b103a0a599f9ded9bcd1ad 100644 (file)
--- a/util/sasl/scram.lua
+++ b/util/sasl/scram.lua
@@ -25,7 +25,7 @@ local t_concat = table.concat;
 local char = string.char;
 local byte = string.byte;
 
-module "sasl.scram"
+local _ENV = nil;
 
 --=========================
 --SASL SCRAM-SHA-1 according to RFC 5802
@@ -87,7 +87,7 @@ local function hashprep(hashname)
        return hashname:lower():gsub("-", "_");
 end
 
-function getAuthenticationDatabaseSHA1(password, salt, iteration_count)
+local function getAuthenticationDatabaseSHA1(password, salt, iteration_count)
        if type(password) ~= "string" or type(salt) ~= "string" or type(iteration_count) ~= "number" then
                return false, "inappropriate argument types"
        end
@@ -101,6 +101,7 @@ function getAuthenticationDatabaseSHA1(password, salt, iteration_count)
 end
 
 local function scram_gen(hash_name, H_f, HMAC_f)
+       local profile_name = "scram_" .. hashprep(hash_name);
        local function scram_hash(self, message)
                local support_channel_binding = false;
                if self.profile.cb then support_channel_binding = true; end
@@ -112,7 +113,7 @@ local function scram_gen(hash_name, H_f, HMAC_f)
                        local client_first_message = message;
 
                        -- TODO: fail if authzid is provided, since we don't support them yet
-                       local gs2_header, gs2_cbind_flag, gs2_cbind_name, authzid, client_first_message_bare, name, clientnonce
+                       local gs2_header, gs2_cbind_flag, gs2_cbind_name, authzid, client_first_message_bare, username, clientnonce
                                = s_match(client_first_message, "^(([pny])=?([^,]*),([^,]*),)(m?=?[^,]*,?n=([^,]*),r=([^,]*),?.*)$");
 
                        if not gs2_cbind_flag then
@@ -140,8 +141,8 @@ local function scram_gen(hash_name, H_f, HMAC_f)
                                gs2_cbind_name = nil;
                        end
 
-                       name = validate_username(name, self.profile.nodeprep);
-                       if not name then
+                       username = validate_username(username, self.profile.nodeprep);
+                       if not username then
                                log("debug", "Username violates either SASLprep or contains forbidden character sequences.")
                                return "failure", "malformed-request", "Invalid username.";
                        end
@@ -149,9 +150,9 @@ local function scram_gen(hash_name, H_f, HMAC_f)
                        -- retreive credentials
                        local stored_key, server_key, salt, iteration_count;
                        if self.profile.plain then
-                               local password, state = self.profile.plain(self, name, self.realm)
-                               if state == nil then return "failure", "not-authorized"
-                               elseif state == false then return "failure", "account-disabled" end
+                               local password, status = self.profile.plain(self, username, self.realm)
+                               if status == nil then return "failure", "not-authorized"
+                               elseif status == false then return "failure", "account-disabled" end
 
                                password = saslprep(password);
                                if not password then
@@ -168,9 +169,9 @@ local function scram_gen(hash_name, H_f, HMAC_f)
                                        log("error", "Generating authentication database failed. Reason: %s", stored_key);
                                        return "failure", "temporary-auth-failure";
                                end
-                       elseif self.profile["scram_"..hashprep(hash_name)] then
-                               local state;
-                               stored_key, server_key, iteration_count, salt, state = self.profile["scram_"..hashprep(hash_name)](self, name, self.realm);
+                       elseif self.profile[profile_name] then
+                               local status;
+                               stored_key, server_key, iteration_count, salt, status = self.profile[profile_name](self, username, self.realm);
                                if state == nil then return "failure", "not-authorized"
                                elseif state == false then return "failure", "account-disabled" end
                        end
@@ -180,7 +181,7 @@ local function scram_gen(hash_name, H_f, HMAC_f)
                        self.state = {
                                gs2_header = gs2_header;
                                gs2_cbind_name = gs2_cbind_name;
-                               name = name;
+                               username = username;
                                nonce = nonce;
 
                                server_key = server_key;
@@ -224,7 +225,7 @@ local function scram_gen(hash_name, H_f, HMAC_f)
 
                        if StoredKey == H_f(ClientKey) then
                                local server_final_message = "v="..base64.encode(ServerSignature);
-                               self["username"] = state.name;
+                               self["username"] = state.username;
                                return "success", server_final_message;
                        else
                                return "failure", "not-authorized", "The response provided by the client doesn't match the one we calculated.";
@@ -234,7 +235,7 @@ local function scram_gen(hash_name, H_f, HMAC_f)
        return scram_hash;
 end
 
-function init(registerMechanism)
+local function init(registerMechanism)
        local function registerSCRAMMechanism(hash_name, hash, hmac_hash)
                registerMechanism("SCRAM-"..hash_name, {"plain", "scram_"..(hashprep(hash_name))}, scram_gen(hash_name:lower(), hash, hmac_hash));
 
@@ -245,4 +246,7 @@ function init(registerMechanism)
        registerSCRAMMechanism("SHA-1", sha1, hmac_sha1);
 end
 
-return _M;
+return {
+       getAuthenticationDatabaseSHA1 = getAuthenticationDatabaseSHA1;
+       init = init;
+}