2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
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;
16 local cert_verify_identity = require "util.x509".verify_identity;
18 local usermanager_get_sasl_handler = require "core.usermanager".get_sasl_handler;
19 local tostring = tostring;
21 local secure_auth_only = module:get_option("c2s_require_encryption") or module:get_option("require_encryption");
22 local allow_unencrypted_plain_auth = module:get_option("allow_unencrypted_plain_auth")
24 local log = module._log;
26 local xmlns_sasl ='urn:ietf:params:xml:ns:xmpp-sasl';
27 local xmlns_bind ='urn:ietf:params:xml:ns:xmpp-bind';
29 local function build_reply(status, ret, err_msg)
30 local reply = st.stanza(status, {xmlns = xmlns_sasl});
31 if status == "challenge" then
32 --log("debug", "CHALLENGE: %s", ret or "");
33 reply:text(base64.encode(ret or ""));
34 elseif status == "failure" then
36 if err_msg then reply:tag("text"):text(err_msg); end
37 elseif status == "success" then
38 --log("debug", "SUCCESS: %s", ret or "");
39 reply:text(base64.encode(ret or ""));
41 module:log("error", "Unknown sasl status: %s", status);
46 local function handle_status(session, status, ret, err_msg)
47 if status == "failure" then
48 module:fire_event("authentication-failure", { session = session, condition = ret, text = err_msg });
49 session.sasl_handler = session.sasl_handler:clean_clone();
50 elseif status == "success" then
51 local ok, err = sm_make_authenticated(session, session.sasl_handler.username);
53 module:fire_event("authentication-success", { session = session });
54 session.sasl_handler = nil;
55 session:reset_stream();
57 module:log("warn", "SASL succeeded but username was invalid");
58 module:fire_event("authentication-failure", { session = session, condition = "not-authorized", text = err });
59 session.sasl_handler = session.sasl_handler:clean_clone();
60 return "failure", "not-authorized", "User authenticated successfully, but username was invalid";
63 return status, ret, err_msg;
66 local function sasl_process_cdata(session, stanza)
67 local text = stanza[1];
69 text = base64.decode(text);
70 --log("debug", "AUTH: %s", text:gsub("[%z\001-\008\011\012\014-\031]", " "));
72 session.sasl_handler = nil;
73 session.send(build_reply("failure", "incorrect-encoding"));
77 local status, ret, err_msg = session.sasl_handler:process(text);
78 status, ret, err_msg = handle_status(session, status, ret, err_msg);
79 local s = build_reply(status, ret, err_msg);
80 log("debug", "sasl reply: %s", tostring(s));
85 module:hook_stanza(xmlns_sasl, "success", function (session, stanza)
86 if session.type ~= "s2sout_unauthed" or session.external_auth ~= "attempting" then return; end
87 module:log("debug", "SASL EXTERNAL with %s succeeded", session.to_host);
88 session.external_auth = "succeeded"
89 session:reset_stream();
90 session:open_stream(session.from_host, session.to_host);
92 module:fire_event("s2s-authenticated", { session = session, host = session.to_host });
96 module:hook_stanza(xmlns_sasl, "failure", function (session, stanza)
97 if session.type ~= "s2sout_unauthed" or session.external_auth ~= "attempting" then return; end
99 module:log("info", "SASL EXTERNAL with %s failed", session.to_host)
100 -- TODO: Log the failure reason
101 session.external_auth = "failed"
104 module:hook_stanza(xmlns_sasl, "failure", function (session, stanza)
105 -- TODO: Dialback wasn't loaded. Do something useful.
108 module:hook_stanza("http://etherx.jabber.org/streams", "features", function (session, stanza)
109 if session.type ~= "s2sout_unauthed" or not session.secure then return; end
111 local mechanisms = stanza:get_child("mechanisms", xmlns_sasl)
113 for mech in mechanisms:childtags() do
114 if mech[1] == "EXTERNAL" then
115 module:log("debug", "Initiating SASL EXTERNAL with %s", session.to_host);
116 local reply = st.stanza("auth", {xmlns = xmlns_sasl, mechanism = "EXTERNAL"});
117 reply:text(base64.encode(session.from_host))
118 session.sends2s(reply)
119 session.external_auth = "attempting"
126 local function s2s_external_auth(session, stanza)
127 local mechanism = stanza.attr.mechanism;
129 if not session.secure then
130 if mechanism == "EXTERNAL" then
131 session.sends2s(build_reply("failure", "encryption-required"))
133 session.sends2s(build_reply("failure", "invalid-mechanism"))
138 if mechanism ~= "EXTERNAL" or session.cert_chain_status ~= "valid" then
139 session.sends2s(build_reply("failure", "invalid-mechanism"))
143 local text = stanza[1]
145 session.sends2s(build_reply("failure", "malformed-request"))
149 -- Either the value is "=" and we've already verified the external
150 -- cert identity, or the value is a string and either matches the
153 text = base64.decode(text)
155 session.sends2s(build_reply("failure", "incorrect-encoding"))
159 if session.cert_identity_status == "valid" then
160 if text ~= "" and text ~= session.from_host then
161 session.sends2s(build_reply("failure", "invalid-authzid"))
166 session.sends2s(build_reply("failure", "invalid-authzid"))
170 local cert = session.conn:socket():getpeercertificate()
171 if (cert_verify_identity(text, "xmpp-server", cert)) then
172 session.cert_identity_status = "valid"
174 session.cert_identity_status = "invalid"
175 session.sends2s(build_reply("failure", "invalid-authzid"))
180 session.external_auth = "succeeded"
182 if not session.from_host then
183 session.from_host = text;
185 session.sends2s(build_reply("success"))
187 local domain = text ~= "" and text or session.from_host;
188 module:log("info", "Accepting SASL EXTERNAL identity from %s", domain);
189 module:fire_event("s2s-authenticated", { session = session, host = domain });
190 session:reset_stream();
194 module:hook("stanza/urn:ietf:params:xml:ns:xmpp-sasl:auth", function(event)
195 local session, stanza = event.origin, event.stanza;
196 if session.type == "s2sin_unauthed" then
197 return s2s_external_auth(session, stanza)
200 if session.type ~= "c2s_unauthed" then return; end
202 if session.sasl_handler and session.sasl_handler.selected then
203 session.sasl_handler = nil; -- allow starting a new SASL negotiation before completing an old one
205 if not session.sasl_handler then
206 session.sasl_handler = usermanager_get_sasl_handler(module.host, session);
208 local mechanism = stanza.attr.mechanism;
209 if not session.secure and (secure_auth_only or (mechanism == "PLAIN" and not allow_unencrypted_plain_auth)) then
210 session.send(build_reply("failure", "encryption-required"));
213 local valid_mechanism = session.sasl_handler:select(mechanism);
214 if not valid_mechanism then
215 session.send(build_reply("failure", "invalid-mechanism"));
218 return sasl_process_cdata(session, stanza);
220 module:hook("stanza/urn:ietf:params:xml:ns:xmpp-sasl:response", function(event)
221 local session = event.origin;
222 if not(session.sasl_handler and session.sasl_handler.selected) then
223 session.send(build_reply("failure", "not-authorized", "Out of order SASL element"));
226 return sasl_process_cdata(session, event.stanza);
228 module:hook("stanza/urn:ietf:params:xml:ns:xmpp-sasl:abort", function(event)
229 local session = event.origin;
230 session.sasl_handler = nil;
231 session.send(build_reply("failure", "aborted"));
235 local mechanisms_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-sasl' };
236 local bind_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-bind' };
237 local xmpp_session_attr = { xmlns='urn:ietf:params:xml:ns:xmpp-session' };
238 module:hook("stream-features", function(event)
239 local origin, features = event.origin, event.features;
240 if not origin.username then
241 if secure_auth_only and not origin.secure then
244 origin.sasl_handler = usermanager_get_sasl_handler(module.host, origin);
245 if origin.encrypted then
246 -- check wether LuaSec has the nifty binding to the function needed for tls-unique
247 -- FIXME: would be nice to have this check only once and not for every socket
248 if origin.conn:socket().getpeerfinished and origin.sasl_handler.add_cb_handler then
249 origin.sasl_handler:add_cb_handler("tls-unique", function(self)
250 return self.userdata:getpeerfinished();
252 origin.sasl_handler["userdata"] = origin.conn:socket();
255 local mechanisms = st.stanza("mechanisms", mechanisms_attr);
256 for mechanism in pairs(origin.sasl_handler:mechanisms()) do
257 if mechanism ~= "PLAIN" or origin.secure or allow_unencrypted_plain_auth then
258 mechanisms:tag("mechanism"):text(mechanism):up();
261 if mechanisms[1] then features:add_child(mechanisms); end
263 features:tag("bind", bind_attr):tag("required"):up():up();
264 features:tag("session", xmpp_session_attr):tag("optional"):up():up();
268 module:hook("s2s-stream-features", function(event)
269 local origin, features = event.origin, event.features;
270 if origin.secure and origin.type == "s2sin_unauthed" then
271 -- Offer EXTERNAL if chain is valid and either we didn't validate
272 -- the identity or it passed.
273 if origin.cert_chain_status == "valid" and origin.cert_identity_status ~= "invalid" then --TODO: Configurable
274 module:log("debug", "Offering SASL EXTERNAL")
275 features:tag("mechanisms", { xmlns = xmlns_sasl })
276 :tag("mechanism"):text("EXTERNAL")
282 module:hook("iq/self/urn:ietf:params:xml:ns:xmpp-bind:bind", function(event)
283 local origin, stanza = event.origin, event.stanza;
285 if stanza.attr.type == "set" then
286 local bind = stanza.tags[1];
287 resource = bind:child_with_name("resource");
288 resource = resource and #resource.tags == 0 and resource[1] or nil;
290 local success, err_type, err, err_msg = sm_bind_resource(origin, resource);
292 origin.send(st.reply(stanza)
293 :tag("bind", { xmlns = xmlns_bind })
294 :tag("jid"):text(origin.full_jid));
295 origin.log("debug", "Resource bound: %s", origin.full_jid);
297 origin.send(st.error_reply(stanza, err_type, err, err_msg));
298 origin.log("debug", "Resource bind failed: %s", err_msg or err);
303 local function handle_legacy_session(event)
304 event.origin.send(st.reply(event.stanza));
308 module:hook("iq/self/urn:ietf:params:xml:ns:xmpp-session:session", handle_legacy_session);
309 module:hook("iq/host/urn:ietf:params:xml:ns:xmpp-session:session", handle_legacy_session);