diff options
| author | Rasmus Dahlberg <rasmus@mullvad.net> | 2022-01-31 17:22:45 +0100 |
|---|---|---|
| committer | Rasmus Dahlberg <rasmus@mullvad.net> | 2022-01-31 17:22:45 +0100 |
| commit | ca6d75f9c8b1c9638c3d3a39a7f675af3a2d32bf (patch) | |
| tree | 4c98ea1a13faeca205767536b37229e64715126a | |
| parent | 148b1cdae56f0110956c18a03c2731a5ceaca3c2 (diff) | |
fixed documentation issue regarding shard interval
| -rw-r--r-- | doc/api.md | 10 | ||||
| -rw-r--r-- | doc/design.md | 11 | ||||
| -rw-r--r-- | issues/open-ended-shard-interval.md | 5 |
3 files changed, 11 insertions, 15 deletions
@@ -303,10 +303,12 @@ Input: Output on success: - None -A submission will not be accepted if `signature` is invalid or if the retrieved -key hash does not match the specified verification key. A submission may also -not be accepted if the second-level domain name exceeded its rate limit. -A rate limit should only be charged for the specified domain hint on success. +A submission will not be accepted if `signature` or `shard_hint` is invalid. +The retrieved key hash must also match the specified verification key. + +A submission may not be accepted if the second-level domain name exceeded its +rate limit. A rate limit should only be charged for the specified domain hint +on success. HTTP status 200 OK must not be returned unless the log has sequenced its Merkle tree so that the next signed tree head merged the added leaf. A submitter diff --git a/doc/design.md b/doc/design.md index 7464ecc..8a46fd2 100644 --- a/doc/design.md +++ b/doc/design.md @@ -82,10 +82,9 @@ but it is mature enough to capture what type of ecosystem we want to bootstrap. additional outbound network connections. Proofs of public logging are provided using the same distribution mechanism as is used for distributing the actual data. In other words, the signer talks to the log on behalf of the verifying party. -- **Sharding to simplify log life cycles:** starting to operate a log is easier -than closing it down in a reliable way. We have a predefined sharding interval -that determines the time during which the log will be active. Submissions to -an older log shard cannot be replayed in another non-overlapping log shard. +- **Sharding to simplify log life cycles:** sigsum logs have open-ended shard +intervals that determine the point in time that incoming submissions must be +scoped for. Past submissions cannot be replayed in non-overlapping shards. - **Defenses against log spam and poisoning:** to keep logs as useful as possible they should be open for everyone. However, accepting logging requests from anyone at arbitrary rates can lead to abusive usage patterns. We store as @@ -309,8 +308,8 @@ public keys. They may also need to be aware of how to locate the data that logged checksums represent. ### 3.3 - Summary -Sigsum logs are sharded and shut down at predefined times. A sigsum log can -shut down _safely_ because verification on the verifier-side is not interactive. +Sigsum logs are sharded and can be shut down _safely_ in the future because +verification on the verifier-side is not interactive. The difficulty of bypassing public logging is based on the difficulty of controlling enough independent witnesses. A witness checks that a log's tree diff --git a/issues/open-ended-shard-interval.md b/issues/open-ended-shard-interval.md deleted file mode 100644 index 90eb65d..0000000 --- a/issues/open-ended-shard-interval.md +++ /dev/null @@ -1,5 +0,0 @@ -# Open-Ended Shard Interval -It looks like doc/design.md is not fully updated yet. For example, the -statement that Sigsum logs are "shutdown at pre-defined times" is incorrect. - -See Section 3.3 - Summary. |