plugins/mod_c2s.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 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 module:set_global();
  10
  11 local add_task = require "util.timer".add_task;
  12 local new_xmpp_stream = require "util.xmppstream".new;
  13 local nameprep = require "util.encodings".stringprep.nameprep;
  14 local sessionmanager = require "core.sessionmanager";
  15 local st = require "util.stanza";
  16 local sm_new_session, sm_destroy_session = sessionmanager.new_session, sessionmanager.destroy_session;
  17 local uuid_generate = require "util.uuid".generate;
  18
  19 local xpcall, tostring, type = xpcall, tostring, type;
  20 local traceback = debug.traceback;
  21
  22 local xmlns_xmpp_streams = "urn:ietf:params:xml:ns:xmpp-streams";
  23
  24 local log = module._log;
  25
  26 local c2s_timeout = module:get_option_number("c2s_timeout");
  27 local stream_close_timeout = module:get_option_number("c2s_close_timeout", 5);
  28 local opt_keepalives = module:get_option_boolean("c2s_tcp_keepalives", module:get_option_boolean("tcp_keepalives", true));
  29
  30 local sessions = module:shared("sessions");
  31 local core_process_stanza = prosody.core_process_stanza;
  32 local hosts = prosody.hosts;
  33
  34 local stream_callbacks = { default_ns = "jabber:client", handlestanza = core_process_stanza };
  35 local listener = {};
  36
  37 --- Stream events handlers
  38 local stream_xmlns_attr = {xmlns='urn:ietf:params:xml:ns:xmpp-streams'};
  39 local default_stream_attr = { ["xmlns:stream"] = "http://etherx.jabber.org/streams", xmlns = stream_callbacks.default_ns, version = "1.0", id = "" };
  40
  41 function stream_callbacks.streamopened(session, attr)
  42         local send = session.send;
  43         session.host = nameprep(attr.to);
  44         if not session.host then
  45                 session:close{ condition = "improper-addressing",
  46                         text = "A valid 'to' attribute is required on stream headers" };
  47                 return;
  48         end
  49         session.version = tonumber(attr.version) or 0;
  50         session.streamid = uuid_generate();
  51         (session.log or session)("debug", "Client sent opening <stream:stream> to %s", session.host);
  52
  53         if not hosts[session.host] or not hosts[session.host].users then
  54                 -- We don't serve this host...
  55                 session:close{ condition = "host-unknown", text = "This server does not serve "..tostring(session.host)};
  56                 return;
  57         end
  58
  59         send("<?xml version='1.0'?>"..st.stanza("stream:stream", {
  60                 xmlns = 'jabber:client', ["xmlns:stream"] = 'http://etherx.jabber.org/streams';
  61                 id = session.streamid, from = session.host, version = '1.0', ["xml:lang"] = 'en' }):top_tag());
  62
  63         (session.log or log)("debug", "Sent reply <stream:stream> to client");
  64         session.notopen = nil;
  65
  66         -- If session.secure is *false* (not nil) then it means we /were/ encrypting
  67         -- since we now have a new stream header, session is secured
  68         if session.secure == false then
  69                 session.secure = true;
  70
  71                 -- Check if TLS compression is used
  72                 local sock = session.conn:socket();
  73                 if sock.info then
  74                         session.compressed = sock:info"compression";
  75                 elseif sock.compression then
  76                         session.compressed = sock:compression(); --COMPAT mw/luasec-hg
  77                 end
  78         end
  79
  80         local features = st.stanza("stream:features");
  81         hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
  82         module:fire_event("stream-features", session, features);
  83
  84         send(features);
  85 end
  86
  87 function stream_callbacks.streamclosed(session)
  88         session.log("debug", "Received </stream:stream>");
  89         session:close(false);
  90 end
  91
  92 function stream_callbacks.error(session, error, data)
  93         if error == "no-stream" then
  94                 session.log("debug", "Invalid opening stream header");
  95                 session:close("invalid-namespace");
  96         elseif error == "parse-error" then
  97                 (session.log or log)("debug", "Client XML parse error: %s", tostring(data));
  98                 session:close("not-well-formed");
  99         elseif error == "stream-error" then
 100                 local condition, text = "undefined-condition";
 101                 for child in data:children() do
 102                         if child.attr.xmlns == xmlns_xmpp_streams then
 103                                 if child.name ~= "text" then
 104                                         condition = child.name;
 105                                 else
 106                                         text = child:get_text();
 107                                 end
 108                                 if condition ~= "undefined-condition" and text then
 109                                         break;
 110                                 end
 111                         end
 112                 end
 113                 text = condition .. (text and (" ("..text..")") or "");
 114                 session.log("info", "Session closed by remote with error: %s", text);
 115                 session:close(nil, text);
 116         end
 117 end
 118
 119 local function handleerr(err) log("error", "Traceback[c2s]: %s", traceback(tostring(err), 2)); end
 120 function stream_callbacks.handlestanza(session, stanza)
 121         stanza = session.filter("stanzas/in", stanza);
 122         if stanza then
 123                 return xpcall(function () return core_process_stanza(session, stanza) end, handleerr);
 124         end
 125 end
 126
 127 --- Session methods
 128 local function session_close(session, reason)
 129         local log = session.log or log;
 130         if session.conn then
 131                 if session.notopen then
 132                         session.send("<?xml version='1.0'?>");
 133                         session.send(st.stanza("stream:stream", default_stream_attr):top_tag());
 134                 end
 135                 if reason then -- nil == no err, initiated by us, false == initiated by client
 136                         local stream_error = st.stanza("stream:error");
 137                         if type(reason) == "string" then -- assume stream error
 138                                 stream_error:tag(reason, {xmlns = 'urn:ietf:params:xml:ns:xmpp-streams' });
 139                         elseif type(reason) == "table" then
 140                                 if reason.condition then
 141                                         stream_error:tag(reason.condition, stream_xmlns_attr):up();
 142                                         if reason.text then
 143                                                 stream_error:tag("text", stream_xmlns_attr):text(reason.text):up();
 144                                         end
 145                                         if reason.extra then
 146                                                 stream_error:add_child(reason.extra);
 147                                         end
 148                                 elseif reason.name then -- a stanza
 149                                         stream_error = reason;
 150                                 end
 151                         end
 152                         stream_error = tostring(stream_error);
 153                         log("debug", "Disconnecting client, <stream:error> is: %s", stream_error);
 154                         session.send(stream_error);
 155                 end
 156
 157                 session.send("</stream:stream>");
 158                 function session.send() return false; end
 159
 160                 local reason = (reason and (reason.name or reason.text or reason.condition)) or reason;
 161                 session.log("info", "c2s stream for %s closed: %s", session.full_jid or ("<"..session.ip..">"), reason or "session closed");
 162
 163                 -- Authenticated incoming stream may still be sending us stanzas, so wait for </stream:stream> from remote
 164                 local conn = session.conn;
 165                 if reason == nil and not session.notopen and session.type == "c2s" then
 166                         -- Grace time to process data from authenticated cleanly-closed stream
 167                         add_task(stream_close_timeout, function ()
 168                                 if not session.destroyed then
 169                                         session.log("warn", "Failed to receive a stream close response, closing connection anyway...");
 170                                         sm_destroy_session(session, reason);
 171                                         conn:close();
 172                                 end
 173                         end);
 174                 else
 175                         sm_destroy_session(session, reason);
 176                         conn:close();
 177                 end
 178         end
 179 end
 180
 181 module:hook_global("user-deleted", function(event)
 182         local username, host = event.username, event.host;
 183         local user = hosts[host].sessions[username];
 184         if user and user.sessions then
 185                 for jid, session in pairs(user.sessions) do
 186                         session:close{ condition = "not-authorized", text = "Account deleted" };
 187                 end
 188         end
 189 end, 200);
 190
 191 --- Port listener
 192 function listener.onconnect(conn)
 193         local session = sm_new_session(conn);
 194         sessions[conn] = session;
 195
 196         session.log("info", "Client connected");
 197
 198         -- Client is using legacy SSL (otherwise mod_tls sets this flag)
 199         if conn:ssl() then
 200                 session.secure = true;
 201
 202                 -- Check if TLS compression is used
 203                 local sock = conn:socket();
 204                 if sock.info then
 205                         session.compressed = sock:info"compression";
 206                 elseif sock.compression then
 207                         session.compressed = sock:compression(); --COMPAT mw/luasec-hg
 208                 end
 209         end
 210
 211         if opt_keepalives then
 212                 conn:setoption("keepalive", opt_keepalives);
 213         end
 214
 215         session.close = session_close;
 216
 217         local stream = new_xmpp_stream(session, stream_callbacks);
 218         session.stream = stream;
 219         session.notopen = true;
 220
 221         function session.reset_stream()
 222                 session.notopen = true;
 223                 session.stream:reset();
 224         end
 225
 226         local filter = session.filter;
 227         function session.data(data)
 228                 data = filter("bytes/in", data);
 229                 if data then
 230                         local ok, err = stream:feed(data);
 231                         if ok then return; end
 232                         log("debug", "Received invalid XML (%s) %d bytes: %s", tostring(err), #data, data:sub(1, 300):gsub("[\r\n]+", " "):gsub("[%z\1-\31]", "_"));
 233                         session:close("not-well-formed");
 234                 end
 235         end
 236
 237
 238         if c2s_timeout then
 239                 add_task(c2s_timeout, function ()
 240                         if session.type == "c2s_unauthed" then
 241                                 session:close("connection-timeout");
 242                         end
 243                 end);
 244         end
 245
 246         session.dispatch_stanza = stream_callbacks.handlestanza;
 247 end
 248
 249 function listener.onincoming(conn, data)
 250         local session = sessions[conn];
 251         if session then
 252                 session.data(data);
 253         end
 254 end
 255
 256 function listener.ondisconnect(conn, err)
 257         local session = sessions[conn];
 258         if session then
 259                 (session.log or log)("info", "Client disconnected: %s", err or "connection closed");
 260                 sm_destroy_session(session, err);
 261                 sessions[conn]  = nil;
 262         end
 263 end
 264
 265 function listener.associate_session(conn, session)
 266         sessions[conn] = session;
 267 end
 268
 269 module:hook("server-stopping", function(event)
 270         local reason = event.reason;
 271         for _, session in pairs(sessions) do
 272                 session:close{ condition = "system-shutdown", text = reason };
 273         end
 274 end, 1000);
 275
 276
 277
 278 module:provides("net", {
 279         name = "c2s";
 280         listener = listener;
 281         default_port = 5222;
 282         encryption = "starttls";
 283         multiplex = {
 284                 pattern = "^<.*:stream.*%sxmlns%s*=%s*(['\"])jabber:client%1.*>";
 285         };
 286 });
 287
 288 module:provides("net", {
 289         name = "legacy_ssl";
 290         listener = listener;
 291         encryption = "ssl";
 292         multiplex = {
 293                 pattern = "^<.*:stream.*%sxmlns%s*=%s*(['\"])jabber:client%1.*>";
 294         };
 295 });
 296
 297