-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #95 from abetterinternet/timg/release-0.5.0
bump prio crate to 0.5.0
- Loading branch information
Showing
7 changed files
with
66 additions
and
39 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,33 @@ | ||
# libprio-rs | ||
[![Build Status]][actions] [![Latest Version]][crates.io] | ||
[![Build Status]][actions] [![Latest Version]][crates.io] [![Docs badge]][docs.rs] | ||
|
||
|
||
[Build Status]: https://github.com/abetterinternet/libprio-rs/workflows/ci-build/badge.svg | ||
[actions]: https://github.com/abetterinternet/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. | ||
|
||
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 | ||
|
||
## Releases | ||
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. | ||
|
||
We use a GitHub Action to publish a crate named `prio` to [crates.io](https://crates.io). To cut a release and publish: | ||
## Verifiable Distributed Aggregation Function (EXPERIMENTAL) | ||
|
||
- Bump the version number in `Cargo.toml` to e.g. `1.2.3` and merge that change to `main` | ||
- Tag that commit on main as `v1.2.3`, either in `git` or in [GitHub's releases UI](https://github.com/abetterinternet/libprio-rs/releases/new). | ||
- Publish a release in [GitHub's releases UI](https://github.com/abetterinternet/libprio-rs/releases/new). | ||
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 | ||
[Privacy Preserving Measurements][ppm] protocol. This support is still experimental, and is evolving | ||
along with the PPM and VDAF specifications. Formal security analysis is also forthcoming. prio3 | ||
should not yet be used in production applications. | ||
|
||
Publishing the release will automatically publish the updated `prio` crate to `crates.io`. | ||
[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/abetterinternet/prio-server | ||
[vdaf]: https://cjpatton.github.io/vdaf/draft-patton-cfrg-vdaf.html | ||
[ppm]: https://github.com/abetterinternet/ppm-specification |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Releases | ||
|
||
We use a GitHub Action to publish a crate named `prio` to [crates.io](https://crates.io). To cut a | ||
release and publish: | ||
|
||
- Bump the version number in `Cargo.toml` to e.g. `1.2.3` and merge that change to `main` | ||
- Tag that commit on main as `v1.2.3`, either in `git` or in [GitHub's releases UI][releases]. | ||
- Publish a release in [GitHub's releases UI][releases]. | ||
|
||
Publishing the release will automatically publish the updated [`prio` crate][crate]. | ||
|
||
[releases]: https://github.com/abetterinternet/libprio-rs/releases/new | ||
[crate]: https://crates.io/crates/prio |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters