Merge 0.6->0.7
[prosody.git] / plugins / mod_saslauth.lua
index 03ea6c8a58b8121caa99f8380b808822ae11f5dc..d407e5da8588ff5bc8787e05fb5232c34326b03e 100644 (file)
 local st = require "util.stanza";
 local sm_bind_resource = require "core.sessionmanager".bind_resource;
 local sm_make_authenticated = require "core.sessionmanager".make_authenticated;
-local s2s_make_authenticated = require "core.s2smanager".make_authenticated;
 local base64 = require "util.encodings".base64;
 
-local cert_verify_identity = require "util.x509".verify_identity;
-
 local nodeprep = require "util.encodings".stringprep.nodeprep;
-local usermanager_get_sasl_handler = require "core.usermanager".get_sasl_handler;
+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 = module:get_option("c2s_require_encryption") or module:get_option("require_encryption");
-local anonymous_login = module:get_option("anonymous_login");
-local allow_unencrypted_plain_auth = module:get_option("allow_unencrypted_plain_auth")
+local sasl_backend = module:get_option("sasl_backend") or "builtin";
+
+-- Cyrus config options
+local require_provisioning = module:get_option("cyrus_require_provisioning") or false;
+local cyrus_service_realm = module:get_option("cyrus_service_realm");
+local cyrus_service_name = module:get_option("cyrus_service_name");
+local cyrus_application_name = module:get_option("cyrus_application_name");
 
 local log = module._log;
 
@@ -31,10 +40,49 @@ 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 sasl_backend == "builtin" then
+       new_sasl = require "util.sasl".new;
+elseif sasl_backend == "cyrus" then
+       prosody.unlock_globals(); --FIXME: Figure out why this is needed and
+                                 -- why cyrussasl isn't caught by the sandbox
+       local ok, cyrus = pcall(require, "util.sasl_cyrus");
+       prosody.lock_globals();
+       if ok then
+               local cyrus_new = cyrus.new;
+               new_sasl = function(realm)
+                       return cyrus_new(
+                               cyrus_service_realm or realm,
+                               cyrus_service_name or "xmpp",
+                               cyrus_application_name or "prosody"
+                       );
+               end
+       else
+               module:log("error", "Failed to load Cyrus SASL because: %s", cyrus);
+               error("Failed to load Cyrus SASL");
+       end
+else
+       module:log("error", "Unknown SASL backend: %s", sasl_backend);
+       error("Unknown SASL backend");
+end
+
+local 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
+};
 
 local anonymous_authentication_profile = {
-       anonymous = function(sasl, username, realm)
+       anonymous = function(username, realm)
                return true; -- for normal usage you should always return true here
        end
 };
@@ -62,20 +110,45 @@ local function handle_status(session, status, ret, err_msg)
        elseif status == "success" then
                local username = nodeprep(session.sasl_handler.username);
 
-               local ok, err = sm_make_authenticated(session, session.sasl_handler.username);
-               if ok then
-                       session.sasl_handler = nil;
-                       session:reset_stream();
+               if not(require_provisioning) or usermanager_user_exists(username, session.host) then
+                       local aret, err = sm_make_authenticated(session, session.sasl_handler.username);
+                       if aret then
+                               session.sasl_handler = nil;
+                               session:reset_stream();
+                       else
+                               module:log("warn", "SASL succeeded but username was invalid");
+                               session.sasl_handler = session.sasl_handler:clean_clone();
+                               return "failure", "not-authorized", "User authenticated successfully, but username was invalid";
+                       end
                else
-                       module:log("warn", "SASL succeeded but username was invalid");
+                       module:log("warn", "SASL succeeded but we don't have an account provisioned for %s", username);
                        session.sasl_handler = session.sasl_handler:clean_clone();
-                       return "failure", "not-authorized", "User authenticated successfully, but username was invalid";
+                       return "failure", "not-authorized", "User authenticated successfully, but not provisioned for XMPP";
                end
        end
        return status, ret, err_msg;
 end
 
-local function sasl_process_cdata(session, stanza)
+local function sasl_handler(session, stanza)
+       if stanza.name == "auth" then
+               -- FIXME ignoring duplicates because ejabberd does
+               if config.get(session.host or "*", "core", "anonymous_login") then
+                       if stanza.attr.mechanism ~= "ANONYMOUS" then
+                               return session.send(build_reply("failure", "invalid-mechanism"));
+                       end
+               elseif stanza.attr.mechanism == "ANONYMOUS" then
+                       return session.send(build_reply("failure", "mechanism-too-weak"));
+               end
+               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
        local text = stanza[1];
        if text then
                text = base64.decode(text);
@@ -83,7 +156,7 @@ local function sasl_process_cdata(session, stanza)
                if not text then
                        session.sasl_handler = nil;
                        session.send(build_reply("failure", "incorrect-encoding"));
-                       return true;
+                       return;
                end
        end
        local status, ret, err_msg = session.sasl_handler:process(text);
@@ -91,173 +164,11 @@ local function sasl_process_cdata(session, stanza)
        local s = build_reply(status, ret, err_msg);
        log("debug", "sasl reply: %s", tostring(s));
        session.send(s);
-       return true;
 end
 
-module:hook_stanza(xmlns_sasl, "success", function (session, stanza)
-       if session.type ~= "s2sout_unauthed" or session.external_auth ~= "attempting" then return; end
-       module:log("debug", "SASL EXTERNAL with %s succeeded", session.to_host);
-       session.external_auth = "succeeded"
-       session:reset_stream();
-
-       local default_stream_attr = {xmlns = "jabber:server", ["xmlns:stream"] = "http://etherx.jabber.org/streams",
-                                   ["xmlns:db"] = 'jabber:server:dialback', version = "1.0", to = session.to_host, from = session.from_host};
-       session.sends2s("<?xml version='1.0'?>");
-       session.sends2s(st.stanza("stream:stream", default_stream_attr):top_tag());
-
-       s2s_make_authenticated(session, session.to_host);
-       return true;
-end)
-
-module:hook_stanza(xmlns_sasl, "failure", function (session, stanza)
-       if session.type ~= "s2sout_unauthed" or session.external_auth ~= "attempting" then return; end
-
-       module:log("info", "SASL EXTERNAL with %s failed", session.to_host)
-       -- TODO: Log the failure reason
-       session.external_auth = "failed"
-end, 500)
-
-module:hook_stanza(xmlns_sasl, "failure", function (session, stanza)
-       -- TODO: Dialback wasn't loaded.  Do something useful.
-end, 90)
-
-module:hook_stanza("http://etherx.jabber.org/streams", "features", function (session, stanza)
-       if session.type ~= "s2sout_unauthed" or not session.secure then return; end
-
-       local mechanisms = stanza:get_child("mechanisms", xmlns_sasl)
-       if mechanisms then
-               for mech in mechanisms:childtags() do
-                       if mech[1] == "EXTERNAL" then
-                               module:log("debug", "Initiating SASL EXTERNAL with %s", session.to_host);
-                               local reply = st.stanza("auth", {xmlns = xmlns_sasl, mechanism = "EXTERNAL"});
-                               reply:text(base64.encode(session.from_host))
-                               session.sends2s(reply)
-                               session.external_auth = "attempting"
-                               return true
-                       end
-               end
-       end
-end, 150);
-
-local function s2s_external_auth(session, stanza)
-       local mechanism = stanza.attr.mechanism;
-
-       if not session.secure then
-               if mechanism == "EXTERNAL" then
-                       session.sends2s(build_reply("failure", "encryption-required"))
-               else
-                       session.sends2s(build_reply("failure", "invalid-mechanism"))
-               end
-               return true;
-       end
-
-       if mechanism ~= "EXTERNAL" or session.cert_chain_status ~= "valid" then
-               session.sends2s(build_reply("failure", "invalid-mechanism"))
-               return true;
-       end
-
-       local text = stanza[1]
-       if not text then
-               session.sends2s(build_reply("failure", "malformed-request"))
-               return true
-       end
-
-       -- Either the value is "=" and we've already verified the external
-       -- cert identity, or the value is a string and either matches the
-       -- from_host (
-
-       text = base64.decode(text)
-       if not text then
-               session.sends2s(build_reply("failure", "incorrect-encoding"))
-               return true;
-       end
-
-       if session.cert_identity_status == "valid" then
-               if text ~= "" and text ~= session.from_host then
-                       session.sends2s(build_reply("failure", "invalid-authzid"))
-                       return true
-               end
-       else
-               if text == "" then
-                       session.sends2s(build_reply("failure", "invalid-authzid"))
-                       return true
-               end
-
-               local cert = session.conn:socket():getpeercertificate()
-               if (cert_verify_identity(text, "xmpp-server", cert)) then
-                       session.cert_identity_status = "valid"
-               else
-                       session.cert_identity_status = "invalid"
-                       session.sends2s(build_reply("failure", "invalid-authzid"))
-                       return true
-               end
-       end
-
-       session.external_auth = "succeeded"
-
-       if not session.from_host then
-               session.from_host = text;
-       end
-       session.sends2s(build_reply("success"))
-       module:log("info", "Accepting SASL EXTERNAL identity from %s", text or session.from_host);
-       s2s_make_authenticated(session, text or session.from_host)
-       session:reset_stream();
-       return true
-end
-
-module:hook("stanza/urn:ietf:params:xml:ns:xmpp-sasl:auth", function(event)
-       local session, stanza = event.origin, event.stanza;
-       if session.type == "s2sin_unauthed" then
-               return s2s_external_auth(session, stanza)
-       end
-
-       if session.type ~= "c2s_unauthed" then return; end
-
-       if session.sasl_handler and session.sasl_handler.selected then
-               session.sasl_handler = nil; -- allow starting a new SASL negotiation before completing an old one
-       end
-       if not session.sasl_handler then
-               if anonymous_login then
-                       session.sasl_handler = new_sasl(module.host, anonymous_authentication_profile);
-               else
-                       session.sasl_handler = usermanager_get_sasl_handler(module.host);
-               end
-       end
-       local mechanism = stanza.attr.mechanism;
-       if anonymous_login then
-               if mechanism ~= "ANONYMOUS" then
-                       session.send(build_reply("failure", "invalid-mechanism"));
-                       return true;
-               end
-       elseif mechanism == "ANONYMOUS" then
-               session.send(build_reply("failure", "mechanism-too-weak"));
-               return true;
-       end
-       if not session.secure and (secure_auth_only or (mechanism == "PLAIN" and not allow_unencrypted_plain_auth)) then
-               session.send(build_reply("failure", "encryption-required"));
-               return true;
-       end
-       local valid_mechanism = session.sasl_handler:select(mechanism);
-       if not valid_mechanism then
-               session.send(build_reply("failure", "invalid-mechanism"));
-               return true;
-       end
-       return sasl_process_cdata(session, stanza);
-end);
-module:hook("stanza/urn:ietf:params:xml:ns:xmpp-sasl:response", function(event)
-       local session = event.origin;
-       if not(session.sasl_handler and session.sasl_handler.selected) then
-               session.send(build_reply("failure", "not-authorized", "Out of order SASL element"));
-               return true;
-       end
-       return sasl_process_cdata(session, event.stanza);
-end);
-module:hook("stanza/urn:ietf:params:xml:ns:xmpp-sasl:abort", function(event)
-       local session = event.origin;
-       session.sasl_handler = nil;
-       session.send(build_reply("failure", "aborted"));
-       return true;
-end);
+module:add_handler("c2s_unauthed", "auth", xmlns_sasl, sasl_handler);
+module:add_handler("c2s_unauthed", "abort", xmlns_sasl, sasl_handler);
+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' };
@@ -268,16 +179,18 @@ module:hook("stream-features", function(event)
                if secure_auth_only and not origin.secure then
                        return;
                end
-               if anonymous_login then
-                       origin.sasl_handler = new_sasl(module.host, anonymous_authentication_profile);
+               local realm = module:get_option("sasl_realm") or origin.host;
+               if module:get_option("anonymous_login") then
+                       origin.sasl_handler = new_sasl(realm, anonymous_authentication_profile);
                else
-                       origin.sasl_handler = usermanager_get_sasl_handler(module.host);
+                       origin.sasl_handler = new_sasl(realm, default_authentication_profile);
+                       if not (module:get_option("allow_unencrypted_plain_auth")) and not origin.secure then
+                               origin.sasl_handler:forbidden({"PLAIN"});
+                       end
                end
                features:tag("mechanisms", mechanisms_attr);
-               for mechanism in pairs(origin.sasl_handler:mechanisms()) do
-                       if mechanism ~= "PLAIN" or origin.secure or allow_unencrypted_plain_auth then
-                               features:tag("mechanism"):text(mechanism):up();
-                       end
+               for k, v in pairs(origin.sasl_handler:mechanisms()) do
+                       features:tag("mechanism"):text(v):up();
                end
                features:up();
        else
@@ -286,45 +199,29 @@ module:hook("stream-features", function(event)
        end
 end);
 
-module:hook("s2s-stream-features", function(event)
-       local origin, features = event.origin, event.features;
-       if origin.secure and origin.type == "s2sin_unauthed" then
-               -- Offer EXTERNAL if chain is valid and either we didn't validate
-               -- the identity or it passed.
-               if origin.cert_chain_status == "valid" and origin.cert_identity_status ~= "invalid" then --TODO: Configurable
-                       module:log("debug", "Offering SASL EXTERNAL")
-                       features:tag("mechanisms", { xmlns = xmlns_sasl })
-                               :tag("mechanism"):text("EXTERNAL")
-                       :up():up();
-               end
-       end
-end);
-
-module:hook("iq/self/urn:ietf:params:xml:ns:xmpp-bind:bind", function(event)
-       local origin, stanza = event.origin, event.stanza;
+module:add_iq_handler("c2s", "urn:ietf:params:xml:ns:xmpp-bind", function(session, stanza)
+       log("debug", "Client requesting a resource bind");
        local resource;
        if stanza.attr.type == "set" then
                local bind = stanza.tags[1];
-               resource = bind:child_with_name("resource");
-               resource = resource and #resource.tags == 0 and resource[1] or nil;
+               if bind and bind.attr.xmlns == xmlns_bind then
+                       resource = bind:child_with_name("resource");
+                       if resource then
+                               resource = resource[1];
+                       end
+               end
        end
-       local success, err_type, err, err_msg = sm_bind_resource(origin, resource);
-       if success then
-               origin.send(st.reply(stanza)
-                       :tag("bind", { xmlns = xmlns_bind })
-                       :tag("jid"):text(origin.full_jid));
-               origin.log("debug", "Resource bound: %s", origin.full_jid);
+       local success, err_type, err, err_msg = sm_bind_resource(session, resource);
+       if not success then
+               session.send(st.error_reply(stanza, err_type, err, err_msg));
        else
-               origin.send(st.error_reply(stanza, err_type, err, err_msg));
-               origin.log("debug", "Resource bind failed: %s", err_msg or err);
+               session.send(st.reply(stanza)
+                       :tag("bind", { xmlns = xmlns_bind})
+                       :tag("jid"):text(session.full_jid));
        end
-       return true;
 end);
 
-local function handle_legacy_session(event)
-       event.origin.send(st.reply(event.stanza));
-       return true;
-end
-
-module:hook("iq/self/urn:ietf:params:xml:ns:xmpp-session:session", handle_legacy_session);
-module:hook("iq/host/urn:ietf:params:xml:ns:xmpp-session:session", handle_legacy_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));
+end);