Linux

crypto/build.rs

@@ -7,33 +7,80 @@ fn main() {
 
 #[cfg(feature = "encryption")]
 fn main() {
-    println!("Running crypto Build Step");
+    let os = std::env::consts::OS;
+    let arch = std::env::consts::ARCH;
+    let cpu: &str = match arch {
+        "x86" => "_X86_",
+        "x86_64" => "_X86_",
+        _ => "_AMD64_"
+    };
+    let extra_four_q_define: &str = match cpu {
+        "_X86_" => "_BOGUS_",
+        _ => "_ARM_"    //Mac M1 need this
+    };
 
-    if std::env::consts::OS == "windows" {
-        cc::Build::new()
+    if os == "windows" {
+        return cc::Build::new()
             .file("../ffi-deps/chopper-win.cpp")
             .define("_MSC_VER", "1")
             .define("_AMD64_", "1")
-            .compile("Chopper")
-    } else {
+            .compile("Chopper");
+    }
+
+    cc::Build::new()
+        .define("__LINUX__", "1")
+        .define(cpu, "1")
+        .define(extra_four_q_define, "1")
+        .define("_AVX_", "1")
+        .define("USE_ENDO", "true")
+        .include("../ffi-deps/FourQlib/FourQ_32bit")
+        .file("../ffi-deps/FourQlib/FourQ_32bit/eccp2.c")
+        .file("../ffi-deps/FourQlib/FourQ_32bit/eccp2_no_endo.c")
+        .file("../ffi-deps/FourQlib/FourQ_32bit/crypto_util.c")
+        .file("../ffi-deps/FourQlib/FourQ_32bit/schnorrq.c")
+        .file("../ffi-deps/FourQlib/FourQ_32bit/kex.c")
+        .file("../ffi-deps/FourQlib/random/random.c")
+        .file("../ffi-deps/FourQlib/sha512/sha512.c")
+        .compile("libFourQ");
+
+    let mut binding = cc::Build::new();
+    let k12 = binding
+        .include("../ffi-deps/K12/lib")
+        .file("../ffi-deps/K12/lib/KangarooTwelve.c");
+
+    if os == "linux" {
+        k12
+            .include("../ffi-deps/K12/lib/Optimized64")
+            .file("../ffi-deps/K12/lib/Optimized64/KeccakP-1600-AVX512.s")
+            .file("../ffi-deps/K12/lib/Optimized64/KeccakP-1600-AVX2.s")
+            .file("../ffi-deps/K12/lib/Optimized64/KeccakP-1600-AVX512-plainC.c")
+            .file("../ffi-deps/K12/lib/Optimized64/KeccakP-1600-opt64.c")
+            .file("../ffi-deps/K12/lib/Optimized64/KeccakP-1600-timesN-AVX512.c")
+            .file("../ffi-deps/K12/lib/Optimized64/KeccakP-1600-timesN-AVX2.c")
+            .file("../ffi-deps/K12/lib/Optimized64/KeccakP-1600-timesN-SSSE3.c")
+            .file("../ffi-deps/K12/lib/Optimized64/KeccakP-1600-runtimeDispatch.c")
+            .flag("-march=native")
+            .flag("-mavx512vl")
+            .flag("-mavx512f")
+            .flag("-msse3")
+            .compile("KangarooTwelve");
+
         cc::Build::new()
+            .file("../ffi-deps/chopper-linux.cpp")
             .define("__LINUX__", "1")
-            .define("_ARM_", "1")
-            .define("_AVX_", "1")
-            .define("USE_ENDO", "true")
-            .include("../ffi-deps/FourQlib/FourQ_32bit")
-            .file("../ffi-deps/FourQlib/FourQ_32bit/eccp2.c")
-            .file("../ffi-deps/FourQlib/FourQ_32bit/eccp2_no_endo.c")
-            .file("../ffi-deps/FourQlib/FourQ_32bit/crypto_util.c")
-            .file("../ffi-deps/FourQlib/FourQ_32bit/schnorrq.c")
-            .file("../ffi-deps/FourQlib/FourQ_32bit/kex.c")
-            .file("../ffi-deps/FourQlib/random/random.c")
-            .file("../ffi-deps/FourQlib/sha512/sha512.c")
-            .compile("libFourQ");
+            .define(cpu, "1")
+            .compile("Chopper")
+    } else {
+        k12
+            .include("../ffi-deps/K12/lib/Inplace32BI")
+            .file("../ffi-deps/K12/lib/Inplace32BI/KeccakP-1600-inplace32BI.c")
+            .compile("KangarooTwelve");
 
         cc::Build::new()
             .file("../ffi-deps/chopper-linux.cpp")
+            .define("__LINUX__", "1")
             .define("_AMD64_", "1")
             .compile("Chopper")
+
     }
 }

ffi-deps/FourQlib/FourQ_32bit/schnorrq.c

@@ -17,7 +17,7 @@
 #include <stdlib.h>
 #include <string.h>
 
-extern int KangarooTwelveCryptoHashFunction(unsigned char* input, unsigned int inputByteLen, unsigned char* output);
+extern int KangarooTwelveCryptoHashFunction(const unsigned char* input, const unsigned int inputByteLen, unsigned char* output);
 #define CryptoHashFunction      KangarooTwelveCryptoHashFunction
 
 ECCRYPTO_STATUS SchnorrQ_KeyGeneration(const unsigned char* SecretKey, unsigned char* PublicKey)

ffi-deps/K12/README.markdown

@@ -0,0 +1,84 @@
+# What is KangarooTwelve ?
+
+[**KangarooTwelve**][k12] (or **K12**) is a fast and secure extendable-output function (XOF), the generalization of hash functions to arbitrary output lengths.
+Derived from Keccak, it aims at higher speeds than FIPS 202's SHA-3 and SHAKE functions, while retaining their flexibility and basis of security.
+
+On high-end platforms, it can exploit a high degree of parallelism, whether using multiple cores or the single-instruction multiple-data (SIMD) instruction set of modern processors.
+On Intel's Haswell and Skylake architectures, KangarooTwelve tops at less than 1.5 cycles/byte for long messages on a single core, and at 0.51 cycles/byte on the SkylakeX and Cascade Lake architectures.
+On the latest Apple A14 and M1 processors, KangarooTwelve can take advantage of the ARMv8-A's SHA-3 dedicated instructions to deliver 0.75 cycles/byte for long messages on a single core.
+On low-end platforms, as well as for short messages, it also benefits from about a factor two speed-up compared to the fastest FIPS 202 instance SHAKE128.
+
+More details can be found in our [ACNS Paper][eprint].
+
+# What can I find here?
+
+This repository contains source code that implements the extandable output (or hash) function [**KangarooTwelve**][k12] (or **K12**).
+Its purpose is to offer optimized implementations of K12 and nothing else.
+
+The code comes from the [**eXtended Keccak Code Package**][xkcp] (or **XKCP**), after much trimming to keep only what is needed for K12.
+It is still structured like the XKCP in two layers. The lower layer implements the permutation Keccak-_p_[1600, 12] and possibly parallel versions thereof, whereas the higher layer implements the sponge construction and the K12 tree hash mode.
+Also, some sources have been merged to reduce the file count.
+
+* For the higher layer, we kept only the code needed for K12.
+* For the lower layer, we removed all the functions that are not needed for K12. The lower layer therefore implements a subset of the SnP and PlSnP interfaces.
+
+For Keccak or Xoodoo-based functions other than K12 only, it is recommended to use the XKCP itself instead and not to mix both this repository and the XKCP.
+
+
+# Is there a tool to compute the K12 hash of a file?
+
+Not in this repository, but Jack O'Connor's [`kangarootwelve_xkcp.rs` repository](https://github.com/oconnor663/kangarootwelve_xkcp.rs) contains Rust bindings to this code and a `k12sum` utility.
+Pre-built binaries can be found [there](https://github.com/oconnor663/kangarootwelve_xkcp.rs/releases).
+
+
+# How can I build this K12 code?
+
+This repository uses the same build system as that of the XKCP.
+To build, the following tools are needed:
+
+* *GCC*
+* *GNU make*
+* *xsltproc*
+
+The different targets are defined in [`Makefile.build`](Makefile.build). This file is expanded into a regular makefile using *xsltproc*. To use it, simply type, e.g.,
+
+```
+make generic64/K12Tests
+```
+
+to build K12Tests generically optimized for 64-bit platforms. The name before the slash indicates the platform, while the part after the slash is the executable to build. As another example, the static (resp. dynamic) library is built by typing `make generic64/libK12.a` (resp. `.so`) or similarly with `generic64` replaced with the appropriate platform name.  An alternate C compiler can be specified via the `CC` environment variable.
+
+Instead of building an executable with *GCC*, one can choose to select the files needed and make a package. For this, simply append `.pack` to the target name, e.g.,
+
+```
+make generic64/K12Tests.pack
+```
+
+This creates a `.tar.gz` archive with all the necessary files to build the given target.
+
+The list of targets can be found at the end of [`Makefile.build`](Makefile.build) or by running `make` without parameters.
+
+## Microsoft Visual Studio support
+
+KangarooTwelve can be compiled with Microsoft Visual Studio (MSVC). The XKCP build system offers support for the creation of project files. To get a project file for a given target, simply append `.vcxproj` to the target name, e.g.,
+
+```
+make generic64noAsm/K12Tests.vcxproj
+```
+
+The targets `generic32` and `generic64noAsm` can be used with MSVC, but not `generic64` as it contains assembly implementations in the GCC syntax, which at this point cannot be used with MSVC.
+Please refer to the documention of [XKCP][xkcp] for more details on the limitations of the support of MSVC.
+
+[k12]: https://keccak.team/kangarootwelve.html
+[xkcp]: https://github.com/XKCP/XKCP
+[eprint]: https://eprint.iacr.org/2016/770.pdf
+
+
+# Acknowledgments
+
+We wish to thank:
+
+- Andy Polyakov for his expertise with the ARMv8-A+SHA3 code, and in particular for his core routine from [CRYPTOGAMS](https://github.com/dot-asm/cryptogams)
+- Duc Tri Nguyen for his benchmark on the Apple M1
+- Jack O'Connor for bug fixes and more importantly for his [Rust bindings](https://github.com/oconnor663/kangarootwelve_xkcp.rs)
+- Kent Ross for his contributions to this code and its quality