summaryrefslogtreecommitdiffstats
path: root/third_party/rust/prio/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /third_party/rust/prio/README.md
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/prio/README.md')
-rw-r--r--third_party/rust/prio/README.md76
1 files changed, 76 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..b81a0150c2
--- /dev/null
+++ b/third_party/rust/prio/README.md
@@ -0,0 +1,76 @@
+# 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 was used in the [Exposure Notifications Private Analytics][enpa]
+system. This 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
+
+This crate 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 evolving along with
+the DAP and VDAF specifications.
+
+### Draft versions and release branches
+
+The `main` branch is under continuous development and will usually be partway between VDAF drafts.
+libprio uses stable release branches to maintain implementations of different VDAF draft versions.
+Crate `prio` version `x.y.z` is released from a corresponding `release/x.y` branch. We try to
+maintain [Rust SemVer][semver] compatibility, meaning that API breaks only happen on minor version
+increases (e.g., 0.10 to 0.11).
+
+| Crate version | Git branch | VDAF draft version | DAP draft version | Conforms to specification? | Status |
+| ----- | ---------- | ------------- | ------------- | --------------------- | ------ |
+| 0.8 | `release/0.8` | [`draft-irtf-cfrg-vdaf-01`][vdaf-01] | [`draft-ietf-ppm-dap-01`][dap-01] | Yes | Unmaintained as of March 28, 2023 |
+| 0.9 | `release/0.9` | [`draft-irtf-cfrg-vdaf-03`][vdaf-03] | [`draft-ietf-ppm-dap-02`][dap-02] and [`draft-ietf-ppm-dap-03`][dap-03] | Yes | Unmaintained as of September 22, 2022 |
+| 0.10 | `release/0.10` | [`draft-irtf-cfrg-vdaf-03`][vdaf-03] | [`draft-ietf-ppm-dap-02`][dap-02] and [`draft-ietf-ppm-dap-03`][dap-03] | Yes | Supported |
+| 0.11 | `release/0.11` | [`draft-irtf-cfrg-vdaf-04`][vdaf-04] | N/A | Yes | Unmaintained |
+| 0.12 | `release/0.12` | [`draft-irtf-cfrg-vdaf-05`][vdaf-05] | [`draft-ietf-ppm-dap-04`][dap-04] | Yes | Supported |
+| 0.13 | `release/0.13` | [`draft-irtf-cfrg-vdaf-06`][vdaf-06] | [`draft-ietf-ppm-dap-05`][dap-05] | Yes | Unmaintained |
+| 0.14 | `release/0.14` | [`draft-irtf-cfrg-vdaf-06`][vdaf-06] | [`draft-ietf-ppm-dap-05`][dap-05] | Yes | Unmaintained |
+| 0.15 | `main` | [`draft-irtf-cfrg-vdaf-07`][vdaf-07] | [`draft-ietf-ppm-dap-06`][dap-06] | Yes | Supported |
+
+[vdaf-01]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/01/
+[vdaf-03]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/03/
+[vdaf-04]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/04/
+[vdaf-05]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/05/
+[vdaf-06]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/06/
+[vdaf-07]: https://datatracker.ietf.org/doc/draft-irtf-cfrg-vdaf/07/
+[dap-01]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/01/
+[dap-02]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/02/
+[dap-03]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/03/
+[dap-04]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/04/
+[dap-05]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/05/
+[dap-06]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/06/
+[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/
+[semver]: https://doc.rust-lang.org/cargo/reference/semver.html
+
+## Cargo Features
+
+This crate defines the following feature flags:
+
+|Name|Default feature?|Description|
+|---|---|---|
+|`crypto-dependencies`|Yes|Enables dependencies on various RustCrypto crates, and uses them to implement `XofShake128` to support VDAFs.|
+|`experimental`|No|Certain experimental APIs are guarded by this feature. They may undergo breaking changes in future patch releases, as an exception to semantic versioning.|
+|`multithreaded`|No|Enables certain Prio3 VDAF implementations that use `rayon` for parallelization of gadget evaluations.|
+|`prio2`|No|Enables the Prio v2 API, and a VDAF based on the Prio2 system.|