diff --git a/Cargo.toml b/Cargo.toml index e914c90d..735667da 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,4 +12,5 @@ members = [ "serpent", "sm4", "twofish", + "threefish", ] diff --git a/threefish/Cargo.toml b/threefish/Cargo.toml new file mode 100644 index 00000000..99dee95e --- /dev/null +++ b/threefish/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "threefish" +version = "0.1.0" +authors = ["The Rust-Crypto Project Developers"] +license = "MIT/Apache-2.0" +description = "Threefish block cipher" +documentation = "https://docs.rs/threefish" +repository = "https://github.com/RustCrypto/block-ciphers" +keywords = ["crypto", "threefish", "gost", "block-cipher"] + +[dependencies] +generic-array = "0.7" +byte-tools = "0.1" +block-cipher-trait = "0.4.0-alpha" + +[dev-dependencies] +crypto-tests = "0.4" diff --git a/threefish/LICENSE-APACHE b/threefish/LICENSE-APACHE new file mode 100644 index 00000000..78173fa2 --- /dev/null +++ b/threefish/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/threefish/LICENSE-MIT b/threefish/LICENSE-MIT new file mode 100644 index 00000000..fdc21b08 --- /dev/null +++ b/threefish/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2016-2017 Christian Barcenas, Artyom Pavlov + +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/threefish/benches/lib.rs b/threefish/benches/lib.rs new file mode 100644 index 00000000..70ff6b4c --- /dev/null +++ b/threefish/benches/lib.rs @@ -0,0 +1,55 @@ +#![no_std] +#![feature(test)] +//#[macro_use] +//extern crate crypto_tests; +extern crate threefish; + +extern crate test; +extern crate block_cipher_trait; +extern crate generic_array; + +use test::Bencher; +use block_cipher_trait::BlockCipher; +use generic_array::GenericArray; + +#[bench] +pub fn encrypt_1_256(bh: &mut Bencher) { + let key = Default::default(); + let tweak = Default::default(); + let state = threefish::Threefish256::new(&key, &tweak); + let input = &[1u8; 32]; + let mut output = GenericArray::default(); + + bh.iter(|| { + state.encrypt_block(GenericArray::from_slice(input), &mut output); + }); + bh.bytes = 32u64; +} + +#[bench] +pub fn encrypt_2_512(bh: &mut Bencher) { + let key = [0u8; 64]; + let tweak = Default::default(); + let state = threefish::Threefish512::new(&key, &tweak); + let input = &[1u8; 64]; + let mut output = GenericArray::default(); + + bh.iter(|| { + state.encrypt_block(GenericArray::from_slice(input), &mut output); + }); + bh.bytes = 64u64; +} + +#[bench] +pub fn encrypt_3_1024(bh: &mut Bencher) { + let key = [0u8; 128]; + let tweak = Default::default(); + let state = threefish::Threefish1024::new(&key, &tweak); + let input = &[1u8; 128]; + let mut output = GenericArray::default(); + + bh.iter(|| { + state.encrypt_block(GenericArray::from_slice(input), &mut output); + }); + bh.bytes = 128u64; +} diff --git a/threefish/src/consts.rs b/threefish/src/consts.rs new file mode 100644 index 00000000..d1ef7f22 --- /dev/null +++ b/threefish/src/consts.rs @@ -0,0 +1,38 @@ +// Magic constant for key schedule +pub const C240: u64 = 0x1BD11BDAA9FC1A22; + +// Rotation constants for the different key lengths +pub const R_256: [[u32; 2]; 8] = [ + [14, 16], [52, 57], [23, 40], [ 5, 37], + [25, 33], [46, 12], [58, 22], [32, 32] +]; + +pub const R_512: [[u32; 4]; 8] = [ + [46, 36, 19, 37], + [33, 27, 14, 42], + [17, 49, 36, 39], + [ 44, 9, 54, 56], + [39, 30, 34, 24], + [13, 50, 10, 17], + [25, 29, 39, 43], + [ 8, 35, 56, 22], +]; + +pub const R_1024: [[u32; 8]; 8] = [ + [24, 13, 8, 47, 8, 17, 22, 37], + [38, 19, 10, 55, 49, 18, 23, 52], + [33, 4, 51, 13, 34, 41, 59, 17], + [ 5, 20, 48, 41, 47, 28, 16, 25], + [41, 9, 37, 31, 12, 47, 44, 30], + [16, 34, 56, 51, 4, 53, 42, 41], + [31, 44, 47, 46, 19, 42, 44, 25], + [ 9, 48, 35, 52, 23, 31, 37, 20] +]; + +// Permutation tables for the different key lengths +pub const P_256: [usize; 4] = [0, 3, 2, 1]; +pub const P_512: [usize; 8] = [6, 1, 0, 7, 2, 5, 4, 3]; +pub const P_1024: [usize; 16] = [ + 0, 15, 2, 11, 6, 13, 4, 9, + 14, 1, 8, 5, 10, 3, 12, 7, +]; diff --git a/threefish/src/lib.rs b/threefish/src/lib.rs new file mode 100644 index 00000000..379223bc --- /dev/null +++ b/threefish/src/lib.rs @@ -0,0 +1,142 @@ +#![no_std] +extern crate byte_tools; +extern crate block_cipher_trait; +extern crate generic_array; +use core::ops::BitXor; + +mod consts; +use consts::{C240, R_256, R_512, R_1024, P_256, P_512, P_1024}; + +use byte_tools::{read_u64v_le, write_u64v_le}; +use block_cipher_trait::{Block, BlockCipher}; +use generic_array::typenum::{U32, U64, U128}; +//use generic_array::typenum::{U8, U32}; + +fn mix(r: u32, x: (u64, u64)) -> (u64, u64) { + let y0 = x.0.wrapping_add(x.1); + let y1 = x.1.rotate_left(r) ^ y0; + (y0, y1) +} + +fn inv_mix(r: u32, y: (u64, u64)) -> (u64, u64) { + let x1 = (y.0 ^ y.1).rotate_right(r); + let x0 = y.0.wrapping_sub(x1); + (x0, x1) +} + +macro_rules! impl_threefish( + ( + $name:ident, $rounds:expr, $n_w:expr, $block_size:ty, + $rot:expr, $perm:expr + ) => ( + + #[derive(Clone, Copy)] + pub struct $name { + sk: [[u64; $n_w]; $rounds / 4 + 1] + } + + impl $name { + pub fn new(key: &[u8; $n_w*8], tweak: &[u8; 16]) -> $name { + let mut k = [0u64; $n_w + 1]; + read_u64v_le(&mut k[..$n_w], key); + k[$n_w] = k[..$n_w].iter().fold(C240, BitXor::bitxor); + + let mut t = [0u64; 3]; + read_u64v_le(&mut t[..2], tweak); + t[2] = t[0] ^ t[1]; + + let mut sk = [[0u64; $n_w]; $rounds / 4 + 1]; + for s in 0..($rounds / 4 + 1) { + for i in 0..$n_w { + sk[s][i] = k[(s + i) % ($n_w + 1)]; + if i == $n_w - 3 { + sk[s][i] = sk[s][i].wrapping_add(t[s % 3]); + } else if i == $n_w - 2 { + sk[s][i] = sk[s][i].wrapping_add(t[(s + 1) % 3]); + } else if i == $n_w - 1 { + sk[s][i] = sk[s][i].wrapping_add(s as u64); + } + } + } + + $name { sk: sk } + } + } + + impl BlockCipher for $name { + type BlockSize = $block_size; + + fn encrypt_block(&self, + input: &Block, + output: &mut Block) + { + let mut v = [0u64; $n_w]; + read_u64v_le(&mut v, input.as_slice()); + + for d in 0..$rounds { + let v_tmp = v.clone(); + for j in 0..($n_w / 2) { + let (v0, v1) = (v_tmp[2 * j], v_tmp[2 * j + 1]); + let (e0, e1) = + if d % 4 == 0 { + (v0.wrapping_add(self.sk[d / 4][2 * j]), + v1.wrapping_add(self.sk[d / 4][2 * j + 1])) + } else { + (v0, v1) + }; + let r = $rot[d % 8][j]; + let (f0, f1) = mix(r, (e0, e1)); + let (pi0, pi1) = + ($perm[2 * j], $perm[2 * j + 1]); + v[pi0] = f0; + v[pi1] = f1; + } + } + + for i in 0..$n_w { + v[i] = v[i].wrapping_add(self.sk[$rounds / 4][i]); + } + + write_u64v_le(output.as_mut_slice(), &v); + } + + fn decrypt_block(&self, + input: &Block, + output: &mut Block) + { + let mut v = [0u64; $n_w]; + read_u64v_le(&mut v, input.as_slice()); + + for i in 0..$n_w { + v[i] = v[i].wrapping_sub(self.sk[$rounds / 4][i]); + } + + for d in (0..$rounds).rev() { + let v_tmp = v.clone(); + for j in 0..($n_w / 2) { + let (inv_pi0, inv_pi1) = + ($perm[2 * j], $perm[2 * j + 1]); + let (f0, f1) = (v_tmp[inv_pi0], v_tmp[inv_pi1]); + let r = $rot[d % 8][j]; + let (e0, e1) = inv_mix(r, (f0, f1)); + let (v0, v1) = + if d % 4 == 0 { + (e0.wrapping_sub(self.sk[d / 4][2 * j]), + e1.wrapping_sub(self.sk[d / 4][2 * j + 1])) + } else { + (e0, e1) + }; + v[2 * j] = v0; + v[2 * j + 1] = v1; + } + } + + write_u64v_le(output.as_mut_slice(), &v); + } + } + ) +); + +impl_threefish!(Threefish256, 72, 4, U32, R_256, P_256); +impl_threefish!(Threefish512, 72, 8, U64, R_512, P_512); +impl_threefish!(Threefish1024, 80, 16, U128, R_1024, P_1024);