diff mod_saslauth_muc/mod_saslauth_muc.lua @ 284:3b96bba9f7e5

mod_saslauth_muc: Initial commit. Implements SASL auth for MUC rooms <http://xmpp.org/extensions/inbox/remote-auth.html>.
author Waqas Hussain <waqas20@gmail.com>
date Thu, 02 Dec 2010 17:22:34 +0500
parents
children 6144fe6161f1
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_saslauth_muc/mod_saslauth_muc.lua	Thu Dec 02 17:22:34 2010 +0500
@@ -0,0 +1,155 @@
+--
+-- mod_saslauth_muc
+--   This module implements http://xmpp.org/extensions/inbox/remote-auth.html for Prosody's MUC component
+--
+-- In your config:
+--   Component "conference.example.com" "muc"
+--       modules_enabled = { "saslauth_muc" };
+--
+--
+
+local timeout = 60; -- SASL timeout in seconds
+
+-- various imports
+local new_sasl = require "util.sasl".new;
+local st = require "util.stanza";
+local timer = require "util.timer";
+
+local jid_bare = require "util.jid".bare;
+local jid_prep = require "util.jid".prep;
+local base64 = require "util.encodings".base64;
+
+local hosts = hosts;
+local module = module;
+local pairs, next = pairs, next;
+local os_time = os.time;
+
+-- SASL sessions management
+local _rooms = {}; -- SASL data
+local function get_handler_for(room, jid) return _rooms[room] and _rooms[room][jid]; end
+local function remove_handler_for(room, jid) if _rooms[room] then _rooms[room][jid] = nil; end end
+local function create_handler_for(room_jid, jid)
+	_rooms[room_jid] = _rooms[room_jid] or {};
+	_rooms[room_jid][jid] = new_sasl(module.host, { plain = function(username, realm)
+		local muc = hosts[module.host].modules.muc;
+		local room = muc and muc.rooms[room_jid];
+		local password = room and room:get_password();
+		local ret = password and true or false;
+		return password, true;
+	end });
+	_rooms[room_jid][jid].timeout = os_time() + timeout;
+	return _rooms[room_jid][jid];
+end
+
+-- Timer to clear SASL sessions
+timer.add_task(timeout, function()
+	local now = os_time();
+	for room, handlers in pairs(_rooms) do
+		for jid, handler in pairs(handlers) do
+			if handler.timeout <= now then handlers[jid] = nil; end
+		end
+		if next(handlers) == nil then _rooms[room] = nil; end
+	end
+	return timeout;
+end);
+
+-- Stanza handlers
+module:hook("presence/full", function(event)
+	local origin, stanza = event.origin, event.stanza;
+	
+	if not stanza.attr.type then -- available presence
+		local room_jid = jid_bare(stanza.attr.to);
+		local room = hosts[module.host].modules.muc.rooms[room_jid];
+
+		if room and not room:get_role(stanza.attr.from) then -- this is a room join
+			if room:get_password() then -- room has a password
+				local x = stanza:get_child("x", "http://jabber.org/protocol/muc");
+				local password = x and x:get_child("password");
+				if not password then -- no password sent
+					local sasl_handler = get_handler_for(jid_bare(stanza.attr.to), stanza.attr.from);
+					if x and sasl_handler and sasl_handler.authorized then -- if already passed SASL
+						x:reset():tag("password", { xmlns = "http://jabber.org/protocol/muc" }):text(room:get_password());
+					else
+						origin.send(st.error_reply(stanza, "auth", "not-authorized")
+							:tag("sasl-required", { xmlns = "urn:xmpp:errors" }));
+						return true;
+					end
+				end
+			end
+		end
+	end
+end, 10);
+
+module:hook("iq-get/bare/urn:ietf:params:xml:ns:xmpp-sasl:mechanisms", function(event)
+	local origin, stanza = event.origin, event.stanza;
+
+	local reply = st.reply(stanza):tag("mechanisms", { xmlns='urn:ietf:params:xml:ns:xmpp-sasl' });
+	for mechanism in pairs(create_handler_for(stanza.attr.to, true):mechanisms()) do
+		reply:tag("mechanism"):text(mechanism):up();
+	end
+	origin.send(reply:up());
+	return true;
+end);
+
+local function build_reply(stanza, status, ret, err_msg)
+	local reply = st.stanza(status, {xmlns = "urn:ietf:params:xml:ns:xmpp-sasl"});
+	if status == "challenge" then
+		reply:text(base64.encode(ret or ""));
+	elseif status == "failure" then
+		reply:tag(ret):up();
+		if err_msg then reply:tag("text"):text(err_msg); end
+	elseif status == "success" then
+		reply:text(base64.encode(ret or ""));
+	else
+		module:log("error", "Unknown sasl status: %s", status);
+	end
+	return st.reply(stanza):add_child(reply);
+end
+local function handle_status(stanza, status)
+	if status == "failure" then
+		remove_handler_for(stanza.attr.to, stanza.attr.from);
+	elseif status == "success" then
+		get_handler_for(stanza.attr.to, stanza.attr.from).authorized = true;
+	end
+end
+local function sasl_process_cdata(session, stanza)
+	local text = stanza.tags[1][1];
+	if text then
+		text = base64.decode(text);
+		if not text then
+			remove_handler_for(stanza.attr.to, stanza.attr.from);
+			session.send(build_reply(stanza, "failure", "incorrect-encoding"));
+			return true;
+		end
+	end
+	local status, ret, err_msg = get_handler_for(stanza.attr.to, stanza.attr.from):process(text);
+	handle_status(stanza, status);
+	local s = build_reply(stanza, status, ret, err_msg);
+	session.send(s);
+	return true;
+end
+
+module:hook("iq-set/bare/urn:ietf:params:xml:ns:xmpp-sasl:auth", function(event)
+	local session, stanza = event.origin, event.stanza;
+
+	if not create_handler_for(stanza.attr.to, stanza.attr.from):select(stanza.tags[1].attr.mechanism) then
+		remove_handler_for(stanza.attr.to, stanza.attr.from);
+		session.send(build_reply(stanza, "failure", "invalid-mechanism"));
+		return true;
+	end
+	return sasl_process_cdata(session, stanza);
+end);
+module:hook("iq-set/bare/urn:ietf:params:xml:ns:xmpp-sasl:response", function(event)
+	local session, stanza = event.origin, event.stanza;
+	if not get_handler_for(stanza.attr.to, stanza.attr.from) then
+		session.send(build_reply(stanza, "failure", "not-authorized", "Out of order SASL element"));
+		return true;
+	end
+	return sasl_process_cdata(session, event.stanza);
+end);
+module:hook("iq-set/bare/urn:ietf:params:xml:ns:xmpp-sasl:abort", function(event)
+	local session, stanza = event.origin, event.stanza;
+	remove_handler_for(stanza.attr.to, stanza.attr.from);
+	session.send(build_reply(stanza, "failure", "aborted"));
+	return true;
+end);