aboutsummaryrefslogtreecommitdiffstats
path: root/util
diff options
context:
space:
mode:
Diffstat (limited to 'util')
-rw-r--r--util/broadcast.lua (renamed from util/pubsub.lua)0
-rw-r--r--util/discohelper.lua89
-rw-r--r--util/helpers.lua27
-rw-r--r--util/iterators.lua33
-rw-r--r--util/muc.lua418
-rw-r--r--util/sasl.lua117
6 files changed, 117 insertions, 567 deletions
diff --git a/util/pubsub.lua b/util/broadcast.lua
index 8f6af2fd..8f6af2fd 100644
--- a/util/pubsub.lua
+++ b/util/broadcast.lua
diff --git a/util/discohelper.lua b/util/discohelper.lua
deleted file mode 100644
index 5d9bf287..00000000
--- a/util/discohelper.lua
+++ /dev/null
@@ -1,89 +0,0 @@
--- 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.
---
-
-
-
-local t_insert = table.insert;
-local jid_split = require "util.jid".split;
-local ipairs = ipairs;
-local st = require "util.stanza";
-
-module "discohelper";
-
-local function addDiscoItemsHandler(self, jid, func)
- if self.item_handlers[jid] then
- t_insert(self.item_handlers[jid], func);
- else
- self.item_handlers[jid] = {func};
- end
-end
-
-local function addDiscoInfoHandler(self, jid, func)
- if self.info_handlers[jid] then
- t_insert(self.info_handlers[jid], func);
- else
- self.info_handlers[jid] = {func};
- end
-end
-
-local function handle(self, stanza)
- if stanza.name == "iq" and stanza.tags[1].name == "query" then
- local query = stanza.tags[1];
- local to = stanza.attr.to;
- local from = stanza.attr.from
- local node = query.attr.node or "";
- local to_node, to_host = jid_split(to);
-
- local reply = st.reply(stanza):query(query.attr.xmlns);
- local handlers;
- if query.attr.xmlns == "http://jabber.org/protocol/disco#info" then -- select handler set
- handlers = self.info_handlers;
- elseif query.attr.xmlns == "http://jabber.org/protocol/disco#items" then
- handlers = self.item_handlers;
- end
- local handler;
- local found; -- to keep track of any handlers found
- if to_node then -- handlers which get called always
- handler = handlers["*node"];
- else
- handler = handlers["*host"];
- end
- if handler then -- call always called handler
- for _, h in ipairs(handler) do
- if h(reply, to, from, node) then found = true; end
- end
- end
- handler = handlers[to]; -- get the handler
- if not handler then -- if not found then use default handler
- if to_node then
- handler = handlers["*defaultnode"];
- else
- handler = handlers["*defaulthost"];
- end
- end
- if handler then
- for _, h in ipairs(handler) do
- if h(reply, to, from, node) then found = true; end
- end
- end
- if found then return reply; end -- return the reply if there was one
- return st.error_reply(stanza, "cancel", "service-unavailable");
- end
-end
-
-function new()
- return {
- item_handlers = {};
- info_handlers = {};
- addDiscoItemsHandler = addDiscoItemsHandler;
- addDiscoInfoHandler = addDiscoInfoHandler;
- handle = handle;
- };
-end
-
-return _M;
diff --git a/util/helpers.lua b/util/helpers.lua
new file mode 100644
index 00000000..c8434794
--- /dev/null
+++ b/util/helpers.lua
@@ -0,0 +1,27 @@
+
+module("helpers", package.seeall);
+
+-- Helper functions for debugging
+
+local log = require "util.logger".init("util.debug");
+
+function log_events(events, name, logger)
+ local f = events.fire_event;
+ if not f then
+ error("Object does not appear to be a util.events object");
+ end
+ logger = logger or log;
+ name = name or tostring(events);
+ function events.fire_event(event, ...)
+ logger("debug", "%s firing event: %s", name, event);
+ return f(event, ...);
+ end
+ events[events.fire_event] = f;
+ return events;
+end
+
+function revert_log_events(events)
+ events.fire_event, events[events.fire_event] = events[events.fire_event], nil; -- :)
+end
+
+return _M;
diff --git a/util/iterators.lua b/util/iterators.lua
index 08bb729c..ba33bc80 100644
--- a/util/iterators.lua
+++ b/util/iterators.lua
@@ -78,6 +78,39 @@ function count(f, s, var)
return x;
end
+-- Return the first n items an iterator returns
+function head(n, f, s, var)
+ local c = 0;
+ return function (s, var)
+ if c >= n then
+ return nil;
+ end
+ c = c + 1;
+ return f(s, var);
+ end, s;
+end
+
+function tail(n, f, s, var)
+ local results, count = {}, 0;
+ while true do
+ local ret = { f(s, var) };
+ var = ret[1];
+ if var == nil then break; end
+ results[(count%n)+1] = ret;
+ count = count + 1;
+ end
+
+ if n > count then n = count; end
+
+ local pos = 0;
+ return function ()
+ pos = pos + 1;
+ if pos > n then return nil; end
+ return unpack(results[((count-1+pos)%n)+1]);
+ end
+ --return reverse(head(n, reverse(f, s, var)));
+end
+
-- Convert the values returned by an iterator to an array
function it2array(f, s, var)
local t, var = {};
diff --git a/util/muc.lua b/util/muc.lua
deleted file mode 100644
index badcffce..00000000
--- a/util/muc.lua
+++ /dev/null
@@ -1,418 +0,0 @@
--- 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.
---
-
-local datamanager = require "util.datamanager";
-local datetime = require "util.datetime";
-
-local jid_split = require "util.jid".split;
-local jid_bare = require "util.jid".bare;
-local st = require "util.stanza";
-local log = require "util.logger".init("mod_muc");
-local multitable_new = require "util.multitable".new;
-local t_insert, t_remove = table.insert, table.remove;
-
-local muc_domain = nil; --module:get_host();
-local history_length = 20;
-
-------------
-local function filter_xmlns_from_array(array, filters)
- local count = 0;
- for i=#array,1,-1 do
- local attr = array[i].attr;
- if filters[attr and attr.xmlns] then
- t_remove(array, i);
- count = count + 1;
- end
- end
- return count;
-end
-local function filter_xmlns_from_stanza(stanza, filters)
- if filters then
- if filter_xmlns_from_array(stanza.tags, filters) ~= 0 then
- return stanza, filter_xmlns_from_array(stanza, filters);
- end
- end
- return stanza, 0;
-end
-local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
-local function get_filtered_presence(stanza)
- return filter_xmlns_from_stanza(st.clone(stanza), presence_filters);
-end
-local kickable_error_conditions = {
- ["gone"] = true;
- ["internal-server-error"] = true;
- ["item-not-found"] = true;
- ["jid-malformed"] = true;
- ["recipient-unavailable"] = true;
- ["redirect"] = true;
- ["remote-server-not-found"] = true;
- ["remote-server-timeout"] = true;
- ["service-unavailable"] = true;
-};
-local function get_kickable_error(stanza)
- for _, tag in ipairs(stanza.tags) do
- if tag.name == "error" and tag.attr.xmlns == "jabber:client" then
- for _, cond in ipairs(tag.tags) do
- if cond.attr.xmlns == "urn:ietf:params:xml:ns:xmpp-stanzas" then
- return kickable_error_conditions[cond.name] and cond.name;
- end
- end
- return true; -- malformed error message
- end
- end
- return true; -- malformed error message
-end
-local function getUsingPath(stanza, path, getText)
- local tag = stanza;
- for _, name in ipairs(path) do
- if type(tag) ~= 'table' then return; end
- tag = tag:child_with_name(name);
- end
- if tag and getText then tag = table.concat(tag); end
- return tag;
-end
-local function getTag(stanza, path) return getUsingPath(stanza, path); end
-local function getText(stanza, path) return getUsingPath(stanza, path, true); end
------------
-
---[[function get_room_disco_info(room, stanza)
- return st.iq({type='result', id=stanza.attr.id, from=stanza.attr.to, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#info")
- :tag("identity", {category='conference', type='text', name=room._data["name"]):up()
- :tag("feature", {var="http://jabber.org/protocol/muc"}); -- TODO cache disco reply
-end
-function get_room_disco_items(room, stanza)
- return st.iq({type='result', id=stanza.attr.id, from=stanza.attr.to, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#items");
-end -- TODO allow non-private rooms]]
-
---
-
-local function room_broadcast_presence(room, stanza, code, nick)
- stanza = get_filtered_presence(stanza);
- local data = room._participants[stanza.attr.from];
- stanza:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
- :tag("item", {affiliation=data.affiliation, role=data.role, nick=nick}):up();
- if code then
- stanza:tag("status", {code=code}):up();
- end
- local me;
- for occupant, o_data in pairs(room._participants) do
- if occupant ~= stanza.attr.from then
- for jid in pairs(o_data.sessions) do
- stanza.attr.to = jid;
- room:route_stanza(stanza);
- end
- else
- me = o_data;
- end
- end
- if me then
- stanza:tag("status", {code='110'});
- for jid in pairs(me.sessions) do
- stanza.attr.to = jid;
- room:route_stanza(stanza);
- end
- end
-end
-local function room_broadcast_message(room, stanza, historic)
- for occupant, o_data in pairs(room._participants) do
- for jid in pairs(o_data.sessions) do
- stanza.attr.to = jid;
- room:route_stanza(stanza);
- end
- end
- if historic then -- add to history
- local history = room._data['history'];
- if not history then history = {}; room._data['history'] = history; end
- -- stanza = st.clone(stanza);
- stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = datetime.datetime()}):up(); -- XEP-0203
- stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
- t_insert(history, st.clone(st.preserialize(stanza)));
- while #history > history_length do t_remove(history, 1) end
- end
-end
-
-
-local function room_send_occupant_list(room, to)
- local current_nick = room._jid_nick[to];
- for occupant, o_data in pairs(room._participants) do
- if occupant ~= current_nick then
- local pres = get_filtered_presence(o_data.sessions[o_data.jid]);
- pres.attr.to, pres.attr.from = to, occupant;
- pres:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
- :tag("item", {affiliation=o_data.affiliation, role=o_data.role}):up();
- room:route_stanza(pres);
- end
- end
-end
-local function room_send_history(room, to)
- local history = room._data['history']; -- send discussion history
- if history then
- for _, msg in ipairs(history) do
- msg = st.deserialize(msg);
- msg.attr.to=to;
- room:route_stanza(msg);
- end
- end
- if room._data['subject'] then
- room:route_stanza(st.message({type='groupchat', from=room.jid, to=to}):tag("subject"):text(room._data['subject']));
- end
-end
-
-local function room_get_disco_info(self, stanza) end
-local function room_get_disco_items(self, stanza) end
-local function room_set_subject(room, current_nick, subject)
- -- TODO check nick's authority
- if subject == "" then subject = nil; end
- room._data['subject'] = subject;
- local msg = st.message({type='groupchat', from=current_nick})
- :tag('subject'):text(subject):up();
- room_broadcast_message(room, msg, false);
- return true;
-end
-
-local function room_handle_to_occupant(self, origin, stanza) -- PM, vCards, etc
- local from, to = stanza.attr.from, stanza.attr.to;
- local room = jid_bare(to);
- local current_nick = self._jid_nick[from];
- local type = stanza.attr.type;
- log("debug", "room: %s, current_nick: %s, stanza: %s", room or "nil", current_nick or "nil", stanza:top_tag());
- if (select(2, jid_split(from)) == muc_domain) then error("Presence from the MUC itself!!!"); end
- if stanza.name == "presence" then
- local pr = get_filtered_presence(stanza);
- pr.attr.from = current_nick;
- if type == "error" then -- error, kick em out!
- if current_nick then
- log("debug", "kicking %s from %s", current_nick, room);
- room_handle_to_occupant(self, origin, st.presence({type='unavailable', from=from, to=to}):tag('status'):text('This participant is kicked from the room because he sent an error presence')); -- send unavailable
- end
- elseif type == "unavailable" then -- unavailable
- if current_nick then
- log("debug", "%s leaving %s", current_nick, room);
- local data = self._participants[current_nick];
- data.role = 'none';
- room_broadcast_presence(self, pr);
- self._participants[current_nick] = nil;
- self._jid_nick[from] = nil;
- end
- elseif not type then -- available
- if current_nick then
- --if #pr == #stanza or current_nick ~= to then -- commented because google keeps resending directed presence
- if current_nick == to then -- simple presence
- log("debug", "%s broadcasted presence", current_nick);
- self._participants[current_nick].sessions[from] = pr;
- room_broadcast_presence(self, pr);
- else -- change nick
- if self._participants[to] then
- log("debug", "%s couldn't change nick", current_nick);
- origin.send(st.error_reply(stanza, "cancel", "conflict"):tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
- else
- local data = self._participants[current_nick];
- local to_nick = select(3, jid_split(to));
- if to_nick then
- log("debug", "%s (%s) changing nick to %s", current_nick, data.jid, to);
- local p = st.presence({type='unavailable', from=current_nick});
- room_broadcast_presence(self, p, '303', to_nick);
- self._participants[current_nick] = nil;
- self._participants[to] = data;
- self._jid_nick[from] = to;
- pr.attr.from = to;
- self._participants[to].sessions[from] = pr;
- room_broadcast_presence(self, pr);
- else
- --TODO malformed-jid
- end
- end
- end
- --else -- possible rejoin
- -- log("debug", "%s had connection replaced", current_nick);
- -- handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to}):tag('status'):text('Replaced by new connection'):up()); -- send unavailable
- -- handle_to_occupant(origin, stanza); -- resend available
- --end
- else -- enter room
- local new_nick = to;
- if self._participants[to] then
- new_nick = nil;
- end
- if not new_nick then
- log("debug", "%s couldn't join due to nick conflict: %s", from, to);
- origin.send(st.error_reply(stanza, "cancel", "conflict"):tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
- else
- log("debug", "%s joining as %s", from, to);
- local data;
--- if not rooms:get(room) and not rooms_info:get(room) then -- new room
--- rooms_info:set(room, 'name', (jid_split(room)));
--- data = {affiliation='owner', role='moderator', jid=from, sessions={[from]=get_filtered_presence(stanza)}};
--- end
- if not data then -- new occupant
- data = {affiliation='none', role='participant', jid=from, sessions={[from]=get_filtered_presence(stanza)}};
- end
- self._participants[to] = data;
- self._jid_nick[from] = to;
- room_send_occupant_list(self, from);
- pr.attr.from = to;
- room_broadcast_presence(self, pr);
- room_send_history(self, from);
- end
- end
- elseif type ~= 'result' then -- bad type
- origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
- end
- elseif not current_nick and type ~= "error" and type ~= "result" then -- not in room
- origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
- elseif stanza.name == "message" and type == "groupchat" then -- groupchat messages not allowed in PM
- origin.send(st.error_reply(stanza, "modify", "bad-request"));
- elseif stanza.name == "message" and type == "error" and get_kickable_error(stanza) then
- log("debug", "%s kicked from %s for sending an error message", current_nick, room);
- room_handle_to_occupant(self, origin, st.presence({type='unavailable', from=from, to=to}):tag('status'):text('This participant is kicked from the room because he sent an error message to another occupant')); -- send unavailable
- else -- private stanza
- local o_data = self._participants[to];
- if o_data then
- log("debug", "%s sent private stanza to %s (%s)", from, to, o_data.jid);
- local jid = o_data.jid;
- -- TODO if stanza.name=='iq' and type=='get' and stanza.tags[1].attr.xmlns == 'vcard-temp' then jid = jid_bare(jid); end
- stanza.attr.to, stanza.attr.from = jid, current_nick;
- self:route_stanza(stanza);
- elseif type ~= "error" and type ~= "result" then -- recipient not in room
- origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
- end
- end
-end
-
-local function room_handle_to_room(self, origin, stanza) -- presence changes and groupchat messages, along with disco/etc
- local type = stanza.attr.type;
- if stanza.name == "iq" and type == "get" then -- disco requests
- local xmlns = stanza.tags[1].attr.xmlns;
- if xmlns == "http://jabber.org/protocol/disco#info" then
- origin.send(room_get_disco_info(self, stanza));
- elseif xmlns == "http://jabber.org/protocol/disco#items" then
- origin.send(room_get_disco_items(self, stanza));
- else
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
- end
- elseif stanza.name == "message" and type == "groupchat" then
- local from, to = stanza.attr.from, stanza.attr.to;
- local room = jid_bare(to);
- local current_nick = self._jid_nick[from];
- if not current_nick then -- not in room
- origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
- else
- local from = stanza.attr.from;
- stanza.attr.from = current_nick;
- local subject = getText(stanza, {"subject"});
- if subject then
- self:set_subject(current_nick, subject); -- TODO use broadcast_message_stanza
- else
- room_broadcast_message(self, stanza, true);
- end
- end
- elseif stanza.name == "presence" then -- hack - some buggy clients send presence updates to the room rather than their nick
- local to = stanza.attr.to;
- local current_nick = self._jid_nick[stanza.attr.from];
- if current_nick then
- stanza.attr.to = current_nick;
- room_handle_to_occupant(self, origin, stanza);
- stanza.attr.to = to;
- elseif type ~= "error" and type ~= "result" then
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
- end
- elseif stanza.name == "message" and not stanza.attr.type and #stanza.tags == 1 and self._jid_nick[stanza.attr.from]
- and stanza.tags[1].name == "x" and stanza.tags[1].attr.xmlns == "http://jabber.org/protocol/muc#user" and #stanza.tags[1].tags == 1
- and stanza.tags[1].tags[1].name == "invite" and stanza.tags[1].tags[1].attr.to then
- local _from, _to = stanza.attr.from, stanza.attr.to;
- local _invitee = stanza.tags[1].tags[1].attr.to;
- stanza.attr.from, stanza.attr.to = _to, _invitee;
- stanza.tags[1].tags[1].attr.from, stanza.tags[1].tags[1].attr.to = _from, nil;
- self:route_stanza(stanza);
- stanza.tags[1].tags[1].attr.from, stanza.tags[1].tags[1].attr.to = nil, _invitee;
- stanza.attr.from, stanza.attr.to = _from, _to;
- else
- if type == "error" or type == "result" then return; end
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
- end
-end
-
-local function room_handle_stanza(self, origin, stanza)
- local to_node, to_host, to_resource = jid_split(stanza.attr.to);
- if to_resource then
- room_handle_to_occupant(self, origin, stanza);
- else
- room_handle_to_room(self, origin, stanza);
- end
-end
-
-module "muc"
-
-function new_room(jid)
- return {
- jid = jid;
- handle_stanza = room_handle_stanza;
- set_subject = room_set_subject;
- route_stanza = function(room, stanza) end; -- Replace with a routing function, e.g., function(room, stanza) core_route_stanza(origin, stanza); end
- _jid_nick = {};
- _participants = {};
- _data = {};
- }
-end
-
-return _M;
-
---[[function get_disco_info(stanza)
- return st.iq({type='result', id=stanza.attr.id, from=muc_domain, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#info")
- :tag("identity", {category='conference', type='text', name=muc_name}):up()
- :tag("feature", {var="http://jabber.org/protocol/muc"}); -- TODO cache disco reply
-end
-function get_disco_items(stanza)
- local reply = st.iq({type='result', id=stanza.attr.id, from=muc_domain, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#items");
- for room in pairs(rooms_info:get()) do
- reply:tag("item", {jid=room, name=rooms_info:get(room, "name")}):up();
- end
- return reply; -- TODO cache disco reply
-end]]
-
---[[function handle_to_domain(origin, stanza)
- local type = stanza.attr.type;
- if type == "error" or type == "result" then return; end
- if stanza.name == "iq" and type == "get" then
- local xmlns = stanza.tags[1].attr.xmlns;
- if xmlns == "http://jabber.org/protocol/disco#info" then
- origin.send(get_disco_info(stanza));
- elseif xmlns == "http://jabber.org/protocol/disco#items" then
- origin.send(get_disco_items(stanza));
- else
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- TODO disco/etc
- end
- else
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable", "The muc server doesn't deal with messages and presence directed at it"));
- end
-end
-
-register_component(muc_domain, function(origin, stanza)
- local to_node, to_host, to_resource = jid_split(stanza.attr.to);
- if to_resource and not to_node then
- if type == "error" or type == "result" then return; end
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- host/resource
- elseif to_resource then
- handle_to_occupant(origin, stanza);
- elseif to_node then
- handle_to_room(origin, stanza)
- else -- to the main muc domain
- if type == "error" or type == "result" then return; end
- handle_to_domain(origin, stanza);
- end
-end);]]
-
---[[module.unload = function()
- deregister_component(muc_domain);
-end
-module.save = function()
- return {rooms = rooms.data; jid_nick = jid_nick.data; rooms_info = rooms_info.data; persist_list = persist_list};
-end
-module.restore = function(data)
- rooms.data, jid_nick.data, rooms_info.data, persist_list =
- data.rooms or {}, data.jid_nick or {}, data.rooms_info or {}, data.persist_list or {};
-end]]
diff --git a/util/sasl.lua b/util/sasl.lua
index 295f5684..d176fd85 100644
--- a/util/sasl.lua
+++ b/util/sasl.lua
@@ -1,14 +1,14 @@
-- sasl.lua v0.4
-- Copyright (C) 2008-2009 Tobias Markmann
---
+--
-- All rights reserved.
---
+--
-- Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
---
+--
-- * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-- * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-- * Neither the name of Tobias Markmann nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
---
+--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -20,7 +20,6 @@ local generate_uuid = require "util.uuid".generate;
local t_insert, t_concat = table.insert, table.concat;
local to_byte, to_char = string.byte, string.char;
local to_unicode = require "util.encodings".idna.to_unicode;
-local saslprep = require "util.encodings".stringprep.saslprep;
local s_match = string.match;
local gmatch = string.gmatch
local string = string
@@ -31,60 +30,56 @@ local print = print
module "sasl"
-local function new_plain(realm, password_handler)
- local object = { mechanism = "PLAIN", realm = realm, password_handler = password_handler}
+-- Credentials handler:
+-- Arguments: ("PLAIN", user, host, password)
+-- Returns: true (success) | false (fail) | nil (user unknown)
+local function new_plain(realm, credentials_handler)
+ local object = { mechanism = "PLAIN", realm = realm, credentials_handler = credentials_handler}
function object.feed(self, message)
-
if message == "" or message == nil then return "failure", "malformed-request" end
local response = message
local authorization = s_match(response, "([^%z]+)")
local authentication = s_match(response, "%z([^%z]+)%z")
local password = s_match(response, "%z[^%z]+%z([^%z]+)")
- authorization, authentication, password = saslprep(authorization), saslprep(authentication), saslprep(password);
-
- if authentication == nil or password == nil then return "failure", "malformed-request" end
-
- local password_encoding, correct_password = self.password_handler(authentication, self.realm, self.realm, "PLAIN")
-
- if correct_password == nil then return "failure", "not-authorized"
- elseif correct_password == false then return "failure", "account-disabled" end
-
- local claimed_password = ""
- if password_encoding == nil then claimed_password = password
- else claimed_password = password_encoding(password) end
- claimed_password = saslprep(claimed_password);
-
- self.username = authentication
- if claimed_password == correct_password then
- return "success"
- else
- return "failure", "not-authorized"
- end
- end
- return object
-end
+ if authentication == nil or password == nil then return "failure", "malformed-request" end
+ self.username = authentication
+ local auth_success = self.credentials_handler("PLAIN", self.username, self.realm, password)
+
+ if auth_success then
+ return "success"
+ elseif auth_success == nil then
+ return "failure", "account-disabled"
+ else
+ return "failure", "not-authorized"
+ end
+ end
+ return object
+end
+-- credentials_handler:
+-- Arguments: (mechanism, node, domain, realm, decoder)
+-- Returns: Password encoding, (plaintext) password
-- implementing RFC 2831
-local function new_digest_md5(realm, password_handler)
+local function new_digest_md5(realm, credentials_handler)
--TODO complete support for authzid
local function serialize(message)
local data = ""
-
+
if type(message) ~= "table" then error("serialize needs an argument of type table.") end
-
+
-- testing all possible values
+ if message["realm"] then data = data..[[realm="]]..message.realm..[[",]] end
if message["nonce"] then data = data..[[nonce="]]..message.nonce..[[",]] end
if message["qop"] then data = data..[[qop="]]..message.qop..[[",]] end
if message["charset"] then data = data..[[charset=]]..message.charset.."," end
if message["algorithm"] then data = data..[[algorithm=]]..message.algorithm.."," end
- if message["realm"] then data = data..[[realm="]]..message.realm..[[",]] end
if message["rspauth"] then data = data..[[rspauth=]]..message.rspauth.."," end
data = data:gsub(",$", "")
return data
end
-
+
local function utf8tolatin1ifpossible(passwd)
local i = 1;
while i <= #passwd do
@@ -140,16 +135,16 @@ local function new_digest_md5(realm, password_handler)
return message;
end
- local object = { mechanism = "DIGEST-MD5", realm = realm, password_handler = password_handler};
-
+ local object = { mechanism = "DIGEST-MD5", realm = realm, credentials_handler = credentials_handler};
+
object.nonce = generate_uuid();
object.step = 0;
object.nonce_count = {};
-
+
function object.feed(self, message)
self.step = self.step + 1;
if (self.step == 1) then
- local challenge = serialize({ nonce = object.nonce,
+ local challenge = serialize({ nonce = object.nonce,
qop = "auth",
charset = "utf-8",
algorithm = "md5-sess",
@@ -161,13 +156,13 @@ local function new_digest_md5(realm, password_handler)
if response["nc"] then
if self.nonce_count[response["nc"]] then return "failure", "not-authorized" end
end
-
+
-- check for username, it's REQUIRED by RFC 2831
if not response["username"] then
return "failure", "malformed-request";
end
self["username"] = response["username"];
-
+
-- check for nonce, ...
if not response["nonce"] then
return "failure", "malformed-request";
@@ -175,23 +170,23 @@ local function new_digest_md5(realm, password_handler)
-- check if it's the right nonce
if response["nonce"] ~= tostring(self.nonce) then return "failure", "malformed-request" end
end
-
+
if not response["cnonce"] then return "failure", "malformed-request", "Missing entry for cnonce in SASL message." end
if not response["qop"] then response["qop"] = "auth" end
-
+
if response["realm"] == nil or response["realm"] == "" then
response["realm"] = "";
elseif response["realm"] ~= self.realm then
return "failure", "not-authorized", "Incorrect realm value";
end
-
+
local decoder;
if response["charset"] == nil then
decoder = utf8tolatin1ifpossible;
elseif response["charset"] ~= "utf-8" then
return "failure", "incorrect-encoding", "The client's response uses "..response["charset"].." for encoding with isn't supported by sasl.lua. Supported encodings are latin or utf-8.";
end
-
+
local domain = "";
local protocol = "";
if response["digest-uri"] then
@@ -200,10 +195,10 @@ local function new_digest_md5(realm, password_handler)
else
return "failure", "malformed-request", "Missing entry for digest-uri in SASL message."
end
-
+
--TODO maybe realm support
self.username = response["username"];
- local password_encoding, Y = self.password_handler(response["username"], to_unicode(domain), response["realm"], "DIGEST-MD5", decoder);
+ local password_encoding, Y = self.credentials_handler("DIGEST-MD5", response["username"], self.realm, response["realm"], decoder);
if Y == nil then return "failure", "not-authorized"
elseif Y == false then return "failure", "account-disabled" end
local A1 = "";
@@ -219,27 +214,27 @@ local function new_digest_md5(realm, password_handler)
A1 = Y..":"..response["nonce"]..":"..response["cnonce"];
end
local A2 = "AUTHENTICATE:"..protocol.."/"..domain;
-
+
local HA1 = md5(A1, true);
local HA2 = md5(A2, true);
-
+
local KD = HA1..":"..response["nonce"]..":"..response["nc"]..":"..response["cnonce"]..":"..response["qop"]..":"..HA2;
local response_value = md5(KD, true);
-
+
if response_value == response["response"] then
-- calculate rspauth
A2 = ":"..protocol.."/"..domain;
-
+
HA1 = md5(A1, true);
HA2 = md5(A2, true);
-
+
KD = HA1..":"..response["nonce"]..":"..response["nc"]..":"..response["cnonce"]..":"..response["qop"]..":"..HA2
local rspauth = md5(KD, true);
self.authenticated = true;
return "challenge", serialize({rspauth = rspauth});
else
return "failure", "not-authorized", "The response provided by the client doesn't match the one we calculated."
- end
+ end
elseif self.step == 3 then
if self.authenticated ~= nil then return "success"
else return "failure", "malformed-request" end
@@ -248,8 +243,10 @@ local function new_digest_md5(realm, password_handler)
return object;
end
-local function new_anonymous(realm, password_handler)
- local object = { mechanism = "ANONYMOUS", realm = realm, password_handler = password_handler}
+-- Credentials handler: Can be nil. If specified, should take the mechanism as
+-- the only argument, and return true for OK, or false for not-OK (TODO)
+local function new_anonymous(realm, credentials_handler)
+ local object = { mechanism = "ANONYMOUS", realm = realm, credentials_handler = credentials_handler}
function object.feed(self, message)
return "success"
end
@@ -258,11 +255,11 @@ local function new_anonymous(realm, password_handler)
end
-function new(mechanism, realm, password_handler)
+function new(mechanism, realm, credentials_handler)
local object
- if mechanism == "PLAIN" then object = new_plain(realm, password_handler)
- elseif mechanism == "DIGEST-MD5" then object = new_digest_md5(realm, password_handler)
- elseif mechanism == "ANONYMOUS" then object = new_anonymous(realm, password_handler)
+ if mechanism == "PLAIN" then object = new_plain(realm, credentials_handler)
+ elseif mechanism == "DIGEST-MD5" then object = new_digest_md5(realm, credentials_handler)
+ elseif mechanism == "ANONYMOUS" then object = new_anonymous(realm, credentials_handler)
else
log("debug", "Unsupported SASL mechanism: "..tostring(mechanism));
return nil