diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..41b2b33 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,8 @@ +[workspace] +resolver = "3" +members = [ + "hmacdrbg" +] + +[profile.dev] +opt-level = 2 diff --git a/hmacdrbg/CHANGELOG.md b/hmacdrbg/CHANGELOG.md new file mode 100644 index 0000000..d6637e0 --- /dev/null +++ b/hmacdrbg/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). diff --git a/hmacdrbg/Cargo.toml b/hmacdrbg/Cargo.toml new file mode 100644 index 0000000..e3c7517 --- /dev/null +++ b/hmacdrbg/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "hmacdrbg" +version = "0.0.1" +description = "Pure Rust implementation of HMAC_DRBG as described in NIST SP800-90A" +authors = ["RustCrypto Developers"] +license = "Apache-2.0 OR MIT" +homepage = "https://github.com/RustCrypto/CSRNGs/tree/master/hmacdrbg" +repository = "https://github.com/RustCrypto/CSRNGs" +readme = "README.md" +categories = ["cryptography", "no-std"] +keywords = ["random", "rng"] +edition = "2024" +rust-version = "1.85" + +[dependencies] +hmac = { version = "0.13", default-features = false } + +[dev-dependencies] +hex-literal = "1" +sha2 = "0.11" diff --git a/hmacdrbg/LICENSE-APACHE b/hmacdrbg/LICENSE-APACHE new file mode 100644 index 0000000..c394d8a --- /dev/null +++ b/hmacdrbg/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 2018-2022 RustCrypto Developers + +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/hmacdrbg/LICENSE-MIT b/hmacdrbg/LICENSE-MIT new file mode 100644 index 0000000..b887850 --- /dev/null +++ b/hmacdrbg/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2018-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/hmacdrbg/README.md b/hmacdrbg/README.md new file mode 100644 index 0000000..9f8d987 --- /dev/null +++ b/hmacdrbg/README.md @@ -0,0 +1,48 @@ +# [RustCrypto]: HMAC_DRBG + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Build Status][build-image]][build-link] +![Apache2/MIT licensed][license-image] +![MSRV][rustc-image] + +Pure Rust implementation of the `HMAC_DRBG` HMAC-based deterministic random bit generator as +described in [NIST SP800-90A]. + +## Minimum Supported Rust Version + +This crate requires **Rust 1.85** at a minimum. + +We may change the MSRV in the future, but it will be accompanied by a minor +version bump. + +## License + +All crates licensed under either of + + * [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) + * [MIT license](https://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/hmacdrbg?logo=rust +[crate-link]: https://crates.io/crates/hmacdrbg +[docs-image]: https://docs.rs/hmacdrbg/badge.svg +[docs-link]: https://docs.rs/hmacdrbg/ +[build-image]: https://github.com/RustCrypto/CSRNGs/actions/workflows/hmacdrbg.yml/badge.svg +[build-link]: https://github.com/RustCrypto/CSRNGs/actions/workflows/hmacdrbg.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 + +[//]: # (links) + +[RustCrypto]: https://github.com/RustCrypto +[NIST SP800-90A]: https://csrc.nist.gov/publications/detail/sp/800-90a/rev-1/final diff --git a/hmacdrbg/src/lib.rs b/hmacdrbg/src/lib.rs new file mode 100644 index 0000000..3ae79c1 --- /dev/null +++ b/hmacdrbg/src/lib.rs @@ -0,0 +1,113 @@ +#![no_std] +#![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" +)] + +use core::fmt::{self, Debug}; +use hmac::{ + KeyInit, SimpleHmacReset, + digest::{Digest, FixedOutputReset, Mac, array::Array, block_api::BlockSizeUser}, +}; + +/// Implementation of the `HMAC_DRBG` HMAC-based deterministic random bit generator as described in +/// [NIST SP800-90A]. +/// +/// [NIST SP800-90A]: https://csrc.nist.gov/publications/detail/sp/800-90a/rev-1/final +pub struct HmacDrbg +where + D: Digest + BlockSizeUser + FixedOutputReset, +{ + /// HMAC key `K` (see RFC 6979 Section 3.2.c) + k: SimpleHmacReset, + + /// Chaining value `V` (see RFC 6979 Section 3.2.c) + v: Array, +} + +impl HmacDrbg +where + D: Digest + BlockSizeUser + FixedOutputReset, +{ + /// Initialize `HMAC_DRBG`. + #[must_use] + #[allow(clippy::missing_panics_doc, reason = "should not panic")] + pub fn new(entropy_input: &[u8], nonce: &[u8], personalization_string: &[u8]) -> Self { + let mut k = SimpleHmacReset::new(&Default::default()); + let mut v = Array::default(); + + v.fill(0x01); + + for i in 0..=1 { + k.update(&v); + k.update(&[i]); + k.update(entropy_input); + k.update(nonce); + k.update(personalization_string); + k = SimpleHmacReset::new_from_slice(&k.finalize().into_bytes()).expect("should work"); + + // Steps 3.2.e,g: v = HMAC_k(v) + k.update(&v); + v = k.finalize_reset().into_bytes(); + } + + Self { k, v } + } + + /// Write the next `HMAC_DRBG` output to the given byte slice. + #[allow(clippy::missing_panics_doc, reason = "should not panic")] + pub fn fill_bytes(&mut self, out: &mut [u8]) { + let mut out_chunks = out.chunks_exact_mut(self.v.len()); + + for out_chunk in &mut out_chunks { + self.k.update(&self.v); + self.v = self.k.finalize_reset().into_bytes(); + out_chunk.copy_from_slice(&self.v[..out_chunk.len()]); + } + + let out_remainder = out_chunks.into_remainder(); + if !out_remainder.is_empty() { + self.k.update(&self.v); + self.v = self.k.finalize_reset().into_bytes(); + out_remainder.copy_from_slice(&self.v[..out_remainder.len()]); + } + + self.k.update(&self.v); + self.k.update(&[0x00]); + self.k = SimpleHmacReset::new_from_slice(&self.k.finalize_reset().into_bytes()) + .expect("should work"); + self.k.update(&self.v); + self.v = self.k.finalize_reset().into_bytes(); + } +} + +impl Debug for HmacDrbg +where + D: Digest + BlockSizeUser + FixedOutputReset, +{ + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + f.debug_struct("HmacDrbg").finish_non_exhaustive() + } +} + +#[cfg(test)] +mod tests { + use super::HmacDrbg; + use hex_literal::hex; + use sha2::Sha256; + + // ECDSA with K-163+SHA-256. + #[test] + fn rfc6979_appendix_a1_k163() { + let x = hex!("009A4D6792295A7F730FC3F2B49CBC0F62E862272F"); + + // NOTE: this input is `SHA256("sample")` with `bits2octets` applied in advance + let h = hex!("01795EDF0D54DB760F156D0DAC04C0322B3A204224"); + + let mut drbg = HmacDrbg::::new(&x, &h, &[]); + let mut out = [0u8; 21]; + drbg.fill_bytes(&mut out); + assert_eq!(out, hex!("9305A46DE7FF8EB107194DEBD3FD48AA20D5E7656C")); + } +}