util/sasl/plain.lua

   1 -- sasl.lua v0.4
   2 -- Copyright (C) 2008-2010 Tobias Markmann
   3 --
   4 --    All rights reserved.
   5 --
   6 --    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
   7 --
   8 --        * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
   9 --        * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  10 --        * Neither the name of Tobias Markmann nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
  11 --
  12 --    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.
  13
  14 local s_match = string.match;
  15 local saslprep = require "util.encodings".stringprep.saslprep;
  16 local log = require "util.logger".init("sasl");
  17
  18 module "plain"
  19
  20 -- ================================
  21 -- SASL PLAIN according to RFC 4616
  22
  23 --[[
  24 Supported Authentication Backends
  25
  26 plain:
  27         function(username, realm)
  28                 return password, state;
  29         end
  30
  31 plain_test:
  32         function(username, password, realm)
  33                 return true or false, state;
  34         end
  35 ]]
  36
  37 local function plain(self, message)
  38         if not message then
  39                 return "failure", "malformed-request";
  40         end
  41
  42         local authorization, authentication, password = s_match(message, "^([^%z]*)%z([^%z]+)%z([^%z]+)");
  43
  44         if not authorization then
  45                 return "failure", "malformed-request";
  46         end
  47
  48         -- SASLprep password and authentication
  49         authentication = saslprep(authentication);
  50         password = saslprep(password);
  51
  52         if (not password) or (password == "") or (not authentication) or (authentication == "") then
  53                 log("debug", "Username or password violates SASLprep.");
  54                 return "failure", "malformed-request", "Invalid username or password.";
  55         end
  56
  57         local correct, state = false, false;
  58         if self.profile.plain then
  59                 local correct_password;
  60                 correct_password, state = self.profile.plain(self, authentication, self.realm);
  61                 correct = (correct_password == password);
  62         elseif self.profile.plain_test then
  63                 correct, state = self.profile.plain_test(self, authentication, password, self.realm);
  64         end
  65
  66         self.username = authentication
  67         if not state then
  68                 return "failure", "account-disabled";
  69         end
  70
  71         if correct then
  72                 return "success";
  73         else
  74                 return "failure", "not-authorized", "Unable to authorize you with the authentication credentials you've sent.";
  75         end
  76 end
  77
  78 function init(registerMechanism)
  79         registerMechanism("PLAIN", {"plain", "plain_test"}, plain);
  80 end
  81
  82 return _M;