Fix issues for OpenSSL 3.0 in engine framework.

- Fix build deprecated warnings against OpenSSL 3.0 - Disable QAT SW ECX, QAT HW ECX, Ciphers, PRF and HKDF due to known issues against OpenSSL 3.0. - Update OpenSSL 3.0 License and err files. - Update README and release version to v0.6.7 Signed-off-by: Yogaraj Alamenda <yogarajx.alamenda@intel.com>

Author: Yogaraj-Alamenda

LICENSE.OPENSSL3.0

@@ -0,0 +1,177 @@
+
+ Apache License
+ Version 2.0, January 2004
+ https://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

Makefile.am

@@ -19,12 +19,17 @@ endif
 endif
 
 QAT_COMMON_SRC = e_qat.c \
- e_qat_err.c \
  qat_fork.c \
  qat_events.c \
  qat_utils.c \
  qat_evp.c
 
+if QAT_OPENSSL_3
+QAT_ERR_SRC = qat_prov_err.c
+else
+QAT_ERR_SRC = e_qat_err.c
+endif
+
 if QAT_HW
  QAT_HW_SRC = qat_hw_init.c \
  qat_hw_asym_common.c \
@@ -61,6 +66,7 @@ if QAT_SW_IPSEC
 endif
 
 qatengine_la_SOURCES = ${QAT_COMMON_SRC} \
+ ${QAT_ERR_SRC} \
  ${QAT_HW_SRC} \
  ${QAT_HW_111_SRC} \
  ${QAT_HW_MEM_SRC} \
@@ -71,7 +77,7 @@ AM_CPPFLAGS = $(includes_openssl) $(includes_qat_hw_usdm) \
  $(includes_qat_hw) $(includes_qat_sw)
 
 AM_CFLAGS = $(cflags) $(cflags_cc_opt) $(cflags_qat_debug_file) \
- $(cflags_mem_driver) $(cflags_openssl_300) \
+ $(cflags_mem_driver) $(cflags_openssl_3)  \
  $(cflags_qat_engine_id) $(cflags_qat_hw_intree) \
  $(cflags_qat_hw) $(cflags_qat_sw) $(cflags_qat_sw_ipsec) \
  $(enable_qat_hw_rsa) $(enable_qat_hw_ciphers) \
@@ -110,6 +116,12 @@ if QAT_OPENSSL_110
  -rebuild -reindex -nostatic -write *.c
 
 else
-rm -f e_qat_err.c e_qat.txt && perl -I$(with_openssl_dir) $(with_openssl_dir)/util/mkerr.pl -conf e_qat.ec \
+if QAT_OPENSSL_3
+perl -I$(with_openssl_dir) $(with_openssl_dir)/util/mkerr.pl -conf qat_prov.ec \
  -rebuild -reindex *.c
+else
+rm -f e_qat_err.c e_qat.txt && perl -I$(with_openssl_dir) $(with_openssl_dir)/util/mkerr.pl -conf e_qat.ec \
+ -rebuild -reindex *.c
+
+endif
 endif

configure.ac

@@ -247,8 +247,8 @@ then
  ac_default_prefix=$with_openssl_install_dir
  if test "`grep "define OPENSSL_VERSION_MAJOR" $with_openssl_install_dir/include/openssl/opensslv.h | awk '{print $4}'`" = "3"
  then
- AC_MSG_NOTICE([Build QAT engine against OpenSSL 3.0.0])
- AC_SUBST([cflags_openssl_300], ["-DSSL_QAT_USE_ASYNC_CALLBACK"])
+ AC_MSG_NOTICE([Build QAT engine against OpenSSL 3.0])
+ AC_SUBST([cflags_openssl_3], ["-DQAT_OPENSSL_3 -DOPENSSL_SUPPRESS_DEPRECATED"])
  libdir="\$(with_openssl_install_dir)/lib/engines-3"
  else
  AC_MSG_NOTICE([Build QAT engine against OpenSSL 1.1.x])
@@ -270,8 +270,8 @@ else
  includes_openssl="`pkg-config --variable=includedir libcrypto`"
  if test "`grep "define OPENSSL_VERSION_MAJOR" $includes_openssl/openssl/opensslv.h | awk '{print $4}'`" = "3"
  then
- AC_MSG_NOTICE([Build QAT engine against OpenSSL 3.0.0])
- AC_SUBST([cflags_openssl_300], ["-DSSL_QAT_USE_ASYNC_CALLBACK"])
+ AC_MSG_NOTICE([Build QAT engine against OpenSSL 3.0])
+ AC_SUBST([cflags_openssl_3], ["-DQAT_OPENSSL_3 -DOPENSSL_SUPPRESS_DEPRECATED"])
  else
  if test "`grep "define OPENSSL_VERSION_NUMBER 0x10100" $includes_openssl/openssl/opensslv.h | wc -l`" = "1"
  then
@@ -283,6 +283,7 @@ else
  AC_SUBST([libdir])
 fi
 AM_CONDITIONAL([QAT_OPENSSL_110], [test "x$cflags_openssl_110" != "x"])
+AM_CONDITIONAL([QAT_OPENSSL_3], [test "x$cflags_openssl_3" != "x"])
 
 # If both QAT HW and QAT SW configured, then check the libraries from standard location and use accordingly.
 if test "x$cflags_qat_hw_intree" = "x"
@@ -385,7 +386,7 @@ else
  AC_MSG_NOTICE([Not Accelerating RSA to Hardware])
 fi
 
-if test "x$enable_qat_hw_ciphers" != "xno" -a "x$cflags_qat_hw" != "x"
+if test "x$enable_qat_hw_ciphers" != "xno" -a "x$cflags_qat_hw" != "x" -a "x$cflags_openssl_3" = "x"
 then
  enable_qat_hw_ciphers="-DENABLE_QAT_HW_CIPHERS"
  AC_MSG_NOTICE([Accelerating CIPHERS to Hardware])
@@ -430,7 +431,7 @@ else
  AC_MSG_NOTICE([Not Accelerating DH to Hardware])
 fi
 
-if test "x$enable_qat_hw_prf" != "xno" -a "x$cflags_qat_hw" != "x"
+if test "x$enable_qat_hw_prf" != "xno" -a "x$cflags_qat_hw" != "x" -a "x$cflags_openssl_3" = "x"
 then
  enable_qat_hw_prf="-DENABLE_QAT_HW_PRF"
  AC_MSG_NOTICE([Accelerating PRF to Hardware])
@@ -439,7 +440,7 @@ else
  AC_MSG_NOTICE([Not Accelerating PRF to Hardware])
 fi
 
-if test "x$enable_qat_hw_hkdf" = "xyes" -a "x$cflags_qat_hw" != "x"
+if test "x$enable_qat_hw_hkdf" = "xyes" -a "x$cflags_qat_hw" != "x" -a "x$cflags_openssl_3" = "x"
 then
  enable_qat_hw_hkdf="-DENABLE_QAT_HW_HKDF"
  AC_MSG_NOTICE([Accelerating HKDF to Hardware])
@@ -448,7 +449,7 @@ else
  AC_MSG_NOTICE([Not Accelerating HKDF to Hardware])
 fi
 
-if test "x$enable_qat_hw_ecx" != "xno" -a "x$cflags_qat_hw" != "x"
+if test "x$enable_qat_hw_ecx" != "xno" -a "x$cflags_qat_hw" != "x" -a "x$cflags_openssl_3" = "x"
 then
  enable_qat_hw_ecx="-DENABLE_QAT_HW_ECX"
  AC_MSG_NOTICE([Accelerating X25519/X448 to Hardware])
@@ -484,7 +485,7 @@ else
  AC_MSG_NOTICE([Not Accelerating RSA to Software (Multi-buffer)])
 fi
 
-if test "x$enable_qat_sw_ecx" != "xno" -a "x$cflags_qat_sw" != "x"
+if test "x$enable_qat_sw_ecx" != "xno" -a "x$cflags_qat_sw" != "x" -a "x$cflags_openssl_3" = "x"
 then
  enable_qat_sw_ecx="-DENABLE_QAT_SW_ECX"
  AC_MSG_NOTICE([Accelerating X25519 to Software (Multi-buffer)])

docs/licensing.md

@@ -4,6 +4,6 @@ The Licensing of the files within this project is split as follows:
 
 | Component |License | Details |
 |---|---|---|
-| Intel® QuickAssist Technology(QAT) OpenSSL* Engine | BSD License | Intel® QuickAssist Technology(QAT) OpenSSL\* Engine - BSD License. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/). Please see the `LICENSE` and `LICENSE.OPENSSL` file contained in the top level folder. Further details can be found in the file headers of the relevant files. |
+| Intel® QuickAssist Technology(QAT) OpenSSL* Engine | BSD-3-Clause | Intel® QuickAssist Technology(QAT) OpenSSL\* Engine - BSD-3-Clause. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/). Please see the `LICENSE` and `LICENSE.OPENSSL` file contained in the top level folder. Further details can be found in the file headers of the relevant files. |
 | Example Intel® Contiguous Memory Driver contained within the folder `qat_contig_mem` | GPLv2 License | Please see the file headers within the `qat_contig_mem` folder, and the full GPLv2 license contained in the file `LICENSE.GPL` within the `qat_contig_mem` folder. |
 |Example Intel® QuickAssist Technology Driver Configuration Files contained within the folder hierarchy `qat` | Dual BSD/GPLv2 License | Please see the file headers of the configuration files, and the full GPLv2 license contained in the file `LICENSE.GPL` within the `qat` folder. |

docs/limitations.md

@@ -27,5 +27,8 @@
  of the Intel® QAT driver for Linux. Use `--with-cc-opt="-DQAT_HW_DISABLE_NONZERO_MEMFREE"`
  in the Intel® QAT OpenSSL\* Engine configuration when building against earlier
  versions of the Linux driver.
+* Support for QAT HW ECX, QAT SW ECX, QAT HW PRF and QAT HW HKDF is disabled when built
+ against OpenSSL 3.0 due to known issues instead it uses non-accelerated implementation
+ from OpenSSL.
 
 [1]:https://github.com/openssl/openssl/pull/2581

docs/software_requirements.md

@@ -8,8 +8,8 @@ Driver for FreeBSD. This release was validated on the following:
 
 * Operating system: CentOS\* 7.4 64-bit version & FreeBSD\* 11.3 64-bit version
 * Kernel: GNU\*/Linux\* 3.10.0-693
-* Intel® Communications Chipset C62X Series Software for Linux\*, version **4.13**
-* Intel® Communications Chipset C62X Series Software for FreeBSD\*, version **3.9**
+* Intel® Communications Chipset C62X Series Software for Linux\*, version **4.14**
+* Intel® Communications Chipset C62X Series Software for FreeBSD\*, version **3.10**
 * OpenSSL\* 1.1.1k
 
 ## qat_sw Requirements

e_qat.c

@@ -87,7 +87,7 @@
 #include "qat_fork.h"
 #include "qat_evp.h"
 #include "qat_utils.h"
-#include "e_qat_err.h"
+
 #ifdef QAT_HW
 # include "qat_hw_ciphers.h"
 # include "qat_hw_polling.h"
@@ -150,10 +150,10 @@
 const char *engine_qat_id = STR(QAT_ENGINE_ID);
 #ifdef QAT_HW
 const char *engine_qat_name =
- "Reference implementation of QAT crypto engine(qat_hw) v0.6.6";
+ "Reference implementation of QAT crypto engine(qat_hw) v0.6.7";
 #else
 const char *engine_qat_name =
- "Reference implementation of QAT crypto engine(qat_sw) v0.6.6";
+ "Reference implementation of QAT crypto engine(qat_sw) v0.6.7";
 #endif
 unsigned int engine_inited = 0;
 
@@ -919,10 +919,12 @@ static int bind_qat(ENGINE *e, const char *id)
  goto end;
  }
 
+#ifndef QAT_OPENSSL_3
  if (!ENGINE_set_pkey_meths(e, qat_pkey_methods)) {
  WARN("ENGINE_set_pkey_meths failed\n");
  goto end;
  }
+#endif
 # ifdef QAT_INTREE
  }
 # endif
@@ -939,13 +941,15 @@ static int bind_qat(ENGINE *e, const char *id)
  goto end;
  }
  }
+# ifndef QAT_OPENSSL_3
  if (mbx_get_algo_info(MBX_ALGO_X25519)) {
  DEBUG("Multibuffer ECDH X25519 Supported\n");
  if (!ENGINE_set_pkey_meths(e, multibuff_x25519_pkey_methods)) {
  WARN("ENGINE_set_pkey_meths failed\n");
  goto end;
  }
  }
+# endif
 
  if (mbx_get_algo_info(MBX_ALGO_ECDHE_NIST_P256) &&
  mbx_get_algo_info(MBX_ALGO_ECDHE_NIST_P384) &&

e_qat.h

@@ -51,6 +51,12 @@
 # include <unistd.h>
 # include <string.h>
 
+# ifdef QAT_OPENSSL_3
+# include "qat_prov_err.h"
+# else
+# include "e_qat_err.h"
+# endif
+
 # ifdef QAT_HW
 # include "cpa.h"
 # include "cpa_types.h"