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 md5 = require "util.hashes".md5;
  16 local log = require "util.logger".init("sasl");
  17 local st = require "util.stanza";
  18 local set = require "util.set";
  19 local array = require "util.array";
  20 local to_unicode = require "util.encodings".idna.to_unicode;
  21
  22 local tostring = tostring;
  23 local pairs, ipairs = pairs, ipairs;
  24 local t_insert, t_concat = table.insert, table.concat;
  25 local s_match = string.match;
  26 local type = type
  27 local error = error
  28 local setmetatable = setmetatable;
  29 local assert = assert;
  30 local require = require;
  31
  32 require "util.iterators"
  33 local keys = keys
  34
  35 local array = require "util.array"
  36 module "sasl"
  37
  38 --[[
  39 Authentication Backend Prototypes:
  40
  41 state = false : disabled
  42 state = true : enabled
  43 state = nil : non-existant
  44 ]]
  45
  46 local method = {};
  47 method.__index = method;
  48 local mechanisms = {};
  49 local backend_mechanism = {};
  50
  51 -- register a new SASL mechanims
  52 local function registerMechanism(name, backends, f)
  53         assert(type(name) == "string", "Parameter name MUST be a string.");
  54         assert(type(backends) == "string" or type(backends) == "table", "Parameter backends MUST be either a string or a table.");
  55         assert(type(f) == "function", "Parameter f MUST be a function.");
  56         mechanisms[name] = f
  57         for _, backend_name in ipairs(backends) do
  58                 if backend_mechanism[backend_name] == nil then backend_mechanism[backend_name] = {}; end
  59                 t_insert(backend_mechanism[backend_name], name);
  60         end
  61 end
  62
  63 -- create a new SASL object which can be used to authenticate clients
  64 function new(realm, profile, forbidden)
  65         local sasl_i = {profile = profile};
  66         sasl_i.realm = realm;
  67         local s = setmetatable(sasl_i, method);
  68         if forbidden == nil then forbidden = {} end
  69         s:forbidden(forbidden)
  70         return s;
  71 end
  72
  73 -- get a fresh clone with the same realm, profiles and forbidden mechanisms
  74 function method:clean_clone()
  75         return new(self.realm, self.profile, self:forbidden())
  76 end
  77
  78 -- set the forbidden mechanisms
  79 function method:forbidden( restrict )
  80         if restrict then
  81                 -- set forbidden
  82                 self.restrict = set.new(restrict);
  83         else
  84                 -- get forbidden
  85                 return array.collect(self.restrict:items());
  86         end
  87 end
  88
  89 -- get a list of possible SASL mechanims to use
  90 function method:mechanisms()
  91         local mechanisms = {}
  92         for backend, f in pairs(self.profile) do
  93                 if backend_mechanism[backend] then
  94                         for _, mechanism in ipairs(backend_mechanism[backend]) do
  95                                 if not self.restrict:contains(mechanism) then
  96                                         mechanisms[mechanism] = true;
  97                                 end
  98                         end
  99                 end
 100         end
 101         self["possible_mechanisms"] = mechanisms;
 102         return array.collect(keys(mechanisms));
 103 end
 104
 105 -- select a mechanism to use
 106 function method:select(mechanism)
 107         if self.mech_i then
 108                 return false;
 109         end
 110
 111         self.mech_i = mechanisms[mechanism]
 112         if self.mech_i == nil then
 113                 return false;
 114         end
 115         return true;
 116 end
 117
 118 -- feed new messages to process into the library
 119 function method:process(message)
 120         --if message == "" or message == nil then return "failure", "malformed-request" end
 121         return self.mech_i(self, message);
 122 end
 123
 124 -- load the mechanisms
 125 local load_mechs = {"plain", "digest-md5", "anonymous", "scram"}
 126 for _, mech in ipairs(load_mechs) do
 127         local name = "util.sasl."..mech;
 128         local m = require(name);
 129         m.init(registerMechanism)
 130 end
 131
 132 return _M;