Go to file
Alfredo Garcia 4bf0d5c58e text updates
Co-authored-by: Deirdre Connolly <durumcrustulum@gmail.com>
2021-06-15 17:10:38 -04:00
.github Bump actions-rs/toolchain from 1 to 1.0.7 2021-05-20 16:18:35 -04:00
benches
rfcs text updates 2021-06-15 17:10:38 -04:00
src Change the type of the identifiers from u8 to u64 (#110) 2021-05-28 09:06:51 -03:00
tests Split out parsing & validation of test VerificationKey from checking of signature 2021-06-01 06:45:52 -04:00
.gitignore
CHANGELOG.md
Cargo.toml update byteorder 2021-05-20 16:21:38 -04:00
Dockerfile
LICENCE
LICENCE.MIT
LICENSE.Apache-2.0
README.md use rust in code sample of the README (#96) 2021-05-17 14:48:24 +02:00
cloudbuild.yaml
codecov.yml
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 RedJubjub implementation for use in Zebra.

Two parameterizations of RedJubjub are used in Zcash, 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 RedJubjub verification key. This allows the VerificationKey type to cache verification checks related to the verification key encoding.

Examples

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

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

let msg = b"Hello!";

// Generate a secret key and sign the message
let sk = SigningKey::<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<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