Rename transcript-trait to flexible-transcript

It offers the trait for flexibility, yet it also offers an incredibly 
competent (and logical) transcript format, along with a Merlin wrapper.
This commit is contained in:
Luke Parker 2022-06-27 09:02:21 -04:00
parent 020d246b8f
commit 7b70baaa96
No known key found for this signature in database
GPG key ID: F9F1386DB1E119B6
5 changed files with 28 additions and 7 deletions

View file

@ -23,7 +23,7 @@ curve25519-dalek = { version = "3", features = ["std"] }
group = { version = "0.12", optional = true }
dalek-ff-group = { path = "../../crypto/dalek-ff-group", optional = true }
transcript = { package = "transcript-trait", path = "../../crypto/transcript", features = ["recommended"], optional = true }
transcript = { package = "flexible-transcript", path = "../../crypto/transcript", features = ["recommended"], optional = true }
frost = { package = "modular-frost", path = "../../crypto/frost", features = ["ed25519"], optional = true }
monero = "0.16"

View file

@ -23,7 +23,7 @@ p256 = { version = "0.11", features = ["arithmetic", "hash2curve"], optional = t
k256 = { version = "0.11", features = ["arithmetic", "hash2curve"], optional = true }
dalek-ff-group = { path = "../dalek-ff-group", version = "0.1", optional = true }
transcript = { package = "transcript-trait", path = "../transcript", version = "0.1" }
transcript = { package = "flexible-transcript", path = "../transcript", version = "0.1" }
multiexp = { path = "../multiexp", version = "0.1", features = ["batch"] }

View file

@ -1,7 +1,7 @@
[package]
name = "transcript-trait"
name = "flexible-transcript"
version = "0.1.1"
description = "A simple transcript trait definition"
description = "A simple transcript trait definition, along with viable options"
license = "MIT"
repository = "https://github.com/serai-dex/serai"
authors = ["Luke Parker <lukeparker5132@gmail.com>"]

View file

@ -1,3 +1,24 @@
# Transcript
# Flexible Transcript
Basic transcript trait with a Merlin wrapper available via the Merlin feature.
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).
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`.

View file

@ -18,7 +18,7 @@ serde_json = "1.0"
curve25519-dalek = { version = "3", features = ["std"] }
blake2 = "0.10"
transcript = { package = "transcript-trait", path = "../crypto/transcript", features = ["recommended"] }
transcript = { package = "flexible-transcript", path = "../crypto/transcript", features = ["recommended"] }
dalek-ff-group = { path = "../crypto/dalek-ff-group" }
frost = { package = "modular-frost", path = "../crypto/frost" }