File

plugins/mod_legacyauth.lua @ 11523:5f15ab7c6ae5

Statistics: Rewrite statistics backends to use OpenMetrics The metric subsystem of Prosody has had some shortcomings from the perspective of the current state-of-the-art in metric observability. The OpenMetrics standard [0] is a formalization of the data model (and serialization format) of the well-known and widely-used Prometheus [1] software stack. The previous stats subsystem of Prosody did not map well to that format (see e.g. [2] and [3]); the key reason is that it was trying to do too much math on its own ([2]) while lacking first-class support for "families" of metrics ([3]) and structured metric metadata (despite the `extra` argument to metrics, there was no standard way of representing common things like "tags" or "labels"). Even though OpenMetrics has grown from the Prometheus world of monitoring, it maps well to other popular monitoring stacks such as: - InfluxDB (labels can be mapped to tags and fields as necessary) - Carbon/Graphite (labels can be attached to the metric name with dot-separation) - StatsD (see graphite when assuming that graphite is used as backend, which is the default) The util.statsd module has been ported to use the OpenMetrics model as a proof of concept. An implementation which exposes the util.statistics backend data as Prometheus metrics is ready for publishing in prosody-modules (most likely as mod_openmetrics_prometheus to avoid breaking existing 0.11 deployments). At the same time, the previous measure()-based API had one major advantage: It is really simple and easy to use without requiring lots of knowledge about OpenMetrics or similar concepts. For that reason as well as compatibility with existing code, it is preserved and may even be extended in the future. However, code relying on the `stats-updated` event as well as `get_stats` from `statsmanager` will break because the data model has changed completely; in case of `stats-updated`, the code will simply not run (as the event was renamed in order to avoid conflicts); the `get_stats` function has been removed completely (so it will cause a traceback when it is attempted to be used). Note that the measure_*_event methods have been removed from the module API. I was unable to find any uses or documentation and thus deemed they should not be ported. Re-implementation is possible when necessary. [0]: https://openmetrics.io/ [1]: https://prometheus.io/ [2]: #959 [3]: #960
author Jonas Schäfer <jonas@wielicki.name>
date Sun, 18 Apr 2021 11:47:41 +0200
parent 10557:e1cb869e2f6c
child 12328:a80314101bc6
line wrap: on
line source

-- Prosody IM
-- Copyright (C) 2008-2010 Matthew Wild
-- Copyright (C) 2008-2010 Waqas Hussain
--
-- This project is MIT/X11 licensed. Please see the
-- COPYING file in the source package for more information.
--



local st = require "util.stanza";
local t_concat = table.concat;

local secure_auth_only = module:get_option("c2s_require_encryption",
	module:get_option("require_encryption"))
	or not(module:get_option("allow_unencrypted_plain_auth"));

local sessionmanager = require "core.sessionmanager";
local usermanager = require "core.usermanager";
local nodeprep = require "util.encodings".stringprep.nodeprep;
local resourceprep = require "util.encodings".stringprep.resourceprep;

module:add_feature("jabber:iq:auth");
module:hook("stream-features", function(event)
	local origin, features = event.origin, event.features;
	if secure_auth_only and not origin.secure then
		-- Sorry, not offering to insecure streams!
		return;
	elseif not origin.username then
		features:tag("auth", {xmlns='http://jabber.org/features/iq-auth'}):up();
	end
end);

module:hook("stanza/iq/jabber:iq:auth:query", function(event)
	local session, stanza = event.origin, event.stanza;

	if session.type ~= "c2s_unauthed" then
		(session.sends2s or session.send)(st.error_reply(stanza, "cancel", "service-unavailable",
			"Legacy authentication is only allowed for unauthenticated client connections."));
		return true;
	end

	if secure_auth_only and not session.secure then
		session.send(st.error_reply(stanza, "modify", "not-acceptable", "Encryption (SSL or TLS) is required to connect to this server"));
		return true;
	end

	local query = stanza.tags[1];
	local username = query:get_child("username");
	local password = query:get_child("password");
	local resource = query:get_child("resource");
	if not (username and password and resource) then
		local reply = st.reply(stanza);
		session.send(reply:query("jabber:iq:auth")
			:tag("username"):up()
			:tag("password"):up()
			:tag("resource"):up());
	else
		username, password, resource = t_concat(username), t_concat(password), t_concat(resource);
		username = nodeprep(username);
		resource = resourceprep(resource)
		if not (username and resource) then
			session.send(st.error_reply(stanza, "modify", "bad-request"));
			return true;
		end
		if usermanager.test_password(username, session.host, password) then
			-- Authentication successful!
			local success, err = sessionmanager.make_authenticated(session, username);
			if success then
				local err_type, err_msg;
				success, err_type, err, err_msg = sessionmanager.bind_resource(session, resource);
				if not success then
					session.send(st.error_reply(stanza, err_type, err, err_msg));
					session.username, session.type = nil, "c2s_unauthed"; -- FIXME should this be placed in sessionmanager?
					return true;
				elseif resource ~= session.resource then -- server changed resource, not supported by legacy auth
					session.send(st.error_reply(stanza, "cancel", "conflict", "The requested resource could not be assigned to this session."));
					session:close(); -- FIXME undo resource bind and auth instead of closing the session?
					return true;
				end
				session.send(st.reply(stanza));
			else
				session.send(st.error_reply(stanza, "auth", "not-authorized", err));
			end
		else
			session.send(st.error_reply(stanza, "auth", "not-authorized"));
		end
	end
	return true;
end);