view misc/sasl/example.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 7d2fcc7a15f7
children
line wrap: on
line source

local method = {}
local method_mt = { __index = method }

-- This should return a set of supported mechanisms
function method:mechanisms()
	return {
		["OAUTH-SOMETHING"] = true;
	}
end

-- Called when a mechanism is selecetd
function method:select(mechanism)
	return mechanism == "OAUTH-SOMETHING";
end

-- Called for each message received
function method:process(message)
	-- parse the message
	if false then
		-- To send a SASL challenge:
		return "challenge", "respond-to-this";
	end

	if false then
		-- To fail, send:
		return "failure", "not-authorized", "Helpful error message here";
	end

	self.username = "someone";
	return "success";
end

local function new_sasl()
	return setmetatable({}, method_mt);
end

function method:clean_clone()
	return setmetatable({}, method_mt);
end

local provider = {}

function provider.get_sasl_handler()
	return new_sasl();
end

module:provides("auth", provider);