breakingbread
ffefd16b98
Rust CI / cargo fmt (pull_request) Successful in 3s
Rust CI / cargo clippy (pull_request) Successful in 28s
Rust CI / test (1.87.0 / no backend / no frontend) (pull_request) Successful in 1m24s
Rust CI / test (stable / no backend / no frontend) (pull_request) Successful in 1m21s
Rust CI / test (1.87.0 / no backend / --features danger) (pull_request) Successful in 1m24s
Rust CI / test (stable / no backend / --features danger) (pull_request) Successful in 1m21s
Rust CI / test (1.87.0 / no backend / --features serde) (pull_request) Successful in 1m30s
Rust CI / test (stable / no backend / --features serde) (pull_request) Successful in 1m23s
Rust CI / test (1.87.0 / --features ristretto255-ciphersuite / no frontend) (pull_request) Successful in 1m33s
Rust CI / test (stable / --features ristretto255-ciphersuite / no frontend) (pull_request) Successful in 1m30s
Rust CI / test (1.87.0 / --features ristretto255-ciphersuite / --features danger) (pull_request) Successful in 1m36s
Rust CI / test (stable / --features ristretto255-ciphersuite / --features danger) (pull_request) Successful in 1m28s
Rust CI / test (1.87.0 / --features ristretto255-ciphersuite / --features serde) (pull_request) Successful in 1m36s
Rust CI / test (stable / --features ristretto255-ciphersuite / --features serde) (pull_request) Successful in 1m29s
Rust CI / cargo audit (pull_request) Successful in 4s
Rust CI / no-std (thumbv6m-none-eabi / no backend) (pull_request) Successful in 12s
Rust CI / no-std (wasm32-unknown-unknown / no backend) (pull_request) Successful in 13s
Rust CI / no-std (thumbv6m-none-eabi / --features ristretto255-ciphersuite) (pull_request) Successful in 12s
Rust CI / no-std (wasm32-unknown-unknown / --features ristretto255-ciphersuite) (pull_request) Successful in 15s
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# voprf
|
|
An implementation of a (verifiable) oblivious pseudorandom function (VOPRF)
|
|
|
|
A VOPRF is a verifiable oblivious pseudorandom function, a protocol between a client and a server. The regular (non-verifiable) OPRF is also supported in this implementation.
|
|
|
|
This implementation is based on [RFC 9497](https://www.rfc-editor.org/rfc/rfc9497).
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
The API can be found [here](https://docs.rs/voprf-vx/) along with an example for usage.
|
|
|
|
Installation
|
|
------------
|
|
|
|
Add the following line to the dependencies of your `Cargo.toml`:
|
|
|
|
```
|
|
voprf = { package = "voprf-vx", version = "1.0.0-rc.0" }
|
|
```
|
|
|
|
### Minimum Supported Rust Version
|
|
|
|
Rust **1.87** or higher.
|
|
|
|
Contributors
|
|
------------
|
|
|
|
This is a fork of [facebook/voprf](https://github.com/facebook/voprf/) maintained by [VexaHub](https://github.com/vexahub).
|
|
|
|
The original author is Kevin Lewi ([@kevinlewi](https://github.com/kevinlewi)).
|
|
To learn more about contributing to this project, [see this document](./CONTRIBUTING.md).
|
|
|
|
License
|
|
-------
|
|
|
|
This project is dual-licensed under either the [MIT license](./LICENSE-MIT)
|
|
or the [Apache License, Version 2.0](./LICENSE-APACHE).
|
|
You may select, at your option, one of the above-listed licenses.
|