Software / code / prosody
Annotate
plugins/mod_csi.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 | 13522:ccd6199cc6a2 |
| rev | line source |
|---|---|
|
12977
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
10429
diff
changeset
|
1 local st = require "prosody.util.stanza"; |
|
9073
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 local xmlns_csi = "urn:xmpp:csi:0"; |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 local csi_feature = st.stanza("csi", { xmlns = xmlns_csi }); |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 |
|
13025
b7d0c1d75a37
mod_csi: Add metrics, covering changes and totals
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
5 local change = module:metric("counter", "changes", "events", "CSI state changes", {"csi_state"}); |
|
13521
7fcae9da8934
mod_csi: Use same label name for gauge as for older counter
Kim Alvefur <zash@zash.se>
parents:
13512
diff
changeset
|
6 local count = module:metric("gauge", "state", "sessions", "", { "csi_state" }); |
|
13025
b7d0c1d75a37
mod_csi: Add metrics, covering changes and totals
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
7 |
|
9073
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 module:hook("stream-features", function (event) |
|
13075
82980f6890cd
mod_csi: Always advertise feature
Kim Alvefur <zash@zash.se>
parents:
13070
diff
changeset
|
9 if event.origin.username then |
|
9073
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 event.features:add_child(csi_feature); |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 end |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 end); |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 function refire_event(name) |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 return function (event) |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 if event.origin.username then |
|
9653
91856829f18b
mod_csi: Fix copypaste mistake [luacheck]
Kim Alvefur <zash@zash.se>
parents:
9651
diff
changeset
|
17 event.origin.state = event.stanza.name; |
|
13025
b7d0c1d75a37
mod_csi: Add metrics, covering changes and totals
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
18 change:with_labels(event.stanza.name):add(1); |
|
9073
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 module:fire_event(name, event); |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 return true; |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 end |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 end; |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 end |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 module:hook("stanza/"..xmlns_csi..":active", refire_event("csi-client-active")); |
|
a5daf3f6d588
mod_csi: Imported from prosody-modules 66b3085ecc49
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 module:hook("stanza/"..xmlns_csi..":inactive", refire_event("csi-client-inactive")); |
|
13510
393e265aafba
mod_csi: Count how many sessions are using CSI and their state
Kim Alvefur <zash@zash.se>
parents:
13075
diff
changeset
|
27 |
|
393e265aafba
mod_csi: Count how many sessions are using CSI and their state
Kim Alvefur <zash@zash.se>
parents:
13075
diff
changeset
|
28 module:hook_global("stats-update", function() |
|
393e265aafba
mod_csi: Count how many sessions are using CSI and their state
Kim Alvefur <zash@zash.se>
parents:
13075
diff
changeset
|
29 local sessions = prosody.hosts[module.host].sessions; |
|
393e265aafba
mod_csi: Count how many sessions are using CSI and their state
Kim Alvefur <zash@zash.se>
parents:
13075
diff
changeset
|
30 if not sessions then return end |
|
13512
0b742bbbb819
mod_csi: Optimize metrics collection (prematurely)
Kim Alvefur <zash@zash.se>
parents:
13511
diff
changeset
|
31 local active, inactive, flushing = 0, 0, 0; |
|
13511
453979e16f2d
mod_csi: Rename unused loop variables to '_' [luacheck]
Kim Alvefur <zash@zash.se>
parents:
13510
diff
changeset
|
32 for _, user_session in pairs(sessions) do |
|
453979e16f2d
mod_csi: Rename unused loop variables to '_' [luacheck]
Kim Alvefur <zash@zash.se>
parents:
13510
diff
changeset
|
33 for _, session in pairs(user_session.sessions) do |
|
13512
0b742bbbb819
mod_csi: Optimize metrics collection (prematurely)
Kim Alvefur <zash@zash.se>
parents:
13511
diff
changeset
|
34 if session.state == "inactive" then |
|
0b742bbbb819
mod_csi: Optimize metrics collection (prematurely)
Kim Alvefur <zash@zash.se>
parents:
13511
diff
changeset
|
35 inactive = inactive + 1; |
|
0b742bbbb819
mod_csi: Optimize metrics collection (prematurely)
Kim Alvefur <zash@zash.se>
parents:
13511
diff
changeset
|
36 elseif session.state == "active" then |
|
13522
ccd6199cc6a2
mod_csi: Update correct variables when counting states
Kim Alvefur <zash@zash.se>
parents:
13521
diff
changeset
|
37 active = active + 1; |
|
13512
0b742bbbb819
mod_csi: Optimize metrics collection (prematurely)
Kim Alvefur <zash@zash.se>
parents:
13511
diff
changeset
|
38 elseif session.state == "flushing" then |
|
13522
ccd6199cc6a2
mod_csi: Update correct variables when counting states
Kim Alvefur <zash@zash.se>
parents:
13521
diff
changeset
|
39 flushing = flushing + 1; |
|
13510
393e265aafba
mod_csi: Count how many sessions are using CSI and their state
Kim Alvefur <zash@zash.se>
parents:
13075
diff
changeset
|
40 end |
|
393e265aafba
mod_csi: Count how many sessions are using CSI and their state
Kim Alvefur <zash@zash.se>
parents:
13075
diff
changeset
|
41 end |
|
393e265aafba
mod_csi: Count how many sessions are using CSI and their state
Kim Alvefur <zash@zash.se>
parents:
13075
diff
changeset
|
42 end |
|
13512
0b742bbbb819
mod_csi: Optimize metrics collection (prematurely)
Kim Alvefur <zash@zash.se>
parents:
13511
diff
changeset
|
43 count:with_labels("active"):set(active); |
|
0b742bbbb819
mod_csi: Optimize metrics collection (prematurely)
Kim Alvefur <zash@zash.se>
parents:
13511
diff
changeset
|
44 count:with_labels("inactive"):set(inactive); |
|
0b742bbbb819
mod_csi: Optimize metrics collection (prematurely)
Kim Alvefur <zash@zash.se>
parents:
13511
diff
changeset
|
45 count:with_labels("flushing"):set(flushing); |
|
13510
393e265aafba
mod_csi: Count how many sessions are using CSI and their state
Kim Alvefur <zash@zash.se>
parents:
13075
diff
changeset
|
46 end); |