mod_saslauth: Make service_name configurable for CyrusSASL users.
[prosody.git] / plugins / mod_saslauth.lua
index 81113d7cdec327a16d859cdabb832915b7a98078..19ed972f032d051fbeec1201406024880c63fee0 100644 (file)
@@ -1,7 +1,7 @@
--- Prosody IM v0.4
+-- Prosody IM
 -- Copyright (C) 2008-2009 Matthew Wild
 -- Copyright (C) 2008-2009 Waqas Hussain
--- 
+--
 -- This project is MIT/X11 licensed. Please see the
 -- COPYING file in the source package for more information.
 --
@@ -13,15 +13,19 @@ local sm_bind_resource = require "core.sessionmanager".bind_resource;
 local sm_make_authenticated = require "core.sessionmanager".make_authenticated;
 local base64 = require "util.encodings".base64;
 
+local nodeprep = require "util.encodings".stringprep.nodeprep;
 local datamanager_load = require "util.datamanager".load;
 local usermanager_validate_credentials = require "core.usermanager".validate_credentials;
+local usermanager_get_supported_methods = require "core.usermanager".get_supported_methods;
+local usermanager_user_exists = require "core.usermanager".user_exists;
+local usermanager_get_password = require "core.usermanager".get_password;
 local t_concat, t_insert = table.concat, table.insert;
 local tostring = tostring;
 local jid_split = require "util.jid".split
 local md5 = require "util.hashes".md5;
 local config = require "core.configmanager";
 
-local secure_auth_only = config.get(module:get_host(), "core", "require_encryption");
+local secure_auth_only = config.get(module:get_host(), "core", "c2s_require_encryption") or config.get(module:get_host(), "core", "require_encryption");
 
 local log = module._log;
 
@@ -29,7 +33,36 @@ local xmlns_sasl ='urn:ietf:params:xml:ns:xmpp-sasl';
 local xmlns_bind ='urn:ietf:params:xml:ns:xmpp-bind';
 local xmlns_stanzas ='urn:ietf:params:xml:ns:xmpp-stanzas';
 
-local new_sasl = require "util.sasl".new;
+local new_sasl
+if config.get(module:get_host(), "core", "cyrus_service_name") then
+       cyrus_new = require "util.sasl_cyrus".new;
+       new_sasl = function(realm)
+                       return cyrus_new(realm, config.get(module:get_host(), "core", "cyrus_service_name"))
+               end
+else
+       new_sasl = require "util.sasl".new;
+end
+
+default_authentication_profile = {
+       plain = function(username, realm)
+                       local prepped_username = nodeprep(username);
+                       if not prepped_username then
+                               log("debug", "NODEprep failed on username: %s", username);
+                               return "", nil;
+                       end
+                       local password = usermanager_get_password(prepped_username, realm);
+                       if not password then
+                               return "", nil;
+                       end
+                       return password, true;
+               end
+};
+
+anonymous_authentication_profile = {
+       anonymous = function(username, realm)
+                       return true; -- for normal usage you should always return true here
+               end
+}
 
 local function build_reply(status, ret, err_msg)
        local reply = st.stanza(status, {xmlns = xmlns_sasl});
@@ -50,34 +83,21 @@ end
 
 local function handle_status(session, status)
        if status == "failure" then
-               session.sasl_handler = nil;
+               session.sasl_handler = session.sasl_handler:clean_clone();
        elseif status == "success" then
-               if not session.sasl_handler.username then -- TODO move this to sessionmanager
+               local username = nodeprep(session.sasl_handler.username);
+               if not username then -- TODO move this to sessionmanager
                        module:log("warn", "SASL succeeded but we didn't get a username!");
                        session.sasl_handler = nil;
                        session:reset_stream();
                        return;
-               end 
+               end
                sm_make_authenticated(session, session.sasl_handler.username);
                session.sasl_handler = nil;
                session:reset_stream();
        end
 end
 
-local function password_callback(node, hostname, realm, mechanism, decoder)
-       local password = (datamanager_load(node, hostname, "accounts") or {}).password; -- FIXME handle hashed passwords
-       local func = function(x) return x; end;
-       if password then
-               if mechanism == "PLAIN" then
-                       return func, password;
-               elseif mechanism == "DIGEST-MD5" then
-                       if decoder then node, realm, password = decoder(node), decoder(realm), decoder(password); end
-                       return func, md5(node..":"..realm..":"..password);
-               end
-       end
-       return func, nil;
-end
-
 local function sasl_handler(session, stanza)
        if stanza.name == "auth" then
                -- FIXME ignoring duplicates because ejabberd does
@@ -88,10 +108,13 @@ local function sasl_handler(session, stanza)
                elseif stanza.attr.mechanism == "ANONYMOUS" then
                        return session.send(build_reply("failure", "mechanism-too-weak"));
                end
-               session.sasl_handler = new_sasl(stanza.attr.mechanism, session.host, password_callback);
-               if not session.sasl_handler then
+               local valid_mechanism = session.sasl_handler:select(stanza.attr.mechanism);
+               if not valid_mechanism then
                        return session.send(build_reply("failure", "invalid-mechanism"));
                end
+               if secure_auth_only and not session.secure then
+                       return session.send(build_reply("failure", "encryption-required"));
+               end
        elseif not session.sasl_handler then
                return; -- FIXME ignoring out of order stanzas because ejabberd does
        end
@@ -105,9 +128,9 @@ local function sasl_handler(session, stanza)
                        return;
                end
        end
-       local status, ret, err_msg = session.sasl_handler:feed(text);
+       local status, ret, err_msg = session.sasl_handler:process(text);
        handle_status(session, status);
-       local s = build_reply(status, ret, err_msg); 
+       local s = build_reply(status, ret, err_msg);
        log("debug", "sasl reply: %s", tostring(s));
        session.send(s);
 end
@@ -119,28 +142,32 @@ module:add_handler("c2s_unauthed", "response", xmlns_sasl, sasl_handler);
 local mechanisms_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-sasl' };
 local bind_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-bind' };
 local xmpp_session_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-session' };
-module:add_event_hook("stream-features", 
-               function (session, features)                                                                                            
+module:add_event_hook("stream-features",
+               function (session, features)
                        if not session.username then
                                if secure_auth_only and not session.secure then
                                        return;
                                end
-                               features:tag("mechanisms", mechanisms_attr);
-                               -- TODO: Provide PLAIN only if TLS is active, this is a SHOULD from the introduction of RFC 4616. This behavior could be overridden via configuration but will issuing a warning or so.
-                                       if config.get(session.host or "*", "core", "anonymous_login") then
-                                               features:tag("mechanism"):text("ANONYMOUS"):up();
-                                       else
-                                               features:tag("mechanism"):text("DIGEST-MD5"):up();
-                                               features:tag("mechanism"):text("PLAIN"):up();
+                               if module:get_option("anonymous_login") then
+                                       session.sasl_handler = new_sasl(session.host, anonymous_authentication_profile);
+                               else
+                                       session.sasl_handler = new_sasl(session.host, default_authentication_profile);
+                                       if not (module:get_option("allow_unencrypted_plain_auth")) and not session.secure then
+                                               session.sasl_handler:forbidden({"PLAIN"});
                                        end
+                               end
+                               features:tag("mechanisms", mechanisms_attr);
+                               for k, v in pairs(session.sasl_handler:mechanisms()) do
+                                       features:tag("mechanism"):text(v):up();
+                               end
                                features:up();
                        else
                                features:tag("bind", bind_attr):tag("required"):up():up();
-                               features:tag("session", xmpp_session_attr):up();
+                               features:tag("session", xmpp_session_attr):tag("optional"):up():up();
                        end
                end);
-                                       
-module:add_iq_handler("c2s", "urn:ietf:params:xml:ns:xmpp-bind", 
+
+module:add_iq_handler("c2s", "urn:ietf:params:xml:ns:xmpp-bind",
                function (session, stanza)
                        log("debug", "Client requesting a resource bind");
                        local resource;
@@ -162,8 +189,8 @@ module:add_iq_handler("c2s", "urn:ietf:params:xml:ns:xmpp-bind",
                                        :tag("jid"):text(session.full_jid));
                        end
                end);
-               
-module:add_iq_handler("c2s", "urn:ietf:params:xml:ns:xmpp-session", 
+
+module:add_iq_handler("c2s", "urn:ietf:params:xml:ns:xmpp-session",
                function (session, stanza)
                        log("debug", "Client requesting a session");
                        session.send(st.reply(stanza));