Crates.io | vrf |
lib.rs | vrf |
version | 0.2.4 |
source | src |
created_at | 2019-05-14 14:16:41.424722 |
updated_at | 2022-04-07 10:58:38.750455 |
description | Fast and extensible Verifiable Random Function (VRF) library; currently supporting secp256k1, secp256r1 and sect163k1 curves |
homepage | https://github.com/witnet/vrf-rs |
repository | https://github.com/witnet/vrf-rs |
max_upload_size | |
id | 134297 |
size | 84,429 |
vrf-rs
is an open source implementation of Verifiable Random Functions (VRFs) written in Rust.
DISCLAIMER: This is experimental software. Be careful!
The library can be built using cargo
and the examples can be executed with:
cargo build
cargo run --example <example_name>
This module uses the OpenSSL library to offer Elliptic Curve Verifiable Random Function (VRF) functionality.
It follows the algorithms described in:
Currently the supported cipher suites are:
P256_SHA256_TAI
: the aforementioned algorithms with SHA256
and the secp256r1
curve (aka NIST P-256
).K163_SHA256_TAI
: the aforementioned algorithms with SHA256
and the sect163k1
curve (aka NIST K-163
).SECP256K1_SHA256_TAI
: the aforementioned algorithms with SHA256
and the secp256k1
curve.Create and verify a VRF proof by using the cipher suite SECP256K1_SHA256_TAI
:
use vrf::openssl::{CipherSuite, ECVRF};
use vrf::VRF;
fn main() {
// Initialization of VRF context by providing a curve
let mut vrf = ECVRF::from_suite(CipherSuite::SECP256K1_SHA256_TAI).unwrap();
// Inputs: Secret Key, Public Key (derived) & Message
let secret_key =
hex::decode("c9afa9d845ba75166b5c215767b1d6934e50c3db36e89b127b8a622b120f6721").unwrap();
let public_key = vrf.derive_public_key(&secret_key).unwrap();
let message: &[u8] = b"sample";
// VRF proof and hash output
let pi = vrf.prove(&secret_key, &message).unwrap();
let hash = vrf.proof_to_hash(&pi).unwrap();
// VRF proof verification (returns VRF hash output)
let beta = vrf.verify(&public_key, &pi, &message);
}
A complete example can be found in examples/basic.rs. It can be executed with:
cargo run --example basic
This library defines a VRF
trait which can be extended in order to use different curves and algorithms.
pub trait VRF<PublicKey, SecretKey> {
type Error;
fn prove(&mut self, x: SecretKey, alpha: &[u8]) -> Result<Vec<u8>, Self::Error>;
fn verify(&mut self, y: PublicKey, pi: &[u8], alpha: &[u8]) -> Result<Vec<u8>, Self::Error>;
}
vrf-rs
is published under the MIT license.