2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 module.host = "*" -- Global module
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";
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)
29 local stream_callbacks = {
30 stream_ns = xmlns_bosh, stream_tag = "body", default_ns = "jabber:client" };
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 local BOSH_DEFAULT_MAXPAUSE = tonumber(module:get_option("bosh_max_pause")) or 300;
38 local consider_bosh_secure = module:get_option_boolean("consider_bosh_secure");
40 local default_headers = { ["Content-Type"] = "text/xml; charset=utf-8" };
42 local cross_domain = module:get_option("cross_domain_bosh");
44 default_headers["Access-Control-Allow-Methods"] = "GET, POST, OPTIONS";
45 default_headers["Access-Control-Allow-Headers"] = "Content-Type";
46 default_headers["Access-Control-Max-Age"] = "7200";
48 if cross_domain == true then
49 default_headers["Access-Control-Allow-Origin"] = "*";
50 elseif type(cross_domain) == "table" then
51 cross_domain = table.concat(cross_domain, ", ");
53 if type(cross_domain) == "string" then
54 default_headers["Access-Control-Allow-Origin"] = cross_domain;
58 local trusted_proxies = module:get_option_set("trusted_proxies", {"127.0.0.1"})._items;
60 local function get_ip_from_request(request)
61 local ip = request.handler:ip();
62 local forwarded_for = request.headers["x-forwarded-for"];
64 forwarded_for = forwarded_for..", "..ip;
65 for forwarded_ip in forwarded_for:gmatch("[^%s,]+") do
66 if not trusted_proxies[forwarded_ip] then
74 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
75 local os_time = os.time;
78 local inactive_sessions = {}; -- Sessions which have no open requests
80 -- Used to respond to idle sessions (those with waiting requests)
81 local waiting_requests = {};
82 function on_destroy_request(request)
83 waiting_requests[request] = nil;
84 local session = sessions[request.sid];
86 local requests = session.requests;
87 for i,r in ipairs(requests) do
89 t_remove(requests, i);
94 -- If this session now has no requests open, mark it as inactive
95 if #requests == 0 and session.bosh_max_inactive and not inactive_sessions[session] then
96 inactive_sessions[session] = os_time();
97 (session.log or log)("debug", "BOSH session marked as inactive at %d", inactive_sessions[session]);
102 function handle_request(method, body, request)
103 if (not body) or request.method ~= "POST" then
104 if request.method == "OPTIONS" then
106 for k,v in pairs(default_headers) do headers[k] = v; end
107 headers["Content-Type"] = nil;
108 return { headers = headers, body = "" };
110 return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
114 log("debug", "Request %s suffered error %s", tostring(request.id), body);
117 --log("debug", "Handling new request %s: %s\n----------", request.id, tostring(body));
118 request.notopen = true;
120 request.on_destroy = on_destroy_request;
122 local stream = new_xmpp_stream(request, stream_callbacks);
123 -- stream:feed() calls the stream_callbacks, so all stanzas in
124 -- the body are processed in this next line before it returns.
127 local session = sessions[request.sid];
129 local r = session.requests;
130 log("debug", "Session %s has %d out of %d requests open", request.sid, #r, session.bosh_hold);
131 log("debug", "and there are %d things in the send_buffer", #session.send_buffer);
132 if #r > session.bosh_hold then
133 -- We are holding too many requests, send what's in the buffer,
134 log("debug", "We are holding too many requests, so...");
135 if #session.send_buffer > 0 then
136 log("debug", "...sending what is in the buffer")
137 session.send(t_concat(session.send_buffer));
138 session.send_buffer = {};
140 -- or an empty response
141 log("debug", "...sending an empty response");
144 elseif #session.send_buffer > 0 then
145 log("debug", "Session has data in the send buffer, will send now..");
146 local resp = t_concat(session.send_buffer);
147 session.send_buffer = {};
151 if not request.destroyed then
152 -- We're keeping this request open, to respond later
153 log("debug", "Have nothing to say, so leaving request unanswered for now");
154 if session.bosh_wait then
155 request.reply_before = os_time() + session.bosh_wait;
156 waiting_requests[request] = true;
158 if inactive_sessions[session] then
159 -- Session was marked as inactive, since we have
160 -- a request open now, unmark it
161 inactive_sessions[session] = nil;
165 return true; -- Inform httpserver we shall reply later
170 local function bosh_reset_stream(session) session.notopen = true; end
172 local stream_xmlns_attr = { xmlns = "urn:ietf:params:xml:ns:xmpp-streams" };
174 local function bosh_close_stream(session, reason)
175 (session.log or log)("info", "BOSH client disconnected");
177 local close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate",
178 ["xmlns:streams"] = xmlns_streams });
182 close_reply.attr.condition = "remote-stream-error";
183 if type(reason) == "string" then -- assume stream error
184 close_reply:tag("stream:error")
185 :tag(reason, {xmlns = xmlns_xmpp_streams});
186 elseif type(reason) == "table" then
187 if reason.condition then
188 close_reply:tag("stream:error")
189 :tag(reason.condition, stream_xmlns_attr):up();
191 close_reply:tag("text", stream_xmlns_attr):text(reason.text):up();
194 close_reply:add_child(reason.extra);
196 elseif reason.name then -- a stanza
197 close_reply = reason;
200 log("info", "Disconnecting client, <stream:error> is: %s", tostring(close_reply));
203 local session_close_response = { headers = default_headers, body = tostring(close_reply) };
205 --FIXME: Quite sure we shouldn't reply to all requests with the error
206 for _, held_request in ipairs(session.requests) do
207 held_request:send(session_close_response);
208 held_request:destroy();
210 sessions[session.sid] = nil;
211 sm_destroy_session(session);
214 function stream_callbacks.streamopened(request, attr)
215 log("debug", "BOSH body open (sid: %s)", attr.sid);
218 -- New session request
219 request.notopen = nil; -- Signals that we accept this opening tag
221 -- TODO: Sanity checks here (rid, to, known host, etc.)
222 if not hosts[attr.to] then
224 log("debug", "BOSH client tried to connect to unknown host: %s", tostring(attr.to));
225 local close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate",
226 ["xmlns:streams"] = xmlns_streams, condition = "host-unknown" });
227 request:send(tostring(close_reply));
234 type = "c2s_unauthed", conn = {}, sid = sid, rid = tonumber(attr.rid), host = attr.to,
235 bosh_version = attr.ver, bosh_wait = attr.wait, streamid = sid,
236 bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
237 requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream,
238 close = bosh_close_stream, dispatch_stanza = core_process_stanza,
239 log = logger.init("bosh"..sid), secure = consider_bosh_secure or request.secure,
240 ip = get_ip_from_request(request);
242 sessions[sid] = session;
244 session.log("debug", "BOSH session created for request from %s", session.ip);
245 log("info", "New BOSH session, assigned it sid '%s'", sid);
246 local r, send_buffer = session.requests, session.send_buffer;
247 local response = { headers = default_headers }
248 function session.send(s)
249 -- We need to ensure that outgoing stanzas have the jabber:client xmlns
250 if s.attr and not s.attr.xmlns then
252 s.attr.xmlns = "jabber:client";
254 --log("debug", "Sending BOSH data: %s", tostring(s));
255 local oldest_request = r[1];
256 if oldest_request then
257 log("debug", "We have an open request, so sending on that");
258 response.body = t_concat{"<body xmlns='http://jabber.org/protocol/httpbind' sid='", sid, "' xmlns:stream = 'http://etherx.jabber.org/streams'>", tostring(s), "</body>" };
259 oldest_request:send(response);
260 --log("debug", "Sent");
261 if oldest_request.stayopen then
263 -- Move front request to back
264 t_insert(r, oldest_request);
268 log("debug", "Destroying the request now...");
269 oldest_request:destroy();
272 log("debug", "Saved to send buffer because there are %d open requests", #r);
273 -- Hmm, no requests are open :(
274 t_insert(session.send_buffer, tostring(s));
275 log("debug", "There are now %d things in the send_buffer", #session.send_buffer);
279 -- Send creation response
281 local features = st.stanza("stream:features");
282 hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
283 fire_event("stream-features", session, features);
284 --xmpp:version='1.0' xmlns:xmpp='urn:xmpp:xbosh'
285 local response = st.stanza("body", { xmlns = xmlns_bosh,
286 inactivity = tostring(BOSH_DEFAULT_INACTIVITY), polling = tostring(BOSH_DEFAULT_POLLING), requests = tostring(BOSH_DEFAULT_REQUESTS), hold = tostring(session.bosh_hold), maxpause = "120",
287 sid = sid, authid = sid, ver = '1.6', from = session.host, secure = 'true', ["xmpp:version"] = "1.0",
288 ["xmlns:xmpp"] = "urn:xmpp:xbosh", ["xmlns:stream"] = "http://etherx.jabber.org/streams" }):add_child(features);
289 request:send{ headers = default_headers, body = tostring(response) };
295 local session = sessions[sid];
298 log("info", "Client tried to use sid '%s' which we don't know about", sid);
299 request:send{ headers = default_headers, body = tostring(st.stanza("body", { xmlns = xmlns_bosh, type = "terminate", condition = "item-not-found" })) };
300 request.notopen = nil;
305 local rid = tonumber(attr.rid);
306 local diff = rid - session.rid;
308 session.log("warn", "rid too large (means a request was lost). Last rid: %d New rid: %s", session.rid, attr.rid);
309 elseif diff <= 0 then
311 session.log("debug", "rid repeated (on request %s), ignoring: %s (diff %d)", request.id, session.rid, diff);
312 request.notopen = nil;
313 request.ignore = true;
315 t_insert(session.requests, request);
321 if attr.type == "terminate" then
322 -- Client wants to end this session
324 request.notopen = nil;
328 if session.notopen then
329 local features = st.stanza("stream:features");
330 hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
331 fire_event("stream-features", session, features);
332 session.send(features);
333 session.notopen = nil;
336 request.notopen = nil; -- Signals that we accept this opening tag
337 t_insert(session.requests, request);
341 function stream_callbacks.handlestanza(request, stanza)
342 if request.ignore then return; end
343 log("debug", "BOSH stanza received: %s\n", stanza:top_tag());
344 local session = sessions[request.sid];
346 if stanza.attr.xmlns == xmlns_bosh then
347 stanza.attr.xmlns = nil;
349 core_process_stanza(session, stanza);
353 function stream_callbacks.error(request, error)
354 log("debug", "Error parsing BOSH request payload; %s", error);
355 if not request.sid then
356 request:send({ headers = default_headers, status = "400 Bad Request" });
360 local session = sessions[request.sid];
361 if error == "stream-error" then -- Remote stream error, we close normally
364 session:close({ condition = "bad-format", text = "Error processing stream" });
368 local dead_sessions = {};
370 -- log("debug", "Checking for requests soon to timeout...");
371 -- Identify requests timing out within the next few seconds
372 local now = os_time() + 3;
373 for request in pairs(waiting_requests) do
374 if request.reply_before <= now then
375 log("debug", "%s was soon to timeout, sending empty response", request.id);
376 -- Send empty response to let the
377 -- client know we're still here
379 sessions[request.sid].send("");
385 local n_dead_sessions = 0;
386 for session, inactive_since in pairs(inactive_sessions) do
387 if session.bosh_max_inactive then
388 if now - inactive_since > session.bosh_max_inactive then
389 (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
390 sessions[session.sid] = nil;
391 inactive_sessions[session] = nil;
392 n_dead_sessions = n_dead_sessions + 1;
393 dead_sessions[n_dead_sessions] = session;
396 inactive_sessions[session] = nil;
400 for i=1,n_dead_sessions do
401 local session = dead_sessions[i];
402 dead_sessions[i] = nil;
403 sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
409 local function setup()
410 local ports = module:get_option("bosh_ports") or { 5280 };
411 httpserver.new_from_config(ports, handle_request, { base = "http-bind" });
412 timer.add_task(1, on_timer);
414 if prosody.start_time then -- already started
417 prosody.events.add_handler("server-started", setup);