util/sasl/plain.lua

   1 -- sasl.lua v0.4
   2 -- Copyright (C) 2008-2009 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 local function plain(self, message)
  23         if not message then
  24                 return "failure", "malformed-request";
  25         end
  26
  27         local authorization, authentication, password = s_match(message, "^([^%z]+)%z([^%z]+)%z([^%z]+)");
  28
  29         if not authorization then
  30                 return "failure", "malformed-request";
  31         end
  32
  33         -- SASLprep password and authentication
  34         authentication = saslprep(authentication);
  35         password = saslprep(password);
  36
  37         if (not password) or (password == "") or (not authentication) or (authentication == "") then
  38                 log("debug", "Username or password violates SASLprep.");
  39                 return "failure", "malformed-request", "Invalid username or password.";
  40         end
  41
  42         local correct, state = false, false;
  43         if self.profile.plain then
  44                 local correct_password;
  45                 correct_password, state = self.profile.plain(authentication, self.realm);
  46                 if correct_password == password then correct = true; else correct = false; end
  47         elseif self.profile.plain_test then
  48                 correct, state = self.profile.plain_test(authentication, self.realm, password);
  49         end
  50
  51         self.username = authentication
  52         if not state then
  53                 return "failure", "account-disabled";
  54         end
  55
  56         if correct then
  57                 return "success";
  58         else
  59                 return "failure", "not-authorized", "Unable to authorize you with the authentication credentials you've sent.";
  60         end
  61 end
  62
  63 function init(registerMechanism)
  64         registerMechanism("PLAIN", {"plain", "plain_test"}, plain);
  65 end
  66
  67 return _M;