diff options
author | Nick Mathewson <nickm@torproject.org> | 2024-02-06 11:18:31 -0500 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2024-02-06 13:00:44 -0500 |
commit | db80b935f799ab44750ff378267b10a967af38e3 (patch) | |
tree | 12be4d952e51f6102fee807c25532025fad91def /spec/param-spec.md | |
parent | ad73886e2a38255b5b0b599628f67fe820a5c440 (diff) | |
download | torspec-db80b935f799ab44750ff378267b10a967af38e3.tar.gz torspec-db80b935f799ab44750ff378267b10a967af38e3.zip |
Apply "cell" and "message" consistently
Done by grepping for "cell" and making sure it was accurate in every
place where it occurs. In tor-spec, I also searched for "message".
Part of #253.
Diffstat (limited to 'spec/param-spec.md')
-rw-r--r-- | spec/param-spec.md | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/spec/param-spec.md b/spec/param-spec.md index d2bfff8..c66bb25 100644 --- a/spec/param-spec.md +++ b/spec/param-spec.md @@ -8,7 +8,8 @@ line of a directory consensus. ## Network protocol parameters {#network-protocol} "circwindow" -- the default package window that circuits should be -established with. It started out at 1000 cells, but some research +established with. It started out at 1000 DATA-bearing relay cells, +but some research indicates that a lower value would mean fewer cells in transit in the network at any given time. Min: 100, Max: 1000, Default: 1000 @@ -16,7 +17,7 @@ First-appeared: Tor 0.2.1.20 "UseOptimisticData" -- If set to zero, clients by default shouldn't try to send optimistic data to servers until they have received a -RELAY_CONNECTED cell. +CONNECTED message. Min: 0, Max: 1, Default: 1 First-appeared: 0.2.3.3-alpha Default was 0 before: 0.2.9.1-alpha @@ -37,7 +38,7 @@ Min: 25, Max: 95, Default: 60 First-appeared: 0.2.4 "ExtendByEd25519ID" -- If true, clients should include Ed25519 -identities for relays when generating EXTEND2 cells. +identities for relays when generating EXTEND2 messages. Min: 0. Max: 1. Default: 0. First-appeared: 0.3.0 @@ -61,7 +62,7 @@ First appeared: 0.4.5.1-alpha. ## Performance-tuning parameters {#performance-tuning} "CircuitPriorityHalflifeMsec" -- the halflife parameter used when -weighting which circuit will send the next cell. Obeyed by Tor +weighting which circuit will send the next relay cell. Obeyed by Tor 0.2.2.10-alpha and later. (Versions of Tor between 0.2.2.7-alpha and 0.2.2.10-alpha recognized a "CircPriorityHalflifeMsec" parameter, but mishandled it badly.) @@ -83,13 +84,13 @@ First-appeared: Tor 0.2.2.11-alpha Removed-in: 0.2.2.16-alpha ``` -"NumNTorsPerTAP" -- When balancing ntor and TAP cells at relays, +"NumNTorsPerTAP" -- When balancing ntor and TAP requests at relays, how many ntor handshakes should we perform for each TAP handshake? Min: 1. Max: 100000. Default: 10. First-appeared: 0.2.4.17-rc "circ_max_cell_queue_size" -- This parameter determines the maximum -number of cells allowed per circuit queue. +number of relay cells allowed per circuit queue. Min: 1000. Max: 2147483647 (INT32_MAX). Default: 50000. First-appeared: 0.3.3.6-rc. @@ -201,7 +202,7 @@ previous onion key for an additional onion-key-grace-period-days days after it is replaced. (Introduced in 0.3.1.1-alpha; prior versions of tor hardcoded both of these values to 7 days.) -"AllowNonearlyExtend" -- If true, permit EXTEND cells that are not inside +"AllowNonearlyExtend" -- If true, permit EXTEND/EXTEND2 requests that are not inside RELAY_EARLY cells. Min: 0. Max: 1. Default: 0. First-appeared: 0.2.3.11-alpha @@ -267,7 +268,7 @@ First appeared: 0.4.7.5-alpha. ## V3 onion service parameters {#onion-service} "hs_intro_min_introduce2", "hs_intro_max_introduce2" -- -Minimum/maximum amount of INTRODUCE2 cells allowed per circuits +Minimum/maximum amount of INTRODUCE2 messages allowed per circuit before rotation (actual amount picked at random between these two values). Min: 0. Max: INT32_MAX. Defaults: 16384, 32768. @@ -389,18 +390,18 @@ rendezvous points for single hop clients. ## Padding-related parameters {#padding} "circpad_max_circ_queued_cells" -- The circuitpadding module will -stop sending more padding cells if more than this many cells are in +stop sending more padding relay cells if more than this many cells are in the circuit queue a given circuit. Min: 0. Max: 50000. Default 1000. First appeared: 0.4.0.3-alpha. -"circpad_global_allowed_cells" -- This is the number of padding cells +"circpad_global_allowed_cells" -- This is the number of padding relay cells that must be sent before the 'circpad_global_max_padding_percent' parameter is applied. Min: 0. Max: 65535. Default: 0 "circpad_global_max_padding_pct" -- This is the maximum ratio of -padding cells to total cells, specified as a percent. If the global +padding relay cells to total relay cells, specified as a percent. If the global ratio of padding cells to total cells across all circuits exceeds this percent value, no more padding is sent until the ratio becomes lower. 0 means no limit. |