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.
11 local prosody = prosody;
12 local hosts = prosody.hosts;
13 local core_process_stanza = prosody.core_process_stanza;
15 local tostring, type = tostring, type;
16 local t_insert = table.insert;
17 local xpcall, traceback = xpcall, debug.traceback;
19 local add_task = require "util.timer".add_task;
20 local st = require "util.stanza";
21 local initialize_filters = require "util.filters".initialize;
22 local nameprep = require "util.encodings".stringprep.nameprep;
23 local new_xmpp_stream = require "util.xmppstream".new;
24 local s2s_new_incoming = require "core.s2smanager".new_incoming;
25 local s2s_new_outgoing = require "core.s2smanager".new_outgoing;
26 local s2s_destroy_session = require "core.s2smanager".destroy_session;
27 local s2s_mark_connected = require "core.s2smanager".mark_connected;
28 local uuid_gen = require "util.uuid".generate;
29 local cert_verify_identity = require "util.x509".verify_identity;
31 local s2sout = module:require("s2sout");
33 local connect_timeout = module:get_option_number("s2s_timeout", 90);
34 local stream_close_timeout = module:get_option_number("s2s_close_timeout", 5);
36 local sessions = module:shared("sessions");
38 local log = module._log;
40 --- Handle stanzas to remote domains
42 local bouncy_stanzas = { message = true, presence = true, iq = true };
43 local function bounce_sendq(session, reason)
44 local sendq = session.sendq;
45 if not sendq then return; end
46 session.log("info", "sending error replies for "..#sendq.." queued stanzas because of failed outgoing connection to "..tostring(session.to_host));
50 (session.log or log)("error", "Replying to to an s2s error reply, please report this! Traceback: %s", traceback());
54 for i, data in ipairs(sendq) do
55 local reply = data[2];
56 if reply and not(reply.attr.xmlns) and bouncy_stanzas[reply.name] then
57 reply.attr.type = "error";
58 reply:tag("error", {type = "cancel"})
59 :tag("remote-server-not-found", {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
61 reply:tag("text", {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"})
62 :text("Server-to-server connection failed: "..reason):up();
64 core_process_stanza(dummy, reply);
71 -- Handles stanzas to existing s2s sessions
72 function route_to_existing_session(event)
73 local from_host, to_host, stanza = event.from_host, event.to_host, event.stanza;
74 if not hosts[from_host] then
75 log("warn", "Attempt to send stanza from %s - a host we don't serve", from_host);
78 local host = hosts[from_host].s2sout[to_host];
80 -- We have a connection to this host already
81 if host.type == "s2sout_unauthed" and (stanza.name ~= "db:verify" or not host.dialback_key) then
82 (host.log or log)("debug", "trying to send over unauthed s2sout to "..to_host);
84 -- Queue stanza until we are able to send it
85 if host.sendq then t_insert(host.sendq, {tostring(stanza), stanza.attr.type ~= "error" and stanza.attr.type ~= "result" and st.reply(stanza)});
86 else host.sendq = { {tostring(stanza), stanza.attr.type ~= "error" and stanza.attr.type ~= "result" and st.reply(stanza)} }; end
87 host.log("debug", "stanza [%s] queued ", stanza.name);
89 elseif host.type == "local" or host.type == "component" then
90 log("error", "Trying to send a stanza to ourselves??")
91 log("error", "Traceback: %s", traceback());
92 log("error", "Stanza: %s", tostring(stanza));
95 (host.log or log)("debug", "going to send stanza to "..to_host.." from "..from_host);
97 if host.from_host ~= from_host then
98 log("error", "WARNING! This might, possibly, be a bug, but it might not...");
99 log("error", "We are going to send from %s instead of %s", tostring(host.from_host), tostring(from_host));
101 if host.sends2s(stanza) then
102 host.log("debug", "stanza sent over %s", host.type);
109 -- Create a new outgoing session for a stanza
110 function route_to_new_session(event)
111 local from_host, to_host, stanza = event.from_host, event.to_host, event.stanza;
112 log("debug", "opening a new outgoing connection for this stanza");
113 local host_session = s2s_new_outgoing(from_host, to_host);
116 host_session.bounce_sendq = bounce_sendq;
117 host_session.sendq = { {tostring(stanza), stanza.attr.type ~= "error" and stanza.attr.type ~= "result" and st.reply(stanza)} };
118 log("debug", "stanza [%s] queued until connection complete", tostring(stanza.name));
119 s2sout.initiate_connection(host_session);
120 if (not host_session.connecting) and (not host_session.conn) then
121 log("warn", "Connection to %s failed already, destroying session...", to_host);
122 s2s_destroy_session(host_session, "Connection failed");
128 function module.add_host(module)
129 if module:get_option_boolean("disallow_s2s", false) then
130 module:log("warn", "The 'disallow_s2s' config option is deprecated, please see http://prosody.im/doc/s2s#disabling");
131 return nil, "This host has disallow_s2s set";
133 module:hook("route/remote", route_to_existing_session, 200);
134 module:hook("route/remote", route_to_new_session, 100);
137 --- Helper to check that a session peer's certificate is valid
138 local function check_cert_status(session)
139 local conn = session.conn:socket()
141 if conn.getpeercertificate then
142 cert = conn:getpeercertificate()
146 local chain_valid, errors = conn:getpeerverification()
147 -- Is there any interest in printing out all/the number of errors here?
148 if not chain_valid then
149 (session.log or log)("debug", "certificate chain validation result: invalid");
150 for depth, t in ipairs(errors) do
151 (session.log or log)("debug", "certificate error(s) at depth %d: %s", depth-1, table.concat(t, ", "))
153 session.cert_chain_status = "invalid";
155 (session.log or log)("debug", "certificate chain validation result: valid");
156 session.cert_chain_status = "valid";
158 local host = session.direction == "incoming" and session.from_host or session.to_host
160 -- We'll go ahead and verify the asserted identity if the
161 -- connecting server specified one.
163 if cert_verify_identity(host, "xmpp-server", cert) then
164 session.cert_identity_status = "valid"
166 session.cert_identity_status = "invalid"
171 module:fire_event("s2s-check-certificate", { host = host, session = session, cert = cert });
174 --- XMPP stream event handlers
176 local stream_callbacks = { default_ns = "jabber:server", handlestanza = core_process_stanza };
178 local xmlns_xmpp_streams = "urn:ietf:params:xml:ns:xmpp-streams";
180 function stream_callbacks.streamopened(session, attr)
181 local send = session.sends2s;
183 session.version = tonumber(attr.version) or 0;
185 -- TODO: Rename session.secure to session.encrypted
186 if session.secure == false then
187 session.secure = true;
189 -- Check if TLS compression is used
190 local sock = session.conn:socket();
192 session.compressed = sock:info"compression";
193 elseif sock.compression then
194 session.compressed = sock:compression(); --COMPAT mw/luasec-hg
198 if session.direction == "incoming" then
199 -- Send a reply stream header
202 local to, from = nameprep(attr.to), nameprep(attr.from);
203 if not to and attr.to then -- COMPAT: Some servers do not reliably set 'to' (especially on stream restarts)
204 session:close({ condition = "improper-addressing", text = "Invalid 'to' address" });
207 if not from and attr.from then -- COMPAT: Some servers do not reliably set 'from' (especially on stream restarts)
208 session:close({ condition = "improper-addressing", text = "Invalid 'from' address" });
212 -- Set session.[from/to]_host if they have not been set already and if
213 -- this session isn't already authenticated
214 if session.type == "s2sin_unauthed" and from and not session.from_host then
215 session.from_host = from;
216 elseif from ~= session.from_host then
217 session:close({ condition = "improper-addressing", text = "New stream 'from' attribute does not match original" });
220 if session.type == "s2sin_unauthed" and to and not session.to_host then
221 session.to_host = to;
222 elseif to ~= session.to_host then
223 session:close({ condition = "improper-addressing", text = "New stream 'to' attribute does not match original" });
227 -- For convenience we'll put the sanitised values into these variables
228 to, from = session.to_host, session.from_host;
230 session.streamid = uuid_gen();
231 (session.log or log)("debug", "Incoming s2s received %s", st.stanza("stream:stream", attr):top_tag());
233 if not hosts[to] then
234 -- Attempting to connect to a host we don't serve
236 condition = "host-unknown";
237 text = "This host does not serve "..to
240 elseif not hosts[to].modules.s2s then
241 -- Attempting to connect to a host that disallows s2s
243 condition = "policy-violation";
244 text = "Server-to-server communication is disabled for this host";
250 if session.secure and not session.cert_chain_status then check_cert_status(session); end
252 send("<?xml version='1.0'?>");
253 send(st.stanza("stream:stream", { xmlns='jabber:server', ["xmlns:db"]='jabber:server:dialback',
254 ["xmlns:stream"]='http://etherx.jabber.org/streams', id=session.streamid, from=to, to=from, version=(session.version > 0 and "1.0" or nil) }):top_tag());
255 if session.version >= 1.0 then
256 local features = st.stanza("stream:features");
259 hosts[to].events.fire_event("s2s-stream-features", { origin = session, features = features });
261 (session.log or log)("warn", "No 'to' on stream header from %s means we can't offer any features", from or "unknown host");
264 log("debug", "Sending stream features: %s", tostring(features));
267 elseif session.direction == "outgoing" then
268 -- If we are just using the connection for verifying dialback keys, we won't try and auth it
269 if not attr.id then error("stream response did not give us a streamid!!!"); end
270 session.streamid = attr.id;
272 if session.secure and not session.cert_chain_status then check_cert_status(session); end
274 -- Send unauthed buffer
275 -- (stanzas which are fine to send before dialback)
276 -- Note that this is *not* the stanza queue (which
277 -- we can only send if auth succeeds) :)
278 local send_buffer = session.send_buffer;
279 if send_buffer and #send_buffer > 0 then
280 log("debug", "Sending s2s send_buffer now...");
281 for i, data in ipairs(send_buffer) do
282 session.sends2s(tostring(data));
283 send_buffer[i] = nil;
286 session.send_buffer = nil;
288 -- If server is pre-1.0, don't wait for features, just do dialback
289 if session.version < 1.0 then
290 if not session.dialback_verifying then
291 hosts[session.from_host].events.fire_event("s2sout-authenticate-legacy", { origin = session });
293 s2s_mark_connected(session);
297 session.notopen = nil;
300 function stream_callbacks.streamclosed(session)
301 (session.log or log)("debug", "Received </stream:stream>");
302 session:close(false);
305 function stream_callbacks.error(session, error, data)
306 if error == "no-stream" then
307 session:close("invalid-namespace");
308 elseif error == "parse-error" then
309 session.log("debug", "Server-to-server XML parse error: %s", tostring(error));
310 session:close("not-well-formed");
311 elseif error == "stream-error" then
312 local condition, text = "undefined-condition";
313 for child in data:children() do
314 if child.attr.xmlns == xmlns_xmpp_streams then
315 if child.name ~= "text" then
316 condition = child.name;
318 text = child:get_text();
320 if condition ~= "undefined-condition" and text then
325 text = condition .. (text and (" ("..text..")") or "");
326 session.log("info", "Session closed by remote with error: %s", text);
327 session:close(nil, text);
331 local function handleerr(err) log("error", "Traceback[s2s]: %s: %s", tostring(err), traceback()); end
332 function stream_callbacks.handlestanza(session, stanza)
333 if stanza.attr.xmlns == "jabber:client" then --COMPAT: Prosody pre-0.6.2 may send jabber:client
334 stanza.attr.xmlns = nil;
336 stanza = session.filter("stanzas/in", stanza);
338 return xpcall(function () return core_process_stanza(session, stanza) end, handleerr);
345 local stream_xmlns_attr = {xmlns='urn:ietf:params:xml:ns:xmpp-streams'};
346 local default_stream_attr = { ["xmlns:stream"] = "http://etherx.jabber.org/streams", xmlns = stream_callbacks.default_ns, version = "1.0", id = "" };
347 local function session_close(session, reason, remote_reason)
348 local log = session.log or log;
350 if session.notopen then
351 session.sends2s("<?xml version='1.0'?>");
352 session.sends2s(st.stanza("stream:stream", default_stream_attr):top_tag());
354 if reason then -- nil == no err, initiated by us, false == initiated by remote
355 if type(reason) == "string" then -- assume stream error
356 log("debug", "Disconnecting %s[%s], <stream:error> is: %s", session.host or "(unknown host)", session.type, reason);
357 session.sends2s(st.stanza("stream:error"):tag(reason, {xmlns = 'urn:ietf:params:xml:ns:xmpp-streams' }));
358 elseif type(reason) == "table" then
359 if reason.condition then
360 local stanza = st.stanza("stream:error"):tag(reason.condition, stream_xmlns_attr):up();
362 stanza:tag("text", stream_xmlns_attr):text(reason.text):up();
365 stanza:add_child(reason.extra);
367 log("debug", "Disconnecting %s[%s], <stream:error> is: %s", session.host or "(unknown host)", session.type, tostring(stanza));
368 session.sends2s(stanza);
369 elseif reason.name then -- a stanza
370 log("debug", "Disconnecting %s->%s[%s], <stream:error> is: %s", session.from_host or "(unknown host)", session.to_host or "(unknown host)", session.type, tostring(reason));
371 session.sends2s(reason);
376 session.sends2s("</stream:stream>");
377 function session.sends2s() return false; end
379 local reason = remote_reason or (reason and (reason.text or reason.condition)) or reason;
380 session.log("info", "%s s2s stream %s->%s closed: %s", session.direction, session.from_host or "(unknown host)", session.to_host or "(unknown host)", reason or "stream closed");
382 -- Authenticated incoming stream may still be sending us stanzas, so wait for </stream:stream> from remote
383 local conn = session.conn;
384 if reason == nil and not session.notopen and session.type == "s2sin" then
385 add_task(stream_close_timeout, function ()
386 if not session.destroyed then
387 session.log("warn", "Failed to receive a stream close response, closing connection anyway...");
388 s2s_destroy_session(session, reason);
393 s2s_destroy_session(session, reason);
394 conn:close(); -- Close immediately, as this is an outgoing connection or is not authed
399 -- Session initialization logic shared by incoming and outgoing
400 local function initialize_session(session)
401 local stream = new_xmpp_stream(session, stream_callbacks);
402 session.stream = stream;
404 session.notopen = true;
406 function session.reset_stream()
407 session.notopen = true;
408 session.stream:reset();
411 local filter = session.filter;
412 function session.data(data)
413 data = filter("bytes/in", data);
415 local ok, err = stream:feed(data);
416 if ok then return; end
417 (session.log or log)("warn", "Received invalid XML: %s", data);
418 (session.log or log)("warn", "Problem was: %s", err);
419 session:close("not-well-formed");
423 session.close = session_close;
425 local handlestanza = stream_callbacks.handlestanza;
426 function session.dispatch_stanza(session, stanza)
427 return handlestanza(session, stanza);
430 add_task(connect_timeout, function ()
431 if session.type == "s2sin" or session.type == "s2sout" then
432 return; -- Ok, we're connected
433 elseif session.type == "s2s_destroyed" then
434 return; -- Session already destroyed
436 -- Not connected, need to close session and clean up
437 (session.log or log)("debug", "Destroying incomplete session %s->%s due to inactivity",
438 session.from_host or "(unknown)", session.to_host or "(unknown)");
439 session:close("connection-timeout");
443 function listener.onconnect(conn)
444 local session = sessions[conn];
445 if not session then -- New incoming connection
446 session = s2s_new_incoming(conn);
447 sessions[conn] = session;
448 session.log("debug", "Incoming s2s connection");
450 local filter = initialize_filters(session);
451 local w = conn.write;
452 session.sends2s = function (t)
453 log("debug", "sending: %s", t.top_tag and t:top_tag() or t:match("^([^>]*>?)"));
455 t = filter("stanzas/out", t);
458 t = filter("bytes/out", tostring(t));
465 initialize_session(session);
466 else -- Outgoing session connected
467 session:open_stream(session.from_host, session.to_host);
471 function listener.onincoming(conn, data)
472 local session = sessions[conn];
478 function listener.onstatus(conn, status)
479 if status == "ssl-handshake-complete" then
480 local session = sessions[conn];
481 if session and session.direction == "outgoing" then
482 session.log("debug", "Sending stream header...");
483 session:open_stream(session.from_host, session.to_host);
488 function listener.ondisconnect(conn, err)
489 local session = sessions[conn];
491 sessions[conn] = nil;
492 if err and session.direction == "outgoing" and session.notopen then
493 (session.log or log)("debug", "s2s connection attempt failed: %s", err);
494 if s2sout.attempt_connection(session, err) then
495 (session.log or log)("debug", "...so we're going to try another target");
496 return; -- Session lives for now
499 (session.log or log)("debug", "s2s disconnected: %s->%s (%s)", tostring(session.from_host), tostring(session.to_host), tostring(err or "connection closed"));
500 s2s_destroy_session(session, err);
504 function listener.register_outgoing(conn, session)
505 session.direction = "outgoing";
506 sessions[conn] = session;
507 initialize_session(session);
510 s2sout.set_listener(listener);
512 module:hook("server-stopping", function(event)
513 local reason = event.reason;
514 for _, session in pairs(sessions) do
515 session:close{ condition = "system-shutdown", text = reason };
521 module:provides("net", {
525 encryption = "starttls";
527 pattern = "^<.*:stream.*%sxmlns%s*=%s*(['\"])jabber:server%1.*>";