util.signal: Update version in header, and author's email
[prosody.git] / util / sasl / scram.lua
index 9362cca7956f7a36eadf8bf34e3a0c3b54b324de..4f80052908cd7148b8d123edfaa5e61f36d02a48 100644 (file)
 --    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 local s_match = string.match;
-
+local type = type
+local string = string
 local base64 = require "util.encodings".base64;
 local xor = require "bit".bxor
 local hmac_sha1 = require "util.hmac".sha1;
 local sha1 = require "util.hashes".sha1;
 local generate_uuid = require "util.uuid".generate;
+local saslprep = require "util.encodings".stringprep.saslprep;
+local log = require "util.logger".init("sasl");
+local t_concat = table.concat;
+local char = string.char;
+local byte = string.byte;
 
-module "plain"
+module "scram"
 
 --=========================
 --SASL SCRAM-SHA-1 according to draft-ietf-sasl-scram-10
@@ -33,17 +39,19 @@ local function bp( b )
        return result
 end
 
+local xor_map = {0;1;2;3;4;5;6;7;8;9;10;11;12;13;14;15;1;0;3;2;5;4;7;6;9;8;11;10;13;12;15;14;2;3;0;1;6;7;4;5;10;11;8;9;14;15;12;13;3;2;1;0;7;6;5;4;11;10;9;8;15;14;13;12;4;5;6;7;0;1;2;3;12;13;14;15;8;9;10;11;5;4;7;6;1;0;3;2;13;12;15;14;9;8;11;10;6;7;4;5;2;3;0;1;14;15;12;13;10;11;8;9;7;6;5;4;3;2;1;0;15;14;13;12;11;10;9;8;8;9;10;11;12;13;14;15;0;1;2;3;4;5;6;7;9;8;11;10;13;12;15;14;1;0;3;2;5;4;7;6;10;11;8;9;14;15;12;13;2;3;0;1;6;7;4;5;11;10;9;8;15;14;13;12;3;2;1;0;7;6;5;4;12;13;14;15;8;9;10;11;4;5;6;7;0;1;2;3;13;12;15;14;9;8;11;10;5;4;7;6;1;0;3;2;14;15;12;13;10;11;8;9;6;7;4;5;2;3;0;1;15;14;13;12;11;10;9;8;7;6;5;4;3;2;1;0;};
+
+local result = {};
 local function binaryXOR( a, b )
-       if string.len(a) > string.len(b) then
-               b = string.rep("\0", a:len() - b:len())..b
-       elseif string.len(a) < string.len(b) then
-               a = string.rep("\0", b:len() - a:len())..a
-       end
-       local result = ""
-       for i=1, a:len() do
-               result = result..string.char(xor(a:byte(i), b:byte(i)))
+       for i=1, #a do
+               local x, y = byte(a, i), byte(b, i);
+               local lowx, lowy = x % 16, y % 16;
+               local hix, hiy = (x - lowx) / 16, (y - lowy) / 16;
+               local lowr, hir = xor_map[lowx * 16 + lowy + 1], xor_map[hix * 16 + hiy + 1];
+               local r = hir * 16 + lowr;
+               result[i] = char(r)
        end
-       return result
+       return t_concat(result);
 end
 
 -- hash algorithm independent Hi(PBKDF2) implementation
@@ -51,7 +59,7 @@ local function Hi(hmac, str, salt, i)
        local Ust = hmac(str, salt.."\0\0\0\1");
        local res = Ust;        
        for n=1,i-1 do
-               Und = hmac(str, Ust)
+               local Und = hmac(str, Ust)
                res = binaryXOR(res, Und)
                Ust = Und
        end
@@ -60,10 +68,18 @@ end
 
 local function validate_username(username)
        -- check for forbidden char sequences
+       for eq in username:gmatch("=(.?.?)") do
+               if eq ~= "2D" and eq ~= "3D" then
+                       return false 
+               end 
+       end
        
        -- replace =2D with , and =3D with =
+       username = username:gsub("=2D", ",");
+       username = username:gsub("=3D", "=");
        
        -- apply SASLprep
+       username = saslprep(username);
        return username;
 end
 
@@ -73,19 +89,28 @@ local function scram_sha_1(self, message)
        if not self.state.name then
                -- we are processing client_first_message
                local client_first_message = message;
+               self.state["client_first_message"] = client_first_message;
                self.state["name"] = client_first_message:match("n=(.+),r=")
                self.state["clientnonce"] = client_first_message:match("r=([^,]+)")
                
-               self.state.name = validate_username(self.state.name);
                if not self.state.name or not self.state.clientnonce then
                        return "failure", "malformed-request";
                end
+               
+               self.state.name = validate_username(self.state.name);
+               if not self.state.name then
+                       log("debug", "Username violates either SASLprep or contains forbidden character sequences.")
+                       return "failure", "malformed-request", "Invalid username.";
+               end
+               
                self.state["servernonce"] = generate_uuid();
                self.state["salt"] = generate_uuid();
                
                local server_first_message = "r="..self.state.clientnonce..self.state.servernonce..",s="..base64.encode(self.state.salt)..",i="..default_i;
+               self.state["server_first_message"] = server_first_message;
                return "challenge", server_first_message
        else
+               if type(message) ~= "string" then return "failure", "malformed-request" end
                -- we are processing client_final_message
                local client_final_message = message;
                
@@ -93,27 +118,33 @@ local function scram_sha_1(self, message)
                self.state["nonce"] = client_final_message:match("r=(.+),p=");
                self.state["channelbinding"] = client_final_message:match("c=(.+),r=");
                if not self.state.proof or not self.state.nonce or not self.state.channelbinding then
-                       return "failure", "malformed-request";
+                       return "failure", "malformed-request", "Missing an attribute(p, r or c) in SASL message.";
                end
                
-               local password;
+               local password, state;
                if self.profile.plain then
                        password, state = self.profile.plain(self.state.name, self.realm)
                        if state == nil then return "failure", "not-authorized"
                        elseif state == false then return "failure", "account-disabled" end
+                       password = saslprep(password);
+                       if not password then
+                               log("debug", "Password violates SASLprep.");
+                               return "failure", "not-authorized", "Invalid password."
+                       end
                end
                
                local SaltedPassword = Hi(hmac_sha1, password, self.state.salt, default_i)
                local ClientKey = hmac_sha1(SaltedPassword, "Client Key")
                local ServerKey = hmac_sha1(SaltedPassword, "Server Key")
                local StoredKey = sha1(ClientKey)
-               local AuthMessage = "n=" .. s_match(client_first_message,"n=(.+)") .. "," .. server_first_message .. "," .. s_match(client_final_message, "(.+),p=.+")
+               local AuthMessage = "n=" .. s_match(self.state.client_first_message,"n=(.+)") .. "," .. self.state.server_first_message .. "," .. s_match(client_final_message, "(.+),p=.+")
                local ClientSignature = hmac_sha1(StoredKey, AuthMessage)
                local ClientProof     = binaryXOR(ClientKey, ClientSignature)
                local ServerSignature = hmac_sha1(ServerKey, AuthMessage)
                
                if base64.encode(ClientProof) == self.state.proof then
                        local server_final_message = "v="..base64.encode(ServerSignature);
+                       self["username"] = self.state.name;
                        return "success", server_final_message;
                else
                        return "failure", "not-authorized", "The response provided by the client doesn't match the one we calculated.";