aboutsummaryrefslogtreecommitdiff
path: root/doc/api.md
Commit message (Collapse)AuthorAgeFilesLines
* change 'verification_key' to 'public_key'Linus Nordberg2022-04-291-9/+9
| | | | | | | | Critically in the API: verification_key -> public_key Less critical in describing text, changing "verification key" and "verification public key" to "public key" all over. Issue: #40
* change 'preimage' to 'message'Linus Nordberg2022-04-291-7/+8
| | | | | | | Also, change 'checksum_hash' to 'checksum' to follow terminology in code, and general language. Issue: #40
* complete renaming of get-tree endpointsLinus Nordberg2022-03-031-1/+1
| | | | cf commit a242308c
* add shard hint to tree_leaf structLinus Nordberg2022-03-021-10/+8
| | | | | | Needed for being able to verify signatures. Also, remove struct statement since we won't expose it and have no use for it.
* redefined base url as log urlRasmus Dahlberg2022-02-131-15/+15
| | | | See details in proposals/2022-01-log-url.
* changed terminology to end-userRasmus Dahlberg2022-02-131-5/+5
| | | | See details in proposals/2022-02-end-user-terminology.md.
* minor wording tweaks and fixesRasmus Dahlberg2022-01-311-11/+12
| | | | The majority of this commit is from ln5, thank you.
* fixed documentation issue regarding shard intervalRasmus Dahlberg2022-01-311-4/+6
|
* documented the decided ssh signature formatRasmus Dahlberg2022-01-311-51/+47
| | | | Refer to doc/proposals/2021-11-ssh-signature-format.md for details.
* documented decided get-tree-head endpoint proposalRasmus Dahlberg2022-01-311-35/+18
| | | | | | | | | Refer to doc/proposals/2022-01-tree-head-endpoint doc/proposals/2022-01-no-quick-tree-head-endpoint for details.
* documented the decided remove arbitrary bytes proposalRasmus Dahlberg2022-01-311-3/+5
| | | | | | | | | | Refer to doc/proposals/2021-11-remove-arbitrary-bytes.md for details. Since our proposal left the exact terminology undefined, this commit took a stab at that. The main idea was to keep referring to what we have in a leaf and what is being signed as a _checksum_. This ensures that we are not undermining or stepping away from our core of "signed checksums". It seemed quite natural to refer to a checksum's preimage.
* documented the decided add-leaf endpoint proposalRasmus Dahlberg2022-01-311-3/+4
| | | | Refer to doc/proposals/2022-01-add-leaf-endpoint for details.
* documented the decided domain hint proposalRasmus Dahlberg2022-01-311-2/+3
| | | | Refer to doc/proposals/2022-01-domain-hint for details.
* documented the decided get-* endpoint proposalRasmus Dahlberg2022-01-311-25/+28
| | | | Refer to archive/doc/proposals/2022-01-get-endpoints for details.
* added proposal into main documentationRasmus Dahlberg2021-12-041-2/+2
| | | | Sigsum logs should now use open-ended shard intervals.
* defined what type of hex encoding is permittedRasmus Dahlberg2021-10-121-4/+4
|
* updated terminology that was lagging behindRasmus Dahlberg2021-10-101-21/+23
| | | | | | | | | - s/verifier/monitor - s/claimant/signer - s/believer/verifier - s/opaque data/data - minor rewordings related to these substitutions - referenced a possible timestamp usage
* clarified that what is logged is a minimal statementRasmus Dahlberg2021-09-281-1/+1
| | | | A claimant may add additional implicit claims via policy.
* fixed endpoint examplesRasmus Dahlberg2021-09-281-13/+28
| | | | | | - Better readability with full code blocks - Replaced localhost with <base url> - Generated new add-leaf example that should be valid
* minor edits and typo fixesRasmus Dahlberg2021-09-281-8/+9
|
* removed unused Trunnel structureRasmus Dahlberg2021-09-281-13/+5
|
* noted that verified timestamps have more use-casesRasmus Dahlberg2021-09-281-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | A believer can be convinced that a sigsum was logged after time T. This is because witnesses do Verifier(append-only) and Verifier(Freshness). Outline: a claimant is about to log a sigsum. 1. Fetch the most recent cosigned tree head. - Timestamp is T - Tree size is N 2. Submit sigsum for logging. 3. Wait for inclusion at index N+k, k=>0. 4. Wait for next cosigned tree head. - Timestamp is T', where T' > T - Tree size is N', where N' > N+k 5. Download inclusion proof for tree size N'. Now you can convince a believer that a sigsum is publicly logged. Just reveal inclusion proof which leads up to the second cosigned tree head. Next, you can reveal the first cosigned tree head that _have not merged that entry yet_. This follows from the first cosigned tree head size, and makes it obvious that the entry must have been merge after time T.
* added a second take on api refactoringRasmus Dahlberg2021-09-061-178/+186
| | | | | | | | - Kept current formats and parsers - Added key_hash in tree_head to protect against an attack - Removed mentions of old terminology, e.g., submitter and end-user. - Referenced some of our persisted discuss pads for additional context. - Minor edits
* fixed s/st/sigsum in api.mdRasmus Dahlberg2021-06-251-30/+27
|
* imported logging docs without any changesRasmus Dahlberg2021-06-221-0/+371
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-22 21:06:24 +0000