diff options
Diffstat (limited to 'third_party/rust/prio/README.md')
| -rw-r--r-- | third_party/rust/prio/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/third_party/rust/prio/README.md b/third_party/rust/prio/README.md new file mode 100644 index 0000000000..0351e8dbd6 --- /dev/null +++ b/third_party/rust/prio/README.md @@ -0,0 +1,34 @@ +# libprio-rs +[![Build Status]][actions] [![Latest Version]][crates.io] [![Docs badge]][docs.rs] + + +[Build Status]: https://github.com/divviup/libprio-rs/workflows/ci-build/badge.svg +[actions]: https://github.com/divviup/libprio-rs/actions?query=branch%3Amain +[Latest Version]: https://img.shields.io/crates/v/prio.svg +[crates.io]: https://crates.io/crates/prio +[Docs badge]: https://img.shields.io/badge/docs.rs-rustdoc-green +[docs.rs]: https://docs.rs/prio/ + +Pure Rust implementation of [Prio](https://crypto.stanford.edu/prio/), a system for Private, Robust, +and Scalable Computation of Aggregate Statistics. + +## Exposure Notifications Private Analytics + +This crate is used in the [Exposure Notifications Private Analytics][enpa] system. This is supported +by the interfaces in modules `server` and `client` and is referred to in various places as Prio v2. +See [`prio-server`][prio-server] or the [ENPA whitepaper][enpa-whitepaper] for more details. + +## Verifiable Distributed Aggregation Function (EXPERIMENTAL) + +Crate `prio` also implements a [Verifiable Distributed Aggregation Function +(VDAF)][vdaf] called "Prio3", implemented in the `vdaf` module, allowing Prio to +be used in the [Distributed Aggregation Protocol][dap] protocol being developed +in the PPM working group at the IETF. This support is still experimental, and is +evolving along with the DAP and VDAF specifications. Formal security analysis is +also forthcoming. Prio3 should not yet be used in production applications. + +[enpa]: https://www.abetterinternet.org/post/prio-services-for-covid-en/ +[enpa-whitepaper]: https://covid19-static.cdn-apple.com/applications/covid19/current/static/contact-tracing/pdf/ENPA_White_Paper.pdf +[prio-server]: https://github.com/divviup/prio-server +[vdaf]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/ +[dap]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/ |