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.22.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.22.dev0-cp310-abi3-manylinux_2_28_x86_64.whl (37.5 MB view details)

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

belfort_heir-2026.6.22.dev0-cp310-abi3-manylinux_2_28_aarch64.whl (36.1 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ARM64

belfort_heir-2026.6.22.dev0-cp310-abi3-macosx_11_0_arm64.whl (40.6 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: belfort_heir-2026.6.22.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.22.dev0.tar.gz
Algorithm Hash digest
SHA256 029178ad7e076e49d235751797e330af278155ec72169c2bb1c4f00ca6912348
MD5 a75a9d282290ef410f553cfef862e7b2
BLAKE2b-256 eaba741e5cf74631f9b306fb554bde00f54ca5e1d163969fe8fdc7970e72a5e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for belfort_heir-2026.6.22.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.22.dev0-cp310-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for belfort_heir-2026.6.22.dev0-cp310-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 3d220fce48aa23718b1855294807a09f64e71e9f6f633bf05821c77b5ff0b1d5
MD5 31cf772f090a68317a98b35d80d29ba9
BLAKE2b-256 d113637ce0c64e386cef14a733a29f13d90ccb0153f547016f8ee09f147f3fba

See more details on using hashes here.

Provenance

The following attestation bundles were made for belfort_heir-2026.6.22.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.22.dev0-cp310-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for belfort_heir-2026.6.22.dev0-cp310-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 f03ad78fdef67fb036f14ee4f11ca4e5a1bd6001fbba1ea52b84bd43f9120473
MD5 f3f92b8c7f046a09f79d2ecd333b3ee9
BLAKE2b-256 a15833972e2b282f9aa10735393d9724fd2ba57467e183908ec06518a1f89501

See more details on using hashes here.

Provenance

The following attestation bundles were made for belfort_heir-2026.6.22.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.22.dev0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for belfort_heir-2026.6.22.dev0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ec69e6976d7364c2698cf838c4ed32405afd605890cf3daca79a63301e3842cf
MD5 ae6b53275b0ccb9db76ac28b25ba3e20
BLAKE2b-256 0a66c562b36f2d73c681c874fe3718b104ee0f574e48b5ca51e08c1842489707

See more details on using hashes here.

Provenance

The following attestation bundles were made for belfort_heir-2026.6.22.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