docs: add details for client login final step #358
Merged
Conversation
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
|
Hi @lucab! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
lucab
force-pushed
the
ups/doc-client-login-finish
branch
from
61e0109
to
44a90b8
Compare
|
@kevinlewi thanks for maintaining this library! |
kevinlewi
force-pushed
the
ups/doc-client-login-finish
branch
from
44a90b8
to
a3beffe
Compare
This tweaks the documentation on the main module, in order to add some details on the outcome of the client login final step. In particular, it clarifies the result of `ClientLogin::finish()` both on success and on errors and it adds some intra-crate links to the relevant structures and fields.
kevinlewi
force-pushed
the
ups/doc-client-login-finish
branch
from
a3beffe
to
2ead83f
Compare
kevinlewi
added a commit
that referenced
this pull request
Oct 10, 2024
* Fix Clippy (#289) * Add Dependabot (#287) * Fix Clippy * Add Dependabot * Bump actions/checkout from 2 to 3 (#291) Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v2...v3) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump actions/cache from 2 to 3 (#292) Bumps [actions/cache](https://github.com/actions/cache) from 2 to 3. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v2...v3) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update dependencies (#288) * Fix Clippy * Update dependencies * Fix CI (#298) * Rename X25519 to Curve25519 (#302) * Update `curve25519-dalek` to 4.0.0-pre.5 (#301) * Update `curve25519-dalek` * Improve documentation * Update `voprf` to 0.5.0-pre.1 * Bump `voprf` to v0.5.0-pre.2 (#304) * Only use explicit crate features (#306) * Publishing v3.0.0-pre.1 (#309) * Update `rustyline` to v0.11 (#313) * Update VOPRF to draft 19 (#307) * Update `argon2` to v0.5 (#314) * Test P-384 (#290) * Update scrypt requirement from 0.10 to 0.11 (#315) Updates the requirements on [scrypt](https://github.com/RustCrypto/password-hashes) to permit the latest version. - [Release notes](https://github.com/RustCrypto/password-hashes/releases) - [Commits](RustCrypto/password-hashes@scrypt-v0.10.0...scrypt-v0.11.0) --- updated-dependencies: - dependency-name: scrypt dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Publishing v3.0.0-pre.2 (#318) * Bump `voprf` to v0.5.0-pre.4 (#322) * Correctly clamp Curve25519 secret keys (#323) * Curve25519 test vectors (#319) * Curve25519 test vectors * Adjust `derive_auth_keypair()` for Curve25519 * Update test vectors * Fix Curve25519 random scalar generation Co-Authored-By: Kevin Lewi <[email protected]> * Update test vectors * Update test vectors * Update test vectors --------- Co-authored-by: Kevin Lewi <[email protected]> * Updating dual-license language (#324) * Update criterion requirement from 0.4 to 0.5 (#325) Updates the requirements on [criterion](https://github.com/bheisler/criterion.rs) to permit the latest version. - [Changelog](https://github.com/bheisler/criterion.rs/blob/master/CHANGELOG.md) - [Commits](bheisler/criterion.rs@0.4.0...0.5.0) --- updated-dependencies: - dependency-name: criterion dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update keypair generation to use derive_auth_keypair (#326) * Fixing simple_login test to enable argon2 feature (#328) * Publishing v3.0.0-pre.3 (#327) * Update rustyline requirement from 11 to 12 (#332) Updates the requirements on [rustyline](https://github.com/kkawakam/rustyline) to permit the latest version. - [Release notes](https://github.com/kkawakam/rustyline/releases) - [Changelog](https://github.com/kkawakam/rustyline/blob/master/History.md) - [Commits](kkawakam/rustyline@v11.0.0...v12.0.0) --- updated-dependencies: - dependency-name: rustyline dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * update parameter from sk to private_key (#329) * Bump `curve25519-dalek` to v4.0.0-rc.3 (#330) * add more resources (WebAssembly and React Native) (#335) * add more resources (WebAssembly and React Native) * Fixing clippy --------- Co-authored-by: Kevin Lewi <[email protected]> * Publishing v3.0.0-pre.4 (#337) * update docs: clarify export_key and session_key length (#338) * Increase MSRV to 1.70 and update workflow dependencies (#342) * Clarifying the persisting of server setup (#344) * Add `clippy::doc_markdown` (#346) * Fixing clippy errors (#347) * Test P-521 (#349) * Test P-521 * De-duplicate generic calls * Simplify full test vectors generation * Adding copyright header to generated test file (#351) * Update rustyline requirement from 12 to 13 (#352) Updates the requirements on [rustyline](https://github.com/kkawakam/rustyline) to permit the latest version. - [Release notes](https://github.com/kkawakam/rustyline/releases) - [Changelog](https://github.com/kkawakam/rustyline/blob/master/History.md) - [Commits](kkawakam/rustyline@v12.0.0...v13.0.0) --- updated-dependencies: - dependency-name: rustyline dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump actions/cache from 3 to 4 (#354) Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v3...v4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Updating dependencies (#360) * docs: add details for client login final step (#358) This tweaks the documentation on the main module, in order to add some details on the outcome of the client login final step. In particular, it clarifies the result of `ClientLogin::finish()` both on success and on errors and it adds some intra-crate links to the relevant structures and fields. * Publishing v3.0.0-pre.5 (#364) * Revert "Update keypair generation to use derive_auth_keypair (#326)" This reverts commit deb7ca3. * Fixups to keep in sync with draft-10 --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: daxpedda <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Nik Graf <[email protected]> Co-authored-by: Luca Bruno <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This tweaks the documentation on the main module, in order to add some details on the outcome of the client login final step. In particular, it clarifies the result of
ClientLogin::finish()both on success and on errors and it adds some intra-crate links to the relevant structures and fields.