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
  17 local setmetatable = setmetatable
  18
  19 local pcall = pcall
  20 local s_match, s_gmatch = string.match, string.gmatch
  21
  22 local sasl_errstring = {
  23         -- SASL result codes --
  24         [1]   = "another step is needed in authentication";
  25         [0]   = "successful result";
  26         [-1]  = "generic failure";
  27         [-2]  = "memory shortage failure";
  28         [-3]  = "overflowed buffer";
  29         [-4]  = "mechanism not supported";
  30         [-5]  = "bad protocol / cancel";
  31         [-6]  = "can't request info until later in exchange";
  32         [-7]  = "invalid parameter supplied";
  33         [-8]  = "transient failure (e.g., weak key)";
  34         [-9]  = "integrity check failed";
  35         [-12] = "SASL library not initialized";
  36
  37         -- client only codes --
  38         [2]   = "needs user interaction";
  39         [-10] = "server failed mutual authentication step";
  40         [-11] = "mechanism doesn't support requested feature";
  41
  42         -- server only codes --
  43         [-13] = "authentication failure";
  44         [-14] = "authorization failure";
  45         [-15] = "mechanism too weak for this user";
  46         [-16] = "encryption needed to use mechanism";
  47         [-17] = "One time use of a plaintext password will enable requested mechanism for user";
  48         [-18] = "passphrase expired, has to be reset";
  49         [-19] = "account disabled";
  50         [-20] = "user not found";
  51         [-23] = "version mismatch with plug-in";
  52         [-24] = "remote authentication server unavailable";
  53         [-26] = "user exists, but no verifier for user";
  54
  55         -- codes for password setting --
  56         [-21] = "passphrase locked";
  57         [-22] = "requested change was not needed";
  58         [-27] = "passphrase is too weak for security policy";
  59         [-28] = "user supplied passwords not permitted";
  60 };
  61 setmetatable(sasl_errstring, { __index = function() return "undefined error!" end });
  62
  63 local _ENV = nil;
  64
  65 local method = {};
  66 method.__index = method;
  67 local initialized = false;
  68
  69 local function init(service_name)
  70         if not initialized then
  71                 local st, errmsg = pcall(cyrussasl.server_init, service_name);
  72                 if st then
  73                         initialized = true;
  74                 else
  75                         log("error", "Failed to initialize Cyrus SASL: %s", errmsg);
  76                 end
  77         end
  78 end
  79
  80 -- create a new SASL object which can be used to authenticate clients
  81 -- host_fqdn may be nil in which case gethostname() gives the value.
  82 --      For GSSAPI, this determines the hostname in the service ticket (after
  83 --      reverse DNS canonicalization, only if [libdefaults] rdns = true which
  84 --      is the default).
  85 local function new(realm, service_name, app_name, host_fqdn)
  86
  87         init(app_name or service_name);
  88
  89         local st, ret = pcall(cyrussasl.server_new, service_name, host_fqdn, realm, nil, nil)
  90         if not st then
  91                 log("error", "Creating SASL server connection failed: %s", ret);
  92                 return nil;
  93         end
  94
  95         local sasl_i = { realm = realm, service_name = service_name, cyrus = ret };
  96
  97         if cyrussasl.set_canon_cb then
  98                 local c14n_cb = function (user)
  99                         local node = s_match(user, "^([^@]+)");
 100                         log("debug", "Canonicalizing username %s to %s", user, node)
 101                         return node
 102                 end
 103                 cyrussasl.set_canon_cb(sasl_i.cyrus, c14n_cb);
 104         end
 105
 106         cyrussasl.setssf(sasl_i.cyrus, 0, 0xffffffff)
 107         local mechanisms = {};
 108         local cyrus_mechs = cyrussasl.listmech(sasl_i.cyrus, nil, "", " ", "");
 109         for w in s_gmatch(cyrus_mechs, "[^ ]+") do
 110                 mechanisms[w] = true;
 111         end
 112         sasl_i.mechs = mechanisms;
 113         return setmetatable(sasl_i, method);
 114 end
 115
 116 -- get a fresh clone with the same realm and service name
 117 function method:clean_clone()
 118         return new(self.realm, self.service_name)
 119 end
 120
 121 -- get a list of possible SASL mechanims to use
 122 function method:mechanisms()
 123         return self.mechs;
 124 end
 125
 126 -- select a mechanism to use
 127 function method:select(mechanism)
 128         if not self.selected and self.mechs[mechanism] then
 129                 self.selected = mechanism;
 130                 return true;
 131         end
 132 end
 133
 134 -- feed new messages to process into the library
 135 function method:process(message)
 136         local err;
 137         local data;
 138
 139         if not self.first_step_done then
 140                 err, data = cyrussasl.server_start(self.cyrus, self.selected, message or "")
 141                 self.first_step_done = true;
 142         else
 143                 err, data = cyrussasl.server_step(self.cyrus, message or "")
 144         end
 145
 146         self.username = cyrussasl.get_username(self.cyrus)
 147
 148         if (err == 0) then -- SASL_OK
 149                 if self.require_provisioning and not self.require_provisioning(self.username) then
 150                         return "failure", "not-authorized", "User authenticated successfully, but not provisioned for XMPP";
 151                 end
 152                 return "success", data
 153         elseif (err == 1) then -- SASL_CONTINUE
 154                 return "challenge", data
 155         elseif (err == -4) then -- SASL_NOMECH
 156                 log("debug", "SASL mechanism not available from remote end")
 157                 return "failure", "invalid-mechanism", "SASL mechanism not available"
 158         elseif (err == -13) then -- SASL_BADAUTH
 159                 return "failure", "not-authorized", sasl_errstring[err];
 160         else
 161                 log("debug", "Got SASL error condition %d: %s", err, sasl_errstring[err]);
 162                 return "failure", "undefined-condition", sasl_errstring[err];
 163         end
 164 end
 165
 166 return {
 167         new = new;
 168 };