diff options
author | Nick Mathewson <nickm@torproject.org> | 2024-04-29 15:41:02 +0000 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2024-04-29 15:41:02 +0000 |
commit | 156c5df9bc828436de97a2f6a70275e3f43e779b (patch) | |
tree | eecf553a7172adfbe0412cf2212d1e336cdeb17e /spec | |
parent | c0ea56f5095359b0f6af94549250cc129a0d94c3 (diff) | |
parent | 144c6954d8e7ca0f2d2f198379a9e8b2aea753f8 (diff) | |
download | torspec-main.tar.gz torspec-main.zip |
param-spec: Document the vanguard params.
See merge request tpo/core/torspec!258
Diffstat (limited to 'spec')
-rw-r--r-- | spec/param-spec.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/spec/param-spec.md b/spec/param-spec.md index cd0af5e..daa70f9 100644 --- a/spec/param-spec.md +++ b/spec/param-spec.md @@ -340,6 +340,43 @@ First appeared: 0.4.2.1-alpha. <a id="param-spec.txt-9"></a> +## Vanguard parameters {#vanguards} + +```text + "vanguards-enabled" -- The type of vanguards to use by default when + building onion service circuits + 0: No vanguards. + 1: Lite vanguards. + 2: Full vanguards. +``` + +```text + "vanguards-hs-service" -- If higher than vanguards-enabled, and we are + running an onion service, we use this level for all our onion service + circuits + 0: No vanguards. + 1: Lite vanguards. + 2: Full vanguards. +``` + +"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) + +"guard-hs-l3-number" -- The number of guards in the L3 guardset +Min: 1. Max: INT32_MAX. Default: 8 + +"guard-hs-l3-lifetime-min" -- The minimum lifetime of L3 guards +Min: 1. Max: INT32_MAX. Default: 3600 (1 hour) + +"guard-hs-l3-lifetime-max" -- The maximum lifetime of L3 guards +Min: 1. Max: INT32_MAX. Default: 172800 (48 hours) + ## Denial-of-service parameters {#dos} Denial of Service mitigation parameters. Introduced in 0.3.3.2-alpha: |