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:set_global(); -- Global module
11 local hosts = _G.hosts;
12 local new_xmpp_stream = require "util.xmppstream".new;
13 local sm = require "core.sessionmanager";
14 local sm_destroy_session = sm.destroy_session;
15 local new_uuid = require "util.uuid".generate;
16 local fire_event = prosody.events.fire_event;
17 local core_process_stanza = prosody.core_process_stanza;
18 local st = require "util.stanza";
19 local logger = require "util.logger";
20 local log = logger.init("mod_bosh");
21 local initialize_filters = require "util.filters".initialize;
22 local math_min = math.min;
24 local xmlns_streams = "http://etherx.jabber.org/streams";
25 local xmlns_xmpp_streams = "urn:ietf:params:xml:ns:xmpp-streams";
26 local xmlns_bosh = "http://jabber.org/protocol/httpbind"; -- (hard-coded into a literal in session.send)
28 local stream_callbacks = {
29 stream_ns = xmlns_bosh, stream_tag = "body", default_ns = "jabber:client" };
31 local BOSH_DEFAULT_HOLD = module:get_option_number("bosh_default_hold", 1);
32 local BOSH_DEFAULT_INACTIVITY = module:get_option_number("bosh_max_inactivity", 60);
33 local BOSH_DEFAULT_POLLING = module:get_option_number("bosh_max_polling", 5);
34 local BOSH_DEFAULT_REQUESTS = module:get_option_number("bosh_max_requests", 2);
35 local bosh_max_wait = module:get_option_number("bosh_max_wait", 120);
37 local consider_bosh_secure = module:get_option_boolean("consider_bosh_secure");
39 local default_headers = { ["Content-Type"] = "text/xml; charset=utf-8", ["Connection"] = "keep-alive" };
41 local cross_domain = module:get_option("cross_domain_bosh", false);
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";
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, ", ");
52 if type(cross_domain) == "string" then
53 default_headers["Access-Control-Allow-Origin"] = cross_domain;
57 local trusted_proxies = module:get_option_set("trusted_proxies", {"127.0.0.1"})._items;
59 local function get_ip_from_request(request)
60 local ip = request.conn:ip();
61 local forwarded_for = request.headers.x_forwarded_for;
63 forwarded_for = forwarded_for..", "..ip;
64 for forwarded_ip in forwarded_for:gmatch("[^%s,]+") do
65 if not trusted_proxies[forwarded_ip] then
73 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
74 local os_time = os.time;
76 -- All sessions, and sessions that have no requests open
77 local sessions, inactive_sessions = module:shared("sessions", "inactive_sessions");
79 -- Used to respond to idle sessions (those with waiting requests)
80 local waiting_requests = {};
81 function on_destroy_request(request)
82 log("debug", "Request destroyed: %s", tostring(request));
83 waiting_requests[request] = nil;
84 local session = sessions[request.context.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 local max_inactive = session.bosh_max_inactive;
96 if max_inactive and #requests == 0 then
97 inactive_sessions[session] = os_time() + max_inactive;
98 (session.log or log)("debug", "BOSH session marked as inactive (for %ds)", max_inactive);
103 function handle_OPTIONS(request)
105 for k,v in pairs(default_headers) do headers[k] = v; end
106 headers["Content-Type"] = nil;
107 return { headers = headers, body = "" };
110 function handle_POST(event)
111 log("debug", "Handling new request %s: %s\n----------", tostring(event.request), tostring(event.request.body));
113 local request, response = event.request, event.response;
114 response.on_destroy = on_destroy_request;
115 local body = request.body;
117 local context = { request = request, response = response, notopen = true };
118 local stream = new_xmpp_stream(context, stream_callbacks);
119 response.context = context;
121 -- stream:feed() calls the stream_callbacks, so all stanzas in
122 -- the body are processed in this next line before it returns.
123 -- In particular, the streamopened() stream callback is where
124 -- much of the session logic happens, because it's where we first
125 -- get to see the 'sid' of this request.
128 -- Stanzas (if any) in the request have now been processed, and
129 -- we take care of the high-level BOSH logic here, including
130 -- giving a response or putting the request "on hold".
131 local session = sessions[context.sid];
133 -- Session was marked as inactive, since we have
134 -- a request open now, unmark it
135 if inactive_sessions[session] and #session.requests > 0 then
136 inactive_sessions[session] = nil;
139 local r = session.requests;
140 log("debug", "Session %s has %d out of %d requests open", context.sid, #r, session.bosh_hold);
141 log("debug", "and there are %d things in the send_buffer:", #session.send_buffer);
142 for i, thing in ipairs(session.send_buffer) do
143 log("debug", " %s", tostring(thing));
145 if #r > session.bosh_hold then
146 -- We are holding too many requests, send what's in the buffer,
147 log("debug", "We are holding too many requests, so...");
148 if #session.send_buffer > 0 then
149 log("debug", "...sending what is in the buffer")
150 session.send(t_concat(session.send_buffer));
151 session.send_buffer = {};
153 -- or an empty response
154 log("debug", "...sending an empty response");
157 elseif #session.send_buffer > 0 then
158 log("debug", "Session has data in the send buffer, will send now..");
159 local resp = t_concat(session.send_buffer);
160 session.send_buffer = {};
164 if not response.finished then
165 -- We're keeping this request open, to respond later
166 log("debug", "Have nothing to say, so leaving request unanswered for now");
167 if session.bosh_wait then
168 waiting_requests[response] = os_time() + session.bosh_wait;
172 if session.bosh_terminate then
173 session.log("debug", "Closing session with %d requests open", #session.requests);
177 return true; -- Inform http server we shall reply later
183 local function bosh_reset_stream(session) session.notopen = true; end
185 local stream_xmlns_attr = { xmlns = "urn:ietf:params:xml:ns:xmpp-streams" };
187 local function bosh_close_stream(session, reason)
188 (session.log or log)("info", "BOSH client disconnected");
190 local close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate",
191 ["xmlns:stream"] = xmlns_streams });
195 close_reply.attr.condition = "remote-stream-error";
196 if type(reason) == "string" then -- assume stream error
197 close_reply:tag("stream:error")
198 :tag(reason, {xmlns = xmlns_xmpp_streams});
199 elseif type(reason) == "table" then
200 if reason.condition then
201 close_reply:tag("stream:error")
202 :tag(reason.condition, stream_xmlns_attr):up();
204 close_reply:tag("text", stream_xmlns_attr):text(reason.text):up();
207 close_reply:add_child(reason.extra);
209 elseif reason.name then -- a stanza
210 close_reply = reason;
213 log("info", "Disconnecting client, <stream:error> is: %s", tostring(close_reply));
216 local response_body = tostring(close_reply);
217 for _, held_request in ipairs(session.requests) do
218 held_request.headers = default_headers;
219 held_request:send(response_body);
221 sessions[session.sid] = nil;
222 inactive_sessions[session] = nil;
223 sm_destroy_session(session);
226 -- Handle the <body> tag in the request payload.
227 function stream_callbacks.streamopened(context, attr)
228 local request, response = context.request, context.response;
229 local sid = attr.sid;
230 log("debug", "BOSH body open (sid: %s)", sid or "<none>");
232 -- New session request
233 context.notopen = nil; -- Signals that we accept this opening tag
235 -- TODO: Sanity checks here (rid, to, known host, etc.)
236 if not hosts[attr.to] then
238 log("debug", "BOSH client tried to connect to unknown host: %s", tostring(attr.to));
239 local close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate",
240 ["xmlns:stream"] = xmlns_streams, condition = "host-unknown" });
241 response:send(tostring(close_reply));
248 type = "c2s_unauthed", conn = {}, sid = sid, rid = tonumber(attr.rid)-1, host = attr.to,
249 bosh_version = attr.ver, bosh_wait = math_min(attr.wait, bosh_max_wait), streamid = sid,
250 bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
251 requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream,
252 close = bosh_close_stream, dispatch_stanza = core_process_stanza, notopen = true,
253 log = logger.init("bosh"..sid), secure = consider_bosh_secure or request.secure,
254 ip = get_ip_from_request(request);
256 sessions[sid] = session;
258 local filter = initialize_filters(session);
260 session.log("debug", "BOSH session created for request from %s", session.ip);
261 log("info", "New BOSH session, assigned it sid '%s'", sid);
263 -- Send creation response
264 local creating_session = true;
266 local r = session.requests;
267 function session.send(s)
268 -- We need to ensure that outgoing stanzas have the jabber:client xmlns
269 if s.attr and not s.attr.xmlns then
271 s.attr.xmlns = "jabber:client";
273 s = filter("stanzas/out", s);
274 --log("debug", "Sending BOSH data: %s", tostring(s));
275 t_insert(session.send_buffer, tostring(s));
277 local oldest_request = r[1];
278 if oldest_request and not session.bosh_processing then
279 log("debug", "We have an open request, so sending on that");
280 oldest_request.headers = default_headers;
281 local body_attr = { xmlns = "http://jabber.org/protocol/httpbind",
282 ["xmlns:stream"] = "http://etherx.jabber.org/streams";
283 type = session.bosh_terminate and "terminate" or nil;
286 if creating_session then
287 body_attr.inactivity = tostring(BOSH_DEFAULT_INACTIVITY);
288 body_attr.polling = tostring(BOSH_DEFAULT_POLLING);
289 body_attr.requests = tostring(BOSH_DEFAULT_REQUESTS);
290 body_attr.wait = tostring(session.bosh_wait);
291 body_attr.hold = tostring(session.bosh_hold);
292 body_attr.authid = sid;
293 body_attr.secure = "true";
294 body_attr.ver = '1.6';
295 body_attr.from = session.host;
296 body_attr["xmlns:xmpp"] = "urn:xmpp:xbosh";
297 body_attr["xmpp:version"] = "1.0";
299 oldest_request:send(st.stanza("body", body_attr):top_tag()..t_concat(session.send_buffer).."</body>");
300 session.send_buffer = {};
307 local session = sessions[sid];
310 log("info", "Client tried to use sid '%s' which we don't know about", sid);
311 response.headers = default_headers;
312 response:send(tostring(st.stanza("body", { xmlns = xmlns_bosh, type = "terminate", condition = "item-not-found" })));
313 context.notopen = nil;
318 local rid = tonumber(attr.rid);
319 local diff = rid - session.rid;
321 session.log("warn", "rid too large (means a request was lost). Last rid: %d New rid: %s", session.rid, attr.rid);
322 elseif diff <= 0 then
324 session.log("debug", "rid repeated (on request %s), ignoring: %s (diff %d)", request.id, session.rid, diff);
325 context.notopen = nil;
326 context.ignore = true;
328 t_insert(session.requests, response);
334 if attr.type == "terminate" then
335 -- Client wants to end this session, which we'll do
336 -- after processing any stanzas in this request
337 session.bosh_terminate = true;
340 context.notopen = nil; -- Signals that we accept this opening tag
341 t_insert(session.requests, response);
343 session.bosh_processing = true; -- Used to suppress replies until processing of this request is done
345 if session.notopen then
346 local features = st.stanza("stream:features");
347 hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
348 fire_event("stream-features", session, features);
349 table.insert(session.send_buffer, tostring(features));
350 session.notopen = nil;
354 function stream_callbacks.handlestanza(context, stanza)
355 if context.ignore then return; end
356 log("debug", "BOSH stanza received: %s\n", stanza:top_tag());
357 local session = sessions[context.sid];
359 if stanza.attr.xmlns == xmlns_bosh then
360 stanza.attr.xmlns = nil;
362 stanza = session.filter("stanzas/in", stanza);
363 core_process_stanza(session, stanza);
367 function stream_callbacks.streamclosed(context)
368 local session = sessions[context.sid];
370 session.bosh_processing = false;
371 if #session.send_buffer > 0 then
377 function stream_callbacks.error(context, error)
378 log("debug", "Error parsing BOSH request payload; %s", error);
379 if not context.sid then
380 local response = context.response;
381 response.headers = default_headers;
382 response.status_code = 400;
387 local session = sessions[context.sid];
388 if error == "stream-error" then -- Remote stream error, we close normally
391 session:close({ condition = "bad-format", text = "Error processing stream" });
395 local dead_sessions = {};
397 -- log("debug", "Checking for requests soon to timeout...");
398 -- Identify requests timing out within the next few seconds
399 local now = os_time() + 3;
400 for request, reply_before in pairs(waiting_requests) do
401 if reply_before <= now then
402 log("debug", "%s was soon to timeout (at %d, now %d), sending empty response", tostring(request), reply_before, now);
403 -- Send empty response to let the
404 -- client know we're still here
406 sessions[request.context.sid].send("");
412 local n_dead_sessions = 0;
413 for session, close_after in pairs(inactive_sessions) do
414 if close_after < now then
415 (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
416 sessions[session.sid] = nil;
417 inactive_sessions[session] = nil;
418 n_dead_sessions = n_dead_sessions + 1;
419 dead_sessions[n_dead_sessions] = session;
423 for i=1,n_dead_sessions do
424 local session = dead_sessions[i];
425 dead_sessions[i] = nil;
426 sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
430 module:add_timer(1, on_timer);
433 local GET_response = {
435 content_type = "text/html";
437 body = [[<html><body>
438 <p>It works! Now point your BOSH client to this URL to connect to Prosody.</p>
439 <p>For more information see <a href="http://prosody.im/doc/setting_up_bosh">Prosody: Setting up BOSH</a>.</p>
443 function module.add_host(module)
444 module:depends("http");
445 module:provides("http", {
446 default_path = "/http-bind";
448 ["GET"] = GET_response;
449 ["GET /"] = GET_response;
450 ["OPTIONS"] = handle_OPTIONS;
451 ["OPTIONS /"] = handle_OPTIONS;
452 ["POST"] = handle_POST;
453 ["POST /"] = handle_POST;