Ty/ct-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(api): List outputs in CtApiClient methods

Browse source
This commit is contained in:
Tyler Beckman 2024-10-27 16:03:40 -06:00
parent 505355189f
commit f526f859a5
Signed by: Ty
GPG key ID: 2813440C772555A4
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/api/mod.rs
View file

@ -23,7 +23,9 @@ impl CtApiClient {
}) })
} }
/// Adds a standard x509 chain to the CT log. /// Adds a standard x509 chain to the CT log. The log will then return
/// information needed to construct a valid SCT entry, including timestamp,
/// CT log signature, sct version, and any log operator extensions.
/// ///
/// See: [`endpoints::ADD_CHAIN`] /// See: [`endpoints::ADD_CHAIN`]
/// ///
@ -54,6 +56,7 @@ impl CtApiClient {
/// Adds a precetificate chain to the CT log. This is largely the same as /// Adds a precetificate chain to the CT log. This is largely the same as
/// [`CtApiClient::add_chain`], except is used specifically when the chain /// [`CtApiClient::add_chain`], except is used specifically when the chain
/// starts with a precertificate rather than the final end-user certificate. /// starts with a precertificate rather than the final end-user certificate.
/// Response data is exactly the same as [`CtApiClient::add_chain`].
/// ///
/// See: [`endpoints::ADD_PRE_CHAIN`] /// See: [`endpoints::ADD_PRE_CHAIN`]
/// ///
@ -84,7 +87,11 @@ impl CtApiClient {
.await .await
} }
/// Fetches the Signed Tree Head information for the current CT log tree /// Fetches the Signed Tree Head information for the current CT log tree.
/// The response contains the tree size, timestamp, root hash, and a
/// signature of all of the above from the CT log. This data can be used to
/// verify the integrity of the tree at any point, and verify inclusion of a
/// leaf in the tree.
/// ///
/// See: [`endpoints::GET_STH`] /// See: [`endpoints::GET_STH`]
/// ///
@ -106,7 +113,9 @@ impl CtApiClient {
} }
/// Fetches the Signed Tree Head consistency proof for a specified start /// Fetches the Signed Tree Head consistency proof for a specified start
/// tree_size and end tree_size. /// tree_size and end tree_size. This consistency proof is simply a list of
/// each merkle tree node necessary to verify the append-only nature of the
/// log between the specified first and second tree sizes.
/// ///
/// See: [`endpoints::GET_STH_CONSISTENCY`] /// See: [`endpoints::GET_STH_CONSISTENCY`]
/// ///
@ -138,7 +147,7 @@ impl CtApiClient {
/// Fetches a single merkle audit proof for a specific leaf node by hash /// Fetches a single merkle audit proof for a specific leaf node by hash
/// from the CT log. The response both includes the index of the hashed /// from the CT log. The response both includes the index of the hashed
/// leaf node and the list of Merkle Tree nodes required to verify proof of /// leaf node and the list of Merkle Tree nodes required to verify proof of
/// existence. /// existence of your specified node in the full tree.
/// ///
/// See: [`endpoints::GET_PROOF_BY_HASH`] /// See: [`endpoints::GET_PROOF_BY_HASH`]
/// ///