From 6e909131327e896a40bd10041c3e81f083fd804d Mon Sep 17 00:00:00 2001 From: Kevin Lewi Date: Fri, 22 Apr 2022 01:51:16 -0700 Subject: [PATCH] Adding documentation on RegistrationUpload and removing patch voprf in Cargo.toml (#273) --- CHANGELOG.md | 3 +++ Cargo.toml | 5 +---- README.md | 2 +- src/lib.rs | 4 ++++ 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fd55583..6fe8660 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # Changelog +## 2.0.0-pre.2 (April 22, 2022) +* Synced implementation with draft-irtf-cfrg-opaque-08 + ## 2.0.0-pre.1 (March 15, 2022) * Synced implementation with draft-irtf-cfrg-opaque-07 diff --git a/Cargo.toml b/Cargo.toml index 72c660d..d8e3f61 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,7 +9,7 @@ name = "opaque-ke" readme = "README.md" repository = "https://github.com/novifinancial/opaque-ke" rust-version = "1.57" -version = "2.0.0-pre.1" +version = "2.0.0-pre.2" [features] default = ["ristretto255-u64", "ristretto255-voprf", "serde"] @@ -77,6 +77,3 @@ name = "opaque" [package.metadata.docs.rs] features = ["argon2", "std", "x25519-u64"] targets = [] - -[patch.crates-io] -voprf = { git = "https://github.com/novifinancial/voprf", branch = "main" } diff --git a/README.md b/README.md index 7d4a0ed..0ae8830 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Installation Add the following line to the dependencies of your `Cargo.toml`: ``` -opaque-ke = "2.0.0-pre.1" +opaque-ke = "2.0.0-pre.2" ``` ### Minimum Supported Rust Version diff --git a/src/lib.rs b/src/lib.rs index e61f9ff..8ea734c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -90,6 +90,10 @@ //! for each client, and the values consist of their corresponding password //! files, to be retrieved upon future login attempts made by the client. //! +//! Note that the [RegistrationUpload] message contains sensitive information +//! (about as sensitive as a hash of the password), and hence should be +//! protected with confidentiality guarantees by the consumer of this library. +//! //! ### Client Registration Start //! In the first step of registration, the client chooses as input a //! registration password. The client runs [ClientRegistration::start] to