util/sasl.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
  15 local pairs, ipairs = pairs, ipairs;
  16 local t_insert = table.insert;
  17 local type = type
  18 local setmetatable = setmetatable;
  19 local assert = assert;
  20 local require = require;
  21
  22 module "sasl"
  23
  24 --[[
  25 Authentication Backend Prototypes:
  26
  27 state = false : disabled
  28 state = true : enabled
  29 state = nil : non-existant
  30 ]]
  31
  32 local method = {};
  33 method.__index = method;
  34 local mechanisms = {};
  35 local backend_mechanism = {};
  36
  37 -- register a new SASL mechanims
  38 local function registerMechanism(name, backends, f)
  39         assert(type(name) == "string", "Parameter name MUST be a string.");
  40         assert(type(backends) == "string" or type(backends) == "table", "Parameter backends MUST be either a string or a table.");
  41         assert(type(f) == "function", "Parameter f MUST be a function.");
  42         mechanisms[name] = f
  43         for _, backend_name in ipairs(backends) do
  44                 if backend_mechanism[backend_name] == nil then backend_mechanism[backend_name] = {}; end
  45                 t_insert(backend_mechanism[backend_name], name);
  46         end
  47 end
  48
  49 -- create a new SASL object which can be used to authenticate clients
  50 function new(realm, profile)
  51         local mechanisms = {};
  52         for backend, f in pairs(profile) do
  53                 if backend_mechanism[backend] then
  54                         for _, mechanism in ipairs(backend_mechanism[backend]) do
  55                                 mechanisms[mechanism] = true;
  56                         end
  57                 end
  58         end
  59         return setmetatable({ profile = profile, realm = realm, mechs = mechanisms }, method);
  60 end
  61
  62 -- get a fresh clone with the same realm and profile
  63 function method:clean_clone()
  64         return new(self.realm, self.profile)
  65 end
  66
  67 -- get a list of possible SASL mechanims to use
  68 function method:mechanisms()
  69         return self.mechs;
  70 end
  71
  72 -- select a mechanism to use
  73 function method:select(mechanism)
  74         if not self.selected and self.mechs[mechanism] then
  75                 self.selected = mechanism;
  76                 return true;
  77         end
  78 end
  79
  80 -- feed new messages to process into the library
  81 function method:process(message)
  82         --if message == "" or message == nil then return "failure", "malformed-request" end
  83         return mechanisms[self.selected](self, message);
  84 end
  85
  86 -- load the mechanisms
  87 require "util.sasl.plain"     .init(registerMechanism);
  88 require "util.sasl.digest-md5".init(registerMechanism);
  89 require "util.sasl.anonymous" .init(registerMechanism);
  90 require "util.sasl.scram"     .init(registerMechanism);
  91
  92 return _M;