diff --git a/Cargo.lock b/Cargo.lock index 23ee1e83..bf684aab 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -463,6 +463,15 @@ dependencies = [ "zmij", ] +[[package]] +name = "sponge-cursor" +version = "0.1.0" +dependencies = [ + "hex-literal 1.1.0 (registry+https://github.com/rust-lang/crates.io-index)", + "hybrid-array", + "zeroize 1.8.2", +] + [[package]] name = "subtle" version = "2.6.1" diff --git a/Cargo.toml b/Cargo.toml index 85716c18..a674e416 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,6 +11,7 @@ members = [ "dbl", "hex-literal", "inout", + "sponge-cursor", "wycheproof2blb", "zeroize", "zeroize_derive", diff --git a/sponge-cursor/CHANGELOG.md b/sponge-cursor/CHANGELOG.md new file mode 100644 index 00000000..a5d6ec41 --- /dev/null +++ b/sponge-cursor/CHANGELOG.md @@ -0,0 +1,10 @@ +# 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). + +## 0.1.0 (UNRELEASED) +- Initial release ([#1477]) + +[#1477]: https://github.com/RustCrypto/utils/pull/1477 diff --git a/sponge-cursor/Cargo.toml b/sponge-cursor/Cargo.toml new file mode 100644 index 00000000..48de679f --- /dev/null +++ b/sponge-cursor/Cargo.toml @@ -0,0 +1,23 @@ +[package] +name = "sponge-cursor" +version = "0.1.0" +authors = ["RustCrypto Developers"] +edition = "2024" +rust-version = "1.85" +documentation = "https://docs.rs/sponge-cursor" +readme = "README.md" +repository = "https://github.com/RustCrypto/utils" +license = "MIT OR Apache-2.0" +keywords = ["block", "buffer"] +categories = ["cryptography", "no-std"] +description = "Cursor for sponge-based absorption and squeezing" + +[dependencies] +hybrid-array = "0.4" +zeroize = { version = "1.4", optional = true, default-features = false } + +[dev-dependencies] +hex-literal = "1" + +[lints] +workspace = true diff --git a/sponge-cursor/LICENSE-APACHE b/sponge-cursor/LICENSE-APACHE new file mode 100644 index 00000000..78173fa2 --- /dev/null +++ b/sponge-cursor/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/sponge-cursor/LICENSE-MIT b/sponge-cursor/LICENSE-MIT new file mode 100644 index 00000000..4697b3e7 --- /dev/null +++ b/sponge-cursor/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2026 The RustCrypto Project 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/sponge-cursor/README.md b/sponge-cursor/README.md new file mode 100644 index 00000000..a9e52d9a --- /dev/null +++ b/sponge-cursor/README.md @@ -0,0 +1,40 @@ +# [RustCrypto]: Sponge Cursor + +[![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] + +Cursor for sponge-based absorption and squeezing. + +## 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/sponge-cursor.svg +[crate-link]: https://crates.io/crates/sponge-cursor +[docs-image]: https://docs.rs/sponge-cursor/badge.svg +[docs-link]: https://docs.rs/sponge-cursor/ +[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/stream/260052-utils +[build-image]: https://github.com/RustCrypto/utils/actions/workflows/sponge-cursor.yml/badge.svg?branch=master +[build-link]: https://github.com/RustCrypto/utils/actions/workflows/sponge-cursor.yml?query=branch:master + +[//]: # (general links) + +[RustCrypto]: https://github.com/RustCrypto diff --git a/sponge-cursor/src/lib.rs b/sponge-cursor/src/lib.rs new file mode 100644 index 00000000..a284db78 --- /dev/null +++ b/sponge-cursor/src/lib.rs @@ -0,0 +1,236 @@ +#![no_std] +#![doc = include_str!("../README.md")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg", + html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg" +)] + +pub use hybrid_array as array; + +use core::marker::PhantomData; +use hybrid_array::{Array, ArraySize}; + +/// Cursor for implementing sponge-based absorption and squeezing. +/// +/// This type wraps `u8` and enforces that its value is always smaller than `Rate`. +/// +/// `Rate` MUST be smaller than `U256`, trying to initialize cursor with an invalid rate will +/// result in a compilation error. +#[derive(Debug, Clone)] +pub struct SpongeCursor { + pos: u8, + _pd: PhantomData, +} + +impl Default for SpongeCursor { + fn default() -> Self { + const { + assert!(Rate::USIZE != 0); + assert!(Rate::USIZE < u8::MAX as usize); + } + + Self { + pos: 0, + _pd: PhantomData, + } + } +} + +impl SpongeCursor { + /// Absorb bytes from `data` into a `u64`-based state using little ednian byte order. + /// + /// Size of state MUST be greater or equal to `Rate`. Using an invalid `N` will result in + /// a compilation error. + #[allow( + clippy::missing_panics_doc, + reason = "the function is panic-free, see: https://rust.godbolt.org/z/WdordTqvv" + )] + #[inline] + pub fn absorb_u64_le( + &mut self, + state: &mut [u64; N], + sponge: fn(&mut [u64; N]), + mut data: &[u8], + ) { + const { + assert!(Rate::USIZE <= size_of::<[u64; N]>()); + assert!(Rate::USIZE < u8::MAX as usize); + assert!(Rate::USIZE % size_of::() == 0); + }; + + if self.pos != 0 { + let pos = self.pos(); + let rem_len = Rate::USIZE - pos; + + let is_partial = data.len() < rem_len; + let head = if is_partial { + data + } else { + let (head, tail) = data.split_at(rem_len); + data = tail; + head + }; + + xor_in::(state, pos, head); + + if is_partial { + self.pos = u8::try_from(pos + head.len()).expect("the sum is smaller than Rate"); + return; + } + + sponge(state); + } + + let blocks = data.chunks_exact(Rate::USIZE); + let tail = blocks.remainder(); + + for block in blocks { + let chunks = block.chunks_exact(size_of::()); + assert!(chunks.remainder().is_empty()); + + for (dst, chunk) in state.iter_mut().zip(chunks) { + let chunk = chunk.try_into().expect("chunk has correct length"); + *dst ^= u64::from_le_bytes(chunk); + } + + sponge(state); + } + + if !tail.is_empty() { + xor_in::(state, 0, tail); + } + + self.pos = u8::try_from(tail.len()).expect("tail.len() is smaller than Rate"); + } + + /// Squeeze data into `dst`. + #[allow(clippy::missing_panics_doc, reason = "the function is panic-free")] + pub fn squeeze_u64_le( + &mut self, + state: &mut [u64; N], + sponge: fn(&mut [u64; N]), + mut dst: &mut [u8], + ) { + const { + assert!(Rate::USIZE <= size_of::<[u64; N]>()); + assert!(Rate::USIZE < u8::MAX as usize); + assert!(Rate::USIZE % size_of::() == 0); + }; + + if self.pos != 0 { + let pos = self.pos(); + let rem_len = Rate::USIZE - pos; + + let is_partial = dst.len() < rem_len; + let split_pos = if is_partial { dst.len() } else { rem_len }; + + let (head, tail) = dst.split_at_mut(split_pos); + dst = tail; + + read_into::(state, pos, head); + + if is_partial { + self.pos = u8::try_from(pos + head.len()).expect("the sum is smaller than Rate"); + return; + } + } + + let mut blocks = dst.chunks_exact_mut(Rate::USIZE); + + for block in &mut blocks { + sponge(state); + + let mut dst_chunks = block.chunks_exact_mut(size_of::()); + for (src, dst_chunk) in state.iter_mut().zip(&mut dst_chunks) { + dst_chunk.copy_from_slice(&src.to_le_bytes()); + } + assert!(dst_chunks.into_remainder().is_empty()); + } + + let tail = blocks.into_remainder(); + + if !tail.is_empty() { + sponge(state); + read_into::(state, 0, tail); + } + + self.pos = u8::try_from(tail.len()).expect("tail.len() is smaller than Rate"); + } + + /// Get current cursor position. + #[must_use] + #[inline(always)] + pub fn pos(&self) -> usize { + let pos = usize::from(self.pos); + debug_assert!(pos < Rate::USIZE); + if pos < Rate::USIZE { + pos + } else { + // SAFETY: the type enforces that `pos` is always smaller than `Rate` + unsafe { core::hint::unreachable_unchecked() }; + } + } +} + +#[cfg(feature = "zeroize")] +impl zeroize::Zeroize for SpongeCursor { + fn zeroize(&mut self) { + self.pos.zeroize(); + } +} + +#[inline(always)] +fn xor_in(state: &mut [u64; N], offset: usize, data: &[u8]) { + const { + assert!(size_of::>() <= size_of::<[u64; N]>()); + assert!(Rate::USIZE % size_of::() == 0); + }; + + if cfg!(target_endian = "little") { + // SAFETY: casting of `&mut [u64; N]` into `&mut [u8; M]` is safe if + // `size_of::<[u8; M]>() <= size_of::<[u64; N]>())`, + // the same applies to `Array` since it's a transparent wrapper around `[T; N]` + let sub_state: &mut Array = unsafe { &mut *(state.as_mut_ptr().cast()) }; + + let dst = &mut sub_state[offset..][..data.len()]; + + for i in 0..dst.len() { + dst[i] ^= data[i]; + } + } else { + let mut buf = Array::::default(); + buf[offset..][..data.len()].copy_from_slice(data); + + let chunks = buf.chunks_exact(size_of::()); + assert!(chunks.remainder().is_empty()); + + for (dst, chunk) in state.iter_mut().zip(chunks) { + let chunk = chunk.try_into().expect("chunk has correct length"); + *dst ^= u64::from_le_bytes(chunk); + } + } +} + +#[inline(always)] +fn read_into(state: &[u64; N], offset: usize, dst: &mut [u8]) { + const { + assert!(size_of::>() <= size_of::<[u64; N]>()); + assert!(Rate::USIZE % size_of::() == 0); + }; + + if cfg!(target_endian = "little") { + // SAFETY: casting of `&mut [u64; N]` into `&mut [u8; M]` is safe if + // `size_of::<[u8; M]>() <= size_of::<[u64; N]>())`, + // the same applies to `Array` since it's a transparent wrapper around `[T; N]` + let sub_state: &Array = unsafe { &*(state.as_ptr().cast()) }; + dst.copy_from_slice(&sub_state[offset..][..dst.len()]); + } else { + let mut buf = Array::::default(); + let mut chunks = buf.chunks_exact_mut(size_of::()); + for (src, dst) in state.iter().zip(&mut chunks) { + dst.copy_from_slice(&src.to_le_bytes()); + } + assert!(chunks.into_remainder().is_empty()); + dst.copy_from_slice(&buf[offset..][..dst.len()]); + } +} diff --git a/sponge-cursor/tests/mod.rs b/sponge-cursor/tests/mod.rs new file mode 100644 index 00000000..75e75a67 --- /dev/null +++ b/sponge-cursor/tests/mod.rs @@ -0,0 +1 @@ +//! Basic tests