Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

HEU

CircleCI PyPI version

中文

HEU (Homomorphic Encryption processing Unit) is a user-friendly and high-performance homomorphic encryption library that supports multiple types and scalable hardware acceleration.

document

https://www.secretflow.org.cn/docs/heu/

Repo status

Homomorphic encryption algorithms are mainly divided into two categories: partially homomorphic encryption (PHE) and fully homomorphic encryption (FHE). Currently, HEU supports most PHE algorithms, while FHE is still under development and will take some time.

Supported algorithms:

  • Additive homomorphic encryption
    • Paillier (recommended)
    • Okamoto–Uchiyama (recommended)
    • EC ElGamal
    • Damgard-Jurik
    • Damgard-Geisler-Krøigaard (DGK)
  • Fully homomorphic encryption
    • Under development and is the current focus of work.

Each algorithm includes a variety of different implementations, and some implementations support hardware accelerators. For more details, please refer to the Document

Compile and install

Environmental requirements

  • CPU
    • x86_64: minimum required AVX instruction set
    • AArch64: ARMv8
  • OS
    • Ubuntu 18.04+
    • Centos 7
    • macOS 11.1+ (macOS Big Sur+)
  • Python
    • Python 3.8+

Install via Pip

pip install sf-heu

Install from source

The following command will automatically compile and install HEU into the default Python environment:

git clone git@github.com:secretflow/heu.git
cd heu
sh build_wheel_entrypoint.sh

Run unit tests (optional)

# just compile, do not run any UT (optional)
bazel build heu/...

# compile and run all UTs
bazel test heu/...

Contribution Guidelines

SecretFlow is an open and inclusive community, and we welcome any kind of contribution. If you want to improve HEU, please refer to Contribution Guide

Metadata

Release files for sf-heu 0.5.0.dev20231128

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for sf-heu 0.5.0.dev20231128
File Interpreter ABI Platform
sf_heu-0.5.0.dev20231128-cp38-cp38-manylinux2014_x86_64.whl CPython 3.8 CPython 3.8 Linux glibc 2.17+ x86-64 Details
sf_heu-0.5.0.dev20231128-cp38-cp38-macosx_11_0_arm64.whl CPython 3.8 CPython 3.8 macOS 11.0+ ARM64 Details

Total release size: 6.1 MB

Release files / sf_heu-0.5.0.dev20231128-cp38-cp38-manylinux2014_x86_64.whl

Download URL sf_heu-0.5.0.dev20231128-cp38-cp38-manylinux2014_x86_64.whl
Size 3.1 MB
Tags CPython 3.8 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
7a38e3ee33075671577bd2be2e0429b9b57a1b78c13f39879b847786b7cabda8
BLAKE2b-256 checksum
How to use checksums
eec84ff772b4bfae3231612283ece71773a15e61ea49af010dd19e1d0c6dcad7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.18

Release files / sf_heu-0.5.0.dev20231128-cp38-cp38-macosx_11_0_arm64.whl

Download URL sf_heu-0.5.0.dev20231128-cp38-cp38-macosx_11_0_arm64.whl
Size 3.0 MB
Tags CPython 3.8 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
d28a7926e09efe9da25f705f23c59cbd2b40a15aadf36c5cedf1cc35f8e68b98
BLAKE2b-256 checksum
How to use checksums
2546f7a80ca0ad34d909761925b3a4b2194696be560b337f7a9ec78d076b5aac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.18
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page