Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-12-22 19:49:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
serai/crypto/transcript
History
Luke Parker f8760ae021
Document the transcript library
2022-07-09 00:37:39 -04:00
..
src Document the transcript library 2022-07-09 00:37:39 -04:00
Cargo.toml Enable no_std on transcript 2022-06-28 04:02:56 -04:00
LICENSE Transcript crate with both a merlin backend and a basic label len value backend 2022-05-03 07:20:24 -04:00
README.md Document the transcript library 2022-07-09 00:37:39 -04:00

README.md

Flexible Transcript

Flexible Transcript is a crate offering:

  • Transcript, a trait offering functions transcripts should implement.
  • DigestTranscript, a competent transcript format instantiated against a provided hash function.
  • MerlinTranscript, a wrapper of merlin into the trait (available via the merlin feature).
  • RecommendedTranscript, a transcript recommended for usage in applications. Currently, this is DigestTranscript<Blake2b512> (available via the recommended feature).

The trait was created while working on an IETF draft which defined an incredibly simple transcript format. Extensions of the protocol would quickly require a more competent format, yet implementing the one specified was mandatory to meet the specification. Accordingly, the library implementing the draft defined an IetfTranscript, dropping labels and not allowing successive challenges, yet thanks to the trait, allowed protocols building on top to provide their own transcript format as needed.

DigestTranscript takes in any hash function implementing Digest, offering a secure transcript format around it. All items are prefixed by a flag, denoting their type, and their length.

MerlinTranscript was used to justify the API, and if any issues existed with DigestTranscript, enable a fallback. It was also meant as a way to be compatible with existing Rust projects using merlin.