diff --git a/.github/workflows/shake.yml b/.github/workflows/shake.yml new file mode 100644 index 000000000..b93289cf4 --- /dev/null +++ b/.github/workflows/shake.yml @@ -0,0 +1,72 @@ +name: shake + +on: + pull_request: + paths: + - ".github/workflows/shake.yml" + - "shake/**" + - "Cargo.*" + push: + branches: master + +defaults: + run: + working-directory: shake + +env: + CARGO_INCREMENTAL: 0 + RUSTFLAGS: "-Dwarnings" + +# Cancels CI jobs when new commits are pushed to a PR branch +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + set-msrv: + uses: RustCrypto/actions/.github/workflows/set-msrv.yml@master + with: + msrv: 1.85.0 + + build: + needs: set-msrv + runs-on: ubuntu-latest + strategy: + matrix: + rust: + - ${{needs.set-msrv.outputs.msrv}} + - stable + target: + - thumbv7em-none-eabi + - wasm32-unknown-unknown + steps: + - uses: actions/checkout@v6 + - uses: RustCrypto/actions/cargo-cache@master + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.rust }} + targets: ${{ matrix.target }} + - uses: RustCrypto/actions/cargo-hack-install@master + - run: cargo hack build --target ${{ matrix.target }} --each-feature + + test: + needs: set-msrv + runs-on: ubuntu-latest + strategy: + matrix: + rust: + - ${{needs.set-msrv.outputs.msrv}} + - stable + steps: + - uses: actions/checkout@v6 + - uses: RustCrypto/actions/cargo-cache@master + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.rust }} + - uses: RustCrypto/actions/cargo-hack-install@master + - run: cargo hack test --feature-powerset + + minimal-versions: + uses: RustCrypto/actions/.github/workflows/minimal-versions.yml@master + with: + working-directory: ${{ github.workflow }} diff --git a/Cargo.lock b/Cargo.lock index 031443bc9..aaef15e2c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -352,6 +352,16 @@ dependencies = [ "hex-literal", ] +[[package]] +name = "shake" +version = "0.1.0" +dependencies = [ + "digest", + "hex-literal", + "keccak", + "sponge-cursor", +] + [[package]] name = "skein" version = "0.2.0" diff --git a/Cargo.toml b/Cargo.toml index 556649dcc..2810314c5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -23,6 +23,7 @@ members = [ "sha2", "sha3", "shabal", + "shake", "skein", "sm3", "streebog", diff --git a/sha3/CHANGELOG.md b/sha3/CHANGELOG.md index 4e64e1557..7ce63e363 100644 --- a/sha3/CHANGELOG.md +++ b/sha3/CHANGELOG.md @@ -10,7 +10,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Internal implementation by removing unnecessary buffering ([#849]) - Serialization format used by `SerializableState` trait implementations ([#849]) +### Removed +- `Shake`, `Shake128`, and `Shake256` types (moved to the `shake` crate) ([#869]) + [#849]: https://github.com/RustCrypto/hashes/pull/849 +[#869]: https://github.com/RustCrypto/hashes/pull/869 ## 0.11.0 (2026-04-02) ### Added diff --git a/sha3/Cargo.toml b/sha3/Cargo.toml index 2cbbc53db..003c0e06a 100644 --- a/sha3/Cargo.toml +++ b/sha3/Cargo.toml @@ -14,11 +14,11 @@ description = "Implementation of the SHA-3 family of cryptographic hash algorith [dependencies] digest = { version = "0.11", default-features = false } -keccak = "0.2" sponge-cursor = "0.1" +keccak = "0.2" [dev-dependencies] -digest = { version = "0.11", features = ["dev"] } +digest = { version = "0.11", default-features = false, features = ["dev"] } hex-literal = "1" [features] diff --git a/sha3/README.md b/sha3/README.md index 501238bc4..a71a93a15 100644 --- a/sha3/README.md +++ b/sha3/README.md @@ -9,14 +9,14 @@ Implementation of the [SHA-3] family of cryptographic hash algorithms. -There are 6 standard algorithms specified in the SHA-3 standard: +There are 4 standard fixed-size algorithms specified in the SHA-3 standard: +`SHA3-224`, `SHA3-256`, `SHA3-384`, `SHA3-512`. -- `SHA3-224`, `SHA3-256`, `SHA3-384`, `SHA3-512` -- `SHAKE128` and `SHAKE256` (an extendable output function (XOF)) +`SHAKE128` and `SHAKE256` extendable output functions (XOF) are defined in the [`shake`] crate Additionally, this crate supports: -- `KeccakFull`: CryptoNight variant of SHA-3 - `Keccak224`, `Keccak256`, `Keccak384`, `Keccak512`: NIST submission without padding changes +- `Keccak256Full`: CryptoNight variant of SHA-3 ## Examples @@ -34,25 +34,6 @@ let hash = hasher.finalize(); assert_eq!(hash, hex!("3a985da74fe225b2045c172d6bd390bd855f086e3e9d525b46bfe24511431532")); ``` -SHAKE functions have an extendable output, so finalization method returns -XOF reader from which results of arbitrary length can be read. Note that -these functions do not implement `Digest`, so lower-level traits have to -be imported: - -```rust -use sha3::{shake::Shake128, digest::{Update, ExtendableOutput, XofReader}}; -use hex_literal::hex; - -let mut hasher = Shake128::default(); -hasher.update(b"abc"); -let mut reader = hasher.finalize_xof(); -let mut buf = [0u8; 10]; -reader.read(&mut buf); -assert_eq!(buf, hex!("5881092dd818bf5cf8a3")); -reader.read(&mut buf); -assert_eq!(buf, hex!("ddb793fbcba74097d5c5")); -``` - See the [`digest`] crate docs for additional examples. ## License @@ -86,4 +67,5 @@ dual licensed as above, without any additional terms or conditions. [//]: # (general links) [SHA-3]: https://en.wikipedia.org/wiki/SHA-3 +[`shake`]: http://docs.rs/shake [`digest`]: https://docs.rs/digest diff --git a/sha3/benches/mod.rs b/sha3/benches/mod.rs index a9b0fc289..38df0e311 100644 --- a/sha3/benches/mod.rs +++ b/sha3/benches/mod.rs @@ -2,10 +2,7 @@ extern crate test; use digest::bench_update; -use sha3::{ - Sha3_224, Sha3_256, Sha3_384, Sha3_512, - shake::{Shake128, Shake256}, -}; +use sha3::{Sha3_224, Sha3_256, Sha3_384, Sha3_512}; use test::Bencher; bench_update!( @@ -39,19 +36,3 @@ bench_update!( sha3_512_1000 1000; sha3_512_10000 10000; ); - -bench_update!( - Shake128::default(); - shake128_10 10; - shake128_100 100; - shake128_1000 1000; - shake128_10000 10000; -); - -bench_update!( - Shake256::default(); - shake256_10 10; - shake256_100 100; - shake256_1000 1000; - shake256_10000 10000; -); diff --git a/sha3/src/lib.rs b/sha3/src/lib.rs index be41c2d87..3bc0e1013 100644 --- a/sha3/src/lib.rs +++ b/sha3/src/lib.rs @@ -20,13 +20,11 @@ use digest::{ }, consts::{U28, U32, U48, U64, U72, U104, U136, U144, U200, U201}, }; + #[cfg(feature = "oid")] mod oids; mod utils; -/// Implementation of the SHAKE function. -pub mod shake; - macro_rules! impl_fixed { ($( $(#[$attr:meta])* diff --git a/sha3/tests/mod.rs b/sha3/tests/mod.rs index 753fa9f76..35d185945 100644 --- a/sha3/tests/mod.rs +++ b/sha3/tests/mod.rs @@ -1,4 +1,4 @@ -use digest::dev::{fixed_reset_test, xof_reset_test}; +use digest::dev::fixed_reset_test; use digest::new_test; new_test!(sha3_224_kat, sha3::Sha3_224, fixed_reset_test); @@ -6,9 +6,6 @@ new_test!(sha3_256_kat, sha3::Sha3_256, fixed_reset_test); new_test!(sha3_384_kat, sha3::Sha3_384, fixed_reset_test); new_test!(sha3_512_kat, sha3::Sha3_512, fixed_reset_test); -new_test!(shake128_kat, sha3::shake::Shake128, xof_reset_test); -new_test!(shake256_kat, sha3::shake::Shake256, xof_reset_test); - // Test vectors from https://github.com/kazcw/yellowsun/blob/test-keccak/src/lib.rs#L171 new_test!(keccak_224_kat, sha3::Keccak224, fixed_reset_test); new_test!(keccak_256_kat, sha3::Keccak256, fixed_reset_test); diff --git a/shake/CHANGELOG.md b/shake/CHANGELOG.md new file mode 100644 index 000000000..e155618ea --- /dev/null +++ b/shake/CHANGELOG.md @@ -0,0 +1,11 @@ +# 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-13) +- Initial release with implementation moved from the `sha3` crate ([#869]) + +[#869]: https://github.com/RustCrypto/hashes/pull/869 diff --git a/shake/Cargo.toml b/shake/Cargo.toml new file mode 100644 index 000000000..205032592 --- /dev/null +++ b/shake/Cargo.toml @@ -0,0 +1,30 @@ +[package] +name = "shake" +version = "0.1.0" +authors = ["RustCrypto Developers"] +edition = "2024" +rust-version = "1.85" +documentation = "https://docs.rs/shake" +readme = "README.md" +repository = "https://github.com/RustCrypto/hashes" +license = "MIT OR Apache-2.0" +keywords = ["sha3", "keccak", "hash", "xof", "digest"] +categories = ["cryptography", "no-std"] +description = "Implementation of the SHAKE family of extendable-output functions (XOFs)" + +[dependencies] +digest = { version = "0.11", default-features = false } +sponge-cursor = "0.1" +keccak = "0.2" + +[dev-dependencies] +digest = { version = "0.11", default-features = false, features = ["dev"] } +hex-literal = "1" + +[features] +default = ["alloc"] +alloc = ["digest/alloc"] +zeroize = ["digest/zeroize", "sponge-cursor/zeroize"] + +[package.metadata.docs.rs] +all-features = true diff --git a/shake/LICENSE-APACHE b/shake/LICENSE-APACHE new file mode 100644 index 000000000..78173fa2e --- /dev/null +++ b/shake/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/shake/LICENSE-MIT b/shake/LICENSE-MIT new file mode 100644 index 000000000..4697b3e72 --- /dev/null +++ b/shake/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/shake/README.md b/shake/README.md new file mode 100644 index 000000000..ed0e26ff7 --- /dev/null +++ b/shake/README.md @@ -0,0 +1,67 @@ +# RustCrypto: SHAKE + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] +[![Build Status][build-image]][build-link] + + +Implementation of the SHAKE family of extendable-output functions (XOFs) +defined in [NIST FIPS 202]. + +## Examples + +SHAKE functions have an extendable output, so finalization methods return +XOF reader from which results of arbitrary length can be read. + +```rust +use shake::Shake128; +use shake::digest::{Update, ExtendableOutput, XofReader}; +use hex_literal::hex; + +let mut hasher = Shake128::default(); +hasher.update(b"abc"); +let mut reader = hasher.finalize_xof(); +let mut buf = [0u8; 10]; +reader.read(&mut buf); +assert_eq!(buf, hex!("5881092dd818bf5cf8a3")); +reader.read(&mut buf); +assert_eq!(buf, hex!("ddb793fbcba74097d5c5")); +``` + +See the [`digest`] crate docs for additional examples. + +## License + +The crate is 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/shake.svg +[crate-link]: https://crates.io/crates/shake +[docs-image]: https://docs.rs/shake/badge.svg +[docs-link]: https://docs.rs/shake +[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/260041-hashes +[build-image]: https://github.com/RustCrypto/hashes/actions/workflows/shake.yml/badge.svg?branch=master +[build-link]: https://github.com/RustCrypto/hashes/actions/workflows/shake.yml?query=branch:master + +[//]: # (general links) + +[NIST FIPS 202]: https://csrc.nist.gov/pubs/fips/202/final +[`digest`]: https://docs.rs/digest diff --git a/shake/benches/mod.rs b/shake/benches/mod.rs new file mode 100644 index 000000000..4b34fbefa --- /dev/null +++ b/shake/benches/mod.rs @@ -0,0 +1,21 @@ +#![feature(test)] +extern crate test; + +use digest::bench_update; +use test::Bencher; + +bench_update!( + shake::Shake128::default(); + shake128_10 10; + shake128_100 100; + shake128_1000 1000; + shake128_10000 10000; +); + +bench_update!( + shake::Shake256::default(); + shake256_10 10; + shake256_100 100; + shake256_1000 1000; + shake256_10000 10000; +); diff --git a/sha3/src/shake.rs b/shake/src/lib.rs similarity index 73% rename from sha3/src/shake.rs rename to shake/src/lib.rs index a395d30c5..ff7a06899 100644 --- a/sha3/src/shake.rs +++ b/shake/src/lib.rs @@ -1,20 +1,26 @@ +#![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" +)] +#![cfg_attr(docsrs, feature(doc_cfg))] +#![forbid(unsafe_code)] +#![warn(missing_docs, missing_debug_implementations)] +#![warn(unreachable_pub)] + +pub use digest; +pub use digest::{ExtendableOutput, Update, XofReader}; + use core::fmt; use digest::{ - CollisionResistance, ExtendableOutput, ExtendableOutputReset, HashMarker, Reset, Update, - XofReader, - common::{ - AlgorithmName, - hazmat::{DeserializeStateError, SerializableState, SerializedState}, - }, - consts::{U16, U32, U201}, + CollisionResistance, ExtendableOutputReset, HashMarker, Reset, + common::AlgorithmName, + consts::{U16, U32}, }; use keccak::{Keccak, State1600}; use sponge_cursor::SpongeCursor; -use crate::utils; - -const SHAKE_PAD: u8 = 0x1F; - /// SHAKE128 hasher. pub type Shake128 = Shake<168>; /// SHAKE256 hasher. @@ -67,12 +73,26 @@ impl Reset for Shake { } } +impl Shake { + fn pad(&mut self) { + const SHAKE_PAD: u8 = 0x1F; + + let pos = self.cursor.pos(); + let word_offset = pos / 8; + let byte_offset = pos % 8; + + let pad = u64::from(SHAKE_PAD) << (8 * byte_offset); + self.state[word_offset] ^= pad; + self.state[RATE / 8 - 1] ^= 1 << 63; + } +} + impl ExtendableOutput for Shake { type Reader = ShakeReader; #[inline] fn finalize_xof(mut self) -> Self::Reader { - utils::pad::(&mut self.state, &self.cursor); + self.pad(); // Note that `ShakeReader` applies the permutation to the state before reading from it Self::Reader { state: self.state, @@ -85,7 +105,7 @@ impl ExtendableOutput for Shake { impl ExtendableOutputReset for Shake { #[inline] fn finalize_xof_reset(&mut self) -> Self::Reader { - utils::pad::(&mut self.state, &self.cursor); + self.pad(); let state = self.state; self.reset(); // Note that `ShakeReader` applies the permutation to the state before reading from it @@ -121,26 +141,6 @@ impl fmt::Debug for Shake { } } -impl SerializableState for Shake { - type SerializedStateSize = U201; - - fn serialize(&self) -> SerializedState { - utils::serialize(&self.state, &self.cursor).into() - } - - fn deserialize( - serialized_state: &SerializedState, - ) -> Result { - utils::deserialize(serialized_state.into()) - .ok_or(DeserializeStateError) - .map(|(state, cursor)| Self { - state, - cursor, - keccak: Default::default(), - }) - } -} - impl Drop for Shake { #[inline] fn drop(&mut self) { @@ -173,26 +173,6 @@ impl XofReader for ShakeReader { } } -impl SerializableState for ShakeReader { - type SerializedStateSize = U201; - - fn serialize(&self) -> SerializedState { - utils::serialize(&self.state, &self.cursor).into() - } - - fn deserialize( - serialized_state: &SerializedState, - ) -> Result { - utils::deserialize(serialized_state.into()) - .ok_or(DeserializeStateError) - .map(|(state, cursor)| Self { - state, - cursor, - keccak: Default::default(), - }) - } -} - impl fmt::Debug for ShakeReader { #[inline] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { diff --git a/shake/tests/cshake.rs b/shake/tests/cshake.rs new file mode 100644 index 000000000..5c44f77b3 --- /dev/null +++ b/shake/tests/cshake.rs @@ -0,0 +1,5 @@ +use digest::dev::xof_reset_test; +use digest::new_test; + +new_test!(shake128_kat, shake::Shake128, xof_reset_test); +new_test!(shake256_kat, shake::Shake256, xof_reset_test); diff --git a/sha3/tests/data/shake128_kat.blb b/shake/tests/data/shake128_kat.blb similarity index 100% rename from sha3/tests/data/shake128_kat.blb rename to shake/tests/data/shake128_kat.blb diff --git a/sha3/tests/data/shake256_kat.blb b/shake/tests/data/shake256_kat.blb similarity index 100% rename from sha3/tests/data/shake256_kat.blb rename to shake/tests/data/shake256_kat.blb