Go to file
Kris Nuttycombe 1cf76ae8c0
Enable `no_std` support via a default-enabled `std` feature flag. (#205)
* Enable `no_std` support via a default-enabled `std` feature flag.

* Add CI workflow for verifying the dependency tree's  compatibility
2024-12-26 14:41:41 -03:00
.github Enable `no_std` support via a default-enabled `std` feature flag. (#205) 2024-12-26 14:41:41 -03:00
benches
rfcs
src Enable `no_std` support via a default-enabled `std` feature flag. (#205) 2024-12-26 14:41:41 -03:00
tests
.gitignore
CHANGELOG.md Enable `no_std` support via a default-enabled `std` feature flag. (#205) 2024-12-26 14:41:41 -03:00
Cargo.toml Enable `no_std` support via a default-enabled `std` feature flag. (#205) 2024-12-26 14:41:41 -03:00
Dockerfile
LICENCE
LICENCE.MIT
LICENSE.Apache-2.0
README.md
cloudbuild.yaml
codecov.yml
zcash-frost-audit-report-20210323.pdf

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