aboutsummaryrefslogtreecommitdiff
path: root/doc/api.md
diff options
context:
space:
mode:
authorRasmus Dahlberg <rasmus@mullvad.net>2022-02-13 14:08:46 +0100
committerRasmus Dahlberg <rasmus@mullvad.net>2022-02-13 14:08:46 +0100
commit9025b56a458e1d7d4060f391c8fdc6381fcda441 (patch)
tree03a93e1a9752d769d9348d1f73abf7f0065f0162 /doc/api.md
parent0bbfb18ef99af510eae9f113ce20106c2a3f6a6d (diff)
changed terminology to end-user
See details in proposals/2022-02-end-user-terminology.md.
Diffstat (limited to 'doc/api.md')
-rw-r--r--doc/api.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/api.md b/doc/api.md
index 1f3f07b..37404bb 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -22,8 +22,8 @@ that it is simple to parse and understand for humans. These formats are not
used for the serialization of signed and/or logged data, where a more well
defined and storage efficient format is desirable.
-A _signer_ should distribute log responses to their verifiers in any format that
-suits them. The (de)serialization required for _verifiers_ is a small subset of
+A _signer_ should distribute log responses to their end-users in any format that
+suits them. The (de)serialization required for _end-users_ is a small subset of
Trunnel. Trunnel is an "idiot-proof" wire-format in use by the Tor project.
Figure 1 of our design document gives an intuition of all involved parties.
@@ -69,7 +69,7 @@ struct tree_head {
`timestamp` is the time since the UNIX epoch (January 1, 1970 00:00 UTC) in
seconds. It is included so that monitors can be convinced of _freshness_ if
enough witnesses added their cosignatures. A signer can also use timestamps
-to prove to a verifier that public logging happened within some interval
+to prove to an end-user that public logging happened within some interval
[\[TS\]](https://git.sigsum.org/sigsum/commit/?id=fef460586e847e378a197381ef1ae3a64e6ea38b).
`tree_size` is the number of leaves in a log.
@@ -127,7 +127,7 @@ shard-specific tree leaf context_.
`key_hash` is a hash of the signer's public verification key using the same
format as Section 2.3.2. It is included
in `tree_leaf` so that each leaf can be attributed to a signer. A hash,
-rather than the full public key, is used to motivate monitors and verifiers to
+rather than the full public key, is used to motivate monitors and end-users to
locate the appropriate key and make an explicit trust decision.
## 3 - Public endpoints
@@ -345,7 +345,7 @@ Output on success:
`key_hash` can be used to identify which witness cosigned a tree head. A
key-hash, rather than the full verification key, is used to motivate monitors
-and verifiers to locate the appropriate key and make an explicit trust decision.
+and end-users to locate the appropriate key and make an explicit trust decision.
Note that logs must be configured with relevant public keys for witnesses.