aboutsummaryrefslogtreecommitdiff
path: root/param-spec.txt
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-01-09 12:46:17 -0500
committerNick Mathewson <nickm@torproject.org>2023-01-09 12:46:17 -0500
commit97f1ffb6b07743125e3accb7d8df2851eadbc63d (patch)
treecd4e6ac04759db8d2d592bec2cbbff1aaf2e1b27 /param-spec.txt
parent7116c9cdaba248aae07a3f1d0e15d9dd102f62c5 (diff)
downloadtorspec-97f1ffb6b07743125e3accb7d8df2851eadbc63d.tar.gz
torspec-97f1ffb6b07743125e3accb7d8df2851eadbc63d.zip
Clarify parameters related to hsv3 protocol.
In param-spec, not all of the parameters for onion services had their ranges and defaults listed; I've added those from the code. Also I clarified the units for hsdir_interval, which were not intuitively obvious.
Diffstat (limited to 'param-spec.txt')
-rw-r--r--param-spec.txt10
1 files changed, 9 insertions, 1 deletions
diff --git a/param-spec.txt b/param-spec.txt
index 67c809d..a63ad3b 100644
--- a/param-spec.txt
+++ b/param-spec.txt
@@ -252,26 +252,34 @@ Table of Contents
Minimum/maximum amount of INTRODUCE2 cells allowed per circuits
before rotation (actual amount picked at random between these two
values).
+ Min: 0. Max: INT32_MAX. Defaults: 16384, 32768.
"hs_intro_min_lifetime", "hs_intro_max_lifetime" -- Minimum/maximum
lifetime in seconds that a service should keep an intro point for
(actual lifetime picked at random between these two values).
+ Min: 0. Max: INT32_MAX. Defaults: 18 hours, 24 hours.
"hs_intro_num_extra" -- Number of extra intro points a service is
allowed to open. This concept comes from proposal #155.
+ Min: 0. Max: 128. Default: 2.
- "hsdir_interval" -- The length of a time period. See
+ "hsdir_interval" -- The length of a time period, _in minutes_. See
rend-spec-v3.txt section [TIME-PERIODS].
+ Min: 30. Max: 14400. Default: 1440.
"hsdir_n_replicas" -- Number of HS descriptor replicas.
+ Min: 1. Max: 16. Default: 2.
"hsdir_spread_fetch" -- Total number of HSDirs per replica a tor
client should select to try to fetch a descriptor.
+ Min: 1. Max: 128. Default: 3.
"hsdir_spread_store" -- Total number of HSDirs per replica a service
will upload its descriptor to.
+ Min: 1. Max: 128. Default: 4
"HSV3MaxDescriptorSize" -- Maximum descriptor size (in bytes).
+ Min: 1. Max: INT32_MAX. Default: 50000
"hs_service_max_rdv_failures" -- This parameter determines the
maximum number of rendezvous attempt an HS service can make per