From 8d54875f8ddb6efa10854b153598492fefbf0585 Mon Sep 17 00:00:00 2001 From: Sachymetsu Date: Sat, 18 Apr 2026 14:44:27 +0200 Subject: [PATCH] Restructure into workspace/crates --- Cargo.lock | 24 ++- Cargo.toml | 42 ++-- LICENSE-APACHE | 201 ++++++++++++++++++ LICENSE-MIT | 21 ++ README.md | 4 +- src/handshake.rs | 11 +- src/lib.rs | 11 +- src/transport.rs | 43 ++-- wharrgarbl-core/Cargo.toml | 11 + .../src/lib.rs | 22 ++ wharrgarbl-strobe/Cargo.toml | 25 +++ {src => wharrgarbl-strobe/src}/basic_kats.rs | 6 +- .../src}/herding_kats/harness.rs | 3 +- .../src}/herding_kats/mod.rs | 8 +- {src => wharrgarbl-strobe/src}/keccakf.rs | 0 wharrgarbl-strobe/src/lib.rs | 31 +++ {src => wharrgarbl-strobe/src}/opflags.rs | 0 {src => wharrgarbl-strobe/src}/ops.rs | 0 {src => wharrgarbl-strobe/src}/strobe.rs | 38 +--- 19 files changed, 409 insertions(+), 92 deletions(-) create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 wharrgarbl-core/Cargo.toml rename src/buffer_slice.rs => wharrgarbl-core/src/lib.rs (87%) create mode 100644 wharrgarbl-strobe/Cargo.toml rename {src => wharrgarbl-strobe/src}/basic_kats.rs (99%) rename {src => wharrgarbl-strobe/src}/herding_kats/harness.rs (98%) rename {src => wharrgarbl-strobe/src}/herding_kats/mod.rs (61%) rename {src => wharrgarbl-strobe/src}/keccakf.rs (100%) create mode 100644 wharrgarbl-strobe/src/lib.rs rename {src => wharrgarbl-strobe/src}/opflags.rs (100%) rename {src => wharrgarbl-strobe/src}/ops.rs (100%) rename {src => wharrgarbl-strobe/src}/strobe.rs (96%) diff --git a/Cargo.lock b/Cargo.lock index 54ea827..0932d25 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -462,14 +462,34 @@ dependencies = [ "aead", "ctutils", "getrandom", - "hex", "hybrid-array", - "keccak", "ml-kem", "rand_core", + "wharrgarbl-core", + "wharrgarbl-strobe", + "zeroize", +] + +[[package]] +name = "wharrgarbl-core" +version = "0.1.0" +dependencies = [ + "aead", +] + +[[package]] +name = "wharrgarbl-strobe" +version = "0.1.0" +dependencies = [ + "aead", + "ctutils", + "hex", + "hybrid-array", + "keccak", "serde", "serde-big-array", "serde_json", + "wharrgarbl-core", "zeroize", ] diff --git a/Cargo.toml b/Cargo.toml index 426ac60..2367dca 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,27 +1,41 @@ -[package] -name = "wharrgarbl" -description = "A whimsical STROBE based encryption protocol" +[workspace] +resolver = "3" +members = ["wharrgarbl-core", "wharrgarbl-strobe"] + +[workspace.package] authors = ["Sachy.dev "] +edition = "2024" repository = "https://tangled.org/sachy.dev/wharrgarbl" version = "0.1.0" -edition = "2024" +license = "MIT OR Apache-2.0" + +[workspace.dependencies] +aead = { version = "0.6.0-rc.10" } +ctutils = { version = "0.4.2", default-features = false } +zeroize = { version = "1.8.2", default-features = false } +hybrid-array = { version = "0.4.10" } + +[package] +name = "wharrgarbl" +description = "A whimsical STROBE based encryption protocol" +edition.workspace = true +repository.workspace = true +version.workspace = true +authors.workspace = true [features] -parallel = ["keccak/parallel"] +parallel = ["wharrgarbl-strobe/parallel"] [dependencies] -keccak = "0.2" -ctutils = { version = "0.4.2", default-features = false } -zeroize = { version = "1.8.2", default-features = false } +wharrgarbl-core = { path = "./wharrgarbl-core", version = "0.1" } +wharrgarbl-strobe = { path = "./wharrgarbl-strobe", version = "0.1" } +ctutils.workspace = true +zeroize.workspace = true ml-kem = { version = "0.3.0-rc.2", features = ["zeroize"] } -hybrid-array = { version = "0.4.10", features = ["alloc"] } +hybrid-array = { workspace = true, features = ["alloc"] } rand_core = { version = "0.10", default-features = false } -aead = { version = "0.6.0-rc.10" } +aead.workspace = true [dev-dependencies] -serde_json = "1" -hex = "0.4" -serde = { version = "1.0.210", default-features = false, features = ["derive"] } -serde-big-array = { version = "0.5" } getrandom = { version = "0.4.2", features = ["sys_rng"] } aead = { version = "0.6.0-rc.10", features = ["alloc"] } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..ad2243e --- /dev/null +++ b/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 2026 Sachymetsu + +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/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..ea34059 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Sachymetsu + +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/README.md b/README.md index 7f6efdb..7b9f1d3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A WIP Strobe+AKE protocol with a whimsical name. Based off the [reference rust implementation here](https://github.com/rozbb/strobe-rs), though with diverging API choices for experimentation. +☢️ **WARNING: DO NOT USE IN PRODUCTION. THIS CRATE IS NOT AUDITED AND IS WIP, MAYBE EVEN NOT AS SECURE AS THOUGHT. AAAAAAAAAA** ☢️ + ## License -TBA when ready +Code dual-licensed under Apache 2.0 or MIT. diff --git a/src/handshake.rs b/src/handshake.rs index c2ba0dd..0fa49db 100644 --- a/src/handshake.rs +++ b/src/handshake.rs @@ -1,12 +1,13 @@ use aead::Buffer; use hybrid_array::typenum::Unsigned; use rand_core::CryptoRng; +use wharrgarbl_core::Role; +use wharrgarbl_strobe::{StrobeSecurity, StrobeState}; use crate::{ WHARRGHARBL_PROTO, kem::{KemEncap, KemSecurity}, - strobe::{Role, StrobeSecurity, StrobeState}, - transport::{self, AeadState, AeadStrobe}, + transport::{AeadState, AeadStrobe}, }; pub struct ClientHandshake { @@ -59,7 +60,7 @@ impl ClientHandshake { let tag = ciphertext .len() - .checked_sub(::TagSize::to_usize()) + .checked_sub(::TagSize::to_usize()) .ok_or(aead::Error)?; let (ciphertext, tag) = ciphertext.split_at(tag); @@ -123,7 +124,7 @@ impl ServerHandshake { let tag = slice .len() - .checked_sub(::TagSize::to_usize()) + .checked_sub(::TagSize::to_usize()) .ok_or(aead::Error)?; let (encap, tag) = buf.as_ref().split_at(tag); @@ -167,7 +168,7 @@ impl ServerHandshake { #[cfg(test)] mod tests { - use crate::buffer_slice::BufferSlice; + use wharrgarbl_core::BufferSlice; use super::*; diff --git a/src/lib.rs b/src/lib.rs index e575f24..da78c80 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,17 +1,8 @@ #![no_std] #![forbid(unsafe_code)] -#[cfg(test)] -mod basic_kats; -pub mod buffer_slice; pub mod handshake; -#[cfg(test)] -mod herding_kats; -mod keccakf; -pub mod kem; -mod opflags; -mod ops; -pub mod strobe; +mod kem; pub mod transport; extern crate alloc; diff --git a/src/transport.rs b/src/transport.rs index 2d3fbe0..ce0f3cd 100644 --- a/src/transport.rs +++ b/src/transport.rs @@ -3,11 +3,10 @@ use aead::{ consts::{U16, U32}, }; use ctutils::{CtEq, CtSelect}; +use wharrgarbl_core::Role; +use wharrgarbl_strobe::{StrobeSecurity, StrobeState}; -use crate::{ - WHARRGHARBL_PROTO, - strobe::{Role, StrobeSecurity, StrobeState}, -}; +use crate::WHARRGHARBL_PROTO; pub struct AeadStrobe { pub(crate) key: Key, @@ -32,11 +31,7 @@ impl aead::AeadInOut for AeadStrobe { mut buffer: aead::inout::InOutBuf<'_, '_, u8>, ) -> aead::Result> { let mut tag: aead::Tag = Default::default(); - let mut strobe = StrobeState::new( - WHARRGHARBL_PROTO.as_bytes(), - self.param, - crate::strobe::Role::Sender, - ); + let mut strobe = StrobeState::new(WHARRGHARBL_PROTO.as_bytes(), self.param, Role::Sender); strobe.key(&self.key); strobe.meta_ad(&self.param.to_bytes()); @@ -56,11 +51,7 @@ impl aead::AeadInOut for AeadStrobe { mut buffer: aead::inout::InOutBuf<'_, '_, u8>, tag: &aead::Tag, ) -> aead::Result<()> { - let mut strobe = StrobeState::new( - WHARRGHARBL_PROTO.as_bytes(), - self.param, - crate::strobe::Role::Receiver, - ); + let mut strobe = StrobeState::new(WHARRGHARBL_PROTO.as_bytes(), self.param, Role::Receiver); strobe.key(&self.key); strobe.meta_ad(&self.param.to_bytes()); @@ -72,6 +63,12 @@ impl aead::AeadInOut for AeadStrobe { } } +impl zeroize::Zeroize for AeadStrobe { + fn zeroize(&mut self) { + self.key.zeroize(); + } +} + pub struct AeadState { pub(crate) aead: AeadStrobe, pub(crate) epstein: aead::Nonce, @@ -79,8 +76,24 @@ pub struct AeadState { role: Role, } +impl zeroize::Zeroize for AeadState { + fn zeroize(&mut self) { + self.aead.zeroize(); + self.epstein.zeroize(); + self.trump.zeroize(); + } +} + +impl zeroize::ZeroizeOnDrop for AeadState {} + +impl Drop for AeadState { + fn drop(&mut self) { + zeroize::Zeroize::zeroize(self); + } +} + impl AeadState { - pub fn new( + pub(crate) fn new( key: Key, sec: StrobeSecurity, outbound: aead::Nonce, diff --git a/wharrgarbl-core/Cargo.toml b/wharrgarbl-core/Cargo.toml new file mode 100644 index 0000000..d1bef5c --- /dev/null +++ b/wharrgarbl-core/Cargo.toml @@ -0,0 +1,11 @@ +[package] +name = "wharrgarbl-core" +description = "Whimsical core types for WHARRGARBL" +authors.workspace = true +edition.workspace = true +repository.workspace = true +version.workspace = true +license.workspace = true + +[dependencies] +aead.workspace = true diff --git a/src/buffer_slice.rs b/wharrgarbl-core/src/lib.rs similarity index 87% rename from src/buffer_slice.rs rename to wharrgarbl-core/src/lib.rs index c83c94a..4bd4269 100644 --- a/src/buffer_slice.rs +++ b/wharrgarbl-core/src/lib.rs @@ -1,3 +1,23 @@ +#![no_std] + +use core::ops::BitXor; + +// Public API for passing in Role +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +#[repr(u8)] +pub enum Role { + Sender = 0, + Receiver = 1, +} + +impl BitXor for Role { + fn bitxor(self, rhs: Self) -> Self::Output { + (self as u8) ^ (rhs as u8) + } + + type Output = u8; +} + #[derive(Debug)] pub struct BufferSlice<'slice> { buffer: &'slice mut [u8], @@ -54,6 +74,8 @@ mod tests { use super::*; use aead::Buffer; + extern crate alloc; + #[test] fn defaults_to_full_buffer_size() { let mut buf = alloc::vec![0u8; 128]; diff --git a/wharrgarbl-strobe/Cargo.toml b/wharrgarbl-strobe/Cargo.toml new file mode 100644 index 0000000..48b4541 --- /dev/null +++ b/wharrgarbl-strobe/Cargo.toml @@ -0,0 +1,25 @@ +[package] +name = "wharrgarbl-strobe" +description = "A whimsical STROBE implementation in Pure Rust" +authors.workspace = true +edition.workspace = true +repository.workspace = true +version.workspace = true +license.workspace = true + +[features] +parallel = ["keccak/parallel"] + +[dependencies] +wharrgarbl-core = { path = "../wharrgarbl-core", version = "0.1" } +aead.workspace = true +zeroize.workspace = true +ctutils.workspace = true +keccak = "0.2" +hybrid-array.workspace = true + +[dev-dependencies] +serde_json = "1" +hex = "0.4" +serde = { version = "1.0.210", default-features = false, features = ["derive"] } +serde-big-array = { version = "0.5" } diff --git a/src/basic_kats.rs b/wharrgarbl-strobe/src/basic_kats.rs similarity index 99% rename from src/basic_kats.rs rename to wharrgarbl-strobe/src/basic_kats.rs index 100e392..8d404a6 100644 --- a/src/basic_kats.rs +++ b/wharrgarbl-strobe/src/basic_kats.rs @@ -6,11 +6,9 @@ use aead::consts::{U16, U65}; use hybrid_array::Array; +use wharrgarbl_core::Role; -use crate::{ - keccakf::KECCAK_BUFFER_SIZE, - strobe::{Role, StrobeSecurity, StrobeState}, -}; +use crate::{StrobeSecurity, keccakf::KECCAK_BUFFER_SIZE, strobe::StrobeState}; extern crate std; diff --git a/src/herding_kats/harness.rs b/wharrgarbl-strobe/src/herding_kats/harness.rs similarity index 98% rename from src/herding_kats/harness.rs rename to wharrgarbl-strobe/src/herding_kats/harness.rs index f2393c6..6a86ae0 100644 --- a/src/herding_kats/harness.rs +++ b/wharrgarbl-strobe/src/herding_kats/harness.rs @@ -4,8 +4,9 @@ use std::{string::String, vec::Vec}; use aead::consts::U14; use serde::{Deserialize, Deserializer, de}; +use wharrgarbl_core::Role; -use crate::strobe::{Role, StrobeSecurity, StrobeState}; +use crate::{StrobeSecurity, strobe::StrobeState}; /// The harness we will put on our KATs so we can herd them and make them do tests. /// (This is the top-level structure of the JSON we find in the test vectors) diff --git a/src/herding_kats/mod.rs b/wharrgarbl-strobe/src/herding_kats/mod.rs similarity index 61% rename from src/herding_kats/mod.rs rename to wharrgarbl-strobe/src/herding_kats/mod.rs index 70eb968..70f5551 100644 --- a/src/herding_kats/mod.rs +++ b/wharrgarbl-strobe/src/herding_kats/mod.rs @@ -9,20 +9,20 @@ mod harness; #[test] fn simple_kats() { - test_against_kat("katties/simple_test_vector.json"); + test_against_kat("../katties/simple_test_vector.json"); } #[test] fn meta_kats() { - test_against_kat("katties/meta_test_vector.json"); + test_against_kat("../katties/meta_test_vector.json"); } #[test] fn streaming_kats() { - test_against_kat("katties/streaming_test_vector.json"); + test_against_kat("../katties/streaming_test_vector.json"); } #[test] fn boundary_kats() { - test_against_kat("katties/boundary_test_vector.json"); + test_against_kat("../katties/boundary_test_vector.json"); } diff --git a/src/keccakf.rs b/wharrgarbl-strobe/src/keccakf.rs similarity index 100% rename from src/keccakf.rs rename to wharrgarbl-strobe/src/keccakf.rs diff --git a/wharrgarbl-strobe/src/lib.rs b/wharrgarbl-strobe/src/lib.rs new file mode 100644 index 0000000..65c9206 --- /dev/null +++ b/wharrgarbl-strobe/src/lib.rs @@ -0,0 +1,31 @@ +mod keccakf; +mod opflags; +mod ops; +mod strobe; + +#[cfg(test)] +mod basic_kats; +#[cfg(test)] +mod herding_kats; + +pub use strobe::StrobeState; + +/// Version of Strobe that this crate implements. +pub static STROBE_VERSION: &str = "1.0.2"; + +#[derive(Debug, Clone, Copy)] +#[repr(u16)] +pub enum StrobeSecurity { + B128 = 128, + B256 = 256, +} + +impl StrobeSecurity { + pub const fn rachet_bytes(self) -> usize { + (self as usize) >> 3 + } + + pub const fn to_bytes(self) -> [u8; 2] { + (self as u16).to_le_bytes() + } +} diff --git a/src/opflags.rs b/wharrgarbl-strobe/src/opflags.rs similarity index 100% rename from src/opflags.rs rename to wharrgarbl-strobe/src/opflags.rs diff --git a/src/ops.rs b/wharrgarbl-strobe/src/ops.rs similarity index 100% rename from src/ops.rs rename to wharrgarbl-strobe/src/ops.rs diff --git a/src/strobe.rs b/wharrgarbl-strobe/src/strobe.rs similarity index 96% rename from src/strobe.rs rename to wharrgarbl-strobe/src/strobe.rs index 419bcb8..3a11fe9 100644 --- a/src/strobe.rs +++ b/wharrgarbl-strobe/src/strobe.rs @@ -1,11 +1,10 @@ -use core::ops::BitXor; - use ctutils::{Choice, CtAssign, CtEq, CtLt, CtSelect}; use hybrid_array::{Array, ArraySize}; +use wharrgarbl_core::Role; use zeroize::Zeroize; use crate::{ - STROBE_VERSION, + STROBE_VERSION, StrobeSecurity, keccakf::{KECCAK_BUFFER_SIZE, KeccakF1600}, opflags::OpFlags, ops, @@ -17,39 +16,6 @@ mod role { pub const RECEIVER: u8 = 1; } -/// Public API for passing in Role -#[derive(Debug, Clone, Copy, PartialEq, Eq)] -#[repr(u8)] -pub enum Role { - Sender = 0, - Receiver = 1, -} - -impl BitXor for Role { - fn bitxor(self, rhs: Self) -> Self::Output { - (self as u8) ^ (rhs as u8) - } - - type Output = u8; -} - -#[derive(Debug, Clone, Copy)] -#[repr(u16)] -pub enum StrobeSecurity { - B128 = 128, - B256 = 256, -} - -impl StrobeSecurity { - pub const fn rachet_bytes(self) -> usize { - (self as usize) >> 3 - } - - pub const fn to_bytes(self) -> [u8; 2] { - (self as u16).to_le_bytes() - } -} - #[derive(Clone)] pub struct StrobeState { /// Internal Keccak state -- 2.51.2