File

tools/migration/migrator/jabberd14.lua @ 13652:a08065207ef0

net.server_epoll: Call :shutdown() on TLS sockets when supported Comment from Matthew: This fixes a potential issue where the Prosody process gets blocked on sockets waiting for them to close. Unlike non-TLS sockets, closing a TLS socket sends layer 7 data, and this can cause problems for sockets which are in the process of being cleaned up. This depends on LuaSec changes which are not yet upstream. From Martijn's original email: So first my analysis of luasec. in ssl.c the socket is put into blocking mode right before calling SSL_shutdown() inside meth_destroy(). My best guess to why this is is because meth_destroy is linked to the __close and __gc methods, which can't exactly be called multiple times and luasec does want to make sure that a tls session is shutdown as clean as possible. I can't say I disagree with this reasoning and don't want to change this behaviour. My solution to this without changing the current behaviour is to introduce a shutdown() method. I am aware that this overlaps in a conflicting way with tcp's shutdown method, but it stays close to the OpenSSL name. This method calls SSL_shutdown() in the current (non)blocking mode of the underlying socket and returns a boolean whether or not the shutdown is completed (matching SSL_shutdown()'s 0 or 1 return values), and returns the familiar ssl_ioerror() strings on error with a false for completion. This error can then be used to determine if we have wantread/wantwrite to finalize things. Once meth_shutdown() has been called once a shutdown flag will be set, which indicates to meth_destroy() that the SSL_shutdown() has been handled by the application and it shouldn't be needed to set the socket to blocking mode. I've left the SSL_shutdown() call in the LSEC_STATE_CONNECTED to prevent TOCTOU if the application reaches a timeout for the shutdown code, which might allow SSL_shutdown() to clean up anyway at the last possible moment. Another thing I've changed to luasec is the call to socket_setblocking() right before calling close(2) in socket_destroy() in usocket.c. According to the latest POSIX[0]: Note that the requirement for close() on a socket to block for up to the current linger interval is not conditional on the O_NONBLOCK setting. Which I read to mean that removing O_NONBLOCK on the socket before close doesn't impact the behaviour and only causes noise in system call tracers. I didn't touch the windows bits of this, since I don't do windows. For the prosody side of things I've made the TLS shutdown bits resemble interface:onwritable(), and put it under a combined guard of self._tls and self.conn.shutdown. The self._tls bit is there to prevent getting stuck on this condition, and self.conn.shutdown is there to prevent the code being called by instances where the patched luasec isn't deployed. The destroy() method can be called from various places and is read by me as the "we give up" error path. To accommodate for these unexpected entrypoints I've added a single call to self.conn:shutdown() to prevent the socket being put into blocking mode. I have no expectations that there is any other use here. Same as previous, the self.conn.shutdown check is there to make sure it's not called on unpatched luasec deployments and self._tls is there to make sure we don't call shutdown() on tcp sockets. I wouldn't recommend logging of the conn:shutdown() error inside close(), since a lot of clients simply close the connection before SSL_shutdown() is done.
author Martijn van Duren <martijn@openbsd.org>
date Thu, 06 Feb 2025 15:04:38 +0000
parent 13142:879a6a33c21b
line wrap: on
line source


if not pcall(require, "prosody.loader") then
	pcall(require, "loader");
end
local lfs = require "lfs";
local st = require "prosody.util.stanza";
local parse_xml = require "prosody.util.xml".parse;
local os_getenv = os.getenv;
local io_open = io.open;
local assert = assert;
local ipairs = ipairs;
local coroutine = coroutine;
local print = print;


local function is_dir(path) return lfs.attributes(path, "mode") == "directory"; end
local function is_file(path) return lfs.attributes(path, "mode") == "file"; end
local function clean_path(path)
	return path:gsub("\\", "/"):gsub("//+", "/"):gsub("^~", os_getenv("HOME") or "~");
end

local function load_xml(path)
	local f, err = io_open(path);
	if not f then return f, err; end
	local data = f:read("*a");
	f:close();
	if not data then return; end
	return parse_xml(data);
end

local function load_spool_file(host, filename, path)
	local xml = load_xml(path);
	if not xml then return; end

	local register_element = xml:get_child("query", "jabber:iq:register");
	local username_element = register_element and register_element:get_child("username", "jabber:iq:register");
	local password_element = register_element and register_element:get_child("password", "jabber:iq:auth");
	local username = username_element and username_element:get_text();
	local password = password_element and password_element:get_text();
	if not username then
		print("[warn] Missing /xdb/{jabber:iq:register}register/username> in file "..filename)
		return;
	elseif username..".xml" ~= filename then
		print("[warn] Missing /xdb/{jabber:iq:register}register/username does not match filename "..filename);
		return;
	end

	local userdata = {
		user = username;
		host = host;
		stores = {};
	};
	local stores = userdata.stores;
	stores.accounts = { password = password };

	for i=1,#xml.tags do
		local tag = xml.tags[i];
		local xname = (tag.attr.xmlns or "")..":"..tag.name;
		if tag.attr.j_private_flag == "1" and tag.attr.xmlns then
			-- Private XML
			stores.private = stores.private or {};
			tag.attr.j_private_flag = nil;
			stores.private[tag.attr.xmlns] = st.preserialize(tag);
		elseif xname == "jabber:iq:auth:password" then
			if stores.accounts.password ~= tag:get_text() then
				if password then
					print("[warn] conflicting passwords")
				else
					stores.accounts.password = tag:get_text();
				end
			end
		elseif xname == "jabber:iq:register:query" then
			-- already processed
		elseif xname == "jabber:xdb:nslist:foo" then
			-- ignore
		elseif xname == "jabber:iq:auth:0k:zerok" then
			-- ignore
		elseif xname == "jabber:iq:roster:query" then
			-- Roster
			local roster = {};
			local subscription_types = { from = true, to = true, both = true, none = true };
			for _,item_element in ipairs(tag.tags) do
				assert(item_element.name == "item");
				assert(item_element.attr.jid);
				assert(subscription_types[item_element.attr.subscription]);
				assert((item_element.attr.ask or "subscribe") == "subscribe")
				if item_element.name == "item" then
					local groups = {};
					for _,group_element in ipairs(item_element.tags) do
						assert(group_element.name == "group");
						groups[group_element:get_text()] = true;
					end
					local item = {
						name = item_element.attr.name;
						subscription = item_element.attr.subscription;
						ask = item_element.attr.ask;
						groups = groups;
					};
					roster[item_element.attr.jid] = item;
				end
			end
			stores.roster = roster;
		elseif xname == "jabber:iq:last:query" then
			-- Last activity
		elseif xname == "jabber:x:offline:foo" then
			-- Offline messages
		elseif xname == "vcard-temp:vCard" then
			-- vCards
			stores.vcard = st.preserialize(tag);
		else
			print("[warn] Unknown tag: "..xname);
		end
	end
	return userdata;
end

local function loop_over_users(path, host, cb)
	for file in lfs.dir(path) do
		if file:match("%.xml$") then
			local user = load_spool_file(host, file, path.."/"..file);
			if user then cb(user); end
		end
	end
end
local function loop_over_hosts(path, cb)
	for host in lfs.dir(path) do
		if host ~= "." and host ~= ".." and is_dir(path.."/"..host) then
			loop_over_users(path.."/"..host, host, cb);
		end
	end
end

local function reader(input)
	local path = clean_path(assert(input.path, "no input.path specified"));
	assert(is_dir(path), "input.path is not a directory");

	if input.host then
		return coroutine.wrap(function() loop_over_users(input.path, input.host, coroutine.yield) end);
	else
		return coroutine.wrap(function() loop_over_hosts(input.path, coroutine.yield) end);
	end
end

return {
	reader = reader;
};