diff options
author | Gabriela Moldovan <gabi@torproject.org> | 2024-03-05 19:50:21 +0000 |
---|---|---|
committer | Gabriela Moldovan <gabi@torproject.org> | 2024-03-19 12:15:41 +0000 |
commit | 11f831834b94a5eef65828914dd8d504af4c96d1 (patch) | |
tree | 309a6fac74d8b01f00e9882dc9971baa6087810f /spec | |
parent | 4198fc5aefd36de87bb1e2a1096a8cecc4f544d3 (diff) | |
download | torspec-11f831834b94a5eef65828914dd8d504af4c96d1.tar.gz torspec-11f831834b94a5eef65828914dd8d504af4c96d1.zip |
param-spec: Document the vanguard params.
This documents the 3 [vanguard-related parameters] currently supported
by C Tor.
Note: Arti will support full vanguards too, so we may want to also add
parameters for configuring the third layer of guards.
[vanguard-related parameters]: https://gitlab.torproject.org/tpo/core/tor/-/blob/2d19050ef9f2612aab826fe2973dd9fab1df8438/src/feature/client/entrynodes.c#L4126-4159
Diffstat (limited to 'spec')
-rw-r--r-- | spec/param-spec.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/spec/param-spec.md b/spec/param-spec.md index cd0af5e..45cc7f0 100644 --- a/spec/param-spec.md +++ b/spec/param-spec.md @@ -340,6 +340,19 @@ First appeared: 0.4.2.1-alpha. <a id="param-spec.txt-9"></a> +## Vanguard parameters {#vanguards} + +"vanguards-lite-enabled" -- Enable the vanguards-lite subsystem + +"guard-hs-l2-number" -- The number of guards in the L2 guardset +Min: 1. Max: INT32_MAX. Default: 4 + +"guard-hs-l2-lifetime-min" -- The minimum lifetime of L2 guards +Min: 1. Max: INT32_MAX. Default: 86400 (1 day) + +"guard-hs-l2-lifetime-max" -- The maximum lifetime of L2 guards +Min: 1. Max: INT32_MAX. Default: 1036800 (12 days) + ## Denial-of-service parameters {#dos} Denial of Service mitigation parameters. Introduced in 0.3.3.2-alpha: |