diff --git a/.github/workflows/pake.yml b/.github/workflows/pake.yml new file mode 100644 index 000000000..415ca967c --- /dev/null +++ b/.github/workflows/pake.yml @@ -0,0 +1,55 @@ +name: pake + +on: + pull_request: + paths: + - "kdf/**" + - "pake/**" + - "Cargo.*" + push: + branches: master + +defaults: + run: + working-directory: pake + +env: + CARGO_INCREMENTAL: 0 + RUSTFLAGS: "-Dwarnings" + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + rust: + - 1.85.0 # MSRV + - stable + target: + - thumbv7em-none-eabi + - wasm32-unknown-unknown + steps: + - uses: actions/checkout@v4 + - uses: RustCrypto/actions/cargo-cache@master + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.rust }} + targets: ${{ matrix.target }} + - run: cargo build --no-default-features --release --target ${{ matrix.target }} + + test: + runs-on: ubuntu-latest + strategy: + matrix: + rust: + - 1.85.0 # MSRV + - stable + steps: + - uses: actions/checkout@v4 + - uses: RustCrypto/actions/cargo-cache@master + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.rust }} + - run: cargo check --all-features + - run: cargo test + - run: cargo test --release diff --git a/Cargo.lock b/Cargo.lock index cbbe20065..4eec6d7ad 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -290,6 +290,12 @@ dependencies = [ name = "kdf" version = "0.1.0-pre.0" +[[package]] +name = "kdf" +version = "0.1.0-pre.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c47f30a65a0a4e5d66cb07522714cd3eeafda0afac011e6797d1fbd939098bc5" + [[package]] name = "kem" version = "0.4.0-rc.2" @@ -343,6 +349,13 @@ dependencies = [ "portable-atomic", ] +[[package]] +name = "pake" +version = "0.0.0" +dependencies = [ + "kdf 0.1.0-pre.0 (registry+https://github.com/rust-lang/crates.io-index)", +] + [[package]] name = "password-hash" version = "0.6.0-rc.8" diff --git a/Cargo.toml b/Cargo.toml index e8146b79d..12d4c742e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,6 +9,7 @@ members = [ "elliptic-curve", "kdf", "kem", + "pake", "password-hash", "universal-hash", "signature", diff --git a/pake/Cargo.toml b/pake/Cargo.toml new file mode 100644 index 000000000..04fb02d10 --- /dev/null +++ b/pake/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "pake" +version = "0.0.0" +authors = ["RustCrypto Developers"] +edition = "2024" +rust-version = "1.85" +documentation = "https://docs.rs/pake" +readme = "README.md" +repository = "https://github.com/RustCrypto/traits" +license = "Apache-2.0 OR MIT" +keywords = ["crypto", "pake"] +categories = ["cryptography", "no-std"] +description = """ +Traits which describe the functionality of [Password-Authenticated Key Exchange] (PAKE) algorithms, which can be used to +establish a shared secret over an insecure channel using only the client's knowledge of a password and the server's +knowledge of a password hash for authentication, without the client revealing their plaintext password to the server +""" + +[dependencies] +kdf = "0.1.0-pre.0" diff --git a/pake/LICENSE-APACHE b/pake/LICENSE-APACHE new file mode 100644 index 000000000..78173fa2e --- /dev/null +++ b/pake/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/pake/LICENSE-MIT b/pake/LICENSE-MIT new file mode 100644 index 000000000..3b4cbedfb --- /dev/null +++ b/pake/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2026 RustCrypto Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/pake/README.md b/pake/README.md new file mode 100644 index 000000000..f68f24f8c --- /dev/null +++ b/pake/README.md @@ -0,0 +1,52 @@ +# [RustCrypto]: Password-Authenticated Key Exchange + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Build Status][build-image]][build-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] + +Traits which describe the functionality of [Password-Authenticated Key Exchange] (PAKE) algorithms. + +## About + +Password-Authenticated Key Exchange (PAKE) algorithms can be used to establish a shared secret over an insecure channel +using only the client's knowledge of a password and the server's knowledge of a password hash for authentication. They +can be thought of like other authenticated key exchange algorithms, like the ones in TLS which use X.509 certificates +for identity, but where the identity is entirely established by the user's username and password, all without the client +ever revealing their plaintext password to the server. + +## License + +Licensed under either of + + * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) + * [MIT license](http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +[//]: # (badges) + +[crate-image]: https://img.shields.io/crates/v/pake.svg +[crate-link]: https://crates.io/crates/pake +[docs-image]: https://docs.rs/pake/badge.svg +[docs-link]: https://docs.rs/pake/ +[build-image]: https://github.com/RustCrypto/traits/actions/workflows/pake.yml/badge.svg +[build-link]: https://github.com/RustCrypto/traits/actions/workflows/pake.yml +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg +[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg +[chat-link]: https://rustcrypto.zulipchat.com/#narrow/channel/260043-KDFs + +[//]: # (links) + +[RustCrypto]: https://github.com/RustCrypto +[Password-Authenticated Key Exchange]: https://en.wikipedia.org/wiki/Password-authenticated_key_agreement#Types +[password hashing functions]: https://en.wikipedia.org/wiki/Key_derivation_function#Password_hashing diff --git a/pake/src/lib.rs b/pake/src/lib.rs new file mode 100644 index 000000000..6557de3cd --- /dev/null +++ b/pake/src/lib.rs @@ -0,0 +1,123 @@ +#![no_std] +#![cfg_attr(docsrs, feature(doc_cfg))] +#![doc = include_str!("../README.md")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg", + html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg" +)] +#![forbid(unsafe_code)] +#![warn(missing_docs, unused_qualifications)] + +use core::fmt; +use kdf::Pbkdf; + +/// PAKE algorithm. +pub trait Pake { + /// Client's proof of validity. + type ClientProof: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Handshake state type. + type HandshakeState: HandshakeState< + ClientProof = Self::ClientProof, + ServerProof = Self::ServerProof, + SharedSecret = Self::SharedSecret, + >; + + /// Verifier of a given user's identity. + type UserVerifier: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Server's proof of validity. + type ServerProof: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Server's verifier for client proofs. + type ServerProofVerifier: ProofVerifier< + Proof = Self::ClientProof, + VerificationProof = Self::ServerProof, + SharedSecret = Self::SharedSecret, + >; + + /// Shared secret type. + type SharedSecret: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Generate the verifier for a given username, password, and salt which can be used in + /// subsequent password-based authentication attempts. + fn generate_user_verifier( + &self, + username: &[u8], + password: &[u8], + salt: &[u8], + ) -> Result; + + /// Initialize a new handshake state for the given user. + fn init_handshake( + &self, + username: &[u8], + verifier: &Self::UserVerifier, + ) -> (Self::HandshakeState, Self::ServerProofVerifier); +} + +/// PAKE handshake state obtained from server. +pub trait HandshakeState: for<'a> TryFrom<&'a [u8]> { + /// Client's proof of validity. + type ClientProof: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Client's verifier for the server's proof. + type ClientProofVerifier: ProofVerifier< + Proof = Self::ServerProof, + VerificationProof = Self::ClientProof, + SharedSecret = Self::SharedSecret, + >; + + /// Serialization of a handshake. + type SerializedHandshake: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Server's proof of validity. + type ServerProof: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Shared secret type. + type SharedSecret: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Serialize this handshake state as a bytestring. + fn to_bytes(&self) -> Self::SerializedHandshake; + + /// Generate the client-side proof. + fn client_proof( + &self, + username: &[u8], + password: &[u8], + salt: &[u8], + ) -> Result<(Self::ClientProof, Self::ClientProofVerifier)>; +} + +/// Proof verifier which outputs a shared secret upon success. +pub trait ProofVerifier { + /// Proof type to be verified. + type Proof: AsRef<[u8]>; + + /// Proof we correctly verified the input proof. + type VerificationProof: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Shared secret to be output upon success. + type SharedSecret: AsRef<[u8]> + for<'a> TryFrom<&'a [u8]>; + + /// Verify the given proof, returning a shared secret upon success. + fn verify_proof( + &self, + proof: &Self::Proof, + ) -> Result<(Self::VerificationProof, Self::SharedSecret)>; +} + +/// PAKE errors. +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub struct Error; + +impl fmt::Display for Error { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str("PAKE error") + } +} + +impl core::error::Error for Error {} + +/// Result type with the `pake` crate's [`Error`]. +pub type Result = core::result::Result;