plugins/mod_bosh.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.host = "*" -- Global module
  10
  11 local hosts = _G.hosts;
  12 local lxp = require "lxp";
  13 local new_xmpp_stream = require "util.xmppstream".new;
  14 local httpserver = require "net.httpserver";
  15 local sm = require "core.sessionmanager";
  16 local sm_destroy_session = sm.destroy_session;
  17 local new_uuid = require "util.uuid".generate;
  18 local fire_event = prosody.events.fire_event;
  19 local core_process_stanza = core_process_stanza;
  20 local st = require "util.stanza";
  21 local logger = require "util.logger";
  22 local log = logger.init("mod_bosh");
  23 local timer = require "util.timer";
  24
  25 local xmlns_streams = "http://etherx.jabber.org/streams";
  26 local xmlns_xmpp_streams = "urn:ietf:params:xml:ns:xmpp-streams";
  27 local xmlns_bosh = "http://jabber.org/protocol/httpbind"; -- (hard-coded into a literal in session.send)
  28
  29 local stream_callbacks = {
  30         stream_ns = xmlns_bosh, stream_tag = "body", default_ns = "jabber:client" };
  31
  32 local BOSH_DEFAULT_HOLD = tonumber(module:get_option("bosh_default_hold")) or 1;
  33 local BOSH_DEFAULT_INACTIVITY = tonumber(module:get_option("bosh_max_inactivity")) or 60;
  34 local BOSH_DEFAULT_POLLING = tonumber(module:get_option("bosh_max_polling")) or 5;
  35 local BOSH_DEFAULT_REQUESTS = tonumber(module:get_option("bosh_max_requests")) or 2;
  36
  37 local consider_bosh_secure = module:get_option_boolean("consider_bosh_secure");
  38
  39 local default_headers = { ["Content-Type"] = "text/xml; charset=utf-8" };
  40
  41 local cross_domain = module:get_option("cross_domain_bosh");
  42 if cross_domain then
  43         default_headers["Access-Control-Allow-Methods"] = "GET, POST, OPTIONS";
  44         default_headers["Access-Control-Allow-Headers"] = "Content-Type";
  45         default_headers["Access-Control-Max-Age"] = "7200";
  46
  47         if cross_domain == true then
  48                 default_headers["Access-Control-Allow-Origin"] = "*";
  49         elseif type(cross_domain) == "table" then
  50                 cross_domain = table.concat(cross_domain, ", ");
  51         end
  52         if type(cross_domain) == "string" then
  53                 default_headers["Access-Control-Allow-Origin"] = cross_domain;
  54         end
  55 end
  56
  57 local trusted_proxies = module:get_option_set("trusted_proxies", {"127.0.0.1"})._items;
  58
  59 local function get_ip_from_request(request)
  60         local ip = request.handler:ip();
  61         local forwarded_for = request.headers["x-forwarded-for"];
  62         if forwarded_for then
  63                 forwarded_for = forwarded_for..", "..ip;
  64                 for forwarded_ip in forwarded_for:gmatch("[^%s,]+") do
  65                         if not trusted_proxies[forwarded_ip] then
  66                                 ip = forwarded_ip;
  67                         end
  68                 end
  69         end
  70         return ip;
  71 end
  72
  73 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
  74 local os_time = os.time;
  75
  76 local sessions = {};
  77 local inactive_sessions = {}; -- Sessions which have no open requests
  78
  79 -- Used to respond to idle sessions (those with waiting requests)
  80 local waiting_requests = {};
  81 function on_destroy_request(request)
  82         waiting_requests[request] = nil;
  83         local session = sessions[request.sid];
  84         if session then
  85                 local requests = session.requests;
  86                 for i,r in ipairs(requests) do
  87                         if r == request then
  88                                 t_remove(requests, i);
  89                                 break;
  90                         end
  91                 end
  92
  93                 -- If this session now has no requests open, mark it as inactive
  94                 if #requests == 0 and session.bosh_max_inactive and not inactive_sessions[session] then
  95                         inactive_sessions[session] = os_time();
  96                         (session.log or log)("debug", "BOSH session marked as inactive at %d", inactive_sessions[session]);
  97                 end
  98         end
  99 end
 100
 101 function handle_request(method, body, request)
 102         if (not body) or request.method ~= "POST" then
 103                 if request.method == "OPTIONS" then
 104                         local headers = {};
 105                         for k,v in pairs(default_headers) do headers[k] = v; end
 106                         headers["Content-Type"] = nil;
 107                         return { headers = headers, body = "" };
 108                 else
 109                         return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
 110                 end
 111         end
 112         if not method then
 113                 log("debug", "Request %s suffered error %s", tostring(request.id), body);
 114                 return;
 115         end
 116         --log("debug", "Handling new request %s: %s\n----------", request.id, tostring(body));
 117         request.notopen = true;
 118         request.log = log;
 119         request.on_destroy = on_destroy_request;
 120
 121         local stream = new_xmpp_stream(request, stream_callbacks);
 122         -- stream:feed() calls the stream_callbacks, so all stanzas in
 123         -- the body are processed in this next line before it returns.
 124         stream:feed(body);
 125
 126         local session = sessions[request.sid];
 127         if session then
 128                 -- Session was marked as inactive, since we have
 129                 -- a request open now, unmark it
 130                 if inactive_sessions[session] and #session.requests > 0 then
 131                         inactive_sessions[session] = nil;
 132                 end
 133
 134                 local r = session.requests;
 135                 log("debug", "Session %s has %d out of %d requests open", request.sid, #r, session.bosh_hold);
 136                 log("debug", "and there are %d things in the send_buffer", #session.send_buffer);
 137                 if #r > session.bosh_hold then
 138                         -- We are holding too many requests, send what's in the buffer,
 139                         log("debug", "We are holding too many requests, so...");
 140                         if #session.send_buffer > 0 then
 141                                 log("debug", "...sending what is in the buffer")
 142                                 session.send(t_concat(session.send_buffer));
 143                                 session.send_buffer = {};
 144                         else
 145                                 -- or an empty response
 146                                 log("debug", "...sending an empty response");
 147                                 session.send("");
 148                         end
 149                 elseif #session.send_buffer > 0 then
 150                         log("debug", "Session has data in the send buffer, will send now..");
 151                         local resp = t_concat(session.send_buffer);
 152                         session.send_buffer = {};
 153                         session.send(resp);
 154                 end
 155
 156                 if not request.destroyed then
 157                         -- We're keeping this request open, to respond later
 158                         log("debug", "Have nothing to say, so leaving request unanswered for now");
 159                         if session.bosh_wait then
 160                                 request.reply_before = os_time() + session.bosh_wait;
 161                                 waiting_requests[request] = true;
 162                         end
 163                 end
 164
 165                 if session.bosh_terminate then
 166                         session.log("debug", "Closing session with %d requests open", #session.requests);
 167                         session:close();
 168                         return nil;
 169                 else
 170                         return true; -- Inform httpserver we shall reply later
 171                 end
 172         end
 173 end
 174
 175
 176 local function bosh_reset_stream(session) session.notopen = true; end
 177
 178 local stream_xmlns_attr = { xmlns = "urn:ietf:params:xml:ns:xmpp-streams" };
 179
 180 local function bosh_close_stream(session, reason)
 181         (session.log or log)("info", "BOSH client disconnected");
 182
 183         local close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate",
 184                 ["xmlns:streams"] = xmlns_streams });
 185
 186
 187         if reason then
 188                 close_reply.attr.condition = "remote-stream-error";
 189                 if type(reason) == "string" then -- assume stream error
 190                         close_reply:tag("stream:error")
 191                                 :tag(reason, {xmlns = xmlns_xmpp_streams});
 192                 elseif type(reason) == "table" then
 193                         if reason.condition then
 194                                 close_reply:tag("stream:error")
 195                                         :tag(reason.condition, stream_xmlns_attr):up();
 196                                 if reason.text then
 197                                         close_reply:tag("text", stream_xmlns_attr):text(reason.text):up();
 198                                 end
 199                                 if reason.extra then
 200                                         close_reply:add_child(reason.extra);
 201                                 end
 202                         elseif reason.name then -- a stanza
 203                                 close_reply = reason;
 204                         end
 205                 end
 206                 log("info", "Disconnecting client, <stream:error> is: %s", tostring(close_reply));
 207         end
 208
 209         local session_close_response = { headers = default_headers, body = tostring(close_reply) };
 210
 211         for _, held_request in ipairs(session.requests) do
 212                 held_request:send(session_close_response);
 213                 held_request:destroy();
 214         end
 215         sessions[session.sid]  = nil;
 216         sm_destroy_session(session);
 217 end
 218
 219 function stream_callbacks.streamopened(request, attr)
 220         log("debug", "BOSH body open (sid: %s)", attr.sid);
 221         local sid = attr.sid
 222         if not sid then
 223                 -- New session request
 224                 request.notopen = nil; -- Signals that we accept this opening tag
 225
 226                 -- TODO: Sanity checks here (rid, to, known host, etc.)
 227                 if not hosts[attr.to] then
 228                         -- Unknown host
 229                         log("debug", "BOSH client tried to connect to unknown host: %s", tostring(attr.to));
 230                         local close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate",
 231                                 ["xmlns:streams"] = xmlns_streams, condition = "host-unknown" });
 232                         request:send(tostring(close_reply));
 233                         return;
 234                 end
 235
 236                 -- New session
 237                 sid = new_uuid();
 238                 local session = {
 239                         type = "c2s_unauthed", conn = {}, sid = sid, rid = tonumber(attr.rid), host = attr.to,
 240                         bosh_version = attr.ver, bosh_wait = attr.wait, streamid = sid,
 241                         bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
 242                         requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream,
 243                         close = bosh_close_stream, dispatch_stanza = core_process_stanza,
 244                         log = logger.init("bosh"..sid), secure = consider_bosh_secure or request.secure,
 245                         ip = get_ip_from_request(request);
 246                 };
 247                 sessions[sid] = session;
 248
 249                 session.log("debug", "BOSH session created for request from %s", session.ip);
 250                 log("info", "New BOSH session, assigned it sid '%s'", sid);
 251                 local r, send_buffer = session.requests, session.send_buffer;
 252                 local response = { headers = default_headers }
 253                 function session.send(s)
 254                         -- We need to ensure that outgoing stanzas have the jabber:client xmlns
 255                         if s.attr and not s.attr.xmlns then
 256                                 s = st.clone(s);
 257                                 s.attr.xmlns = "jabber:client";
 258                         end
 259                         --log("debug", "Sending BOSH data: %s", tostring(s));
 260                         local oldest_request = r[1];
 261                         if oldest_request then
 262                                 log("debug", "We have an open request, so sending on that");
 263                                 response.body = t_concat({
 264                                         "<body xmlns='http://jabber.org/protocol/httpbind' ",
 265                                         session.bosh_terminate and "type='terminate' " or "",
 266                                         "sid='", sid, "' xmlns:stream = 'http://etherx.jabber.org/streams'>",
 267                                         tostring(s),
 268                                         "</body>"
 269                                 });
 270                                 oldest_request:send(response);
 271                                 --log("debug", "Sent");
 272                                 if oldest_request.stayopen then
 273                                         if #r>1 then
 274                                                 -- Move front request to back
 275                                                 t_insert(r, oldest_request);
 276                                                 t_remove(r, 1);
 277                                         end
 278                                 else
 279                                         log("debug", "Destroying the request now...");
 280                                         oldest_request:destroy();
 281                                 end
 282                         elseif s ~= "" then
 283                                 log("debug", "Saved to send buffer because there are %d open requests", #r);
 284                                 -- Hmm, no requests are open :(
 285                                 t_insert(session.send_buffer, tostring(s));
 286                                 log("debug", "There are now %d things in the send_buffer", #session.send_buffer);
 287                         end
 288                         return true;
 289                 end
 290
 291                 -- Send creation response
 292
 293                 local features = st.stanza("stream:features");
 294                 hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
 295                 fire_event("stream-features", session, features);
 296                 --xmpp:version='1.0' xmlns:xmpp='urn:xmpp:xbosh'
 297                 local response = st.stanza("body", { xmlns = xmlns_bosh,
 298                         wait = attr.wait,
 299                         inactivity = tostring(BOSH_DEFAULT_INACTIVITY),
 300                         polling = tostring(BOSH_DEFAULT_POLLING),
 301                         requests = tostring(BOSH_DEFAULT_REQUESTS),
 302                         hold = tostring(session.bosh_hold),
 303                         sid = sid, authid = sid,
 304                         ver  = '1.6', from = session.host,
 305                         secure = 'true', ["xmpp:version"] = "1.0",
 306                         ["xmlns:xmpp"] = "urn:xmpp:xbosh",
 307                         ["xmlns:stream"] = "http://etherx.jabber.org/streams"
 308                 }):add_child(features);
 309                 request:send{ headers = default_headers, body = tostring(response) };
 310
 311                 request.sid = sid;
 312                 return;
 313         end
 314
 315         local session = sessions[sid];
 316         if not session then
 317                 -- Unknown sid
 318                 log("info", "Client tried to use sid '%s' which we don't know about", sid);
 319                 request:send{ headers = default_headers, body = tostring(st.stanza("body", { xmlns = xmlns_bosh, type = "terminate", condition = "item-not-found" })) };
 320                 request.notopen = nil;
 321                 return;
 322         end
 323
 324         if session.rid then
 325                 local rid = tonumber(attr.rid);
 326                 local diff = rid - session.rid;
 327                 if diff > 1 then
 328                         session.log("warn", "rid too large (means a request was lost). Last rid: %d New rid: %s", session.rid, attr.rid);
 329                 elseif diff <= 0 then
 330                         -- Repeated, ignore
 331                         session.log("debug", "rid repeated (on request %s), ignoring: %s (diff %d)", request.id, session.rid, diff);
 332                         request.notopen = nil;
 333                         request.ignore = true;
 334                         request.sid = sid;
 335                         t_insert(session.requests, request);
 336                         return;
 337                 end
 338                 session.rid = rid;
 339         end
 340
 341         if session.notopen then
 342                 local features = st.stanza("stream:features");
 343                 hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
 344                 fire_event("stream-features", session, features);
 345                 session.send(features);
 346                 session.notopen = nil;
 347         end
 348
 349         if attr.type == "terminate" then
 350                 -- Client wants to end this session, which we'll do
 351                 -- after processing any stanzas in this request
 352                 session.bosh_terminate = true;
 353         end
 354
 355         request.notopen = nil; -- Signals that we accept this opening tag
 356         t_insert(session.requests, request);
 357         request.sid = sid;
 358 end
 359
 360 function stream_callbacks.handlestanza(request, stanza)
 361         if request.ignore then return; end
 362         log("debug", "BOSH stanza received: %s\n", stanza:top_tag());
 363         local session = sessions[request.sid];
 364         if session then
 365                 if stanza.attr.xmlns == xmlns_bosh then
 366                         stanza.attr.xmlns = nil;
 367                 end
 368                 core_process_stanza(session, stanza);
 369         end
 370 end
 371
 372 function stream_callbacks.error(request, error)
 373         log("debug", "Error parsing BOSH request payload; %s", error);
 374         if not request.sid then
 375                 request:send({ headers = default_headers, status = "400 Bad Request" });
 376                 return;
 377         end
 378
 379         local session = sessions[request.sid];
 380         if error == "stream-error" then -- Remote stream error, we close normally
 381                 session:close();
 382         else
 383                 session:close({ condition = "bad-format", text = "Error processing stream" });
 384         end
 385 end
 386
 387 local dead_sessions = {};
 388 function on_timer()
 389         -- log("debug", "Checking for requests soon to timeout...");
 390         -- Identify requests timing out within the next few seconds
 391         local now = os_time() + 3;
 392         for request in pairs(waiting_requests) do
 393                 if request.reply_before <= now then
 394                         log("debug", "%s was soon to timeout, sending empty response", request.id);
 395                         -- Send empty response to let the
 396                         -- client know we're still here
 397                         if request.conn then
 398                                 sessions[request.sid].send("");
 399                         end
 400                 end
 401         end
 402
 403         now = now - 3;
 404         local n_dead_sessions = 0;
 405         for session, inactive_since in pairs(inactive_sessions) do
 406                 if session.bosh_max_inactive then
 407                         if now - inactive_since > session.bosh_max_inactive then
 408                                 (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
 409                                 sessions[session.sid]  = nil;
 410                                 inactive_sessions[session] = nil;
 411                                 n_dead_sessions = n_dead_sessions + 1;
 412                                 dead_sessions[n_dead_sessions] = session;
 413                         end
 414                 else
 415                         inactive_sessions[session] = nil;
 416                 end
 417         end
 418
 419         for i=1,n_dead_sessions do
 420                 local session = dead_sessions[i];
 421                 dead_sessions[i] = nil;
 422                 sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
 423         end
 424         return 1;
 425 end
 426
 427
 428 local function setup()
 429         local ports = module:get_option("bosh_ports") or { 5280 };
 430         httpserver.new_from_config(ports, handle_request, { base = "http-bind" });
 431         timer.add_task(1, on_timer);
 432 end
 433 if prosody.start_time then -- already started
 434         setup();
 435 else
 436         prosody.events.add_handler("server-started", setup);
 437 end