Intel(R) Cryptography Primitives Library 1.0.1

Author: ipl_ci

BUILD.md

@@ -10,14 +10,13 @@
 - [Building Intel® Cryptography Primitives Library on macOS\*](#building-intel-cryptography-primitives-library-on-macos)
 - [CMake Build Options](#cmake-build-options)
     - [Common for all operating systems](#common-for-all-operating-systems)
-    - [Windows\* OS](#windows-os-1)
-    - [Linux\* OS](#linux-os-1)
+    - [Windows\* OS](#windows-os)
+    - [Linux\* OS](#linux-os)
 - [CMake Commands FAQ](#cmake-commands-faq)
+    - [How to build a 32-bit library?](#how-to-build-a-32-bit-library)
     - [How to build a 64-bit generic library without any CPU-specific optimizations?](#how-to-build-a-64-bit-generic-library-without-any-cpu-specific-optimizations)
     - [How to build two libraries with optimizations for Intel® Advanced Vector Extensions 2 and Intel® Advanced Vector Extensions 512 instruction sets?](#how-to-build-two-libraries-with-optimizations-for-intel-advanced-vector-extensions-2-and-intel-advanced-vector-extensions-512-instruction-sets)
     - [How to build a library to work in a kernel space?](#how-to-build-a-library-to-work-in-a-kernel-space)
-    - [How to specify path to OpenSSL*](#how-to-specify-path-to-openssl)
-    - [How to run Intel® Cryptography Primitives Library with clang-tidy?](#how-to-run-intel-cryptography-primitives-library-with-clang-tidy)
 - [Incorporating Intel® Cryptography Primitives Library sources into custom build system](#incorporating-intel-cryptography-primitives-library-sources-into-custom-build-system)
 
 
@@ -63,7 +62,7 @@ To build the Intel® Cryptography Primitives Library on Linux\* OS, complete the
 1. Clone the source code from GitHub\* as follows:
 
     ``` bash
-    git clone --recursive https://github.com/intel/cryptography-primitives
+    git clone --recursive https://github.com/intel/ipp-crypto
     ```
 
 2. Set the environment for one of the supported C/C++ compilers.
@@ -114,7 +113,7 @@ To build the Intel® Cryptography Primitives Library on Windows* OS, complete th
 1. Clone the source code from GitHub\* as follows:
 
     ``` bash
-    git clone --recursive https://github.com/intel/cryptography-primitives
+    git clone --recursive https://github.com/intel/ipp-crypto
     ```
 
 2. Set the environment variables for one of the supported C/C++ compilers.
@@ -153,7 +152,7 @@ To build the Intel® Cryptography Primitives Library on Windows* OS, complete th
 
 ## Building Intel® Cryptography Primitives Library on macOS\*
 
-> **NOTE:** Intel® Cryptography Primitives Library stopped macOS\* validation and maintenance based on the announcement in the [Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography) 2021.9 release notes](https://www.intel.com/content/www/us/en/developer/articles/release-notes/intel-ipp-previous-release-notes.html#inpage-nav-1-1).\
+> **NOTE:** Intel® Cryptography Primitives Library stopped macOS\* validation and maintenance based on the announcement in the [Intel® Integrated Performance Primitives Cryptography (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).
 
@@ -162,7 +161,7 @@ To build the Intel® Cryptography Primitives Library on macOS\*, complete the fo
 1. Clone the source code from GitHub\* as follows:
 
     ``` bash
-    git clone --recursive https://github.com/intel/cryptography-primitives
+    git clone --recursive https://github.com/intel/ipp-crypto
     ```
 
 2. Set the environment variables for one of the supported C/C++ compilers.
@@ -223,9 +222,6 @@ To build the Intel® Cryptography Primitives Library on macOS\*, complete the fo
 
     - Example for Linux\* OS and the Intel® 64 architecture:
         `-DPLATFORM_LIST="m7;n8;y8;e9;l9;k0;k1"`
-- `-DMBX_PLATFORM_LIST="<platform list>"` - optional, works only if `-DMERGED_BLD:BOOL=off` is set. Sets target platforms for the code to be compiled for [Crypto Multi Buffer library](./sources/ippcp/crypto_mb/Readme.md). Please, refer to [Crypto Multi Buffer library target platforms list](./sources/ippcp/crypto_mb/Readme.md/#target-optimization-codes-in-function-names) to check the supported platforms.
-    - Example:
-        `-DMBX_PLATFORM_LIST="k1;l9"`
 - `-DNO_CRYPTO_MB:BOOL=TRUE` - optional, turns off the build of [Crypto Multi Buffer library](./sources/ippcp/crypto_mb/Readme.md) and, as a consequence, removes all dependencies on OpenSSL library.
 - `-DTONGSUO:BOOL=on`, `-DBORINGSSL:BOOL=on` - required only if forks of OpenSSL library are used to resolve OpenSSL dependencies - Tongsuo and BoringSSL respectively. These flags make sense when [Crypto Multi Buffer library](./sources/ippcp/crypto_mb/Readme.md) is built.
 > **NOTE:** -DBABASSL:BOOL=on flag is deprecated and targeted to be removed in the future releases. Please use -DTONGSUO:BOOL=on instead.\*.
@@ -287,13 +283,8 @@ To build the Intel® Cryptography Primitives Library on macOS\*, complete the fo
 `cmake CMakeLists.txt -B_build -DARCH=intel64 -DNONPIC_LIB:BOOL=on`
 
 ### How to specify path to OpenSSL\*
-
 `cmake CMakeLists.txt -B_build -DARCH=intel64 -DOPENSSL_INCLUDE_DIR=/path/to/openssl/include -DOPENSSL_LIBRARIES=/path/to/openssl/lib -DOPENSSL_ROOT_DIR=/path/to/openssl`
 
-### How to run Intel® Cryptography Primitives Library with clang-tidy?
-
-`CC=clang CXX=clang++ cmake CMakeLists.txt -B_build -DARCH=intel64 -DCRYPTO_USE_CLANG_TIDY:BOOL=on`
-
 ## Incorporating Intel® Cryptography Primitives Library sources into custom build system
 
 You can include Intel® Cryptography Primitives Library sources into some arbitrary project's CMake build system and build them with it.
@@ -330,3 +321,7 @@ endif()
 #     `IPPCRYPTO_INCLUDE_DIRS` - path to Intel® Cryptography Primitives Library headers
 #     `IPPCRYPTO_ROOT_DIR` - library root dir (a folder with 'include' and 'lib' directories)
 ```
+
+### How to run Intel® IPP Cryptography with clang-tidy?
+
+`CC=clang CXX=clang++ cmake CMakeLists.txt -B_build -DARCH=intel64 -DCRYPTO_USE_CLANG_TIDY:BOOL=on`

CHANGELOG.md

@@ -2,17 +2,12 @@
 
 This is a list of notable changes to Intel® Cryptography Primitives Library, in reverse chronological order.
 
-## Intel(R) Cryptography Primitives Library 1.1.0
-
-- Added single buffer SHA384, SHA512, SHA512/224, SHA512/256 hash algorithm optimizations with the new SHA512 instructions for Lunar Lake and Arrow Lake S CPUs.
-- Enabled support of [specific ISA library](./OVERVIEW.md#specific-isa-library) build for Crypto Multi buffer library.
-Cmake build options `-DMERGED_BLD:BOOL=off -DMBX_PLATFORM_LIST="k1;l9"` may be used. Please refer to
-[BUILD.md](./BUILD.md) for the details.
-- Fixed AVX512 IFMA implementation (k1 branch) of SM2 signature and verification single-buffer algorithm. The optimized path is re-enabled.
+## Intel(R) Cryptography Primitives Library 1.0.1
+- Fixed an issue with invalid memory access for AES-GCM algorithm with Intel® Advanced Vector Extensions 2 (Intel® AVX2) vector extensions of Intel® AES New Instructions (Intel® AES-NI) in case of corner sizes.
 
 ## Intel(R) Cryptography Primitives Library 1.0.0
 - Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography) was renamed to Intel(R) Cryptography Primitives Library.
-- Added single buffer SM3 hash algorithm optimization with the new SM3 instructions for Lunar Lake and Arrow Lake S CPUs.
+- Added IPPCP SM3 hash algorithm optimization with the new instruction set (SM3-NI) for Lunar Lake and Arrow Lake CPUs.
 - Added Intel® AVX-IFMA RSA implementation to Crypto Multi buffer library.
 - Fixed bug in IceLake optimization (`k1` branch) of ECDSA signature function caused by incorrect processing of R and S component's size and sign.
 - Added FIPS selftest for Leighton-Micali Hash-Based Signatures(LMS) verification algorithm.

CMakeLists.txt

@@ -50,16 +50,15 @@ if("${CMAKE_GENERATOR}" STREQUAL "NMake Makefiles")
   endif()
 endif()
 
-# on ninja/WIN32 the build type fallback mechanism needs to be placed before the `project` call
+project(${PROJECT_FULL_NAME}
+        VERSION ${PROJECT_VERSION}
+        LANGUAGES C CXX)
+
 if("${CMAKE_BUILD_TYPE}" STREQUAL "")
   message(STATUS "CMAKE_BUILD_TYPE is unset, defaulting to Release")
   set(CMAKE_BUILD_TYPE "Release")
 endif()
 
-project(${PROJECT_FULL_NAME}
-        VERSION ${PROJECT_VERSION}
-        LANGUAGES C CXX)
-
 find_package(Python REQUIRED)
 
 if(WIN32 AND (${CMAKE_GENERATOR} MATCHES "Visual Studio"))
@@ -91,10 +90,6 @@ endif()
 if("${MERGED_BLD}" STREQUAL "")
   set(MERGED_BLD ON)
 endif()
-# Crypto_mb merged build flag is set same as IPPCP by default
-if(MERGED_BLD)
-  set(MBX_MERGED_BLD ON)
-endif()
 
 # Set default installation directories
 if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
@@ -248,6 +243,7 @@ if (NOT (CRYPTO_USE_CLANG_TIDY))
   endif()
 endif()
 
+
 if(BUILD_EXAMPLES)
   # This helps to organize examples projects structure in IDE by folders
   set_property(GLOBAL PROPERTY USE_FOLDERS ON)

CONTRIBUTING.md

@@ -7,8 +7,8 @@ We welcome community contributions to Intel® Cryptography Primitives Library!
 
 If you have an idea how to improve the product:
 
- - Let us know via [GitHub* Issues](https://github.com/intel/cryptography-primitives/issues).
- - Send your proposal directly via [pull request](https://github.com/intel/cryptography-primitives/pulls).
+ - Let us know via [GitHub* Issues](https://github.com/intel/ipp-crypto/issues).
+ - Send your proposal directly via [pull request](https://github.com/intel/ipp-crypto/pulls).
 
 
 
@@ -29,7 +29,7 @@ Existing automation guarantees regular synchronization of repositories.
 </pre>
 
 ## License
-Intel® Cryptography Primitives Library is licensed under the terms in [LICENSE](./LICENSE). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
+Intel® Cryptography Primitives Library 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/).  

DEPRECATION_NOTES.md

@@ -19,7 +19,7 @@ The deprecated API means it is obsolete and will be removed in one of future Int
 
 The code paths n8/s8 (Intel® SSSE3) and g9/e9 (Intel® AVX) are deprecated and removed from the merged build of Intel® Cryptography Primitives Library, lower optimizations are used instead. 1cpu headers are still available for all code paths. These branches can also be built as 1cpu libraries if specified in the platform list, e.g. `-DMERGED_BLD:BOOL=off -DPLATFORM_LIST=s8;e9`.
 
-## Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography) 2020 Update1 (branch [ipp-crypto_2020_update1](https://github.com/intel/cryptography-primitives/tree/ipp-crypto_2020_update1))
+## Intel® Integrated Performance Primitives Cryptography (Intel® IPP Cryptography) 2020 Update1 (branch [ipp-crypto_2020_update1](https://github.com/intel/ipp-crypto/tree/ipp-crypto_2020_update1))
 
 ### Hash Functionality
 
@@ -88,14 +88,14 @@ The code paths n8/s8 (Intel® SSSE3) and g9/e9 (Intel® AVX) are deprecated and
 
 ### IppsHashAlgId to IppsHashMethod Parameter Map
 
-| Algorithm  | IppsHashAlgId (deprecated) |                          IppsHashMethod (recommended)                                     |                                                Notes                                                                                                                        |
-| :--------: | :------------------------: | :---------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-|    SHA1    |      ippsHashAlg_SHA1      | ippsHashMethod_SHA1<br>ippsHashMethod_SHA1_NI<br>ippsHashMethod_SHA1_TT                   | Intel® Secure Hash Algorithm - New Instructions (Intel® SHA-NI) not supported<br>Intel® SHA-NI only supported<br>Automatic switch on Intel® SHA-NI, if possible (tick-tock) |
-|   SHA224   |     ippsHashAlg_SHA224     | ippsHashMethod_SHA224<br>ippsHashMethod_SHA224_NI<br>ippsHashMethod_SHA224_TT             | Intel® SHA-NI not supported<br>Intel® SHA-NI only supported<br>Automatic switch on Intel® SHA-NI, if possible supported                                                     |
-|   SHA256   |     ippsHashAlg_SHA256     | ippsHashMethod_SHA256<br>ippsHashMethod_SHA256_NI<br>ippsHashMethod_SHA256_TT             | Intel® SHA-NI not supported<br>Intel® SHA-NI only supported<br>Automatic switch on Intel® SHA-NI, if possible supported                                                     |
-|   SHA384   |     ippsHashAlg_SHA384     | ippsHashMethod_SHA384<br>ippsHashMethod_SHA384_NI<br>ippsHashMethod_SHA384_TT             | Intel® SHA512 not supported<br>Intel® SHA512 only supported<br>Automatic switch on Intel® SHA512, if possible supported                                                     |
-|   SHA512   |     ippsHashAgl_SHA512     | ippsHashMethod_SHA512<br>ippsHashMethod_SHA512_NI<br>ippsHashMethod_SHA512_TT             | Intel® SHA512 not supported<br>Intel® SHA512 only supported<br>Automatic switch on Intel® SHA512, if possible supported                                                     |
-|    SM3     |      ippsHashAlg_SM3       |                              ippsHashMethod_SM3                                           |                                                  -                                                                                                                          |
-|    MD5     |      ippsHashAlg_MD5       |                              ippsHashMethod_MD5                                           |                                                  -                                                                                                                          |
-| SHA512-224 |   ippsHashAlg_SHA512_224   | ippsHashMethod_SHA512_224<br>ippsHashMethod_SHA512_224_NI<br>ippsHashMethod_SHA512_224_TT | Intel® SHA512 not supported<br>Intel® SHA512 only supported<br>Automatic switch on Intel® SHA512, if possible supported                                                     |
-| SHA512-256 |   ippsHashAlg_SHA512_256   | ippsHashMethod_SHA512_256<br>ippsHashMethod_SHA512_256_NI<br>ippsHashMethod_SHA512_256_TT | Intel® SHA512 not supported<br>Intel® SHA512 only supported<br>Automatic switch on Intel® SHA512, if possible supported                                                     |
+| Algorithm  | IppsHashAlgId (deprecated) |                          IppsHashMethod (recommended)                          |                                                 Notes                                                 |
+| :--------: | :------------------------: | :---------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: |
+|    SHA1    |      ippsHashAlg_SHA1      |    ippsHashMethod_SHA1<br>ippsHashMethod_SHA1_NI<br>ippsHashMethod_SHA1_TT    |  Intel® Secure Hash Algorithm - New Instructions (Intel® SHA-NI) not supported<br>Intel SHA-NI only supported<br>Automatic switch on Intel SHA-NI, if possible (tick-tock) |
+|   SHA224   |     ippsHashAlg_SHA224     | ippsHashMethod_SHA224<br>ippsHashMethod_SHA224_NI<br>ippsHashMethod_SHA224_TT |  Intel SHA-NI not supported<br>Intel SHA-NI only supported<br>Automatic switch on Intel SHA-NI, if possible supported  |
+|   SHA256   |     ippsHashAlg_SHA256     | ippsHashMethod_SHA256<br>ippsHashMethod_SHA256_NI<br>ippsHashMethod_SHA256_TT |  Intel SHA-NI not supported<br>Intel SHA-NI only supported<br>Automatic switch on Intel SHA-NI, if possible supported  |
+|   SHA384   |     ippsHashAlg_SHA384     |                             ippsHashMethod_SHA384                             |                                                  -                                                   |
+|   SHA512   |     ippsHashAgl_SHA512     |                             ippsHashMethod_SHA512                             |                                                  -                                                   |
+|    SM3     |      ippsHashAlg_SM3       |                              ippsHashMethod_SM3                               |                                                  -                                                   |
+|    MD5     |      ippsHashAlg_MD5       |                              ippsHashMethod_MD5                               |                                                  -                                                   |
+| SHA512-224 |   ippsHashAlg_SHA512_224   |                           ippsHashMethod_SHA512_224                           |                                                  -                                                   |
+| SHA512-256 |   ippsHashAlg_SHA512_256   |                           ippsHashMethod_SHA512_256                           |                                                  -                                                   |