2 -- Copyright (C) 2008-2009 Matthew Wild
3 -- Copyright (C) 2008-2009 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
12 local sessions = sessions;
13 local core_process_stanza = function(a, b) core_process_stanza(a, b); end
14 local add_task = require "util.timer".add_task;
15 local socket = require "socket";
16 local format = string.format;
17 local t_insert, t_sort = table.insert, table.sort;
18 local get_traceback = debug.traceback;
19 local tostring, pairs, ipairs, getmetatable, newproxy, error, tonumber,
21 = tostring, pairs, ipairs, getmetatable, newproxy, error, tonumber,
24 local idna_to_ascii = require "util.encodings".idna.to_ascii;
25 local connlisteners_get = require "net.connlisteners".get;
26 local wrapclient = require "net.server".wrapclient;
27 local modulemanager = require "core.modulemanager";
28 local st = require "stanza";
29 local stanza = st.stanza;
30 local nameprep = require "util.encodings".stringprep.nameprep;
32 local fire_event = require "core.eventmanager".fire_event;
33 local uuid_gen = require "util.uuid".generate;
35 local logger_init = require "util.logger".init;
37 local log = logger_init("s2smanager");
39 local sha256_hash = require "util.hashes".sha256;
41 local adns, dns = require "net.adns", require "net.dns";
42 local config = require "core.configmanager";
43 local connect_timeout = config.get("*", "core", "s2s_timeout") or 60;
44 local dns_timeout = config.get("*", "core", "dns_timeout") or 60;
45 local max_dns_depth = config.get("*", "core", "dns_max_depth") or 3;
48 _G.prosody.incoming_s2s = incoming_s2s;
49 local incoming_s2s = incoming_s2s;
53 function compare_srv_priorities(a,b)
54 return a.priority < b.priority or (a.priority == b.priority and a.weight > b.weight);
57 local function bounce_sendq(session, reason)
58 local sendq = session.sendq;
60 session.log("info", "sending error replies for "..#sendq.." queued stanzas because of failed outgoing connection to "..tostring(session.to_host));
64 (session.log or log)("error", "Replying to to an s2s error reply, please report this! Traceback: %s", get_traceback());
68 for i, data in ipairs(sendq) do
69 local reply = data[2];
70 local xmlns = reply.attr.xmlns;
71 if not xmlns or xmlns == "jabber:client" or xmlns == "jabber:server" then
72 reply.attr.type = "error";
73 reply:tag("error", {type = "cancel"})
74 :tag("remote-server-not-found", {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):up();
76 reply:tag("text", {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"}):text("Connection failed: "..reason):up();
78 core_process_stanza(dummy, reply);
86 function send_to_host(from_host, to_host, data)
87 if not hosts[from_host] then
88 log("warn", "Attempt to send stanza from %s - a host we don't 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 (data.name ~= "db:verify" or not host.dialback_key) and ((not data.xmlns) or data.xmlns == "jabber:client" or data.xmlns == "jabber:server") 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(data), st.reply(data)});
99 else host.sendq = { {tostring(data), st.reply(data)} }; end
100 host.log("debug", "stanza [%s] queued ", data.name);
101 elseif host.type == "local" or host.type == "component" then
102 log("error", "Trying to send a stanza to ourselves??")
103 log("error", "Traceback: %s", get_traceback());
104 log("error", "Stanza: %s", tostring(data));
106 (host.log or log)("debug", "going to send stanza to "..to_host.." from "..from_host);
108 if host.from_host ~= from_host then
109 log("error", "WARNING! This might, possibly, be a bug, but it might not...");
110 log("error", "We are going to send from %s instead of %s", tostring(host.from_host), tostring(from_host));
113 host.log("debug", "stanza sent over "..host.type);
116 log("debug", "opening a new outgoing connection for this stanza");
117 local host_session = new_outgoing(from_host, to_host);
120 host_session.sendq = { {tostring(data), st.reply(data)} };
121 log("debug", "stanza [%s] queued until connection complete", tostring(data.name));
122 if (not host_session.connecting) and (not host_session.conn) then
123 log("warn", "Connection to %s failed already, destroying session...", to_host);
124 destroy_session(host_session);
129 local open_sessions = 0;
131 function new_incoming(conn)
132 local session = { conn = conn, type = "s2sin_unauthed", direction = "incoming", hosts = {} };
134 session.trace = newproxy(true);
135 getmetatable(session.trace).__gc = function () open_sessions = open_sessions - 1; end;
137 open_sessions = open_sessions + 1;
138 local w, log = conn.write, logger_init("s2sin"..tostring(conn):match("[a-f0-9]+$"));
140 session.sends2s = function (t) log("debug", "sending: %s", t.top_tag and t:top_tag() or t:match("^([^>]*>?)")); w(conn, tostring(t)); end
141 incoming_s2s[session] = true;
142 add_task(connect_timeout, function ()
143 if session.conn ~= conn or
144 session.type == "s2sin" then
145 return; -- Ok, we're connect[ed|ing]
147 -- Not connected, need to close session and clean up
148 (session.log or log)("warn", "Destroying incomplete session %s->%s due to inactivity",
149 session.from_host or "(unknown)", session.to_host or "(unknown)");
150 session:close("connection-timeout");
155 function new_outgoing(from_host, to_host, connect)
156 local host_session = { to_host = to_host, from_host = from_host, host = from_host,
157 notopen = true, type = "s2sout_unauthed", direction = "outgoing",
158 open_stream = session_open_stream };
160 hosts[from_host].s2sout[to_host] = host_session;
164 local conn_name = "s2sout"..tostring(host_session):match("[a-f0-9]*$");
165 log = logger_init(conn_name);
166 host_session.log = log;
169 if connect ~= false then
170 -- Kick the connection attempting machine into life
171 attempt_connection(host_session);
174 if not host_session.sends2s then
175 -- A sends2s which buffers data (until the stream is opened)
176 -- note that data in this buffer will be sent before the stream is authed
177 -- and will not be ack'd in any way, successful or otherwise
179 function host_session.sends2s(data)
182 host_session.send_buffer = buffer;
184 log("debug", "Buffering data on unconnected s2sout to %s", to_host);
185 buffer[#buffer+1] = data;
186 log("debug", "Buffered item %d: %s", #buffer, tostring(data));
194 function attempt_connection(host_session, err)
195 local from_host, to_host = host_session.from_host, host_session.to_host;
196 local connect_host, connect_port = idna_to_ascii(to_host), 5269;
198 if not connect_host then
202 if not err then -- This is our first attempt
203 log("debug", "First attempt to connect to %s, starting with SRV lookup...", to_host);
204 host_session.connecting = true;
206 handle = adns.lookup(function (answer)
208 host_session.connecting = nil;
210 log("debug", to_host.." has SRV records, handling...");
211 local srv_hosts = {};
212 host_session.srv_hosts = srv_hosts;
213 for _, record in ipairs(answer) do
214 t_insert(srv_hosts, record.srv);
216 t_sort(srv_hosts, compare_srv_priorities);
218 local srv_choice = srv_hosts[1];
219 host_session.srv_choice = 1;
221 connect_host, connect_port = srv_choice.target or to_host, srv_choice.port or connect_port;
222 log("debug", "Best record found, will connect to %s:%d", connect_host, connect_port);
225 log("debug", to_host.." has no SRV records, falling back to A");
227 -- Try with SRV, or just the plain hostname if no SRV
228 local ok, err = try_connect(host_session, connect_host, connect_port);
230 if not attempt_connection(host_session, err) then
231 -- No more attempts will be made
232 destroy_session(host_session, err);
235 end, "_xmpp-server._tcp."..connect_host..".", "SRV");
237 -- Set handler for DNS timeout
238 add_task(dns_timeout, function ()
240 adns.cancel(handle, true);
244 log("debug", "DNS lookup for %s sent, waiting for response before we can connect", to_host);
245 return true; -- Attempt in progress
246 elseif host_session.srv_hosts and #host_session.srv_hosts > host_session.srv_choice then -- Not our first attempt, and we also have SRV
247 host_session.srv_choice = host_session.srv_choice + 1;
248 local srv_choice = host_session.srv_hosts[host_session.srv_choice];
249 connect_host, connect_port = srv_choice.target or to_host, srv_choice.port or connect_port;
250 host_session.log("info", "Connection failed (%s). Attempt #%d: This time to %s:%d", tostring(err), host_session.srv_choice, connect_host, connect_port);
252 host_session.log("info", "Out of connection options, can't connect to %s", tostring(host_session.to_host));
253 -- We're out of options
257 if not (connect_host and connect_port) then
258 -- Likely we couldn't resolve DNS
259 log("warn", "Hmm, we're without a host (%s) and port (%s) to connect to for %s, giving up :(", tostring(connect_host), tostring(connect_port), tostring(to_host));
263 return try_connect(host_session, connect_host, connect_port);
266 function try_connect(host_session, connect_host, connect_port)
267 host_session.connecting = true;
269 handle = adns.lookup(function (reply)
271 host_session.connecting = nil;
273 -- COMPAT: This is a compromise for all you CNAME-(ab)users :)
274 if not (reply and reply[#reply] and reply[#reply].a) then
275 local count = max_dns_depth;
276 reply = dns.peek(connect_host, "CNAME", "IN");
277 while count > 0 and reply and reply[#reply] and not reply[#reply].a and reply[#reply].cname do
278 log("debug", "Looking up %s (DNS depth is %d)", tostring(reply[#reply].cname), count);
279 reply = dns.peek(reply[#reply].cname, "A", "IN") or dns.peek(reply[#reply].cname, "CNAME", "IN");
283 -- end of CNAME resolving
285 if reply and reply[#reply] and reply[#reply].a then
286 log("debug", "DNS reply for %s gives us %s", connect_host, reply[#reply].a);
287 return make_connect(host_session, reply[#reply].a, connect_port);
289 log("debug", "DNS lookup failed to get a response for %s", connect_host);
290 if not attempt_connection(host_session, "name resolution failed") then -- Retry if we can
291 log("debug", "No other records to try for %s - destroying", host_session.to_host);
292 destroy_session(host_session, "DNS resolution failed"); -- End of the line, we can't
295 end, connect_host, "A", "IN");
297 -- Set handler for DNS timeout
298 add_task(dns_timeout, function ()
300 adns.cancel(handle, true);
307 function make_connect(host_session, connect_host, connect_port)
308 (host_session.log or log)("info", "Beginning new connection attempt to %s (%s:%d)", host_session.to_host, connect_host, connect_port);
309 -- Ok, we're going to try to connect
311 local from_host, to_host = host_session.from_host, host_session.to_host;
313 local conn, handler = socket.tcp()
316 log("warn", "Failed to create outgoing connection, system error: %s", handler);
317 return false, handler;
321 local success, err = conn:connect(connect_host, connect_port);
322 if not success and err ~= "timeout" then
323 log("warn", "s2s connect() to %s (%s:%d) failed: %s", host_session.to_host, connect_host, connect_port, err);
327 local cl = connlisteners_get("xmppserver");
328 conn = wrapclient(conn, connect_host, connect_port, cl, cl.default_mode or 1 );
329 host_session.conn = conn;
331 -- Register this outgoing connection so that xmppserver_listener knows about it
332 -- otherwise it will assume it is a new incoming connection
333 cl.register_outgoing(conn, host_session);
335 local w, log = conn.write, host_session.log;
336 host_session.sends2s = function (t) log("debug", "sending: %s", (t.top_tag and t:top_tag()) or t:match("^[^>]*>?")); w(conn, tostring(t)); end
338 host_session:open_stream(from_host, to_host);
340 log("debug", "Connection attempt in progress...");
341 add_task(connect_timeout, function ()
342 if host_session.conn ~= conn or
343 host_session.type == "s2sout" or
344 host_session.connecting then
345 return; -- Ok, we're connect[ed|ing]
347 -- Not connected, need to close session and clean up
348 (host_session.log or log)("warn", "Destroying incomplete session %s->%s due to inactivity",
349 host_session.from_host or "(unknown)", host_session.to_host or "(unknown)");
350 host_session:close("connection-timeout");
355 function session_open_stream(session, from, to)
356 session.sends2s(st.stanza("stream:stream", {
357 xmlns='jabber:server', ["xmlns:db"]='jabber:server:dialback',
358 ["xmlns:stream"]='http://etherx.jabber.org/streams',
359 from=from, to=to, version='1.0', ["xml:lang"]='en'}):top_tag());
362 function streamopened(session, attr)
363 local send = session.sends2s;
365 -- TODO: #29: SASL/TLS on s2s streams
366 session.version = tonumber(attr.version) or 0;
368 if session.secure == false then
369 session.secure = true;
372 if session.version >= 1.0 and not (attr.to and attr.from) then
373 (session.log or log)("warn", "Remote of stream "..(session.from_host or "(unknown)").."->"..(session.to_host or "(unknown)")
374 .." failed to specify to (%s) and/or from (%s) hostname as per RFC", tostring(attr.to), tostring(attr.from));
377 if session.direction == "incoming" then
378 -- Send a reply stream header
379 session.to_host = attr.to and nameprep(attr.to);
380 session.from_host = attr.from and nameprep(attr.from);
382 session.streamid = uuid_gen();
383 (session.log or log)("debug", "incoming s2s received <stream:stream>");
384 if session.to_host and not hosts[session.to_host] then
385 -- Attempting to connect to a host we don't serve
386 session:close({ condition = "host-unknown"; text = "This host does not serve "..session.to_host });
389 send("<?xml version='1.0'?>");
390 send(stanza("stream:stream", { xmlns='jabber:server', ["xmlns:db"]='jabber:server:dialback',
391 ["xmlns:stream"]='http://etherx.jabber.org/streams', id=session.streamid, from=session.to_host, to=session.from_host, version=(session.version > 0 and "1.0" or nil) }):top_tag());
392 if session.version >= 1.0 then
393 local features = st.stanza("stream:features");
395 if session.to_host then
396 hosts[session.to_host].events.fire_event("s2s-stream-features", { origin = session, features = features });
398 (session.log or log)("warn", "No 'to' on stream header from %s means we can't offer any features", session.from_host or "unknown host");
401 log("debug", "Sending stream features: %s", tostring(features));
404 elseif session.direction == "outgoing" then
405 -- If we are just using the connection for verifying dialback keys, we won't try and auth it
406 if not attr.id then error("stream response did not give us a streamid!!!"); end
407 session.streamid = attr.id;
409 -- Send unauthed buffer
410 -- (stanzas which are fine to send before dialback)
411 -- Note that this is *not* the stanza queue (which
412 -- we can only send if auth succeeds) :)
413 local send_buffer = session.send_buffer;
414 if send_buffer and #send_buffer > 0 then
415 log("debug", "Sending s2s send_buffer now...");
416 for i, data in ipairs(send_buffer) do
417 session.sends2s(tostring(data));
418 send_buffer[i] = nil;
421 session.send_buffer = nil;
423 -- If server is pre-1.0, don't wait for features, just do dialback
424 if session.version < 1.0 then
425 if not session.dialback_verifying then
426 log("debug", "Initiating dialback...");
427 initiate_dialback(session);
429 mark_connected(session);
433 session.notopen = nil;
436 function streamclosed(session)
437 (session.log or log)("debug", "</stream:stream>");
438 if session.sends2s then
439 session.sends2s("</stream:stream>");
441 session.notopen = true;
444 function initiate_dialback(session)
445 -- generate dialback key
446 session.dialback_key = generate_dialback(session.streamid, session.to_host, session.from_host);
447 session.sends2s(format("<db:result from='%s' to='%s'>%s</db:result>", session.from_host, session.to_host, session.dialback_key));
448 session.log("info", "sent dialback key on outgoing s2s stream");
451 function generate_dialback(id, to, from)
452 return sha256_hash(id..to..from..hosts[from].dialback_secret, true);
455 function verify_dialback(id, to, from, key)
456 return key == generate_dialback(id, to, from);
459 function make_authenticated(session, host)
460 if not session.secure then
461 local local_host = session.direction == "incoming" and session.to_host or session.from_host;
462 if config.get(local_host, "core", "s2s_require_encryption") then
464 condition = "policy-violation",
465 text = "Encrypted server-to-server communication is required but was not "
466 ..((session.direction == "outgoing" and "offered") or "used")
470 if session.type == "s2sout_unauthed" then
471 session.type = "s2sout";
472 elseif session.type == "s2sin_unauthed" then
473 session.type = "s2sin";
475 session.hosts[host].authed = true;
477 elseif session.type == "s2sin" and host then
478 session.hosts[host].authed = true;
482 session.log("debug", "connection %s->%s is now authenticated", session.from_host or "(unknown)", session.to_host or "(unknown)");
484 mark_connected(session);
489 -- Stream is authorised, and ready for normal stanzas
490 function mark_connected(session)
491 local sendq, send = session.sendq, session.sends2s;
493 local from, to = session.from_host, session.to_host;
495 session.log("info", session.direction.." s2s connection "..from.."->"..to.." complete");
497 local send_to_host = send_to_host;
498 function session.send(data) send_to_host(to, from, data); end
501 if session.direction == "outgoing" then
503 session.log("debug", "sending "..#sendq.." queued stanzas across new outgoing connection to "..session.to_host);
504 for i, data in ipairs(sendq) do
511 session.srv_hosts = nil;
515 local resting_session = { -- Resting, not dead
517 }; resting_session.__index = resting_session;
519 function retire_session(session)
520 local log = session.log or log;
521 for k in pairs(session) do
522 if k ~= "trace" and k ~= "log" and k ~= "id" then
527 function session.send(data) log("debug", "Discarding data sent to resting session: %s", tostring(data)); end
528 function session.data(data) log("debug", "Discarding data received from resting session: %s", tostring(data)); end
529 return setmetatable(session, resting_session);
532 function destroy_session(session, reason)
533 (session.log or log)("info", "Destroying "..tostring(session.direction).." session "..tostring(session.from_host).."->"..tostring(session.to_host));
535 if session.direction == "outgoing" then
536 hosts[session.from_host].s2sout[session.to_host] = nil;
537 bounce_sendq(session, reason);
538 elseif session.direction == "incoming" then
539 incoming_s2s[session] = nil;
542 retire_session(session); -- Clean session until it is GC'd