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