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 uuid_gen = require "util.uuid".generate;
28 local fire_global_event = prosody.events.fire_event;
30 local s2sout = module:require("s2sout");
32 local connect_timeout = module:get_option_number("s2s_timeout", 90);
33 local stream_close_timeout = module:get_option_number("s2s_close_timeout", 5);
34 local opt_keepalives = module:get_option_boolean("s2s_tcp_keepalives", module:get_option_boolean("tcp_keepalives", true));
35 local secure_auth = module:get_option_boolean("s2s_secure_auth", false); -- One day...
36 local secure_domains, insecure_domains =
37 module:get_option_set("s2s_secure_domains", {})._items, module:get_option_set("s2s_insecure_domains", {})._items;
38 local require_encryption = module:get_option_boolean("s2s_require_encryption", false);
40 local measure_connections = module:measure("connections", "counter");
42 local sessions = module:shared("sessions");
44 local log = module._log;
46 --- Handle stanzas to remote domains
48 local bouncy_stanzas = { message = true, presence = true, iq = true };
49 local function bounce_sendq(session, reason)
50 local sendq = session.sendq;
51 if not sendq then return; end
52 session.log("info", "Sending error replies for "..#sendq.." queued stanzas because of failed outgoing connection to "..tostring(session.to_host));
56 (session.log or log)("error", "Replying to to an s2s error reply, please report this! Traceback: %s", traceback());
60 (session.log or log)("error", "Attempting to close the dummy origin of s2s error replies, please report this! Traceback: %s", traceback());
63 for i, data in ipairs(sendq) do
64 local reply = data[2];
65 if reply and not(reply.attr.xmlns) and bouncy_stanzas[reply.name] then
66 reply.attr.type = "error";
67 reply:tag("error", {type = "cancel"})
68 :tag("remote-server-not-found", {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
70 reply:tag("text", {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"})
71 :text("Server-to-server connection failed: "..reason):up();
73 core_process_stanza(dummy, reply);
80 -- Handles stanzas to existing s2s sessions
81 function route_to_existing_session(event)
82 local from_host, to_host, stanza = event.from_host, event.to_host, event.stanza;
83 if not hosts[from_host] then
84 log("warn", "Attempt to send stanza from %s - a host we don't serve", from_host);
87 if hosts[to_host] then
88 log("warn", "Attempt to route stanza to a remote %s - a host we do serve?!", from_host);
91 local host = hosts[from_host].s2sout[to_host];
93 -- We have a connection to this host already
94 if host.type == "s2sout_unauthed" and (stanza.name ~= "db:verify" or not host.dialback_key) then
95 (host.log or log)("debug", "trying to send over unauthed s2sout to "..to_host);
97 -- Queue stanza until we are able to send it
98 if host.sendq then t_insert(host.sendq, {tostring(stanza), stanza.attr.type ~= "error" and stanza.attr.type ~= "result" and st.reply(stanza)});
99 else host.sendq = { {tostring(stanza), stanza.attr.type ~= "error" and stanza.attr.type ~= "result" and st.reply(stanza)} }; end
100 host.log("debug", "stanza [%s] queued ", stanza.name);
102 elseif host.type == "local" or host.type == "component" then
103 log("error", "Trying to send a stanza to ourselves??")
104 log("error", "Traceback: %s", traceback());
105 log("error", "Stanza: %s", tostring(stanza));
108 (host.log or log)("debug", "going to send stanza to "..to_host.." from "..from_host);
110 if host.from_host ~= from_host then
111 log("error", "WARNING! This might, possibly, be a bug, but it might not...");
112 log("error", "We are going to send from %s instead of %s", tostring(host.from_host), tostring(from_host));
114 if host.sends2s(stanza) then
115 host.log("debug", "stanza sent over %s", host.type);
122 -- Create a new outgoing session for a stanza
123 function route_to_new_session(event)
124 local from_host, to_host, stanza = event.from_host, event.to_host, event.stanza;
125 log("debug", "opening a new outgoing connection for this stanza");
126 local host_session = s2s_new_outgoing(from_host, to_host);
129 host_session.bounce_sendq = bounce_sendq;
130 host_session.sendq = { {tostring(stanza), stanza.attr.type ~= "error" and stanza.attr.type ~= "result" and st.reply(stanza)} };
131 log("debug", "stanza [%s] queued until connection complete", tostring(stanza.name));
132 s2sout.initiate_connection(host_session);
133 if (not host_session.connecting) and (not host_session.conn) then
134 log("warn", "Connection to %s failed already, destroying session...", to_host);
135 s2s_destroy_session(host_session, "Connection failed");
141 local function keepalive(event)
142 return event.session.sends2s(' ');
145 module:hook("s2s-read-timeout", keepalive, -1);
147 function module.add_host(module)
148 if module:get_option_boolean("disallow_s2s", false) then
149 module:log("warn", "The 'disallow_s2s' config option is deprecated, please see http://prosody.im/doc/s2s#disabling");
150 return nil, "This host has disallow_s2s set";
152 module:hook("route/remote", route_to_existing_session, -1);
153 module:hook("route/remote", route_to_new_session, -10);
154 module:hook("s2s-authenticated", make_authenticated, -1);
155 module:hook("s2s-read-timeout", keepalive, -1);
156 module:hook_stanza("http://etherx.jabber.org/streams", "features", function (session, stanza)
157 if session.type == "s2sout" then
158 -- Stream is authenticated and we are seem to be done with feature negotiation,
159 -- so the stream is ready for stanzas. RFC 6120 Section 4.3
160 mark_connected(session);
162 elseif not session.dialback_verifying then
163 session.log("warn", "No SASL EXTERNAL offer and Dialback doesn't seem to be enabled, giving up");
170 -- Stream is authorised, and ready for normal stanzas
171 function mark_connected(session)
172 local sendq = session.sendq;
174 local from, to = session.from_host, session.to_host;
176 session.log("info", "%s s2s connection %s->%s complete", session.direction:gsub("^.", string.upper), from, to);
178 local event_data = { session = session };
179 if session.type == "s2sout" then
180 fire_global_event("s2sout-established", event_data);
181 hosts[from].events.fire_event("s2sout-established", event_data);
183 local host_session = hosts[to];
184 session.send = function(stanza)
185 return host_session.events.fire_event("route/remote", { from_host = to, to_host = from, stanza = stanza });
188 fire_global_event("s2sin-established", event_data);
189 hosts[to].events.fire_event("s2sin-established", event_data);
192 if session.direction == "outgoing" then
194 session.log("debug", "sending %d queued stanzas across new outgoing connection to %s", #sendq, session.to_host);
195 local send = session.sends2s;
196 for i, data in ipairs(sendq) do
203 session.ip_hosts = nil;
204 session.srv_hosts = nil;
208 function make_authenticated(event)
209 local session, host = event.session, event.host;
210 if not session.secure then
211 if require_encryption or (secure_auth and not(insecure_domains[host])) or secure_domains[host] then
213 condition = "policy-violation",
214 text = "Encrypted server-to-server communication is required but was not "
215 ..((session.direction == "outgoing" and "offered") or "used")
220 session:close({ condition = "undefined-condition", text = "Attempt to authenticate as a host we serve" });
222 if session.type == "s2sout_unauthed" then
223 session.type = "s2sout";
224 elseif session.type == "s2sin_unauthed" then
225 session.type = "s2sin";
227 if not session.hosts[host] then session.hosts[host] = {}; end
228 session.hosts[host].authed = true;
230 elseif session.type == "s2sin" and host then
231 if not session.hosts[host] then session.hosts[host] = {}; end
232 session.hosts[host].authed = true;
236 session.log("debug", "connection %s->%s is now authenticated for %s", session.from_host, session.to_host, host);
238 if (session.type == "s2sout" and session.external_auth ~= "succeeded") or session.type == "s2sin" then
239 -- Stream either used dialback for authentication or is an incoming stream.
240 mark_connected(session);
246 --- Helper to check that a session peer's certificate is valid
247 function check_cert_status(session)
248 local host = session.direction == "outgoing" and session.to_host or session.from_host
249 local conn = session.conn:socket()
251 if conn.getpeercertificate then
252 cert = conn:getpeercertificate()
255 return module:fire_event("s2s-check-certificate", { host = host, session = session, cert = cert });
258 --- XMPP stream event handlers
260 local stream_callbacks = { default_ns = "jabber:server", handlestanza = core_process_stanza };
262 local xmlns_xmpp_streams = "urn:ietf:params:xml:ns:xmpp-streams";
264 function stream_callbacks.streamopened(session, attr)
265 session.version = tonumber(attr.version) or 0;
267 -- TODO: Rename session.secure to session.encrypted
268 if session.secure == false then
269 session.secure = true;
270 session.encrypted = true;
272 local sock = session.conn:socket();
274 local info = sock:info();
275 (session.log or log)("info", "Stream encrypted (%s with %s)", info.protocol, info.cipher);
276 session.compressed = info.compression;
278 (session.log or log)("info", "Stream encrypted");
279 session.compressed = sock.compression and sock:compression(); --COMPAT mw/luasec-hg
283 if session.direction == "incoming" then
284 -- Send a reply stream header
287 local to, from = nameprep(attr.to), nameprep(attr.from);
288 if not to and attr.to then -- COMPAT: Some servers do not reliably set 'to' (especially on stream restarts)
289 session:close({ condition = "improper-addressing", text = "Invalid 'to' address" });
292 if not from and attr.from then -- COMPAT: Some servers do not reliably set 'from' (especially on stream restarts)
293 session:close({ condition = "improper-addressing", text = "Invalid 'from' address" });
297 -- Set session.[from/to]_host if they have not been set already and if
298 -- this session isn't already authenticated
299 if session.type == "s2sin_unauthed" and from and not session.from_host then
300 session.from_host = from;
301 elseif from ~= session.from_host then
302 session:close({ condition = "improper-addressing", text = "New stream 'from' attribute does not match original" });
305 if session.type == "s2sin_unauthed" and to and not session.to_host then
306 session.to_host = to;
307 elseif to ~= session.to_host then
308 session:close({ condition = "improper-addressing", text = "New stream 'to' attribute does not match original" });
312 -- For convenience we'll put the sanitised values into these variables
313 to, from = session.to_host, session.from_host;
315 session.streamid = uuid_gen();
316 (session.log or log)("debug", "Incoming s2s received %s", st.stanza("stream:stream", attr):top_tag());
318 if not hosts[to] then
319 -- Attempting to connect to a host we don't serve
321 condition = "host-unknown";
322 text = "This host does not serve "..to
325 elseif not hosts[to].modules.s2s then
326 -- Attempting to connect to a host that disallows s2s
328 condition = "policy-violation";
329 text = "Server-to-server communication is disabled for this host";
336 session:close({ condition = "undefined-condition", text = "Attempt to connect from a host we serve" });
340 if session.secure and not session.cert_chain_status then
341 if check_cert_status(session) == false then
346 session:open_stream(session.to_host, session.from_host)
347 session.notopen = nil;
348 if session.version >= 1.0 then
349 local features = st.stanza("stream:features");
352 hosts[to].events.fire_event("s2s-stream-features", { origin = session, features = features });
354 (session.log or log)("warn", "No 'to' on stream header from %s means we can't offer any features", from or session.ip or "unknown host");
355 fire_global_event("s2s-stream-features-legacy", { origin = session, features = features });
358 if ( session.type == "s2sin" or session.type == "s2sout" ) or features.tags[1] then
359 log("debug", "Sending stream features: %s", tostring(features));
360 session.sends2s(features);
362 (session.log or log)("warn", "No features to offer, giving up");
363 session:close({ condition = "undefined-condition", text = "No features to offer" });
366 elseif session.direction == "outgoing" then
367 session.notopen = nil;
369 log("error", "Stream response from %s did not give us a stream id!", session.to_host);
370 session:close({ condition = "undefined-condition", text = "Missing stream ID" });
373 session.streamid = attr.id;
375 if session.secure and not session.cert_chain_status then
376 if check_cert_status(session) == false then
381 -- Send unauthed buffer
382 -- (stanzas which are fine to send before dialback)
383 -- Note that this is *not* the stanza queue (which
384 -- we can only send if auth succeeds) :)
385 local send_buffer = session.send_buffer;
386 if send_buffer and #send_buffer > 0 then
387 log("debug", "Sending s2s send_buffer now...");
388 for i, data in ipairs(send_buffer) do
389 session.sends2s(tostring(data));
390 send_buffer[i] = nil;
393 session.send_buffer = nil;
395 -- If server is pre-1.0, don't wait for features, just do dialback
396 if session.version < 1.0 then
397 if not session.dialback_verifying then
398 hosts[session.from_host].events.fire_event("s2sout-authenticate-legacy", { origin = session });
400 mark_connected(session);
406 function stream_callbacks.streamclosed(session)
407 (session.log or log)("debug", "Received </stream:stream>");
408 session:close(false);
411 function stream_callbacks.error(session, error, data)
412 if error == "no-stream" then
413 session.log("debug", "Invalid opening stream header (%s)", (data:gsub("^([^\1]+)\1", "{%1}")));
414 session:close("invalid-namespace");
415 elseif error == "parse-error" then
416 session.log("debug", "Server-to-server XML parse error: %s", tostring(error));
417 session:close("not-well-formed");
418 elseif error == "stream-error" then
419 local condition, text = "undefined-condition";
420 for child in data:children() do
421 if child.attr.xmlns == xmlns_xmpp_streams then
422 if child.name ~= "text" then
423 condition = child.name;
425 text = child:get_text();
427 if condition ~= "undefined-condition" and text then
432 text = condition .. (text and (" ("..text..")") or "");
433 session.log("info", "Session closed by remote with error: %s", text);
434 session:close(nil, text);
438 local function handleerr(err) log("error", "Traceback[s2s]: %s", traceback(tostring(err), 2)); end
439 function stream_callbacks.handlestanza(session, stanza)
440 if stanza.attr.xmlns == "jabber:client" then --COMPAT: Prosody pre-0.6.2 may send jabber:client
441 stanza.attr.xmlns = nil;
443 stanza = session.filter("stanzas/in", stanza);
445 return xpcall(function () return core_process_stanza(session, stanza) end, handleerr);
452 local stream_xmlns_attr = {xmlns='urn:ietf:params:xml:ns:xmpp-streams'};
453 local function session_close(session, reason, remote_reason)
454 local log = session.log or log;
456 if session.notopen then
457 if session.direction == "incoming" then
458 session:open_stream(session.to_host, session.from_host);
460 session:open_stream(session.from_host, session.to_host);
463 if reason then -- nil == no err, initiated by us, false == initiated by remote
464 if type(reason) == "string" then -- assume stream error
465 log("debug", "Disconnecting %s[%s], <stream:error> is: %s", session.host or session.ip or "(unknown host)", session.type, reason);
466 session.sends2s(st.stanza("stream:error"):tag(reason, {xmlns = 'urn:ietf:params:xml:ns:xmpp-streams' }));
467 elseif type(reason) == "table" then
468 if reason.condition then
469 local stanza = st.stanza("stream:error"):tag(reason.condition, stream_xmlns_attr):up();
471 stanza:tag("text", stream_xmlns_attr):text(reason.text):up();
474 stanza:add_child(reason.extra);
476 log("debug", "Disconnecting %s[%s], <stream:error> is: %s", session.host or session.ip or "(unknown host)", session.type, tostring(stanza));
477 session.sends2s(stanza);
478 elseif reason.name then -- a stanza
479 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));
480 session.sends2s(reason);
485 session.sends2s("</stream:stream>");
486 function session.sends2s() return false; end
488 local reason = remote_reason or (reason and (reason.text or reason.condition)) or reason;
489 session.log("info", "%s s2s stream %s->%s closed: %s", session.direction:gsub("^.", string.upper), session.from_host or "(unknown host)", session.to_host or "(unknown host)", reason or "stream closed");
491 -- Authenticated incoming stream may still be sending us stanzas, so wait for </stream:stream> from remote
492 local conn = session.conn;
493 if reason == nil and not session.notopen and session.type == "s2sin" then
494 add_task(stream_close_timeout, function ()
495 if not session.destroyed then
496 session.log("warn", "Failed to receive a stream close response, closing connection anyway...");
497 s2s_destroy_session(session, reason);
502 s2s_destroy_session(session, reason);
503 conn:close(); -- Close immediately, as this is an outgoing connection or is not authed
508 function session_stream_attrs(session, from, to, attr)
509 if not from or (hosts[from] and hosts[from].modules.dialback) then
510 attr["xmlns:db"] = 'jabber:server:dialback';
520 -- Session initialization logic shared by incoming and outgoing
521 local function initialize_session(session)
522 local stream = new_xmpp_stream(session, stream_callbacks);
523 local log = session.log or log;
524 session.stream = stream;
526 session.notopen = true;
528 function session.reset_stream()
529 session.notopen = true;
530 session.streamid = nil;
531 session.stream:reset();
534 session.stream_attrs = session_stream_attrs;
536 local filter = initialize_filters(session);
537 local conn = session.conn;
538 local w = conn.write;
540 function session.sends2s(t)
541 log("debug", "sending: %s", t.top_tag and t:top_tag() or t:match("^[^>]*>?"));
543 t = filter("stanzas/out", t);
546 t = filter("bytes/out", tostring(t));
553 function session.data(data)
554 data = filter("bytes/in", data);
556 local ok, err = stream:feed(data);
557 if ok then return; end
558 log("warn", "Received invalid XML: %s", data);
559 log("warn", "Problem was: %s", err);
560 session:close("not-well-formed");
564 session.close = session_close;
566 local handlestanza = stream_callbacks.handlestanza;
567 function session.dispatch_stanza(session, stanza)
568 return handlestanza(session, stanza);
571 module:fire_event("s2s-created", { session = session });
573 add_task(connect_timeout, function ()
574 if session.type == "s2sin" or session.type == "s2sout" then
575 return; -- Ok, we're connected
576 elseif session.type == "s2s_destroyed" then
577 return; -- Session already destroyed
579 -- Not connected, need to close session and clean up
580 (session.log or log)("debug", "Destroying incomplete session %s->%s due to inactivity",
581 session.from_host or "(unknown)", session.to_host or "(unknown)");
582 session:close("connection-timeout");
586 function listener.onconnect(conn)
587 measure_connections(1);
588 conn:setoption("keepalive", opt_keepalives);
589 local session = sessions[conn];
590 if not session then -- New incoming connection
591 session = s2s_new_incoming(conn);
592 sessions[conn] = session;
593 session.log("debug", "Incoming s2s connection");
594 initialize_session(session);
595 else -- Outgoing session connected
596 session:open_stream(session.from_host, session.to_host);
598 session.ip = conn:ip();
601 function listener.onincoming(conn, data)
602 local session = sessions[conn];
608 function listener.onstatus(conn, status)
609 if status == "ssl-handshake-complete" then
610 local session = sessions[conn];
611 if session and session.direction == "outgoing" then
612 session.log("debug", "Sending stream header...");
613 session:open_stream(session.from_host, session.to_host);
618 function listener.ontimeout(conn)
619 -- Called instead of onconnect when the connection times out
620 measure_connections(1);
623 function listener.ondisconnect(conn, err)
624 measure_connections(-1);
625 local session = sessions[conn];
627 sessions[conn] = nil;
628 if err and session.direction == "outgoing" and session.notopen then
629 (session.log or log)("debug", "s2s connection attempt failed: %s", err);
630 if s2sout.attempt_connection(session, err) then
631 return; -- Session lives for now
634 (session.log or log)("debug", "s2s disconnected: %s->%s (%s)", tostring(session.from_host), tostring(session.to_host), tostring(err or "connection closed"));
635 s2s_destroy_session(session, err);
639 function listener.onreadtimeout(conn)
640 local session = sessions[conn];
641 local host = session.host or session.to_host;
643 return (hosts[host] or prosody).events.fire_event("s2s-read-timeout", { session = session });
647 function listener.register_outgoing(conn, session)
648 sessions[conn] = session;
649 initialize_session(session);
652 function listener.ondetach(conn)
653 sessions[conn] = nil;
656 function check_auth_policy(event)
657 local host, session = event.host, event.session;
658 local must_secure = secure_auth;
660 if not must_secure and secure_domains[host] then
662 elseif must_secure and insecure_domains[host] then
666 if must_secure and (session.cert_chain_status ~= "valid" or session.cert_identity_status ~= "valid") then
667 module:log("warn", "Forbidding insecure connection to/from %s", host or session.ip or "(unknown host)");
668 if session.direction == "incoming" then
669 session:close({ condition = "not-authorized", text = "Your server's certificate is invalid, expired, or not trusted by "..session.to_host });
670 else -- Close outgoing connections without warning
671 session:close(false);
677 module:hook("s2s-check-certificate", check_auth_policy, -1);
679 s2sout.set_listener(listener);
681 module:hook("server-stopping", function(event)
682 local reason = event.reason;
683 for _, session in pairs(sessions) do
684 session:close{ condition = "system-shutdown", text = reason };
690 module:provides("net", {
694 encryption = "starttls";
696 pattern = "^<.*:stream.*%sxmlns%s*=%s*(['\"])jabber:server%1.*>";