Annotate

util/argparse.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 13762:81856814d74f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 local function parse(arg, config)
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 local short_params = config and config.short_params or {};
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 local value_params = config and config.value_params or {};
13160
4ee9a912ceea util.argparse: Add support for repeatable parameters
Kim Alvefur <zash@zash.se>
parents: 13058
diff changeset
4 local array_params = config and config.array_params or {};
13733
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
5 local kv_params = config and config.kv_params or {};
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
6 local strict = config and config.strict;
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
7 local stop_on_positional = not config or config.stop_on_positional ~= false;
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 local parsed_opts = {};
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 if #arg == 0 then
12477
cc84682b8429 util.argparse: Revise 553c6204fe5b with a different approach
Matthew Wild <mwild1@gmail.com>
parents: 12475
diff changeset
12 return parsed_opts;
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 end
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 while true do
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 local raw_param = arg[1];
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 if not raw_param then
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 break;
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 end
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 local prefix = raw_param:match("^%-%-?");
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
21 if not prefix and stop_on_positional then
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 break;
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 elseif prefix == "--" and raw_param == "--" then
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 table.remove(arg, 1);
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 break;
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 end
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
28 if prefix then
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
29 local param = table.remove(arg, 1):sub(#prefix+1);
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
30 if #param == 1 and short_params then
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
31 param = short_params[param];
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
32 end
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
34 if not param then
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
35 return nil, "param-not-found", raw_param;
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 end
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
37
13733
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
38 local uparam = param:match("^[^=]*"):gsub("%-", "_");
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
39
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
40 local param_k, param_v;
13733
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
41 if value_params[uparam] or array_params[uparam] then
13762
81856814d74f util.argparse: Fix bug (regression?) in argument parsing with --foo=bar
Matthew Wild <mwild1@gmail.com>
parents: 13733
diff changeset
42 param_k = uparam;
81856814d74f util.argparse: Fix bug (regression?) in argument parsing with --foo=bar
Matthew Wild <mwild1@gmail.com>
parents: 13733
diff changeset
43 param_v = param:match("^=(.*)$", #uparam+1);
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
44 if not param_v then
13762
81856814d74f util.argparse: Fix bug (regression?) in argument parsing with --foo=bar
Matthew Wild <mwild1@gmail.com>
parents: 13733
diff changeset
45 param_v = table.remove(arg, 1);
81856814d74f util.argparse: Fix bug (regression?) in argument parsing with --foo=bar
Matthew Wild <mwild1@gmail.com>
parents: 13733
diff changeset
46 if not param_v then
81856814d74f util.argparse: Fix bug (regression?) in argument parsing with --foo=bar
Matthew Wild <mwild1@gmail.com>
parents: 13733
diff changeset
47 return nil, "missing-value", raw_param;
81856814d74f util.argparse: Fix bug (regression?) in argument parsing with --foo=bar
Matthew Wild <mwild1@gmail.com>
parents: 13733
diff changeset
48 end
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 end
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
50 else
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
51 param_k, param_v = param:match("^([^=]+)=(.+)$");
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
52 if not param_k then
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
53 if param:match("^no%-") then
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
54 param_k, param_v = param:sub(4), false;
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
55 else
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
56 param_k, param_v = param, true;
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
57 end
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
58 end
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
59 param_k = param_k:gsub("%-", "_");
13733
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
60 if strict and not kv_params[param_k] then
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
61 return nil, "param-not-found", raw_param;
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
62 end
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
63 end
13733
48c056c10e5a util.argparse: Add strict mode + tests
Matthew Wild <mwild1@gmail.com>
parents: 13731
diff changeset
64 if array_params[uparam] then
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
65 if parsed_opts[param_k] then
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
66 table.insert(parsed_opts[param_k], param_v);
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
67 else
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
68 parsed_opts[param_k] = { param_v };
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
69 end
13160
4ee9a912ceea util.argparse: Add support for repeatable parameters
Kim Alvefur <zash@zash.se>
parents: 13058
diff changeset
70 else
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
71 parsed_opts[param_k] = param_v;
13160
4ee9a912ceea util.argparse: Add support for repeatable parameters
Kim Alvefur <zash@zash.se>
parents: 13058
diff changeset
72 end
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
73 elseif not stop_on_positional then
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
74 table.insert(parsed_opts, table.remove(arg, 1));
13160
4ee9a912ceea util.argparse: Add support for repeatable parameters
Kim Alvefur <zash@zash.se>
parents: 13058
diff changeset
75 end
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
76 end
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
77
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
78 if stop_on_positional then
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
79 for i = 1, #arg do
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
80 parsed_opts[i] = arg[i];
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
81 end
12477
cc84682b8429 util.argparse: Revise 553c6204fe5b with a different approach
Matthew Wild <mwild1@gmail.com>
parents: 12475
diff changeset
82 end
13731
d78e0f422464 util.argparse: Optionally continue processing past positional parameters
Matthew Wild <mwild1@gmail.com>
parents: 13160
diff changeset
83
12477
cc84682b8429 util.argparse: Revise 553c6204fe5b with a different approach
Matthew Wild <mwild1@gmail.com>
parents: 12475
diff changeset
84 return parsed_opts;
10651
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
85 end
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
86
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
87 return {
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
88 parse = parse;
1196f1e8d178 util.startup: Break out command line argument parsing into util.argparse
Kim Alvefur <zash@zash.se>
parents:
diff changeset
89 }