Skip to main content

The HEIR compiler

Project description

HEIR: Homomorphic Encryption Intermediate Representation

GitHub Workflow Status (with event) GitHub Contributors GitHub Discussions GitHub License OpenSSF Scorecard

An MLIR-based toolchain for homomorphic encryption compilers. Read the docs at the HEIR website.

For more information on MLIR, see the MLIR homepage.

Quickstart (Python)

Pip install the heir_py package

pip install heir_py

Then run an example:

from heir import compile
from heir.mlir import I64, Secret

@compile()  # defaults to scheme="bgv", OpenFHE backend, and debug=False
def func(x: Secret[I64], y: Secret[I64]):
    sum = x + y
    diff = x - y
    mul = x * y
    expression = sum * diff + mul
    deadcode = expression * mul
    return expression

func.setup()
enc_x = func.encrypt_x(7)
enc_y = func.encrypt_y(8)
result_enc = func.eval(enc_x, enc_y)
result = func.decrypt_result(result_enc)

print(
  f"Expected result for `func`: {func.original(7,8)}, FHE result:"
  f" {result}"
)

This will compile the function above using the BGV scheme to machine code via the OpenFHE backend. Then calling the function will encrypt the inputs, run the function, and return the decrypted result. The function call foo(7, 8) runs the entire encrypt-run-decrypt flow for ease of testing.

Building from source

HEIR requires a recent C compiler (see clang_matrix for version-specific support, recent GCCs also tend to work), and some backends like OpenFHE require libomp-dev.

HEIR depends on LLVM (from source) so a clean build may take 15-30 minutes depending on your machine.

This project uses bazel for its build system. Install bazelisk to manage the bazel version automatically. Then, with bazel on your path (pointing to bazelisk), run the following to build the main pass-running tool.

bazel build //tools:heir-opt

Or run an end-to-end test like

bazel test //tests/Examples/openfhe/ckks/halevi_shoup_matvec:all

See the bazel tips page for more example commands and tips on using bazel.

Supported backends and schemes

Backend Library BGV BFV CKKS CGGI
OpenFHE
Lattigo
tfhe-rs
Jaxite

Note some backends do not support all schemes.

Contributing

There are many ways to contribute to HEIR:

Citations

The HEIR project can be cited in in academic work through following entry:

@misc{ali2025heir,
      title={HEIR: A Universal Compiler for Homomorphic Encryption},
      author={Asra Ali and Jaeho Choi and Bryant Gipson and Shruthi Gorantala
              and Jeremy Kun and Wouter Legiest and Lawrence Lim and Alexander
              Viand and Meron Zerihun Demissie and Hongren Zheng},
      year={2025},
      eprint={2508.11095},
      archivePrefix={arXiv},
      primaryClass={cs.CR},
      url={https://arxiv.org/abs/2508.11095},
}

Support disclaimer

This is not an officially supported Google product.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

belfort_heir-2026.6.16.dev0.tar.gz (14.3 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

belfort_heir-2026.6.16.dev0-cp310-abi3-manylinux_2_28_x86_64.whl (37.4 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ x86-64

belfort_heir-2026.6.16.dev0-cp310-abi3-manylinux_2_28_aarch64.whl (36.0 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ARM64

belfort_heir-2026.6.16.dev0-cp310-abi3-macosx_11_0_arm64.whl (40.5 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

File details

Details for the file belfort_heir-2026.6.16.dev0.tar.gz.

File metadata

  • Download URL: belfort_heir-2026.6.16.dev0.tar.gz
  • Upload date:
  • Size: 14.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for belfort_heir-2026.6.16.dev0.tar.gz
Algorithm Hash digest
SHA256 043685a43519381e5f218b78a97f3dd6118c0bbdf6074e4d41e98ec5b0a1e538
MD5 be6f31429ef49e28c90ea66f79f408de
BLAKE2b-256 9857553356270725d5f178d4dc2d08c2284caf1b63cb26829fa219dc0d8ddab2

See more details on using hashes here.

Provenance

The following attestation bundles were made for belfort_heir-2026.6.16.dev0.tar.gz:

Publisher: release.yml on belfortlabs/heir

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file belfort_heir-2026.6.16.dev0-cp310-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for belfort_heir-2026.6.16.dev0-cp310-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c5c3907f2234f4f8eeb66a6a9d183077e00376ec27a3533a5213a92dce391d4b
MD5 8827f61705006d2a0627e1d7d63eaf1e
BLAKE2b-256 6abd57ea802c66cb1a669d456c8b0da41b13833ee0efe2c4d6f199ec9d36374c

See more details on using hashes here.

Provenance

The following attestation bundles were made for belfort_heir-2026.6.16.dev0-cp310-abi3-manylinux_2_28_x86_64.whl:

Publisher: release.yml on belfortlabs/heir

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file belfort_heir-2026.6.16.dev0-cp310-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for belfort_heir-2026.6.16.dev0-cp310-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 c28705497802ea80f638cd6b4743c0e1308582728d5c340cd7e78aedbea32c93
MD5 91f6399750ec441b8f05cac4f329b926
BLAKE2b-256 91b947912d13c322599d8831718203fa2bdd1e36db4b6158ccec759d59678848

See more details on using hashes here.

Provenance

The following attestation bundles were made for belfort_heir-2026.6.16.dev0-cp310-abi3-manylinux_2_28_aarch64.whl:

Publisher: release.yml on belfortlabs/heir

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file belfort_heir-2026.6.16.dev0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for belfort_heir-2026.6.16.dev0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 638e07926a13e4dc9e3c37204ebc67fe7900b694937598f047c56ff8dbfc2e71
MD5 75bd7979dc4582bfbb148cd4f25a723e
BLAKE2b-256 fd97be34811eea910afd917cc32fe6d03c1c2d082f3d645ed48e595876a24830

See more details on using hashes here.

Provenance

The following attestation bundles were made for belfort_heir-2026.6.16.dev0-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: release.yml on belfortlabs/heir

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page