plugins/mod_saslauth.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2009 Matthew Wild
   3 -- Copyright (C) 2008-2009 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9
  10
  11 local st = require "util.stanza";
  12 local sm_bind_resource = require "core.sessionmanager".bind_resource;
  13 local sm_make_authenticated = require "core.sessionmanager".make_authenticated;
  14 local base64 = require "util.encodings".base64;
  15
  16 local datamanager_load = require "util.datamanager".load;
  17 local usermanager_validate_credentials = require "core.usermanager".validate_credentials;
  18 local usermanager_get_supported_methods = require "core.usermanager".get_supported_methods;
  19 local usermanager_user_exists = require "core.usermanager".user_exists;
  20 local usermanager_get_password = require "core.usermanager".get_password;
  21 local t_concat, t_insert = table.concat, table.insert;
  22 local tostring = tostring;
  23 local jid_split = require "util.jid".split
  24 local md5 = require "util.hashes".md5;
  25 local config = require "core.configmanager";
  26
  27 local secure_auth_only = config.get(module:get_host(), "core", "require_encryption");
  28
  29 local log = module._log;
  30
  31 local xmlns_sasl ='urn:ietf:params:xml:ns:xmpp-sasl';
  32 local xmlns_bind ='urn:ietf:params:xml:ns:xmpp-bind';
  33 local xmlns_stanzas ='urn:ietf:params:xml:ns:xmpp-stanzas';
  34
  35 local new_sasl = require "util.sasl".new;
  36
  37 local function build_reply(status, ret, err_msg)
  38         local reply = st.stanza(status, {xmlns = xmlns_sasl});
  39         if status == "challenge" then
  40                 log("debug", "%s", ret or "");
  41                 reply:text(base64.encode(ret or ""));
  42         elseif status == "failure" then
  43                 reply:tag(ret):up();
  44                 if err_msg then reply:tag("text"):text(err_msg); end
  45         elseif status == "success" then
  46                 log("debug", "%s", ret or "");
  47                 reply:text(base64.encode(ret or ""));
  48         else
  49                 module:log("error", "Unknown sasl status: %s", status);
  50         end
  51         return reply;
  52 end
  53
  54 local function handle_status(session, status)
  55         if status == "failure" then
  56                 session.sasl_handler = nil;
  57         elseif status == "success" then
  58                 if not session.sasl_handler.username then -- TODO move this to sessionmanager
  59                         module:log("warn", "SASL succeeded but we didn't get a username!");
  60                         session.sasl_handler = nil;
  61                         session:reset_stream();
  62                         return;
  63                 end
  64                 sm_make_authenticated(session, session.sasl_handler.username);
  65                 session.sasl_handler = nil;
  66                 session:reset_stream();
  67         end
  68 end
  69
  70 local function credentials_callback(mechanism, ...)
  71   if mechanism == "PLAIN" then
  72     local username, hostname, password = arg[1], arg[2], arg[3];
  73     local response = usermanager_validate_credentials(hostname, username, password, mechanism)
  74     if response == nil then return false
  75     else return response end
  76   elseif mechanism == "DIGEST-MD5" then
  77     function func(x) return x; end
  78     local node, domain, realm, decoder = arg[1], arg[2], arg[3], arg[4];
  79     local password = usermanager_get_password(node, domain)
  80     if decoder then node, realm, password = decoder(node), decoder(realm), decoder(password); end
  81     return func, md5(node..":"..realm..":"..password);
  82   end
  83 end
  84
  85 local function sasl_handler(session, stanza)
  86         if stanza.name == "auth" then
  87                 -- FIXME ignoring duplicates because ejabberd does
  88                 if config.get(session.host or "*", "core", "anonymous_login") then
  89                         if stanza.attr.mechanism ~= "ANONYMOUS" then
  90                                 return session.send(build_reply("failure", "invalid-mechanism"));
  91                         end
  92                 elseif stanza.attr.mechanism == "ANONYMOUS" then
  93                         return session.send(build_reply("failure", "mechanism-too-weak"));
  94                 end
  95                 session.sasl_handler = new_sasl(stanza.attr.mechanism, session.host, credentials_callback);
  96                 if not session.sasl_handler then
  97                         return session.send(build_reply("failure", "invalid-mechanism"));
  98                 end
  99         elseif not session.sasl_handler then
 100                 return; -- FIXME ignoring out of order stanzas because ejabberd does
 101         end
 102         local text = stanza[1];
 103         if text then
 104                 text = base64.decode(text);
 105                 log("debug", "%s", text);
 106                 if not text then
 107                         session.sasl_handler = nil;
 108                         session.send(build_reply("failure", "incorrect-encoding"));
 109                         return;
 110                 end
 111         end
 112         local status, ret, err_msg = session.sasl_handler:feed(text);
 113         handle_status(session, status);
 114         local s = build_reply(status, ret, err_msg);
 115         log("debug", "sasl reply: %s", tostring(s));
 116         session.send(s);
 117 end
 118
 119 module:add_handler("c2s_unauthed", "auth", xmlns_sasl, sasl_handler);
 120 module:add_handler("c2s_unauthed", "abort", xmlns_sasl, sasl_handler);
 121 module:add_handler("c2s_unauthed", "response", xmlns_sasl, sasl_handler);
 122
 123 local mechanisms_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-sasl' };
 124 local bind_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-bind' };
 125 local xmpp_session_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-session' };
 126 module:add_event_hook("stream-features",
 127                 function (session, features)
 128                         if not session.username then
 129                                 if secure_auth_only and not session.secure then
 130                                         return;
 131                                 end
 132                                 features:tag("mechanisms", mechanisms_attr);
 133                                 -- 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.
 134                                         if config.get(session.host or "*", "core", "anonymous_login") then
 135                                                 features:tag("mechanism"):text("ANONYMOUS"):up();
 136                                         else
 137                                                 mechanisms = usermanager_get_supported_methods(session.host or "*");
 138                                                 for k, v in pairs(mechanisms) do
 139                                                         features:tag("mechanism"):text(k):up();
 140                                                 end
 141                                         end
 142                                 features:up();
 143                         else
 144                                 features:tag("bind", bind_attr):tag("required"):up():up();
 145                                 features:tag("session", xmpp_session_attr):up();
 146                         end
 147                 end);
 148
 149 module:add_iq_handler("c2s", "urn:ietf:params:xml:ns:xmpp-bind",
 150                 function (session, stanza)
 151                         log("debug", "Client requesting a resource bind");
 152                         local resource;
 153                         if stanza.attr.type == "set" then
 154                                 local bind = stanza.tags[1];
 155                                 if bind and bind.attr.xmlns == xmlns_bind then
 156                                         resource = bind:child_with_name("resource");
 157                                         if resource then
 158                                                 resource = resource[1];
 159                                         end
 160                                 end
 161                         end
 162                         local success, err_type, err, err_msg = sm_bind_resource(session, resource);
 163                         if not success then
 164                                 session.send(st.error_reply(stanza, err_type, err, err_msg));
 165                         else
 166                                 session.send(st.reply(stanza)
 167                                         :tag("bind", { xmlns = xmlns_bind})
 168                                         :tag("jid"):text(session.full_jid));
 169                         end
 170                 end);
 171
 172 module:add_iq_handler("c2s", "urn:ietf:params:xml:ns:xmpp-session",
 173                 function (session, stanza)
 174                         log("debug", "Client requesting a session");
 175                         session.send(st.reply(stanza));
 176                 end);