Go to file
Deirdre Connolly 6734710c3e 0.6.0 2023-02-03 16:47:35 -05:00
.github Bump codecov/codecov-action from 3.0.0 to 3.1.0 2022-04-22 07:41:53 -04:00
benches Fix benches 2020-07-05 00:22:08 -04:00
rfcs add missing checks 2021-06-15 17:10:38 -04:00
src refactor to use reddsa crate (#152) 2023-02-01 18:22:37 -05:00
tests refactor to use reddsa crate (#152) 2023-02-01 18:22:37 -05:00
.gitignore Optimized batch verification (#36) 2020-07-03 18:23:28 -04:00
CHANGELOG.md refactor to use reddsa crate (#152) 2023-02-01 18:22:37 -05:00
Cargo.toml 0.6.0 2023-02-03 16:47:35 -05:00
Dockerfile Add Dockerfile for gcloud build 2019-12-09 18:32:56 -05:00
LICENCE Frost keygen with dealer (#47) 2021-02-25 09:06:54 -07: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 use rust in code sample of the README (#96) 2021-05-17 14:48:24 +02: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 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