Go to file
Jack Grigg 878dd1351b Introduce SpendAuth: SigType and Binding: SigType traits
The prior `SpendAuth` and `Binding` enums have been renamed to
`sapling::{SpendAuth, Binding}`. These might subsequently be removed
from the crate entirely (moving into a wrapping `redjubjub` crate).

The code assumes that scalar and point representations are [u8; 32],
which will be the case for all curves we instantiate RedDSA with for
Zcash.
2021-11-18 21:15:03 +00:00
.github Bump codecov/codecov-action from 1.5.0 to 1.5.2 2021-06-21 17:07:49 -04:00
benches Introduce SpendAuth: SigType and Binding: SigType traits 2021-11-18 21:15:03 +00:00
rfcs add missing checks 2021-06-15 17:10:38 -04:00
src Introduce SpendAuth: SigType and Binding: SigType traits 2021-11-18 21:15:03 +00:00
tests Introduce SpendAuth: SigType and Binding: SigType traits 2021-11-18 21:15:03 +00:00
.gitignore Optimized batch verification (#36) 2020-07-03 18:23:28 -04:00
CHANGELOG.md Don't reject small-order verification keys (#137) 2021-11-18 15:53:35 -03:00
Cargo.toml Introduce SpendAuth: SigType and Binding: SigType traits 2021-11-18 21:15:03 +00:00
Dockerfile Rename crate to reddsa 2021-11-18 21:14:08 +00:00
LICENCE Rename crate to reddsa 2021-11-18 21:14:08 +00:00
LICENCE.MIT Frost keygen with dealer (#47) 2021-02-25 09:06:54 -07:00
LICENSE.Apache-2.0 Frost keygen with dealer (#47) 2021-02-25 09:06:54 -07:00
README.md Introduce SpendAuth: SigType and Binding: SigType traits 2021-11-18 21:15:03 +00:00
cloudbuild.yaml Add GitHub Actions workflow which runs Google Cloudbuild jobs 2019-12-09 18:32:56 -05:00
codecov.yml Add CodeCov config file (#51) 2021-01-19 20:16:54 -05:00
zcash-frost-audit-report-20210323.pdf Add FROST audit pdf to root of repo 2021-03-29 13:19:22 -04:00

README.md

A minimal RedDSA implementation for use in Zcash.

Two specializations of RedDSA are used in Zcash: RedJubjub and RedPallas. For each of these, two parameterizations are used, one for BindingSig and one for SpendAuthSig. This library distinguishes these in the type system, using the sealed SigType trait as a type-level enum.

In addition to the Signature, SigningKey, VerificationKey types, the library also provides VerificationKeyBytes, a refinement of a [u8; 32] indicating that bytes represent an encoding of a RedDSA verification key. This allows the VerificationKey type to cache verification checks related to the verification key encoding. For all specializations of RedDSA used in Zcash, encodings of signing and verification keys are 32 bytes.

Examples

Creating a BindingSig, serializing and deserializing it, and verifying the signature:

# use std::convert::TryFrom;
use rand::thread_rng;
use reddsa::*;

let msg = b"Hello!";

// Generate a secret key and sign the message
let sk = SigningKey::<sapling::Binding>::new(thread_rng());
let sig = sk.sign(thread_rng(), msg);

// Types can be converted to raw byte arrays using From/Into
let sig_bytes: [u8; 64] = sig.into();
let pk_bytes: [u8; 32] = VerificationKey::from(&sk).into();

// Deserialize and verify the signature.
let sig: Signature<sapling::Binding> = sig_bytes.into();
assert!(
    VerificationKey::try_from(pk_bytes)
        .and_then(|pk| pk.verify(msg, &sig))
        .is_ok()
);

docs

cargo doc --features "nightly" --open