diff options
| author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2024-03-05 11:49:02 +0000 |
|---|---|---|
| committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2024-03-05 15:42:53 +0000 |
| commit | 9fedec9a1ebbb18d08334d7edf0e17b0a458b6fd (patch) | |
| tree | 2740217590ba745f99baf5805f51b8afd7407fe8 | |
| parent | 81942fbbc418d1fadbb8f84c10d46ccc74e52c58 (diff) | |
| download | torspec-9fedec9a1ebbb18d08334d7edf0e17b0a458b6fd.tar.gz torspec-9fedec9a1ebbb18d08334d7edf0e17b0a458b6fd.zip | |
hspow: Use consistent terminology for hspow schemes
The text uses "scheme" and "version" a couple of times. The formal
protocol says "type". The terminology should be consistent. IMO
"scheme" is the best word to use. "version" is particularly bad.
Change all references to "type" and "version" to "scheme".
| -rw-r--r-- | spec/hspow-spec/v1-equix.md | 4 | ||||
| -rw-r--r-- | spec/rend-spec/hsdesc-encrypt.md | 10 |
2 files changed, 7 insertions, 7 deletions
diff --git a/spec/hspow-spec/v1-equix.md b/spec/hspow-spec/v1-equix.md index 025af48..f49086a 100644 --- a/spec/hspow-spec/v1-equix.md +++ b/spec/hspow-spec/v1-equix.md @@ -1,4 +1,4 @@ -# Onion service proof-of-work: Version 1, Equi-X and Blake2b +# Onion service proof-of-work: Scheme v1, Equi-X and Blake2b ## Implementations {#implementations} @@ -82,7 +82,7 @@ Thus the effort is communicated explicitly in our protocol, and it forms part of ## Parameter descriptor {#parameter-descriptor} This whole protocol starts with the service encoding its parameters in a `pow-params` line within the 'encrypted' (inner) part of the v3 descriptor. The [second layer plaintext format](../rend-spec/hsdesc-encrypt.md#second-layer-plaintext) describes it canonically. The parameters offered are: -- `type`, always `v1` for the algorithm described here +- `scheme`, always `v1` for the algorithm described here - `seed-b64`, a periodically updated 32-byte random seed, base64 encoded - `suggested-effort`, the latest output from the [service-side effort controller](./common-protocol.md#service-effort) - `expiration-time`, a timestamp when we plan to replace the seed. diff --git a/spec/rend-spec/hsdesc-encrypt.md b/spec/rend-spec/hsdesc-encrypt.md index 3e91172..86abfae 100644 --- a/spec/rend-spec/hsdesc-encrypt.md +++ b/spec/rend-spec/hsdesc-encrypt.md @@ -252,21 +252,21 @@ list of intro points etc. The plaintext has the following format: ``` ```text - "pow-params" SP type SP seed-b64 SP suggested-effort + "pow-params" SP scheme SP seed-b64 SP suggested-effort SP expiration-time NL - [At most once per "type"] + [At most once per "scheme"] If present, this line provides parameters for an optional proof-of-work client puzzle. A client that supports an offered scheme can include a corresponding solution in its introduction request to improve priority in the service's processing queue. - Only version 1 is currently defined. - Other versions may have a different format. + Only scheme `v1` is currently defined. + Other schemes may have a different format. Introduced in tor-0.4.8.1-alpha. - type: The type of PoW system used. We call the one specified here "v1". + scheme: The PoW system used. We call the one specified here "v1". seed-b64: A random seed that should be used as the input to the PoW hash function. Should be 32 random bytes encoded in base64 |