Software / code / prosody
Annotate
plugins/muc/occupant_id.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 | 13577:a45b209302c1 |
| rev | line source |
|---|---|
|
13577
a45b209302c1
muc: Update link to XEP-0421 (instead of inbox)
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
1 -- Implementation of https://xmpp.org/extensions/xep-0421.html |
|
11215
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 -- XEP-0421: Anonymous unique occupant identifiers for MUCs |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 -- (C) 2020 Maxime “pep” Buquet <pep@bouah.net> |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 -- (C) 2020 Matthew Wild <mwild1@gmail.com> |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 |
|
12977
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
12108
diff
changeset
|
7 local uuid = require "prosody.util.uuid"; |
|
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
12108
diff
changeset
|
8 local hmac_sha256 = require "prosody.util.hashes".hmac_sha256; |
|
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
12108
diff
changeset
|
9 local b64encode = require "prosody.util.encodings".base64.encode; |
|
11215
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 local xmlns_occupant_id = "urn:xmpp:occupant-id:0"; |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 |
|
12108
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
13 local function get_room_salt(room) |
|
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
14 local salt = room._data.occupant_id_salt; |
|
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
15 if not salt then |
|
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
16 salt = uuid.generate(); |
|
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
17 room._data.occupant_id_salt = salt; |
|
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
18 end |
|
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
19 return salt; |
|
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
20 end |
|
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
21 |
|
11215
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 local function get_occupant_id(room, occupant) |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 if occupant.stable_id then |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 return occupant.stable_id; |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 end |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 |
|
12108
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
27 local salt = get_room_salt(room) |
|
11215
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 occupant.stable_id = b64encode(hmac_sha256(occupant.bare_jid, salt)); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 return occupant.stable_id; |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 end |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 local function update_occupant(event) |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 local stanza, room, occupant, dest_occupant = event.stanza, event.room, event.occupant, event.dest_occupant; |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
36 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
37 -- "muc-occupant-pre-change" provides "dest_occupant" but not "occupant". |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
38 if dest_occupant ~= nil then |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
39 occupant = dest_occupant; |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
40 end |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
41 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
42 -- strip any existing <occupant-id/> tags to avoid forgery |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
43 stanza:remove_children("occupant-id", xmlns_occupant_id); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
44 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
45 local unique_id = get_occupant_id(room, occupant); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
46 stanza:tag("occupant-id", { xmlns = xmlns_occupant_id, id = unique_id }):up(); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
47 end |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
48 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
49 local function muc_private(event) |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
50 local stanza, room = event.stanza, event.room; |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
51 local occupant = room._occupants[stanza.attr.from]; |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
52 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
53 update_occupant({ |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
54 stanza = stanza, |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
55 room = room, |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
56 occupant = occupant, |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
57 }); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
58 end |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
59 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
60 if module:get_option_boolean("muc_occupant_id", true) then |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
61 module:add_feature(xmlns_occupant_id); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
62 module:hook("muc-disco#info", function (event) |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
63 event.reply:tag("feature", { var = xmlns_occupant_id }):up(); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
64 end); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
65 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
66 module:hook("muc-broadcast-presence", update_occupant); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
67 module:hook("muc-occupant-pre-join", update_occupant); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
68 module:hook("muc-occupant-pre-change", update_occupant); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
69 module:hook("muc-occupant-groupchat", update_occupant); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
70 module:hook("muc-private-message", muc_private); |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
71 end |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
72 |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
73 return { |
|
12108
e9882c4c397f
MUC: Add method for getting the occupant id salt to allow reuse
Kim Alvefur <zash@zash.se>
parents:
11215
diff
changeset
|
74 get_room_salt = get_room_salt; |
|
11215
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
75 get_occupant_id = get_occupant_id; |
|
9ce0a899ff07
MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
76 }; |