Go to file
Henry de Valence eb5714779c release: update CHANGELOG and version. 2020-07-09 10:30:01 -07:00
.github Create Dependabot config file 2020-06-09 16:27:11 -04:00
benches Fix benches 2020-07-05 00:22:08 -04:00
src release: update CHANGELOG and version. 2020-07-09 10:30:01 -07:00
tests Optimized batch verification (#36) 2020-07-03 18:23:28 -04:00
.gitignore Optimized batch verification (#36) 2020-07-03 18:23:28 -04:00
CHANGELOG.md release: update CHANGELOG and version. 2020-07-09 10:30:01 -07:00
Cargo.toml release: update CHANGELOG and version. 2020-07-09 10:30:01 -07:00
Dockerfile Add Dockerfile for gcloud build 2019-12-09 18:32:56 -05:00
README.md Change terminology to signing, verification keys (#35) 2020-06-25 11:56:29 -07:00
cloudbuild.yaml Add GitHub Actions workflow which runs Google Cloudbuild jobs 2019-12-09 18:32:56 -05: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