Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Huelse/SEAL-Python
Microsoft SEAL 4.X For Python
https://github.com/Huelse/SEAL-Python
encryption he homomorphic-encryption microsoft-seal pyseal python-bindings seal seal-python
Last synced: 2 months ago
JSON representation
Microsoft SEAL 4.X For Python
- Host: GitHub
- URL: https://github.com/Huelse/SEAL-Python
- Owner: Huelse
- License: mit
- Created: 2019-07-15T09:16:52.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-27T12:25:12.000Z (3 months ago)
- Last Synced: 2024-04-04T05:44:58.070Z (3 months ago)
- Topics: encryption, he, homomorphic-encryption, microsoft-seal, pyseal, python-bindings, seal, seal-python
- Language: C++
- Homepage:
- Size: 8.45 MB
- Stars: 300
- Watchers: 10
- Forks: 66
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-he - SEAL-python - Python binding for the [Microsoft SEAL](#SEAL) library. (Libraries)
- awesome-fhe - SEAL-python - Python binding for the [Microsoft SEAL](#SEAL) library. (Libraries / [Sunscreen](https://sunscreen.tech/))
README
## Microsoft SEAL For Python
Microsoft [**SEAL**](https://github.com/microsoft/SEAL) is an easy-to-use open-source ([MIT licensed](https://github.com/microsoft/SEAL/blob/master/LICENSE)) homomorphic encryption library developed by the Cryptography Research group at Microsoft.
[**pybind11**](https://github.com/pybind/pybind11) is a lightweight header-only library that exposes C++ types in Python and vice versa, mainly to create Python bindings of existing C++ code.
This is a python binding for the Microsoft SEAL library.
## Contents
* [Build](#build)
* [Note](#note)
* [Serialize](#serialize)
* [Other](#other)
* [FAQ](#faq)
## Build
* ### Linux
Recommend: Clang++ (>= 10.0) or GNU G++ (>= 9.4), CMake (>= 3.16)
```shell
# Optional
sudo apt-get install git build-essential cmake python3 python3-dev python3-pip
# Get the repository or download from the releases
git clone https://github.com/Huelse/SEAL-Python.git
cd SEAL-Python
# Install dependencies
pip3 install numpy pybind11
# Init the SEAL and pybind11
git submodule update --init --recursive
# Get the newest repositories (dev only)
# git submodule update --remote
# Build the SEAL lib
cd SEAL
cmake -S . -B build -DSEAL_USE_MSGSL=OFF -DSEAL_USE_ZLIB=OFF
cmake --build build
cd ..
# Run the setup.py
python3 setup.py build_ext -i
# Test
cp seal.*.so examples
cd examples
python3 4_bgv_basics.py
```
Build examples: `-DSEAL_BUILD_EXAMPLES=ON`
Zstandard compression off: `-DSEAL_USE_ZSTD=OFF`
[More cmake options](https://github.com/microsoft/SEAL#basic-cmake-options)
* ### Windows
Visual Studio 2019 or newer is required. x64 support only! And use the **x64 Native Tools Command Prompt for VS** command prompt to configure and build the Microsoft SEAL library. It's usually can be found in your Start Menu.
```shell
# Run in "x64 Native Tools Command Prompt for VS" command prompt
cmake -S . -B build -G Ninja -DSEAL_USE_MSGSL=OFF -DSEAL_USE_ZLIB=OFF
cmake --build build
# Build
pip install numpy pybind11
python setup.py build_ext -i
# Test
cp seal.*.pyd examples
cd examples
python 4_bgv_basics.py
```
Microsoft SEAL official [docs](https://github.com/microsoft/SEAL#building-microsoft-seal-manually).
* ### Docker
requires: [Docker](https://www.docker.com/)
To build source code into a docker image (from this directory):
```shell
docker build -t huelse/seal -f Dockerfile .
```
To use the image by running it as an interactive container:
```shell
docker run -it huelse/seal
```
## Note
* ### Serialize
See more in `examples/7_serialization.py`, here is a simple example:
```python
cipher.save('cipher')
load_cipher = Ciphertext()
load_cipher.load(context, 'cipher') # work if the context is valid.
```
Supported classes: `EncryptionParameters, Ciphertext, Plaintext, SecretKey, PublicKey, RelinKeys, GaloisKeys`
* ### Other
There are a lot of changes in the latest SEAL lib, we try to make the API in python can be used easier, but it may remain some problems unknown, if any problems or bugs, report [issues](https://github.com/Huelse/SEAL-Python/issues).
Email: [[email protected]](mailto:[email protected]?subject=Github-SEAL-Python-Issues)
## FAQ
1. ImportError: undefined symbol
Build a shared SEAL library `cmake . -DBUILD_SHARED_LIBS=ON`, and get the `libseal.so`,
then change the path in `setup.py`, and rebuild.
2. ImportError: libseal.so... cannot find
a. `sudo ln -s /path/to/libseal.so /usr/lib`
b. add `/usr/local/lib` or the `SEAL/native/lib` to `/etc/ld.so.conf` and refresh it `sudo ldconfig`
c. build in cmake.
3. BuildError:
1. C++17 at least
2. x86_64 is required, which `x86_32` is not supported
4. ModuleNotFoundError: No module named 'seal'
The `.so` or `.pyd` file must be in the current directory, or you have `install` it already.
5. Windows Error LNK2001, RuntimeLibrary and MT_StaticRelease mismatch
Only `x64` is supported, Choose `x64 Native Tools Command Prompt for VS`.
6. Warning about building the dynamic library with static library in MacOS, etc.
1. Build a shared SEAL library by adding a CMake option `-DBUILD_SHARED_LIBS=ON`
2. Edit `extra_objects` in setup.py to `*.dylib` or else.
## Contributing
* Professor: [Dr. Chen](https://zhigang-chen.github.io/)
* [Contributors](https://github.com/Huelse/SEAL-Python/graphs/contributors)