Software / code / prosody
Annotate
plugins/mod_turn_external.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 | 13213:50324f66ca2a |
| rev | line source |
|---|---|
|
12977
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
12437
diff
changeset
|
1 local set = require "prosody.util.set"; |
|
12282
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
2 |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 local secret = module:get_option_string("turn_external_secret"); |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 local host = module:get_option_string("turn_external_host", module.host); |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 local user = module:get_option_string("turn_external_user"); |
|
13213
50324f66ca2a
plugins: Use integer config API with interval specification where sensible
Kim Alvefur <zash@zash.se>
parents:
13209
diff
changeset
|
6 local port = module:get_option_integer("turn_external_port", 3478, 1, 65535); |
|
13209
c8d949cf6b09
plugins: Switch to :get_option_period() for time range options
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
7 local ttl = module:get_option_period("turn_external_ttl", "1 day"); |
|
12282
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
8 local tcp = module:get_option_boolean("turn_external_tcp", false); |
|
13213
50324f66ca2a
plugins: Use integer config API with interval specification where sensible
Kim Alvefur <zash@zash.se>
parents:
13209
diff
changeset
|
9 local tls_port = module:get_option_integer("turn_external_tls_port", nil, 1, 65535); |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 |
|
12437
9f5d0b77e3df
mod_turn_external: Update status and friendlier handling of missing secret option (fixes #1727)
Matthew Wild <mwild1@gmail.com>
parents:
12290
diff
changeset
|
11 if not secret then |
|
9f5d0b77e3df
mod_turn_external: Update status and friendlier handling of missing secret option (fixes #1727)
Matthew Wild <mwild1@gmail.com>
parents:
12290
diff
changeset
|
12 module:log_status("error", "Failed to initialize: the 'turn_external_secret' option is not set in your configuration"); |
|
9f5d0b77e3df
mod_turn_external: Update status and friendlier handling of missing secret option (fixes #1727)
Matthew Wild <mwild1@gmail.com>
parents:
12290
diff
changeset
|
13 return; |
|
9f5d0b77e3df
mod_turn_external: Update status and friendlier handling of missing secret option (fixes #1727)
Matthew Wild <mwild1@gmail.com>
parents:
12290
diff
changeset
|
14 end |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
|
12282
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
16 local services = set.new({ "stun-udp"; "turn-udp" }); |
|
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
17 if tcp then |
|
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
18 services:add("stun-tcp"); |
|
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
19 services:add("turn-tcp"); |
|
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
20 end |
|
12283
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
21 if tls_port then |
|
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
22 services:add("turns-tcp"); |
|
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
23 end |
|
12282
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
24 |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 module:depends "external_services"; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 |
|
12283
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
27 for _, type in ipairs({ "stun"; "turn"; "turns" }) do |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
28 for _, transport in ipairs({"udp"; "tcp"}) do |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
29 if services:contains(type .. "-" .. transport) then |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
30 module:add_item("external_service", { |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
31 type = type; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
32 transport = transport; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
33 host = host; |
|
12283
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
34 port = type == "turns" and tls_port or port; |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 username = type == "turn" and user or nil; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
37 secret = type == "turn" and secret or nil; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
38 ttl = type == "turn" and ttl or nil; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
39 }) |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
40 end |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
41 end |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
42 end |