vexahub/opaque-vx
4
0
Fork 0
Code Issues 1 Pull Requests 2 Actions Releases 3 Activity

Changes related to renaming master branch to main (#231)

Browse Source
This commit is contained in:
Kevin Lewi
2021-08-18 13:57:24 -07:00
committed by GitHub
parent 6c7840514d
commit a99a934ead
3 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/main.yml
+1 -1
View File
@@ -2,7 +2,7 @@ name: Rust CI
on: on:
push: push:
branches: branches:
- master - main
pull_request: pull_request:
types: [opened, repoened, synchronize] types: [opened, repoened, synchronize]
CONTRIBUTING.md
+1 -1
View File
@@ -5,7 +5,7 @@ possible.
## Pull Requests ## Pull Requests
We actively welcome your pull requests. We actively welcome your pull requests.
1. Fork the repo and create your branch from `master`. 1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests. 2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation. 3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes. 4. Ensure the test suite passes.
src/lib.rs
+2 -2
View File
@@ -35,7 +35,7 @@
//! type SlowHash = opaque_ke::slow_hash::NoOpHash; //! type SlowHash = opaque_ke::slow_hash::NoOpHash;
//! } //! }
//! ``` //! ```
//! See [examples/simple_login.rs](https://github.com/novifinancial/opaque-ke/blob/master/examples/simple_login.rs) //! See [examples/simple_login.rs](https://github.com/novifinancial/opaque-ke/blob/main/examples/simple_login.rs)
//! for a working example of a simple password-based login using OPAQUE. //! for a working example of a simple password-based login using OPAQUE.
//! //!
//! Note that our choice of slow hashing function in this example, `NoOpHash`, is selected only to ensure //! Note that our choice of slow hashing function in this example, `NoOpHash`, is selected only to ensure
@@ -508,7 +508,7 @@
//! know the password the client uses during registration and login can recover this secret, as it is never exposed to the server. As a result, the export key //! know the password the client uses during registration and login can recover this secret, as it is never exposed to the server. As a result, the export key
//! can be used (separately from the OPAQUE protocol) to provide confidentiality and integrity to other data which only the client should be able to process. //! can be used (separately from the OPAQUE protocol) to provide confidentiality and integrity to other data which only the client should be able to process.
//! For instance, if the server is expected to maintain any client-side secrets which require a password to access, then this export key can be used to encrypt //! For instance, if the server is expected to maintain any client-side secrets which require a password to access, then this export key can be used to encrypt
//! these secrets so that they remain hidden from the server (see [examples/digital_locker.rs](https://github.com/novifinancial/opaque-ke/blob/master/examples/digital_locker.rs) //! these secrets so that they remain hidden from the server (see [examples/digital_locker.rs](https://github.com/novifinancial/opaque-ke/blob/main/examples/digital_locker.rs)
//! for a working example). //! for a working example).
//! //!
//! You can access the export key from the `export_key` field of [ClientRegistrationFinishResult] and [ClientLoginFinishResult]. //! You can access the export key from the `export_key` field of [ClientRegistrationFinishResult] and [ClientLoginFinishResult].