moduleapi: in module:provides(), add the name of the module in item._provided_by
[prosody.git] / util / sasl.lua
index 94ed3ac984afdc6645179582ba9023b5dbb613c7..afb3861b08f90d70db33d9657da4df77efe43036 100644 (file)
@@ -1,5 +1,5 @@
 -- sasl.lua v0.4
--- Copyright (C) 2008-2009 Tobias Markmann
+-- Copyright (C) 2008-2010 Tobias Markmann
 --
 --    All rights reserved.
 --
 --    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.
 
 
-local md5 = require "util.hashes".md5;
-local log = require "util.logger".init("sasl");
-local tostring = tostring;
-local st = require "util.stanza";
-local generate_uuid = require "util.uuid".generate;
 local pairs, ipairs = pairs, ipairs;
-local t_insert, t_concat = table.insert, table.concat;
-local to_byte, to_char = string.byte, string.char;
-local to_unicode = require "util.encodings".idna.to_unicode;
-local s_match = string.match;
-local gmatch = string.gmatch
-local string = string
-local math = require "math"
+local t_insert = table.insert;
 local type = type
-local error = error
-local print = print
 local setmetatable = setmetatable;
 local assert = assert;
+local require = require;
 
-require "util.iterators"
-local keys = keys
-
-local array = require "util.array"
 module "sasl"
 
 --[[
 Authentication Backend Prototypes:
 
-plain:
-       function(username, realm)
-               return password, state;
-       end
-
-plain-test:
-       function(username, realm, password)
-               return true or false, state;
-       end
-
-digest-md5:
-       function(username, realm, encoding)
-               return digesthash, state;
-       end
-
-digest-md5-test:
-       function(username, realm, encoding, digesthash)
-               return true or false, state;
-       end
+state = false : disabled
+state = true : enabled
+state = nil : non-existant
 ]]
 
 local method = {};
@@ -67,7 +35,7 @@ local mechanisms = {};
 local backend_mechanism = {};
 
 -- register a new SASL mechanims
-local function registerMechanism(name, backends, f)
+function registerMechanism(name, backends, f)
        assert(type(name) == "string", "Parameter name MUST be a string.");
        assert(type(backends) == "string" or type(backends) == "table", "Parameter backends MUST be either a string or a table.");
        assert(type(f) == "function", "Parameter f MUST be a function.");
@@ -80,48 +48,49 @@ end
 
 -- create a new SASL object which can be used to authenticate clients
 function new(realm, profile)
-       sasl_i = {profile = profile};
-       sasl_i.realm = realm;
-       return setmetatable(sasl_i, method);
+       local mechanisms = profile.mechanisms;
+       if not mechanisms then
+               mechanisms = {};
+               for backend, f in pairs(profile) do
+                       if backend_mechanism[backend] then
+                               for _, mechanism in ipairs(backend_mechanism[backend]) do
+                                       mechanisms[mechanism] = true;
+                               end
+                       end
+               end
+               profile.mechanisms = mechanisms;
+       end
+       return setmetatable({ profile = profile, realm = realm, mechs = mechanisms }, method);
+end
+
+-- get a fresh clone with the same realm and profile
+function method:clean_clone()
+       return new(self.realm, self.profile)
 end
 
 -- get a list of possible SASL mechanims to use
 function method:mechanisms()
-       local mechanisms = {}
-       for backend, f in pairs(self.profile) do
-               print(backend)
-               if backend_mechanism[backend] then
-                       for _, mechanism in ipairs(backend_mechanism[backend]) do
-                               mechanisms[mechanism] = true;
-                       end
-               end
-       end
-       self["possible_mechanisms"] = mechanisms;
-       return array.collect(keys(mechanisms));
+       return self.mechs;
 end
 
 -- select a mechanism to use
 function method:select(mechanism)
-       if self.mech_i then
-               return false;
-       end
-       
-       self.mech_i = mechanisms[mechanism]
-       if self.mech_i == nil then 
-               return false;
+       if not self.selected and self.mechs[mechanism] then
+               self.selected = mechanism;
+               return true;
        end
-       return true;
 end
 
 -- feed new messages to process into the library
 function method:process(message)
-       if message == "" or message == nil then return "failure", "malformed-request" end
-       return self.mech_i(self, message);
+       --if message == "" or message == nil then return "failure", "malformed-request" end
+       return mechanisms[self.selected](self, message);
 end
 
 -- load the mechanisms
-require "sasl.plain"
-require "sasl.digest-md5"
-require "sasl.scram"
+require "util.sasl.plain"     .init(registerMechanism);
+require "util.sasl.digest-md5".init(registerMechanism);
+require "util.sasl.anonymous" .init(registerMechanism);
+require "util.sasl.scram"     .init(registerMechanism);
 
 return _M;