sponge-cursor-0.1.0/.cargo_vcs_info.json0000644000000001531046102023000136610ustar { "git": { "sha1": "9c8674f4fdf00fb524cd06d89da29d125db07582" }, "path_in_vcs": "sponge-cursor" }sponge-cursor-0.1.0/CHANGELOG.md000064400000000000000000000005461046102023000142460ustar 00000000000000# 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 (2026-05-08) - Initial release ([#1477]) [#1477]: https://github.com/RustCrypto/utils/pull/1477 sponge-cursor-0.1.0/Cargo.lock0000644000000023151046102023000116360ustar # This file is automatically @generated by Cargo. # It is not intended for manual editing. version = 4 [[package]] name = "cfg-if" version = "1.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801" [[package]] name = "cpufeatures" version = "0.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8b2a41393f66f16b0823bb79094d54ac5fbd34ab292ddafb9a0456ac9f87d201" dependencies = [ "libc", ] [[package]] name = "keccak" version = "0.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9e24a010dd405bd7ed803e5253182815b41bf2e6a80cc3bfc066658e03a198aa" dependencies = [ "cfg-if", "cpufeatures", ] [[package]] name = "libc" version = "0.2.182" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6800badb6cb2082ffd7b6a67e6125bb39f18782f793520caee8cb8846be06112" [[package]] name = "sponge-cursor" version = "0.1.0" dependencies = [ "keccak", "zeroize", ] [[package]] name = "zeroize" version = "1.8.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b97154e67e32c85465826e8bcc1c59429aaaf107c1e4a9e53c8d8ccd5eff88d0" sponge-cursor-0.1.0/Cargo.toml0000644000000044021046102023000116600ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2024" rust-version = "1.85" name = "sponge-cursor" version = "0.1.0" authors = ["RustCrypto Developers"] build = false autolib = false autobins = false autoexamples = false autotests = false autobenches = false description = "Cursor for sponge-based absorption and squeezing" documentation = "https://docs.rs/sponge-cursor" readme = "README.md" keywords = [ "block", "buffer", ] categories = [ "cryptography", "no-std", ] license = "MIT OR Apache-2.0" repository = "https://github.com/RustCrypto/utils" [lib] name = "sponge_cursor" path = "src/lib.rs" [[test]] name = "mod" path = "tests/mod.rs" [dependencies.zeroize] version = "1.4" optional = true default-features = false [dev-dependencies.keccak] version = "0.2" [lints.clippy] borrow_as_ptr = "warn" cast_lossless = "warn" cast_possible_truncation = "warn" cast_possible_wrap = "warn" cast_precision_loss = "warn" cast_sign_loss = "warn" checked_conversions = "warn" doc_markdown = "warn" from_iter_instead_of_collect = "warn" implicit_saturating_sub = "warn" manual_assert = "warn" map_unwrap_or = "warn" missing_errors_doc = "warn" missing_panics_doc = "warn" mod_module_files = "warn" must_use_candidate = "warn" needless_range_loop = "allow" ptr_as_ptr = "warn" redundant_closure_for_method_calls = "warn" ref_as_ptr = "warn" return_self_not_must_use = "warn" semicolon_if_nothing_returned = "warn" std_instead_of_alloc = "warn" std_instead_of_core = "warn" trivially_copy_pass_by_ref = "warn" undocumented_unsafe_blocks = "warn" unnecessary_safety_comment = "warn" unwrap_in_result = "warn" unwrap_used = "warn" [lints.rust] missing_copy_implementations = "warn" missing_debug_implementations = "warn" missing_docs = "warn" trivial_casts = "warn" trivial_numeric_casts = "warn" unused_lifetimes = "warn" unused_qualifications = "warn" sponge-cursor-0.1.0/Cargo.toml.orig000064400000000000000000000010621046102023000153160ustar 00000000000000[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] zeroize = { version = "1.4", optional = true, default-features = false } [dev-dependencies] keccak = "0.2" [lints] workspace = true sponge-cursor-0.1.0/LICENSE-APACHE000064400000000000000000000251411046102023000143570ustar 00000000000000 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. sponge-cursor-0.1.0/LICENSE-MIT000064400000000000000000000020651046102023000140670ustar 00000000000000Copyright (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. sponge-cursor-0.1.0/README.md000064400000000000000000000030101046102023000137010ustar 00000000000000# [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 sponge-cursor-0.1.0/src/lib.rs000064400000000000000000000156431046102023000143440ustar 00000000000000#![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" )] mod u64_le_utils; /// 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 `256`, trying to initialize cursor with an invalid rate will /// result in a compilation error. #[derive(Debug, Clone, Eq, PartialEq, Hash)] pub struct SpongeCursor { pos: u8, } impl Default for SpongeCursor { fn default() -> Self { const { assert!(RATE != 0); assert!(RATE < u8::MAX as usize); } Self { pos: 0 } } } // Note that the methods should compile into a panic-free code, // see: https://rust.godbolt.org/z/r93WE8zq3 impl SpongeCursor { /// Create new cursor with the provided position. /// /// Returns `None` if `pos` is bigger or equal to `RATE`. #[must_use] pub fn new(pos: u8) -> Option { if usize::from(pos) < RATE { Some(Self { pos }) } else { None } } /// Get current cursor position as `u8`. #[must_use] #[inline(always)] #[allow(clippy::missing_panics_doc, reason = "the method is panic-free")] pub fn raw_pos(&self) -> u8 { let rate_u8 = u8::try_from(RATE).expect("RATE is smaller than 256"); debug_assert!(self.pos < rate_u8); if self.pos < rate_u8 { self.pos } else { // SAFETY: the type enforces that `pos` is always smaller than `RATE` unsafe { core::hint::unreachable_unchecked() }; } } /// Get current cursor position as `usize`. #[must_use] #[inline(always)] pub fn pos(&self) -> usize { let pos = usize::from(self.pos); debug_assert!(pos < RATE); if pos < RATE { pos } else { // SAFETY: the type enforces that `pos` is always smaller than `RATE` unsafe { core::hint::unreachable_unchecked() }; } } /// Set new cursor position. /// /// # Panics /// If `new_pos` is greater or equal to `RATE`. fn set_pos(&mut self, new_pos: usize) { assert!(new_pos < RATE); self.pos = u8::try_from(new_pos).expect("`new_pos` is smaller than `RATE`"); } /// Absorb bytes from `data` into `state` using little-endian byte order. /// /// Size of `state` in bytes MUST be greater or equal to `RATE`. /// Using an invalid `N` will result in a compilation error. #[allow(clippy::missing_panics_doc, reason = "the method is panic-free")] #[inline] pub fn absorb_u64_le( &mut self, state: &mut [u64; N], sponge: fn(&mut [u64; N]), mut data: &[u8], ) { const { assert!(RATE <= size_of::<[u64; N]>()); assert!(RATE < u8::MAX as usize); assert!(RATE % size_of::() == 0); }; if self.pos != 0 { let pos = self.pos(); let rem_len = RATE .checked_sub(pos) .expect("`pos` is always smaller than `RATE`"); if data.len() < rem_len { u64_le_utils::absorb_partial::(state, pos, data); self.set_pos(pos + data.len()); return; } let (head, tail) = data.split_at(rem_len); data = tail; u64_le_utils::absorb_partial::(state, pos, head); sponge(state); } let blocks = data.chunks_exact(RATE); let tail = blocks.remainder(); for block in blocks { let block: &[u8; RATE] = block.try_into().expect("`block` has correct size"); u64_le_utils::absorb_full(state, block); sponge(state); } if !tail.is_empty() { u64_le_utils::absorb_partial::(state, 0, tail); } self.set_pos(tail.len()); } /// Squeeze data from `state` by reading it into `buf` using little-endian byte order. /// /// Size of `state` in bytes MUST be greater or equal to `RATE`. /// Using an invalid `N` will result in a compilation error. #[inline] pub fn squeeze_read_u64_le( &mut self, state: &mut [u64; N], sponge: fn(&mut [u64; N]), buf: &mut [u8], ) { self.squeeze_inner_u64_le( state, sponge, buf, u64_le_utils::squeeze_read_partial::, u64_le_utils::squeeze_read_full, ); } /// Squeeze data from `state` by XOR-ing it with data in `buf` using little-endian byte order. /// /// Size of `state` in bytes MUST be greater or equal to `RATE`. /// Using an invalid `N` will result in a compilation error. #[inline] pub fn squeeze_xor_u64_le( &mut self, state: &mut [u64; N], sponge: fn(&mut [u64; N]), buf: &mut [u8], ) { self.squeeze_inner_u64_le( state, sponge, buf, u64_le_utils::squeeze_xor_partial::, u64_le_utils::squeeze_xor_full, ); } /// Squeeze data by calling custom functions using little-endian byte order. #[inline(always)] fn squeeze_inner_u64_le( &mut self, state: &mut [u64; N], sponge: fn(&mut [u64; N]), mut buf: &mut [u8], process_partial: fn(&[u64; N], usize, &mut [u8]), process_full: fn(&[u64; N], &mut [u8; RATE]), ) { const { assert!(RATE <= size_of::<[u64; N]>()); assert!(RATE < u8::MAX as usize); assert!(RATE % size_of::() == 0); }; if self.pos != 0 { let pos = self.pos(); let rem_len = RATE - pos; if buf.len() < rem_len { process_partial(state, pos, buf); self.set_pos(pos + buf.len()); return; } let (head, tail) = buf.split_at_mut(rem_len); buf = tail; process_partial(state, pos, head); } let mut blocks = buf.chunks_exact_mut(RATE); for block in &mut blocks { sponge(state); let block = block.try_into().expect("`block` has correct size"); process_full(state, block); } let tail = blocks.into_remainder(); if !tail.is_empty() { sponge(state); process_partial(state, 0, tail); } self.set_pos(tail.len()); } } #[cfg(feature = "zeroize")] impl zeroize::Zeroize for SpongeCursor { fn zeroize(&mut self) { self.pos.zeroize(); } } sponge-cursor-0.1.0/src/u64_le_utils.rs000064400000000000000000000114121046102023000161020ustar 00000000000000//! Utility functions. //! //! Note that support of big-endian targets is somewhat sub-optimal since we prioritized //! simplicity of the implementation. #[inline(always)] pub(crate) fn absorb_full( state: &mut [u64; N], block: &[u8; RATE], ) { const { assert!(size_of::<[u8; RATE]>() <= size_of::<[u64; N]>()); assert!(RATE % size_of::() == 0); }; 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); } } #[inline(always)] pub(crate) fn absorb_partial( state: &mut [u64; N], offset: usize, data: &[u8], ) { const { assert!(size_of::<[u8; RATE]>() <= size_of::<[u64; N]>()); assert!(RATE % 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]>())` let sub_state: &mut [u8; RATE] = 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 = [0u8; RATE]; 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)] pub(crate) fn squeeze_read_full( state: &[u64; N], dst: &mut [u8; RATE], ) { const { assert!(size_of::<[u8; RATE]>() <= size_of::<[u64; N]>()); assert!(RATE % size_of::() == 0); }; let mut dst_chunks = dst.chunks_exact_mut(size_of::()); for (src, dst_chunk) in state.iter().zip(&mut dst_chunks) { dst_chunk.copy_from_slice(&src.to_le_bytes()); } assert!(dst_chunks.into_remainder().is_empty()); } #[inline(always)] pub(crate) fn squeeze_read_partial( state: &[u64; N], offset: usize, dst: &mut [u8], ) { const { assert!(size_of::<[u8; RATE]>() <= size_of::<[u64; N]>()); assert!(RATE % size_of::() == 0); }; let mut buf = [0u8; RATE]; let sub_state: &[u8; RATE] = if cfg!(target_endian = "little") { // SAFETY: casting of `&[u64; N]` into `&[u8; M]` is safe if // `size_of::<[u8; M]>() <= size_of::<[u64; N]>())` unsafe { &*(state.as_ptr().cast::<[u8; RATE]>()) } } else { 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()); &buf }; let src = &sub_state[offset..][..dst.len()]; dst.copy_from_slice(src); } #[inline(always)] pub(crate) fn squeeze_xor_full( state: &[u64; N], dst: &mut [u8; RATE], ) { const { assert!(size_of::<[u8; RATE]>() <= size_of::<[u64; N]>()); assert!(RATE % size_of::() == 0); }; let mut dst_chunks = dst.chunks_exact_mut(size_of::()); for (src, dst_chunk) in state.iter().zip(&mut dst_chunks) { let dst_chunk: &mut [u8; 8] = dst_chunk.try_into().expect("chunk has correct size"); let chunk_val = u64::from_le_bytes(*dst_chunk); *dst_chunk = (chunk_val ^ src).to_le_bytes(); } assert!(dst_chunks.into_remainder().is_empty()); } #[inline(always)] pub(crate) fn squeeze_xor_partial( state: &[u64; N], offset: usize, dst: &mut [u8], ) { const { assert!(size_of::<[u8; RATE]>() <= size_of::<[u64; N]>()); assert!(RATE % size_of::() == 0); }; let mut buf = [0u8; RATE]; let sub_state: &[u8; RATE] = if cfg!(target_endian = "little") { // SAFETY: casting of `&[u64; N]` into `&[u8; M]` is safe if // `size_of::<[u8; M]>() <= size_of::<[u64; N]>())` unsafe { &*(state.as_ptr().cast::<[u8; RATE]>()) } } else { 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()); &buf }; let src = &sub_state[offset..][..dst.len()]; for i in 0..dst.len() { dst[i] ^= src[i]; } } sponge-cursor-0.1.0/tests/data/squeeze.bin000064400000000000000000000007641046102023000166650ustar 00000000000000亨詛躨姦髁+f蔙[jG蔩鐷45m爀3璠F痸6嫠綸9襭7欫m%罀^锉cF豸鍈妳$;Lro霻▂鳛L +)/戃从讎斞?鈴$0`e鞣綵S櫈,/餒@G皍z/g羄1谲薩礁:`aI?z-洰娕&e樂 綸F瀨4EP引$闿徻沤犮旟&琡TBh:h`芲]m阂簻2嫶朻<偒Z堛芅殯q瓕E獢v庣I閴狔Ve1繮鏿G餑柈鲈V}咼Xzチ戦s;產胖NB汛#V9 吴〖'唷I僶"濱*蝯HX敀h设筨bx賌.c驵/ⅷ]捕y猩版p樖9%吚{r臻)T趬1c/ M駟⺳〡菾+Z啎ǚdt愘+ ㄏ殥埕1*#]件}t漖L2%潊K瘞馝b]4V閻派g.劀Wo圡c>晄罃1┳Z&毽鑹6榷 |sponge-cursor-0.1.0/tests/mod.rs000064400000000000000000000100521046102023000147150ustar 00000000000000//! Basic tests use keccak::{Keccak, State1600}; use sponge_cursor::SpongeCursor; const DATA_LEN: usize = 500; const CHUNK_SIZES: &[usize] = &[1, 17, 133, 139, 203, 300]; static SHORT_DATA: [u8; 12] = *b"hello world!"; #[allow(clippy::cast_possible_truncation)] static LONG_DATA: [u8; DATA_LEN] = { let mut buf = [0u8; DATA_LEN]; let mut i = 0; while i < buf.len() { buf[i] = (i % 217) as u8; i += 1; } buf }; static CONCAT_DATA: [u8; SHORT_DATA.len() + DATA_LEN] = { let mut buf = [0u8; SHORT_DATA.len() + DATA_LEN]; // TODO(MSRV-1.87): use `copy_from_slice` let mut i = 0; while i < buf.len() { buf[i] = if i < SHORT_DATA.len() { SHORT_DATA[i] } else { LONG_DATA[i - SHORT_DATA.len()] }; i += 1; } buf }; static STATE: State1600 = [ 0xB2970DE4121985B5, 0x29C223B87687A340, 0x4A146BF36ABB1CC8, 0x3D3BCBE920587765, 0x8293EBA8BC356351, 0x329C7414B019521A, 0x5E733DF382609717, 0x20F3B803705BCC28, 0xB1A1DCC9DC4FCD20, 0x084A6874972249D7, 0x85C9D5D5437F2081, 0x84E9EDD8482329E0, 0x2E6259B24480185D, 0x9B9F2680A9872C6A, 0xCB08DC6DF5ADBB78, 0x12BBABF030B4A3DE, 0x82F72D4928A50AE4, 0x1D071289E249ACB5, 0x701BC30DFA4E5DF5, 0xBA4910413F89A74E, 0x3CCD8011250F3584, 0x9548960143837F4C, 0xC025CF3059BE5E14, 0x0863BB97DA339D82, 0x207CEB1D10C336C4, ]; static SQUEEZE_DATA: &[u8; DATA_LEN] = include_bytes!("data/squeeze.bin"); #[test] fn keccak_test() { Keccak::new().with_p1600::<1>(|p1600| { let mut cursor = SpongeCursor::<136>::default(); let mut state = State1600::default(); cursor.absorb_u64_le(&mut state, p1600, &SHORT_DATA); assert_eq!(state[0], 0x6F77_206F_6C6C_6568); assert_eq!(state[1], 0x0000_0000_2164_6C72); assert!(state[2..].iter().all(|v| *v == 0)); assert_eq!(cursor.pos(), SHORT_DATA.len()); assert_eq!(usize::from(cursor.raw_pos()), SHORT_DATA.len()); let short_len = u8::try_from(SHORT_DATA.len()).unwrap(); assert_eq!(cursor, SpongeCursor::new(short_len).unwrap()); let expected_pos = (SHORT_DATA.len() + LONG_DATA.len()) % 136; for &chunk_size in CHUNK_SIZES { let mut state_copy = state; let mut cursor_copy = cursor.clone(); for chunk in LONG_DATA.chunks(chunk_size) { cursor_copy.absorb_u64_le(&mut state_copy, p1600, chunk); } assert_eq!(state_copy, STATE); assert_eq!(cursor_copy.pos(), expected_pos); assert_eq!(usize::from(cursor_copy.raw_pos()), expected_pos); } { let mut cursor = SpongeCursor::<136>::default(); let mut state = State1600::default(); cursor.absorb_u64_le(&mut state, p1600, &CONCAT_DATA); assert_eq!(state, STATE); assert_eq!(cursor.pos(), expected_pos); assert_eq!(usize::from(cursor.raw_pos()), expected_pos); } cursor.absorb_u64_le(&mut state, p1600, &LONG_DATA); assert_eq!(state, STATE); assert_eq!(cursor.pos(), expected_pos); assert_eq!(usize::from(cursor.raw_pos()), expected_pos); p1600(&mut state); for &chunk_size in CHUNK_SIZES { let mut buf = [0u8; DATA_LEN]; cursor = Default::default(); let mut state_copy = state; for chunk in buf.chunks_mut(chunk_size) { cursor.squeeze_read_u64_le(&mut state_copy, p1600, chunk); } assert_eq!(&buf, SQUEEZE_DATA); } let expected: [u8; DATA_LEN] = core::array::from_fn(|i| LONG_DATA[i] ^ SQUEEZE_DATA[i]); for &chunk_size in CHUNK_SIZES { let mut buf = LONG_DATA; cursor = Default::default(); let mut state_copy = state; for chunk in buf.chunks_mut(chunk_size) { cursor.squeeze_xor_u64_le(&mut state_copy, p1600, chunk); } assert_eq!(buf, expected); } }); }