view mod_sasl_ssdp/mod_sasl_ssdp.lua @ 6319:04c3273cb81f

mod_auth_cyrus: Add empty 'profile' table to SASL handler objects This is for compatibility with Prosody's built-in util.sasl objects. A SASL profile table usually includes methods supported by the backend, which can be used by SASL mechanism handlers to perform operations (such as testing the password). It also optionally contains a 'cb' field with channel binding method handlers. The Cyrus backend doesn't support channel binding, and doesn't have the same concept of auth backend methods (it handles all that internally, and Prosody has no insight or control over it). Thus, we create an empty profile which informs Prosody that the SASL handler does not support any of the auth or channel binding methods. Some features will not work, but they didn't work anyway. This just makes it explicit. This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to always contain a 'profile' field.
author Matthew Wild <mwild1@gmail.com>
date Thu, 04 Sep 2025 10:14:46 +0100
parents eedeed1bccf7
children
line wrap: on
line source

local array = require "util.array";
local set = require "util.set";
local hashes = require "util.hashes";
local it = require "util.iterators";
local base64_enc = require "util.encodings".base64.encode;

-- *** The following code is copy-pasted from mod_saslauth/mod_sasl2, like requested by Zash ***
-- *** Please update, if you modify mod_saslauth or mod_sasl2! ***
local allow_unencrypted_plain_auth = module:get_option_boolean("allow_unencrypted_plain_auth", false)
local insecure_mechanisms = module:get_option_set("insecure_sasl_mechanisms", allow_unencrypted_plain_auth and {} or {"PLAIN", "LOGIN"});
local disabled_mechanisms = module:get_option_set("disable_sasl_mechanisms", { "DIGEST-MD5" });
-- *** End of copy-pasted code ***

local hash_functions = {
	["SCRAM-SHA-1"] = hashes.sha1;
	["SCRAM-SHA-1-PLUS"] = hashes.sha1;
	["SCRAM-SHA-256"] = hashes.sha256;
	["SCRAM-SHA-256-PLUS"] = hashes.sha256;
	["SCRAM-SHA-512"] = hashes.sha512;
	["SCRAM-SHA-512-PLUS"] = hashes.sha512;
};

function add_ssdp_info(event)
	local sasl_handler = event.session.sasl_handler;
	local hash = hash_functions[sasl_handler.selected];
	if not hash then
		module:log("debug", "Not enabling SSDP for unsupported mechanism: %s", sasl_handler.selected);
		return;
	end

	-- *** The following code is copy-pasted from mod_saslauth/mod_sasl2, like requested by Zash ***
	-- *** Please update, if you modify mod_saslauth or mod_sasl2! ***
	local usable_mechanisms = set.new();
	local available_mechanisms = sasl_handler:mechanisms()
	for mechanism in pairs(available_mechanisms) do
		if disabled_mechanisms:contains(mechanism) then
			module:log("debug", "Not offering disabled mechanism %s", mechanism);
		elseif not event.session.secure and insecure_mechanisms:contains(mechanism) then
			module:log("debug", "Not offering mechanism %s on insecure connection", mechanism);
		else
			module:log("debug", "Offering mechanism %s", mechanism);
			usable_mechanisms:add(mechanism);
		end
	end
	-- *** End of copy-pasted code ***

	local mechanism_list = array.collect(usable_mechanisms):sort();
	local cb = sasl_handler.profile.cb;
	local cb_list = cb and array.collect(it.keys(cb)):sort();
	local ssdp_string;
	if cb_list then
		ssdp_string = mechanism_list:concat("\30").."\31"..cb_list:concat("\30");
	else
		ssdp_string = mechanism_list:concat("\30");
	end
	module:log("debug", "Calculated SSDP string: %s", ssdp_string);
	event.message = event.message..",h="..base64_enc(hash(ssdp_string));
	sasl_handler.state.server_first_message = event.message;
end

module:hook("sasl/c2s/challenge", add_ssdp_info, 1);
module:hook("sasl2/c2s/challenge", add_ssdp_info, 1);