From 06b7f133569ab2fb6965de2d32d2236141f45055 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Wed, 22 Sep 2021 14:13:34 +0100 Subject: [PATCH 1/4] Empty f4jumble crate --- Cargo.toml | 1 + components/f4jumble/Cargo.toml | 15 +++ components/f4jumble/LICENSE-APACHE | 202 +++++++++++++++++++++++++++++ components/f4jumble/LICENSE-MIT | 21 +++ components/f4jumble/README.md | 20 +++ components/f4jumble/src/lib.rs | 7 + 6 files changed, 266 insertions(+) create mode 100644 components/f4jumble/Cargo.toml create mode 100644 components/f4jumble/LICENSE-APACHE create mode 100644 components/f4jumble/LICENSE-MIT create mode 100644 components/f4jumble/README.md create mode 100644 components/f4jumble/src/lib.rs diff --git a/Cargo.toml b/Cargo.toml index a52e48ffa..5d1f89d7e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,7 @@ [workspace] members = [ "components/equihash", + "components/f4jumble", "components/zcash_address", "components/zcash_encoding", "components/zcash_note_encryption", diff --git a/components/f4jumble/Cargo.toml b/components/f4jumble/Cargo.toml new file mode 100644 index 000000000..768831e9e --- /dev/null +++ b/components/f4jumble/Cargo.toml @@ -0,0 +1,15 @@ +[package] +name = "f4jumble" +description = "Implementation of Zcash's F4Jumble algorithm" +version = "0.0.0" +authors = [ + "Jack Grigg ", + "Kris Nuttycombe ", +] +homepage = "https://github.com/zcash/librustzcash" +repository = "https://github.com/zcash/librustzcash" +readme = "README.md" +license = "MIT OR Apache-2.0" +edition = "2018" + +[dependencies] diff --git a/components/f4jumble/LICENSE-APACHE b/components/f4jumble/LICENSE-APACHE new file mode 100644 index 000000000..1e5006dc1 --- /dev/null +++ b/components/f4jumble/LICENSE-APACHE @@ -0,0 +1,202 @@ + 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/components/f4jumble/LICENSE-MIT b/components/f4jumble/LICENSE-MIT new file mode 100644 index 000000000..9500c140c --- /dev/null +++ b/components/f4jumble/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2021 Electric Coin Company + +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/components/f4jumble/README.md b/components/f4jumble/README.md new file mode 100644 index 000000000..51d05aa46 --- /dev/null +++ b/components/f4jumble/README.md @@ -0,0 +1,20 @@ +# f4jumble + +TBD + +## License + +Licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or 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. diff --git a/components/f4jumble/src/lib.rs b/components/f4jumble/src/lib.rs new file mode 100644 index 000000000..31e1bb209 --- /dev/null +++ b/components/f4jumble/src/lib.rs @@ -0,0 +1,7 @@ +#[cfg(test)] +mod tests { + #[test] + fn it_works() { + assert_eq!(2 + 2, 4); + } +} From e13e746e8a4883d6683e24da00580d55f632b115 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Wed, 22 Sep 2021 14:21:48 +0100 Subject: [PATCH 2/4] Move F4Jumble implementation into f4jumble crate --- components/f4jumble/Cargo.toml | 4 + components/f4jumble/src/lib.rs | 190 +++++++++++++++++- .../f4jumble => f4jumble/src}/test_vectors.rs | 0 .../src}/test_vectors_long.rs | 0 components/zcash_address/Cargo.toml | 1 + components/zcash_address/src/kind/unified.rs | 2 - .../src/kind/unified/f4jumble.rs | 189 ----------------- 7 files changed, 191 insertions(+), 195 deletions(-) rename components/{zcash_address/src/kind/unified/f4jumble => f4jumble/src}/test_vectors.rs (100%) rename components/{zcash_address/src/kind/unified/f4jumble => f4jumble/src}/test_vectors_long.rs (100%) delete mode 100644 components/zcash_address/src/kind/unified/f4jumble.rs diff --git a/components/f4jumble/Cargo.toml b/components/f4jumble/Cargo.toml index 768831e9e..7e2b0cfa3 100644 --- a/components/f4jumble/Cargo.toml +++ b/components/f4jumble/Cargo.toml @@ -13,3 +13,7 @@ license = "MIT OR Apache-2.0" edition = "2018" [dependencies] +blake2b_simd = "0.5" + +[dev-dependencies] +proptest = "1" diff --git a/components/f4jumble/src/lib.rs b/components/f4jumble/src/lib.rs index 31e1bb209..84c86014f 100644 --- a/components/f4jumble/src/lib.rs +++ b/components/f4jumble/src/lib.rs @@ -1,7 +1,189 @@ +use blake2b_simd::{Params as Blake2bParams, OUTBYTES}; +use std::cmp::min; +use std::ops::RangeInclusive; + #[cfg(test)] -mod tests { - #[test] - fn it_works() { - assert_eq!(2 + 2, 4); +mod test_vectors; +#[cfg(test)] +mod test_vectors_long; + +const VALID_LENGTH: RangeInclusive = 48..=4194368; + +macro_rules! H_PERS { + ( $i:expr ) => { + [ + 85, 65, 95, 70, 52, 74, 117, 109, 98, 108, 101, 95, 72, $i, 0, 0, + ] + }; +} + +macro_rules! G_PERS { + ( $i:expr, $j:expr ) => { + [ + 85, + 65, + 95, + 70, + 52, + 74, + 117, + 109, + 98, + 108, + 101, + 95, + 71, + $i, + ($j & 0xFF) as u8, + ($j >> 8) as u8, + ] + }; +} + +struct Hashes { + l_l: usize, + l_r: usize, +} + +impl Hashes { + fn new(message_length: usize) -> Self { + let l_l = min(OUTBYTES, message_length / 2); + let l_r = message_length - l_l; + Hashes { l_l, l_r } + } + + fn h(&self, i: u8, u: &[u8]) -> Vec { + Blake2bParams::new() + .hash_length(self.l_l) + .personal(&H_PERS!(i)) + .hash(&u) + .as_ref() + .to_vec() + } + + fn g(&self, i: u8, u: &[u8]) -> Vec { + (0..ceildiv(self.l_r, OUTBYTES)) + .flat_map(|j| { + Blake2bParams::new() + .hash_length(OUTBYTES) + .personal(&G_PERS!(i, j as u16)) + .hash(u) + .as_ref() + .to_vec() + .into_iter() + }) + .take(self.l_r) + .collect() + } +} + +fn xor(a: &[u8], b: &[u8]) -> Vec { + a.iter().zip(b.iter()).map(|(a0, b0)| a0 ^ b0).collect() +} + +fn ceildiv(num: usize, den: usize) -> usize { + (num + den - 1) / den +} + +#[allow(clippy::many_single_char_names)] +pub fn f4jumble(a: &[u8]) -> Option> { + if VALID_LENGTH.contains(&a.len()) { + let hashes = Hashes::new(a.len()); + let (a, b) = a.split_at(hashes.l_l); + + let x = xor(b, &hashes.g(0, a)); + let y = xor(a, &hashes.h(0, &x)); + let d = xor(&x, &hashes.g(1, &y)); + let mut c = xor(&y, &hashes.h(1, &d)); + + c.extend(d); + Some(c) + } else { + None + } +} + +#[allow(clippy::many_single_char_names)] +pub fn f4jumble_inv(c: &[u8]) -> Option> { + if VALID_LENGTH.contains(&c.len()) { + let hashes = Hashes::new(c.len()); + let (c, d) = c.split_at(hashes.l_l); + + let y = xor(c, &hashes.h(1, d)); + let x = xor(d, &hashes.g(1, &y)); + let mut a = xor(&y, &hashes.h(0, &x)); + let b = xor(&x, &hashes.g(0, &a)); + + a.extend(b); + Some(a) + } else { + None + } +} + +#[cfg(test)] +mod tests { + use blake2b_simd::blake2b; + use proptest::collection::vec; + use proptest::prelude::*; + + use super::{ + f4jumble, f4jumble_inv, test_vectors::test_vectors, test_vectors_long, VALID_LENGTH, + }; + + #[test] + fn h_pers() { + assert_eq!(&H_PERS!(7), b"UA_F4Jumble_H\x07\x00\x00"); + } + + #[test] + fn g_pers() { + assert_eq!(&G_PERS!(7, 13), b"UA_F4Jumble_G\x07\x0d\x00"); + assert_eq!(&G_PERS!(7, 65535), b"UA_F4Jumble_G\x07\xff\xff"); + } + + proptest! { + #![proptest_config(ProptestConfig::with_cases(5))] + + #[test] + fn f4jumble_roundtrip(msg in vec(any::(), VALID_LENGTH)) { + let jumbled = f4jumble(&msg).unwrap(); + let jumbled_len = jumbled.len(); + prop_assert_eq!( + msg.len(), jumbled_len, + "Jumbled length {} was not equal to message length {}", + jumbled_len, msg.len() + ); + + let unjumbled = f4jumble_inv(&jumbled).unwrap(); + prop_assert_eq!( + jumbled_len, unjumbled.len(), + "Unjumbled length {} was not equal to jumbled length {}", + unjumbled.len(), jumbled_len + ); + + prop_assert_eq!(msg, unjumbled, "Unjumbled message did not match original message."); + } + } + + #[test] + fn f4jumble_check_vectors() { + for v in test_vectors() { + let jumbled = f4jumble(&v.normal).unwrap(); + assert_eq!(jumbled, v.jumbled); + let unjumbled = f4jumble_inv(&v.jumbled).unwrap(); + assert_eq!(unjumbled, v.normal); + } + } + + #[test] + fn f4jumble_check_vectors_long() { + for v in test_vectors_long::TEST_VECTORS { + let normal: Vec = (0..v.length).map(|i| i as u8).collect(); + let jumbled = f4jumble(&normal).unwrap(); + assert_eq!(blake2b(&jumbled).as_bytes(), v.jumbled_hash); + let unjumbled = f4jumble_inv(&jumbled).unwrap(); + assert_eq!(unjumbled, normal); + } } } diff --git a/components/zcash_address/src/kind/unified/f4jumble/test_vectors.rs b/components/f4jumble/src/test_vectors.rs similarity index 100% rename from components/zcash_address/src/kind/unified/f4jumble/test_vectors.rs rename to components/f4jumble/src/test_vectors.rs diff --git a/components/zcash_address/src/kind/unified/f4jumble/test_vectors_long.rs b/components/f4jumble/src/test_vectors_long.rs similarity index 100% rename from components/zcash_address/src/kind/unified/f4jumble/test_vectors_long.rs rename to components/f4jumble/src/test_vectors_long.rs diff --git a/components/zcash_address/Cargo.toml b/components/zcash_address/Cargo.toml index 03bf9eec9..8e9ca84f9 100644 --- a/components/zcash_address/Cargo.toml +++ b/components/zcash_address/Cargo.toml @@ -15,6 +15,7 @@ edition = "2018" bech32 = "0.8" blake2b_simd = "0.5" bs58 = { version = "0.4", features = ["check"] } +f4jumble = { version = "0.0", path = "../f4jumble" } zcash_encoding = { version = "0.0", path = "../zcash_encoding" } [dev-dependencies] diff --git a/components/zcash_address/src/kind/unified.rs b/components/zcash_address/src/kind/unified.rs index 335f671a0..9f013dbde 100644 --- a/components/zcash_address/src/kind/unified.rs +++ b/components/zcash_address/src/kind/unified.rs @@ -8,8 +8,6 @@ use zcash_encoding::CompactSize; use crate::kind; -mod f4jumble; - /// The HRP for a Bech32m-encoded mainnet Unified Address. /// /// Defined in [ZIP 316][zip-0316]. diff --git a/components/zcash_address/src/kind/unified/f4jumble.rs b/components/zcash_address/src/kind/unified/f4jumble.rs deleted file mode 100644 index 84c86014f..000000000 --- a/components/zcash_address/src/kind/unified/f4jumble.rs +++ /dev/null @@ -1,189 +0,0 @@ -use blake2b_simd::{Params as Blake2bParams, OUTBYTES}; -use std::cmp::min; -use std::ops::RangeInclusive; - -#[cfg(test)] -mod test_vectors; -#[cfg(test)] -mod test_vectors_long; - -const VALID_LENGTH: RangeInclusive = 48..=4194368; - -macro_rules! H_PERS { - ( $i:expr ) => { - [ - 85, 65, 95, 70, 52, 74, 117, 109, 98, 108, 101, 95, 72, $i, 0, 0, - ] - }; -} - -macro_rules! G_PERS { - ( $i:expr, $j:expr ) => { - [ - 85, - 65, - 95, - 70, - 52, - 74, - 117, - 109, - 98, - 108, - 101, - 95, - 71, - $i, - ($j & 0xFF) as u8, - ($j >> 8) as u8, - ] - }; -} - -struct Hashes { - l_l: usize, - l_r: usize, -} - -impl Hashes { - fn new(message_length: usize) -> Self { - let l_l = min(OUTBYTES, message_length / 2); - let l_r = message_length - l_l; - Hashes { l_l, l_r } - } - - fn h(&self, i: u8, u: &[u8]) -> Vec { - Blake2bParams::new() - .hash_length(self.l_l) - .personal(&H_PERS!(i)) - .hash(&u) - .as_ref() - .to_vec() - } - - fn g(&self, i: u8, u: &[u8]) -> Vec { - (0..ceildiv(self.l_r, OUTBYTES)) - .flat_map(|j| { - Blake2bParams::new() - .hash_length(OUTBYTES) - .personal(&G_PERS!(i, j as u16)) - .hash(u) - .as_ref() - .to_vec() - .into_iter() - }) - .take(self.l_r) - .collect() - } -} - -fn xor(a: &[u8], b: &[u8]) -> Vec { - a.iter().zip(b.iter()).map(|(a0, b0)| a0 ^ b0).collect() -} - -fn ceildiv(num: usize, den: usize) -> usize { - (num + den - 1) / den -} - -#[allow(clippy::many_single_char_names)] -pub fn f4jumble(a: &[u8]) -> Option> { - if VALID_LENGTH.contains(&a.len()) { - let hashes = Hashes::new(a.len()); - let (a, b) = a.split_at(hashes.l_l); - - let x = xor(b, &hashes.g(0, a)); - let y = xor(a, &hashes.h(0, &x)); - let d = xor(&x, &hashes.g(1, &y)); - let mut c = xor(&y, &hashes.h(1, &d)); - - c.extend(d); - Some(c) - } else { - None - } -} - -#[allow(clippy::many_single_char_names)] -pub fn f4jumble_inv(c: &[u8]) -> Option> { - if VALID_LENGTH.contains(&c.len()) { - let hashes = Hashes::new(c.len()); - let (c, d) = c.split_at(hashes.l_l); - - let y = xor(c, &hashes.h(1, d)); - let x = xor(d, &hashes.g(1, &y)); - let mut a = xor(&y, &hashes.h(0, &x)); - let b = xor(&x, &hashes.g(0, &a)); - - a.extend(b); - Some(a) - } else { - None - } -} - -#[cfg(test)] -mod tests { - use blake2b_simd::blake2b; - use proptest::collection::vec; - use proptest::prelude::*; - - use super::{ - f4jumble, f4jumble_inv, test_vectors::test_vectors, test_vectors_long, VALID_LENGTH, - }; - - #[test] - fn h_pers() { - assert_eq!(&H_PERS!(7), b"UA_F4Jumble_H\x07\x00\x00"); - } - - #[test] - fn g_pers() { - assert_eq!(&G_PERS!(7, 13), b"UA_F4Jumble_G\x07\x0d\x00"); - assert_eq!(&G_PERS!(7, 65535), b"UA_F4Jumble_G\x07\xff\xff"); - } - - proptest! { - #![proptest_config(ProptestConfig::with_cases(5))] - - #[test] - fn f4jumble_roundtrip(msg in vec(any::(), VALID_LENGTH)) { - let jumbled = f4jumble(&msg).unwrap(); - let jumbled_len = jumbled.len(); - prop_assert_eq!( - msg.len(), jumbled_len, - "Jumbled length {} was not equal to message length {}", - jumbled_len, msg.len() - ); - - let unjumbled = f4jumble_inv(&jumbled).unwrap(); - prop_assert_eq!( - jumbled_len, unjumbled.len(), - "Unjumbled length {} was not equal to jumbled length {}", - unjumbled.len(), jumbled_len - ); - - prop_assert_eq!(msg, unjumbled, "Unjumbled message did not match original message."); - } - } - - #[test] - fn f4jumble_check_vectors() { - for v in test_vectors() { - let jumbled = f4jumble(&v.normal).unwrap(); - assert_eq!(jumbled, v.jumbled); - let unjumbled = f4jumble_inv(&v.jumbled).unwrap(); - assert_eq!(unjumbled, v.normal); - } - } - - #[test] - fn f4jumble_check_vectors_long() { - for v in test_vectors_long::TEST_VECTORS { - let normal: Vec = (0..v.length).map(|i| i as u8).collect(); - let jumbled = f4jumble(&normal).unwrap(); - assert_eq!(blake2b(&jumbled).as_bytes(), v.jumbled_hash); - let unjumbled = f4jumble_inv(&jumbled).unwrap(); - assert_eq!(unjumbled, normal); - } - } -} From 501a343fc9ce8092cd53ef74bf34fef73a5c0424 Mon Sep 17 00:00:00 2001 From: str4d Date: Thu, 23 Sep 2021 04:22:18 +1200 Subject: [PATCH 3/4] f4jumble: Update authors list Co-authored-by: Daira Hopwood --- components/f4jumble/Cargo.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/components/f4jumble/Cargo.toml b/components/f4jumble/Cargo.toml index 7e2b0cfa3..5412ad72f 100644 --- a/components/f4jumble/Cargo.toml +++ b/components/f4jumble/Cargo.toml @@ -5,6 +5,7 @@ version = "0.0.0" authors = [ "Jack Grigg ", "Kris Nuttycombe ", + "Daira Hopwood ", ] homepage = "https://github.com/zcash/librustzcash" repository = "https://github.com/zcash/librustzcash" From edd341faba1a9ba7001415cef6dc17750c60eef0 Mon Sep 17 00:00:00 2001 From: str4d Date: Thu, 23 Sep 2021 04:38:39 +1200 Subject: [PATCH 4/4] f4jumble: Add description to README Co-authored-by: Daira Hopwood --- components/f4jumble/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/components/f4jumble/README.md b/components/f4jumble/README.md index 51d05aa46..0777ab59b 100644 --- a/components/f4jumble/README.md +++ b/components/f4jumble/README.md @@ -1,6 +1,10 @@ # f4jumble -TBD +An implementation of the F4Jumble algorithm, an unkeyed variable-width +permutation. + +F4Jumble is used by Zcash Unified Addresses and Unified Viewing Keys to +prevent certain kinds of malleation attacks, and is specified by [ZIP 316](https://zips.z.cash/zip316). ## License