diff --git a/.clang-format b/.clang-format index 6ee397d..c2b1851 100644 --- a/.clang-format +++ b/.clang-format @@ -1,4 +1,4 @@ -# Copyright (C) 2020-2021 Intel Corporation +# Copyright (C) 2021-2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 BasedOnStyle: Google diff --git a/.gitignore b/.gitignore index 8f704c8..40cd9e8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + .vscode/ .vs/ build*/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 491a7e4..ca66725 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,3 +1,6 @@ +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + exclude: 'docs/doxygen/' repos: - repo: https://github.com/pre-commit/pre-commit-hooks diff --git a/.typos.toml b/.typos.toml index 50006f5..94783ef 100644 --- a/.typos.toml +++ b/.typos.toml @@ -1,3 +1,6 @@ +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + [default.extend-identifiers] [default.extend-words] diff --git a/CMakeLists.txt b/CMakeLists.txt index 51de00a..1179ffa 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,6 @@ # Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + cmake_minimum_required(VERSION 3.15.1) project(IPCL_PYTHON VERSION 1.0.0 LANGUAGES C CXX) diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..702e633 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,5 @@ +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + +# Default codeowner for all files +* @dpg-dbio-glade-creek-projectphe-owners diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3aa303a --- /dev/null +++ b/LICENSE @@ -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 2021-2022 Intel Corporation + + 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/README.md b/README.md index 1eefdea..ecaec3c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Python bindings and wrapper for Intel Paillier Cryptosystem Library [Intel Paillier Cryptosystem Library](https://github.com/intel/pailliercryptolib) is an open-source library which provides accelerated performance of a partial homomorphic encryption (HE), named Paillier cryptosystem, by utilizing Intel® [IPP-Crypto](https://github.com/intel/ipp-crypto) technologies on Intel CPUs supporting the AVX512IFMA instructions. The library is written in modern standard C++ and provides the essential API for the Paillier cryptosystem scheme. -Intel Paillier Cryptosystem Library - Python is an Python extension module intended for Python based privacy preserving machine learning solutions which utilizes the partial HE scheme for increased protection. +Intel Paillier Cryptosystem Library - Python is a Python extension package intended for Python based privacy preserving machine learning solutions which utilizes the partial HE scheme for increased data and model protection. ## Contents - [Python bindings and wrapper for Intel Paillier Cryptosystem Library](#python-bindings-and-wrapper-for-intel-paillier-cryptosystem-library) @@ -14,16 +14,23 @@ Intel Paillier Cryptosystem Library - Python is an Python extension module inten - [Contributors](#contributors) ## Introduction -adding intro - match front end +Paillier cryptosystem is a probabilistic asymmetric algorithm for public key cryptography and a partial homomorphic encryption scheme which allows two types of computation: +- addition of two ciphertexts +- addition and multiplication of a ciphertext by a plaintext number + +As a public key encryption scheme, Paillier cryptosystem has three stages: + + - Generate public-private key pair + - Encryption with public key + - Decryption with private key + +For increased security, typically the key length is at least 1024 bits, but recommendation is 2048 bits or larger. To handle such large size integers, conventional implementations of the Paillier cryptosystem utilizes the GNU Multiple Precision Arithmetic Library (GMP). The essential computation of the scheme relies on the modular exponentiation, and our library takes advantage of the multi-buffer modular exponentiation function (```mbx_exp_mb8```) of IPP-Crypto library, which is enabled in AVX512IFMA instruction sets supporting SKUs, such as Intel Icelake Xeon CPUs. + +The Python extension package allows ease of use of the C++ backend library. The extension provides seamless conversion from Python integer and floating point objects, which are theoretically infinite precision limited by memory size, to C++ [BigNumber type](https://www.intel.com/content/www/us/en/develop/documentation/ipp-crypto-reference/top/public-key-cryptography-functions/big-number-arithmetic.html). It also allows easier handling of arrays in ```numpy.ndarray``` or ```list``` format, for encryption, decryption and HE computations. ## Installing the package ### Requirements -In order to install and use the extension module, the system must support the AVX512IFMA instruction set, which is enabled in Intel Icelake or higher generation CPUs. -The extension runs on Python3, more specifically: -``` -python>=3.6.9 -pip>=22.0.1 -``` +In order to install and use the extension package, the system must support the AVX512IFMA instruction set, which is enabled in Intel Icelake or higher generation CPUs and runs on ```Python>=3.6.9```. ### Dependencies Must have dependencies include: @@ -32,24 +39,19 @@ cmake >=3.15.1 git pthread g++ >= 7.0 or clang >= 10.0 +pip>=22.0.1 ``` -The following libraries are also required, -``` -nasm>=2.15 -OpenSSL -``` -which can be installed by: -```bash -sudo apt update -sudo apt install libssl-dev -``` -For ```nasm```, please refer to the [Netwide Assembler webpage](https://nasm.us/) for installation details. +For additional dependencies regarding the C++ backend, refer to the [Intel Paillier Cryptosystem Library](https://github.com/intel/pailliercryptolib). ### Installation -Compiling and installing the extension can be done by: +Compiling and installing the package can be done by: ```bash python setup.py install ``` +or +```bash +pip install . +``` To test the installed module, ```bash @@ -108,7 +110,11 @@ print(np.allclose(a * b, de_d)) For more details, please refer to [documentation (TBD)](https://github.com/intel/pailliercryptolib-python). +# Standardization +This library is in compliance with the homomorphic encryption standards [ISO/IEC 18033-6](https://www.iso.org/standard/67740.html). +The compliance test is included in the C++ backend [unit-test](https://github.com/intel-sandbox/libraries.security.cryptography.homomorphic-encryption.glade.pailliercryptolib/blob/main/test/test_cryptography.cpp#L117-L258). # Contributors Main contributors to this project, sorted by alphabetical order of last name are: + - [Xiaojun Huang](https://github.com/xhuan28) - [Sejun Kim](https://github.com/skmono) (lead) - [Bin Wang](https://github.com/bwang30) diff --git a/lib/fate_fixedpoint.cmake b/lib/fate_fixedpoint.cmake index cca8a6b..a60efe4 100644 --- a/lib/fate_fixedpoint.cmake +++ b/lib/fate_fixedpoint.cmake @@ -1,4 +1,5 @@ # Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 include(ExternalProject) set(FATE_FIXEDPOINT_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/ext_fate_fixedpoint) diff --git a/lib/ipcl.cmake b/lib/ipcl.cmake index 0fcb117..b30d380 100644 --- a/lib/ipcl.cmake +++ b/lib/ipcl.cmake @@ -1,4 +1,5 @@ # Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 include(ExternalProject) MESSAGE(STATUS "Configuring Intel Paillier Cryptosystem Library") diff --git a/lib/pybind11.cmake b/lib/pybind11.cmake index 4eead72..3b4b2d1 100644 --- a/lib/pybind11.cmake +++ b/lib/pybind11.cmake @@ -1,4 +1,5 @@ # Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 include(FetchContent) find_package(Git) diff --git a/requirements.txt b/requirements.txt index 8be3c8c..551b2b2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,6 @@ +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + wheel numpy>=1.20.0 pycryptodomex>=3.6.6 diff --git a/setup.py b/setup.py index 4408478..924328d 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,8 @@ #! /usr/bin/env python3 +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + import os import re import sys diff --git a/src/ipcl_python/__init__.py b/src/ipcl_python/__init__.py index 1472298..e29705f 100644 --- a/src/ipcl_python/__init__.py +++ b/src/ipcl_python/__init__.py @@ -1,3 +1,6 @@ +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + from .ipcl_python import ( PaillierKeypair, PaillierPublicKey, diff --git a/src/ipcl_python/bindings/__init__.py b/src/ipcl_python/bindings/__init__.py index 53ae22a..90dd36c 100644 --- a/src/ipcl_python/bindings/__init__.py +++ b/src/ipcl_python/bindings/__init__.py @@ -1,2 +1,5 @@ +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + from .ipcl_bindings import * from .fixedpoint import * diff --git a/src/ipcl_python/bindings/baseconverter.cpp b/src/ipcl_python/bindings/baseconverter.cpp index a178018..e236f53 100644 --- a/src/ipcl_python/bindings/baseconverter.cpp +++ b/src/ipcl_python/bindings/baseconverter.cpp @@ -1,4 +1,5 @@ // Copyright (C) 2021-2022 Intel Corporation +// SPDX-License-Identifier: Apache-2.0 #include "include/baseconverter.h" diff --git a/src/ipcl_python/bindings/include/baseconverter.h b/src/ipcl_python/bindings/include/baseconverter.h index 60e3011..31a6783 100644 --- a/src/ipcl_python/bindings/include/baseconverter.h +++ b/src/ipcl_python/bindings/include/baseconverter.h @@ -1,4 +1,5 @@ // Copyright (C) 2021-2022 Intel Corporation +// SPDX-License-Identifier: Apache-2.0 #include diff --git a/src/ipcl_python/bindings/include/ipcl_bindings.h b/src/ipcl_python/bindings/include/ipcl_bindings.h index ab660be..e8a2526 100644 --- a/src/ipcl_python/bindings/include/ipcl_bindings.h +++ b/src/ipcl_python/bindings/include/ipcl_bindings.h @@ -1,4 +1,5 @@ // Copyright (C) 2021-2022 Intel Corporation +// SPDX-License-Identifier: Apache-2.0 #include #include diff --git a/src/ipcl_python/bindings/ipcl_bindings.cpp b/src/ipcl_python/bindings/ipcl_bindings.cpp index 918dc08..a4e9ba6 100644 --- a/src/ipcl_python/bindings/ipcl_bindings.cpp +++ b/src/ipcl_python/bindings/ipcl_bindings.cpp @@ -1,4 +1,5 @@ // Copyright (C) 2021-2022 Intel Corporation +// SPDX-License-Identifier: Apache-2.0 #include "include/ipcl_bindings.h" diff --git a/src/ipcl_python/bindings/ipcl_bindings_classes.cpp b/src/ipcl_python/bindings/ipcl_bindings_classes.cpp index 78ae681..09ca9c8 100644 --- a/src/ipcl_python/bindings/ipcl_bindings_classes.cpp +++ b/src/ipcl_python/bindings/ipcl_bindings_classes.cpp @@ -1,4 +1,5 @@ // Copyright (C) 2021-2022 Intel Corporation +// SPDX-License-Identifier: Apache-2.0 #include diff --git a/src/ipcl_python/ipcl_python.py b/src/ipcl_python/ipcl_python.py index e2d169b..09b755b 100644 --- a/src/ipcl_python/ipcl_python.py +++ b/src/ipcl_python/ipcl_python.py @@ -1,4 +1,5 @@ # Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 from .fixedpoint import FixedPointNumber from .ipcl_bindings import ( diff --git a/tests/__init__.py b/tests/__init__.py index e69de29..065f5e9 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1,2 @@ +# Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 diff --git a/tests/ipcl_python_test.py b/tests/ipcl_python_test.py index 7e8bf52..a18abc4 100644 --- a/tests/ipcl_python_test.py +++ b/tests/ipcl_python_test.py @@ -1,4 +1,5 @@ # Copyright (C) 2021-2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 import numpy as np import unittest