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 Channel Binding:
  32
  33 To enable support of channel binding in some mechanisms you need to provide appropriate callbacks in a table
  34 at profile.cb.
  35
  36 Example:
  37         profile.cb["tls-unique"] = function(self)
  38                 return self.user
  39         end
  40
  41 ]]
  42
  43 local method = {};
  44 method.__index = method;
  45 local mechanisms = {};
  46 local backend_mechanism = {};
  47
  48 -- register a new SASL mechanims
  49 local function registerMechanism(name, backends, f)
  50         assert(type(name) == "string", "Parameter name MUST be a string.");
  51         assert(type(backends) == "string" or type(backends) == "table", "Parameter backends MUST be either a string or a table.");
  52         assert(type(f) == "function", "Parameter f MUST be a function.");
  53         mechanisms[name] = f
  54         for _, backend_name in ipairs(backends) do
  55                 if backend_mechanism[backend_name] == nil then backend_mechanism[backend_name] = {}; end
  56                 t_insert(backend_mechanism[backend_name], name);
  57         end
  58 end
  59
  60 -- create a new SASL object which can be used to authenticate clients
  61 function new(realm, profile)
  62         local mechanisms = {};
  63         for backend, f in pairs(profile) do
  64                 if backend_mechanism[backend] then
  65                         for _, mechanism in ipairs(backend_mechanism[backend]) do
  66                                 mechanisms[mechanism] = true;
  67                         end
  68                 end
  69         end
  70         return setmetatable({ profile = profile, realm = realm, mechs = mechanisms }, method);
  71 end
  72
  73 -- add a channel binding handler
  74 function method:add_cb_handler(name, f)
  75         if type(self.profile.cb) ~= "table" then
  76                 self.profile.cb = {};
  77         end
  78         self.profile.cb[name] = f;
  79         return self;
  80 end
  81
  82 -- get a fresh clone with the same realm and profile
  83 function method:clean_clone()
  84         return new(self.realm, self.profile)
  85 end
  86
  87 -- get a list of possible SASL mechanims to use
  88 function method:mechanisms()
  89         return self.mechs;
  90 end
  91
  92 -- select a mechanism to use
  93 function method:select(mechanism)
  94         if not self.selected and self.mechs[mechanism] then
  95                 self.selected = mechanism;
  96                 return true;
  97         end
  98 end
  99
 100 -- feed new messages to process into the library
 101 function method:process(message)
 102         --if message == "" or message == nil then return "failure", "malformed-request" end
 103         return mechanisms[self.selected](self, message);
 104 end
 105
 106 -- load the mechanisms
 107 require "util.sasl.plain"     .init(registerMechanism);
 108 require "util.sasl.digest-md5".init(registerMechanism);
 109 require "util.sasl.anonymous" .init(registerMechanism);
 110 require "util.sasl.scram"     .init(registerMechanism);
 111
 112 return _M;