A library for doing homomorphic encryption operations on tensors
TenSEAL is a library for doing homomorphic encryption operations on tensors, built on top of Microsoft SEAL. It provides ease of use through a Python API, while preserving efficiency by implementing most of its operations using C++.
We show the basic operations over encrypted data, more advanced usage for machine learning applications can be found on our tutorial section
import tenseal as ts
Setup TenSEAL context
context = ts.context( ts.SCHEME_TYPE.CKKS, poly_modulus_degree=8192, coeff_mod_bit_sizes=[60, 40, 40, 60] ) context.generate_galois_keys() context.global_scale = 2**40
v1 = [0, 1, 2, 3, 4] v2 = [4, 3, 2, 1, 0]
enc_v1 = ts.ckks_vector(context, v1) enc_v2 = ts.ckks_vector(context, v2)
result = enc_v1 + enc_v2 result.decrypt() # ~ [4, 4, 4, 4, 4]
result = enc_v1.dot(enc_v2) result.decrypt() # ~ 
matrix = [ [73, 0.5, 8], [81, -5, 66], [-100, -78, -2], [0, 9, 17], [69, 11 , 10], ] result = enc_v1.matmul(matrix) result.decrypt() # ~ [157, -90, 153]
$ pip install tenseal
Supported platforms and their requirements are listed below: (this are only required for building TenSEAL from source) - Linux: A modern version of GNU G++ (>= 6.0) or Clang++ (>= 5.0). - MacOS: Xcode toolchain (>= 9.3) - Windows: Microsoft Visual Studio (>= 10.0.40219.1, Visual Studio 2010 SP1 or later).
If you want to install tenseal from the repository, you should first make sure to have the requirements for your platform (listed above) and CMake (3.12 or higher) installed, then get the third party libraries (if you didn't already) by running the following command from the root directory of the project
$ git submodule init $ git submodule update
TenSEAL uses Protocol Buffers for serialization, and you will need the protocol buffer compiler too.
If you are on Windows, you will first need to build SEAL library using Visual Studio, you should use the solution file
third_party/SEALto build the project
Platform=x64. For more details check the instructions in Building Microsoft SEAL
You can then trigger the build and the installation
$ pip install .
You can use our Docker image for a ready to use environment with TenSEAL installed
$ docker container run --interactive --tty openmined/tenseal
openmined/tensealpoints to the image from the last release, use
openmined/tenseal:devfor the image built from the master branch.
You can also build your custom image, this might be handy for developers working on the project
$ docker build -t tenseal -f docker-images/Dockerfile-py38 .
To interactively run this docker image as a container after it has been built you can run
$ docker container run -it tenseal
To use this library in another Bazel project, add the following in your WORKSPACE file:
gitrepository( name = "orgopenminedtenseal", remote = "https://github.com/OpenMined/TenSEAL", branch = "master", initsubmodules = True, )
You can benchmark the implementation at any point by running
$ bazel run -c opt --spawn_strategy=standalone //tests/cpp/benchmarks:benchmark
For support in using this library, please join the #lib_tenseal Slack channel. If you’d like to follow along with any code changes to the library, please join the #code_tenseal Slack channel. Click here to join our Slack community!