Software / code / prosody
File
plugins/mod_debug_stanzas/watcher.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 | 12977:74b9e05af71e |
line wrap: on
line source
local filters = require "prosody.util.filters"; local jid = require "prosody.util.jid"; local set = require "prosody.util.set"; local client_watchers = {}; -- active_filters[session] = { -- filter_func = filter_func; -- downstream = { cb1, cb2, ... }; -- } local active_filters = {}; local function subscribe_session_stanzas(session, handler, reason) if active_filters[session] then table.insert(active_filters[session].downstream, handler); if reason then handler(reason, nil, session); end return; end local downstream = { handler }; active_filters[session] = { filter_in = function (stanza) module:log("debug", "NOTIFY WATCHER %d", #downstream); for i = 1, #downstream do downstream[i]("received", stanza, session); end return stanza; end; filter_out = function (stanza) module:log("debug", "NOTIFY WATCHER %d", #downstream); for i = 1, #downstream do downstream[i]("sent", stanza, session); end return stanza; end; downstream = downstream; }; filters.add_filter(session, "stanzas/in", active_filters[session].filter_in); filters.add_filter(session, "stanzas/out", active_filters[session].filter_out); if reason then handler(reason, nil, session); end end local function unsubscribe_session_stanzas(session, handler, reason) local active_filter = active_filters[session]; if not active_filter then return; end for i = #active_filter.downstream, 1, -1 do if active_filter.downstream[i] == handler then table.remove(active_filter.downstream, i); if reason then handler(reason, nil, session); end end end if #active_filter.downstream == 0 then filters.remove_filter(session, "stanzas/in", active_filter.filter_in); filters.remove_filter(session, "stanzas/out", active_filter.filter_out); end active_filters[session] = nil; end local function unsubscribe_all_from_session(session, reason) local active_filter = active_filters[session]; if not active_filter then return; end for i = #active_filter.downstream, 1, -1 do local handler = table.remove(active_filter.downstream, i); if reason then handler(reason, nil, session); end end filters.remove_filter(session, "stanzas/in", active_filter.filter_in); filters.remove_filter(session, "stanzas/out", active_filter.filter_out); active_filters[session] = nil; end local function unsubscribe_handler_from_all(handler, reason) for session in pairs(active_filters) do unsubscribe_session_stanzas(session, handler, reason); end end local s2s_watchers = {}; module:hook("s2sin-established", function (event) for _, watcher in ipairs(s2s_watchers) do if watcher.target_spec == event.session.from_host then subscribe_session_stanzas(event.session, watcher.handler, "opened"); end end end); module:hook("s2sout-established", function (event) for _, watcher in ipairs(s2s_watchers) do if watcher.target_spec == event.session.to_host then subscribe_session_stanzas(event.session, watcher.handler, "opened"); end end end); module:hook("s2s-closed", function (event) unsubscribe_all_from_session(event.session, "closed"); end); local watched_hosts = set.new(); local handler_map = setmetatable({}, { __mode = "kv" }); local function add_stanza_watcher(spec, orig_handler) local function filtering_handler(event_type, stanza, session) if stanza and spec.filter_spec then if spec.filter_spec.with_jid then if event_type == "sent" and (not stanza.attr.from or not jid.compare(stanza.attr.from, spec.filter_spec.with_jid)) then return; elseif event_type == "received" and (not stanza.attr.to or not jid.compare(stanza.attr.to, spec.filter_spec.with_jid)) then return; end end end return orig_handler(event_type, stanza, session); end handler_map[orig_handler] = filtering_handler; if spec.target_spec.jid then local target_is_remote_host = not jid.node(spec.target_spec.jid) and not prosody.hosts[spec.target_spec.jid]; if target_is_remote_host then -- Watch s2s sessions table.insert(s2s_watchers, { target_spec = spec.target_spec.jid; handler = filtering_handler; orig_handler = orig_handler; }); -- Scan existing s2sin for matches for session in pairs(prosody.incoming_s2s) do if spec.target_spec.jid == session.from_host then subscribe_session_stanzas(session, filtering_handler, "attached"); end end -- Scan existing s2sout for matches for local_host, local_session in pairs(prosody.hosts) do --luacheck: ignore 213/local_host for remote_host, remote_session in pairs(local_session.s2sout) do if spec.target_spec.jid == remote_host then subscribe_session_stanzas(remote_session, filtering_handler, "attached"); end end end else table.insert(client_watchers, { target_spec = spec.target_spec.jid; handler = filtering_handler; orig_handler = orig_handler; }); local host = jid.host(spec.target_spec.jid); if not watched_hosts:contains(host) and prosody.hosts[host] then module:context(host):hook("resource-bind", function (event) for _, watcher in ipairs(client_watchers) do module:log("debug", "NEW CLIENT: %s vs %s", event.session.full_jid, watcher.target_spec); if jid.compare(event.session.full_jid, watcher.target_spec) then module:log("debug", "MATCH"); subscribe_session_stanzas(event.session, watcher.handler, "opened"); else module:log("debug", "NO MATCH"); end end end); module:context(host):hook("resource-unbind", function (event) unsubscribe_all_from_session(event.session, "closed"); end); watched_hosts:add(host); end for full_jid, session in pairs(prosody.full_sessions) do if jid.compare(full_jid, spec.target_spec.jid) then subscribe_session_stanzas(session, filtering_handler, "attached"); end end end else error("No recognized target selector"); end end local function remove_stanza_watcher(orig_handler) local handler = handler_map[orig_handler]; unsubscribe_handler_from_all(handler, "detached"); handler_map[orig_handler] = nil; for i = #client_watchers, 1, -1 do if client_watchers[i].orig_handler == orig_handler then table.remove(client_watchers, i); end end for i = #s2s_watchers, 1, -1 do if s2s_watchers[i].orig_handler == orig_handler then table.remove(s2s_watchers, i); end end end local function cleanup(reason) client_watchers = {}; s2s_watchers = {}; for session in pairs(active_filters) do unsubscribe_all_from_session(session, reason or "cancelled"); end end return { add = add_stanza_watcher; remove = remove_stanza_watcher; cleanup = cleanup; };