https://github.com/vechain/go-ecvrf
Elliptic Curve Verifiable Radom Function(ECVRF) library written in Go
https://github.com/vechain/go-ecvrf
crypto curve ellipitic hash random verifiable vrf
Last synced: 6 months ago
JSON representation
Elliptic Curve Verifiable Radom Function(ECVRF) library written in Go
- Host: GitHub
- URL: https://github.com/vechain/go-ecvrf
- Owner: vechain
- License: mit
- Created: 2020-03-03T06:05:44.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-25T12:58:49.000Z (over 3 years ago)
- Last Synced: 2025-03-26T18:43:58.067Z (6 months ago)
- Topics: crypto, curve, ellipitic, hash, random, verifiable, vrf
- Language: Go
- Homepage:
- Size: 75.2 KB
- Stars: 10
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-ecvrf
[](https://pkg.go.dev/github.com/vechain/go-ecvrf)
[](https://travis-ci.org/vechain/go-ecvrf)
[](https://github.com/vechain/go-ecvrf/blob/master/LICENSE)
Golang implementation of Elliptic Curve Verifiable Random Function (VRF) follows [draft-irtf-cfrg-vrf-06](https://tools.ietf.org/id/draft-irtf-cfrg-vrf-06.html) and [RFC 6979](https://tools.ietf.org/html/rfc6979).
# What's VRF
A Verifiable Random Function (VRF) is the public-key version of a keyed cryptographic hash. Only the holder of the private key can compute the hash, but anyone with public key can verify the correctness of the hash.
A key application of the VRF is to provide privacy against offline enumeration (e.g. dictionary attacks) on data stored in a hash-based data structure. In this application, a Prover holds the VRF private key and uses the VRF hashing to construct a hash-based data structure on the input data. Due to the nature of the VRF, only the Prover can answer queries about whether or not some data is stored in the data structure. Anyone who knows the public VRF key can verify that the Prover has answered the queries correctly. However no offline inferences (i.e. inferences without querying the Prover) can be made about the data stored in the data strucuture.
# Installation
```
go get -u github.com/vechain/go-ecvrf
```
# Examples
Using SECP256K1_SHA256_TAI cipher suite:
* VRF Proving
```golang
// the private key
var sk *ecdsa.PrivateKey
// code to load sk
// ...
// the input to be hashed by the VRF
alpha := "Hello VeChain"
// `beta`: the VRF hash output
// `pi`: the VRF proof
beta, pi, err := ecvrf.Secp256k1Sha256Tai.Prove(sk, []byte(alpha))
if err != nil {
// something wrong.
// most likely sk is not properly loaded.
return
}
```
* VRF Verifying
```golang
// the public key
var pk *ecdsa.PublicKey
// code to load pk
// ...
// the input to be hashed by the VRF
alpha := "Hello VeChain"
// `pi` is the VRF proof
beta, err := ecvrf.Secp256k1Sha256Tai.Verify(pk, []byte(alpha), pi)
if err != nil {
// invalid proof
return
}
// got correct beta
```
# Supported Cipher Suites
* P256_SHA256_TAI
* SECP256K1_SHA256_TAI
It's easy to extends this library to use different Weierstrass curves and Hash algorithms, by providing cooked `Config` like:
```golang
// the following codes build a new P256_SHA256_TAI VRF object.
vrf := ecvrf.New(&ecvrf.Config{
Curve: elliptic.P256(),
SuiteString: 0x01,
Cofactor: 0x01,
NewHasher: sha256.New,
Decompress: elliptic.UnmarshalCompressed,
})
```
# Benchmark
```bash
$ go test -benchmem -run=^$ -bench ^BenchmarkVRF$ github.com/vechain/go-ecvrf -benchtime=5s
goos: linux
goarch: amd64
pkg: github.com/vechain/go-ecvrf
cpu: Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz
BenchmarkVRF/secp256k1sha256tai-proving-8 22207 279600 ns/op 4881 B/op 95 allocs/op
BenchmarkVRF/secp256k1sha256tai-verifying-8 15150 399938 ns/op 5009 B/op 114 allocs/op
BenchmarkVRF/p256sha256tai-proving-8 31328 193911 ns/op 9083 B/op 294 allocs/op
BenchmarkVRF/p256sha256tai-verifying-8 19875 300613 ns/op 19472 B/op 515 allocs/op
PASS
ok github.com/vechain/go-ecvrf 36.060s
```
# References
* [draft-irtf-cfrg-vrf-06](https://tools.ietf.org/id/draft-irtf-cfrg-vrf-06.html)
* [RFC 6979](https://tools.ietf.org/html/rfc6979)
* [witnet/vrf-rs](https://github.com/witnet/vrf-rs)
* [google/keytransparency](https://github.com/google/keytransparency)
# License
Copyright (c) 2020 vechain.org.
Licensed under the MIT license.