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