util/sasl_cyrus.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 cyrussasl = require "cyrussasl";
  15 local log = require "util.logger".init("sasl_cyrus");
  16 local array = require "util.array";
  17
  18 local tostring = tostring;
  19 local pairs, ipairs = pairs, ipairs;
  20 local t_insert, t_concat = table.insert, table.concat;
  21 local s_match = string.match;
  22
  23 local keys = keys;
  24
  25 local print = print
  26
  27 module "sasl_cyrus"
  28
  29 local method = {};
  30 method.__index = method;
  31 local mechanisms = {};
  32 local backend_mechanism = {};
  33
  34 -- register a new SASL mechanims
  35 local function registerMechanism(name, backends, f)
  36         assert(type(name) == "string", "Parameter name MUST be a string.");
  37         assert(type(backends) == "string" or type(backends) == "table", "Parameter backends MUST be either a string or a table.");
  38         assert(type(f) == "function", "Parameter f MUST be a function.");
  39         mechanisms[name] = f
  40         for _, backend_name in ipairs(backends) do
  41                 if backend_mechanism[backend_name] == nil then backend_mechanism[backend_name] = {}; end
  42                 t_insert(backend_mechanism[backend_name], name);
  43         end
  44 end
  45
  46 -- create a new SASL object which can be used to authenticate clients
  47 function new(realm, service_name)
  48         local sasl_i = {};
  49         sasl_i.realm = realm;
  50         sasl_i.service_name = service_name;
  51         sasl_i.cyrus = cyrussasl.server_new(service_name, realm, realm, nil, nil)
  52         if sasl_i.cyrus == 0 then
  53                 log("error", "got NULL return value from server_new")
  54                 return nil;
  55         end
  56         cyrussasl.setssf(sasl_i.cyrus, 0, 0xffffffff)
  57         local s = setmetatable(sasl_i, method);
  58         return s;
  59 end
  60
  61 -- get a fresh clone with the same realm, profiles and forbidden mechanisms
  62 function method:clean_clone()
  63         return new(self.realm, self.service_name)
  64 end
  65
  66 -- set the forbidden mechanisms
  67 function method:forbidden( restrict )
  68         log("debug", "Called method:forbidden. NOT IMPLEMENTED.")
  69         return {}
  70 end
  71
  72 -- get a list of possible SASL mechanims to use
  73 function method:mechanisms()
  74         local mechanisms = {}
  75         local cyrus_mechs = cyrussasl.listmech(self.cyrus)
  76         for w in s_gmatch(cyrus_mechs, "%a+") do
  77                 mechanisms[w] = true;
  78         end
  79         self.mechanisms = mechanisms
  80         return array.collect(keys(mechanisms));
  81 end
  82
  83 -- select a mechanism to use
  84 function method:select(mechanism)
  85         self.mechanism = mechanism;
  86         return not self.mechanisms[mechanisms];
  87 end
  88
  89 -- feed new messages to process into the library
  90 function method:process(message)
  91         local err;
  92         local data;
  93         if self.mechanism then
  94                 err, data = cyrussasl.server_start(self.cyrus, self.mechanism, message)
  95         else
  96                 err, data = cyrussasl.server_step(self.cyrus, message)
  97         end
  98
  99         self.username = cyrussasl.get_username(self.cyrus)
 100
 101         if (err == 0) then -- SASL_OK
 102            return "success", data
 103         elseif (err == 1) then -- SASL_CONTINUE
 104            return "challenge", data
 105         elseif (err == -4) then -- SASL_NOMECH
 106            log("debug", "SASL mechanism not available from remote end")
 107            return "failure",
 108              "undefined-condition",
 109              "SASL mechanism not available"
 110         elseif (err == -13) then -- SASL_BADAUTH
 111            return "failure", "not-authorized"
 112         else
 113            log("debug", "Got SASL error condition %d", err)
 114            return "failure",
 115              "undefined-condition",
 116              cyrussasl.get_message( self.cyrus )
 117         end
 118 end
 119
 120 return _M;