File

plugins/mod_pubsub/commands.lib.lua @ 13801:a5d5fefb8b68 13.0

mod_tls: Enable Prosody's certificate checking for incoming s2s connections (fixes #1916) (thanks Damian, Zash) Various options in Prosody allow control over the behaviour of the certificate verification process For example, some deployments choose to allow falling back to traditional "dialback" authentication (XEP-0220), while others verify via DANE, hard-coded fingerprints, or other custom plugins. Implementing this flexibility requires us to override OpenSSL's default certificate verification, to allow Prosody to verify the certificate itself, apply custom policies and make decisions based on the outcome. To enable our custom logic, we have to suppress OpenSSL's default behaviour of aborting the connection with a TLS alert message. With LuaSec, this can be achieved by using the verifyext "lsec_continue" flag. We also need to use the lsec_ignore_purpose flag, because XMPP s2s uses server certificates as "client" certificates (for mutual TLS verification in outgoing s2s connections). Commit 99d2100d2918 moved these settings out of the defaults and into mod_s2s, because we only really need these changes for s2s, and they should be opt-in, rather than automatically applied to all TLS services we offer. That commit was incomplete, because it only added the flags for incoming direct TLS connections. StartTLS connections are handled by mod_tls, which was not applying the lsec_* flags. It previously worked because they were already in the defaults. This resulted in incoming s2s connections with "invalid" certificates being aborted early by OpenSSL, even if settings such as `s2s_secure_auth = false` or DANE were present in the config. Outgoing s2s connections inherit verify "none" from the defaults, which means OpenSSL will receive the cert but will not terminate the connection when it is deemed invalid. This means we don't need lsec_continue there, and we also don't need lsec_ignore_purpose (because the remote peer is a "server"). Wondering why we can't just use verify "none" for incoming s2s? It's because in that mode, OpenSSL won't request a certificate from the peer for incoming connections. Setting verify "peer" is how you ask OpenSSL to request a certificate from the client, but also what triggers its built-in verification.
author Matthew Wild <mwild1@gmail.com>
date Tue, 01 Apr 2025 17:26:56 +0100
parent 13623:e226f9632a48
line wrap: on
line source

local it = require "prosody.util.iterators";
local st = require "prosody.util.stanza";

local pubsub_lib = module:require("mod_pubsub/pubsub");

local function add_commands(get_service)
	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "list_nodes";
		desc = "List nodes on a pubsub service";
		args = {
			{ name = "service_jid", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			local nodes = select(2, assert(service:get_nodes(true)));
			local count = 0;
			for node_name in pairs(nodes) do
				count = count + 1;
				self.session.print(node_name);
			end
			return true, ("%d nodes"):format(count);
		end;
	});

	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "list_items";
		desc = "List items on a pubsub node";
		args = {
			{ name = "service_jid", type = "string" };
			{ name = "node_name", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid, node_name) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			local items = select(2, assert(service:get_items(node_name, true)));

			local count = 0;
			for item_name in pairs(items) do
				count = count + 1;
				self.session.print(item_name);
			end
			return true, ("%d items"):format(count);
		end;
	});

	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "get_item";
		desc = "Show item content on a pubsub node";
		args = {
			{ name = "service_jid", type = "string" };
			{ name = "node_name", type = "string" };
			{ name = "item_name", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid, node_name, item_name) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			local items = select(2, assert(service:get_items(node_name, true)));

			if not items[item_name] then
				return false, "Item not found";
			end

			self.session.print(items[item_name]);

			return true;
		end;
	});

	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "get_node_config";
		desc = "Get the current configuration for a node";
		args = {
			{ name = "service_jid", type = "string" };
			{ name = "node_name", type = "string" };
			{ name = "option_name", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid, node_name, option_name) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			local config = select(2, assert(service:get_node_config(node_name, true)));

			local config_form = pubsub_lib.node_config_form:form(config, "submit");

			local count = 0;
			if option_name then
				count = 1;
				local field = config_form:get_child_with_attr("field", nil, "var", option_name);
				if not field then
					return false, "option not found";
				end
				self.session.print(field:get_child_text("value"));
			else
				local opts = {};
				for field in config_form:childtags("field") do
					opts[field.attr.var] = field:get_child_text("value");
				end
				for k, v in it.sorted_pairs(opts) do
					count = count + 1;
					self.session.print(k, v);
				end
			end

			return true, ("Showing %d config options"):format(count);
		end;
	});

	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "set_node_config_option";
		desc = "Set a config option on a pubsub node";
		args = {
			{ name = "service_jid", type = "string" };
			{ name = "node_name", type = "string" };
			{ name = "option_name", type = "string" };
			{ name = "option_value", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid, node_name, option_name, option_value) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			local config = select(2, assert(service:get_node_config(node_name, true)));

			local new_config_form = st.stanza("x", { xmlns = "jabber:x:data" })
				:tag("field", { var = option_name })
					:text_tag("value", option_value)
				:up();

			local new_config = pubsub_lib.node_config_form:data(new_config_form, config);

			assert(service:set_node_config(node_name, true, new_config));

			local applied_config = select(2, assert(service:get_node_config(node_name, true)));

			local applied_config_form = pubsub_lib.node_config_form:form(applied_config, "submit");
			local applied_field = applied_config_form:get_child_with_attr("field", nil, "var", option_name);
			if not applied_field then
				return false, "Unknown config field: "..option_name;
			end
			return true, "Applied config: "..applied_field:get_child_text("value");
		end;
	});

	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "delete_item";
		desc = "Delete a single item from a node";
		args = {
			{ name = "service_jid", type = "string" };
			{ name = "node_name", type = "string" };
			{ name = "item_name", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid, node_name, item_name) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			return assert(service:retract(node_name, true, item_name));
		end;
	});

	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "delete_all_items";
		desc = "Delete all items from a node";
		args = {
			{ name = "service_jid", type = "string" };
			{ name = "node_name", type = "string" };
			{ name = "notify_subscribers", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid, node_name, notify_subscribers) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			return assert(service:purge(node_name, true, notify_subscribers == "true"));
		end;
	});

	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "create_node";
		desc = "Create a new node";
		args = {
			{ name = "service_jid", type = "string" };
			{ name = "node_name", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid, node_name) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			return assert(service:create(node_name, true));
		end;
	});

	module:add_item("shell-command", {
		section = "pubsub";
		section_desc = "Manage publish/subscribe nodes";
		name = "delete_node";
		desc = "Delete a node entirely";
		args = {
			{ name = "service_jid", type = "string" };
			{ name = "node_name", type = "string" };
		};
		host_selector = "service_jid";

		handler = function (self, service_jid, node_name) --luacheck: ignore 212/self
			-- luacheck: ignore 431/service
			local service = get_service(service_jid);
			return assert(service:delete(node_name, true));
		end;
	});
end

return {
	add_commands = add_commands;
}