Software / code / prosody
Annotate
teal-src/README.md @ 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 | 13005:1167aaf1aa1f |
| rev | line source |
|---|---|
|
13002
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 # Teal definitions and sources |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 This directory contains files written in the |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 [Teal](https://github.com/teal-language/tl) language, a typed dialect of |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 Lua. There are two kinds of files, `.tl` Teal source code and `.d.tl` |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 type definitions files for modules written in Lua. The later allows |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 writing type-aware Teal using regular Lua or C code. |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 ## Setup |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 The Teal compiler can be installed from LuaRocks using: |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 |
|
13004
47efa93ea859
teal-src/README: Tweak markdown syntax
Kim Alvefur <zash@zash.se>
parents:
13002
diff
changeset
|
13 ```bash |
|
47efa93ea859
teal-src/README: Tweak markdown syntax
Kim Alvefur <zash@zash.se>
parents:
13002
diff
changeset
|
14 luarocks install tl |
|
47efa93ea859
teal-src/README: Tweak markdown syntax
Kim Alvefur <zash@zash.se>
parents:
13002
diff
changeset
|
15 ``` |
|
13002
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 ## Checking types |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 ```bash |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 tl check teal-src/prosody/util/example.tl |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 ``` |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 Some editors and IDEs also have support, see [text editor |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 support](https://github.com/teal-language/tl#text-editor-support) |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 |
|
13005
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
27 ## Compiling to Lua |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
28 |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
29 `GNUmakefile` contains a rule for building Lua files from Teal sources. |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
30 It also applies [LuaFormat](https://github.com/Koihik/LuaFormatter) to |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
31 make the resulting code more readable, albeit this makes the line |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
32 numbers no longer match the original Teal source. Sometimes minor |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
33 `luacheck` issues remain, such as types being represented as unused |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
34 tables, which can be removed. |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
35 |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
36 ```bash |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
37 sensible-editor teal-src/prosody/util/example.tl |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
38 # Write some code, remember to run tl check |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
39 make util/example.lua |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
40 sensible-editor util/example.lua |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
41 # Apply any minor tweaks that may be needed |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
42 ``` |
|
1167aaf1aa1f
teal-src/README: Words on Compiling to Lua
Kim Alvefur <zash@zash.se>
parents:
13004
diff
changeset
|
43 |
|
13002
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
44 ## Files of note |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
45 |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
46 `module.d.tl` |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
47 : Describes the module environment. |
|
d8e2b995f975
teal-src: Add a README with a few pointers to get started
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
48 |