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