WW3'24 source code update

Author: ipl_ci

.gitignore

@@ -0,0 +1,33 @@
+# Common certs and secrets
+
+*.pem
+*.pgp
+*.gpg
+*.key
+*.crt
+
+## Common Linux files ##
+# Backup or temp files
+*~
+*.pyc
+*.obj
+.idea
+__pycache__/
+
+# temporary files if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+## Common Mac files ##
+
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+
+## Common Windows files ##
+
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+*.lnk

BUILD.md

@@ -147,11 +147,11 @@ To build the Intel IPP Cryptography library on Windows* OS, complete the followi
 
 ## Building Intel IPP Cryptography on macOS\*
 
-The software was validated on:
-
-- macOS\* 12.0
+> **NOTE:** Intel IPP Cryptography stopped macOS\* validation and maintenance based on the announcement in the [Intel IPP Cryptography 2021.9 release notes](https://www.intel.com/content/www/us/en/developer/articles/release-notes/release-notes-for-oneapi-integrated-performance-primitives.html#inpage-nav-3-1).\
+The Intel IPP Cryptography 2021.10 release is the last release validated on macOS\* 12.0.\
+For further macOS\* testing and maintenance we are relying on contributions from the community. For more details, see [Contributing Rules](./CONTRIBUTING.md).
 
-To build the Intel IPP Cryptography library on macOS*, complete the following steps:
+To build the Intel IPP Cryptography library on macOS\*, complete the following steps:
 
 1. Clone the source code from GitHub\* as follows:
 
@@ -219,14 +219,24 @@ To build the Intel IPP Cryptography library on macOS*, complete the following st
         `-DPLATFORM_LIST="w7;n8;y8;e9;l9;k0"`
 - `-DIPPCP_CUSTOM_BUILD="<CPU features list>"` - optional, works only if `-DMERGED_BLD:BOOL=off` is set, i.e. only for 1CPU libraries. Enables the CPU feature dispatching mask at compile-time based on the provided list.
 
-   - Currently supported by the library custom features dispatching: 
+   - Currently supported by the library custom features dispatching:
         1. Intel® Advanced Encryption Standard New Instructions (Intel® AES-NI) code-path enabling: `IPPCP_AES_ON;IPPCP_CLMUL_ON`
-        2. Intel® Advanced Vector Extensions 512 (Intel(R) AVX-512) and vector extensions of Intel(R) AES New Instructions (Intel(R) AES-NI) code-path enabling: `IPPCP_VAES_ON;IPPCP_VCLMUL_ON`
+        2. Intel® Advanced Vector Extensions 512 (Intel® AVX-512) / Intel® Advanced Vector Extensions 2 (Intel® AVX2) vector extensions of Intel® AES New Instructions (Intel® AES-NI) code-paths enabling: `IPPCP_VAES_ON;IPPCP_VCLMUL_ON`.
     - Example:
-        `-DPLATFORM_LIST="IPPCP_AES_ON;IPPCP_CLMUL_ON"` - this combination enables Intel® AES-NI in all 1CPU libraries, which contains this code path.
+        `-DIPPCP_CUSTOM_BUILD="IPPCP_AES_ON;IPPCP_CLMUL_ON"` - this combination enables Intel® AES-NI in all 1CPU libraries, which contains this code path.
     - Example of using a combination of CPU features:
-        `-DPLATFORM_LIST="IPPCP_AES_ON;IPPCP_CLMUL_ON;IPPCP_VAES_ON;IPPCP_VCLMUL_ON"` - in this combination the highest available feature in each 1CPU library will be enabled (e.g. for `"y8"` it’s Intel® AES-NI and for `"k1"` - Intel AVX-512 VAES)
-
+        `-DIPPCP_CUSTOM_BUILD="IPPCP_AES_ON;IPPCP_CLMUL_ON;IPPCP_VAES_ON;IPPCP_VCLMUL_ON"` - in this combination the highest available feature in each 1CPU library will be enabled (e.g. for `"y8"` it’s Intel® AES-NI, for `"l9"` it's Intel® AVX2 VAES, and for `"k1"` - Intel® AVX-512 VAES)
+- `-DIPPCP_FIPS_MODE:BOOL=<on|off>` - optional. Regulates the build of FIPS-compliant Intel IPP Cryptography library.
+
+  - `-DIPPCP_FIPS_MODE:BOOL=on`: enables all FIPS-compliance changes in Intel IPP Cryptography library.
+  - `-DIPPCP_FIPS_MODE:BOOL=off`: default configuration. Intel IPP Cryptography library build with such option is not FIPS-compliant.
+- `-DIPPCP_SELFTEST_USE_MALLOC:BOOL=<on|off>` - optional. Enables internal memory allocation and release using `malloc()` and `free()` functions inside Intel IPP Cryptography library selftests.
+  - `-DIPPCP_SELFTEST_USE_MALLOC:BOOL=on`: memory management is held by FIPS selftests, all processing APIs should be called with input parameters equal to `NULL`.
+  - `-DIPPCP_SELFTEST_USE_MALLOC:BOOL=off`: default configuration. Memory management is held by customer's application, all processing APIs should be called with work buffers of the valid length.
+- `-DMBX_FIPS_MODE:BOOL=<on|off>` - optional. Regulates the build of FIPS-compliant  Crypto Multi-buffer Library.
+
+  - `-DMBX_FIPS_MODE:BOOL=on`: enables all FIPS-compliance changes in Crypto Multi-buffer Library.
+  - `-DMBX_FIPS_MODE:BOOL=off`: default configuration. Crypto Multi-buffer Library build with such option is not FIPS-compliant.
 ### Windows\* OS
 
 - `-G"<tool-chain-generator>"` - defines the native build system CMake will generate from the input files.

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This is a list of notable changes to Intel(R) IPP Cryptography, in reverse chronological order.
 
+## Intel(R) IPP Cryptography 2021.10
+- Added the verification part of eXtended Merkle Signature Scheme (XMSS) algorithm.
+- Added FIPS-compliance mode for the library. More information can be found in the [Intel(R) IPP Cryptography FIPS Guide](./README_FIPS.md).
+
 ## Intel(R) IPP Cryptography 2021.9
 - Added optimized RSA-2048 code for multi-buffer (8 buffers) Intel® AVX-512 implementation.
 - Added Intel® Advanced Vector Extensions 2 (Intel® AVX2) vector extensions of Intel® AES New Instructions (Intel® AES-NI) optimization for AES-GCM algorithm.

CMakeLists.txt

@@ -1,19 +1,18 @@
-#===============================================================================
+#=========================================================================
 # Copyright (C) 2017 Intel Corporation
 #
-# Licensed under the Apache License, Version 2.0 (the 'License');
+# 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
+# 	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,
+# 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.
-#
-#===============================================================================
+# See the License for the  specific  language  governing  permissions  and
+# limitations under the License.
+#=========================================================================
 
 #
 # Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography)

CONTRIBUTING.md

@@ -28,6 +28,17 @@ Existing automation guarantees regular synchronization of repositories.
   +-------------+                     +------------+
 </pre>
 
+## License
+Intel® IPP Cryptography is licensed under the terms in LICENSE <https://github.com/intel/ipp-crypto/blob/develop/LICENSE>. By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
+
+## Developer Certification of Origin (DCO)
+We encourage you to use Signed-off-by feature to comply with [Developer Certification of Origin (DCO)](https://developercertificate.org/).  
+The name in the commit message Signed-off-by line and your email must match the change authorship information.  Make sure your .gitconfig is set up correctly so you can use `git commit -s` for signing your commits: 
+
+`git config --global user.name "Kris Smith"`
+
+`git config --global user.email [email protected]`
+
 ## Contribution Flow
 
 - Contributor creates fork from develop, commits the changes into the created branch, opens a PR and requests a review.

OVERVIEW.md

@@ -103,7 +103,7 @@ List of CPU feature subsets that the library has special optimizations for:
 - RDRAND
 - RDSEED
 - CLMUL
-- Intel AVX-512 VAES
+- Intel AVX-512/AVX2 VAES
 - Intel AVX-512 IFMA
 - Intel AVX-512 GFNI
 

README.md

@@ -2,7 +2,7 @@
 
 [Build Instructions](./BUILD.md) | [Contributing Guide](#how-to-contribute) | [Documentation](#documentation) | [Get Help](#get-help) | [Intel IPP Product Page](https://www.intel.com/content/www/us/en/developer/tools/oneapi/ipp.html)
 
-Intel® Integrated Performance Primitives (Intel® IPP) Cryptography is a secure, fast and lightweight library of building blocks for cryptography, highly-optimized for various Intel® CPUs.
+Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography) is a secure, fast and lightweight library of building blocks for cryptography, highly-optimized for various Intel® CPUs.
 
 ## Key Features
 The library provides a comprehensive set of routines commonly used for cryptographic operations, including:
@@ -41,6 +41,11 @@ The library provides a comprehensive set of routines commonly used for cryptogra
 - Kernel mode compatibility
 - Thread-safe design
 
+## FIPS 140 Compliance
+
+Intel IPP Cryptography supports building blocks (self-tests, services) for FIPS 140-3 compliance.
+See [FIPS] (./README_FIPS.md) document for details.
+
 ## Installation
 
 [How to Get and Build the Intel IPP Cryptography Library](./BUILD.md)