Skip to main content

Evervault SDK

Project description


Unit Tests Status

Evervault Python SDK

The Evervault Python SDK is a toolkit for encrypting data as it enters your server, working with Functions, and proxying your outbound api requests to specific domains through Outbound Relay to allow them to be decrypted before reaching their target.

Getting Started

Before starting with the Evervault Python SDK, you will need to create an account and a team.

For full installation support, book time here.

Before contributing, make sure to use commitizen & to read


See the Evervault Python SDK documentation.


Our Python SDK is distributed via pypi, and can be installed using pip.

pip install evervault


To make Evervault available for use in your app:

import evervault

# Initialize the client with your team’s API key

# Encrypt your data
encrypted = evervault.encrypt({ "name": "Claude" })

# Process the encrypted data in a Function
result ="<YOUR_FUNCTION_NAME>", encrypted)

# Send the decrypted data to a third-party API
evervault.enable_outbound_relay()"", json = encrypted)

# Send attested requests to a Cage
attested_session = evervault.cage_requests_session({ 'my-cage': { 'pcr_8': '...' } })
# Attested TLS directly to the enclave


The Evervault Python SDK exposes five functions.


evervault.init() initializes the SDK with your API key. Configurations for the interception of outbound requests may also be passed in this function.

evervault.init(api_key = str[, decryption_domains=[], retry = bool, curve = str])
Parameter Type Description
api_key str The API key of your Evervault Team
curve str The elliptic curve used for cryptographic operations. See Elliptic Curve Support to learn more.


evervault.encrypt() encrypts data for use in your Functions. To encrypt data at the server, simply pass a python primitive type into the evervault.encrypt() function. Store the encrypted data in your database as normal.

evervault.encrypt(data = dict | list | set | str | int | bool)
Parameter Type Description
data dict, list, set, str, int, bool Data to be encrypted invokes a Function with a given payload. = str, data = dict[, options = dict])
Parameter Type Description
function_name str Name of the Function to be run.
data dict Payload for the Function.
options dict Options for the Function run.

Function Run Options

Option Type Default Description
async Boolean False Run your Function in async mode. Async Function runs will be queued for processing.
version Integer None Specify the version of your Function to run. By default, the latest version will be run.


evervault.create_run_token() creates a single use, time bound token for invoking a function.

evervault.create_run_token(function_name = str, data = dict)
Parameter Type Description
function_name str Name of the Function the run token should be created for.
data dict Payload that the token can be used with.


evervault.enable_outbound_relay() configures your application to proxy HTTP requests using Outbound Relay based on the configuration created in the Evervault dashboard. See Outbound Relay to learn more. Asynchronous HTTP requests are supported with aiohttp. Pass in a aiohttp.ClientSession to enable them for that session. Note: Requires Python 3.11+

evervault.enable_outbound_relay([decryption_domains = Array, debug_requests = Boolean])
Parameter Type Default Description
decryption_domains Array None Requests sent to any of the domains listed will be proxied through Outbound Relay. This will override the configuration created using the Evervault dashboard.
debug_requests Boolean False Output request domains and whether they were sent through Outbound Relay.
client_session aiohttp.ClientSession None The aiohttp client session to enable outbound relay on. Requires Python >= 3.11.


evervault.cage_requests_session() creates a requests Session which attests all traffic between your client and the Cage. You can provide the PCRs generated at build time to have even tighter control on the attestation.

evervault.cage_requests_session([cage_attestation_data = dict])
Parameter Type Default Description
cage_attestation_data dict None Provide attestation measures to make assertions about the code running within your enclave. The cage_attestation_data dict is a mapping of cage names to their corresponding attestation measures.


Bug reports and pull requests are welcome on GitHub at


Questions or feedback? Let us know.

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

evervault-2.2.0.tar.gz (18.6 kB view hashes)

Uploaded source

Built Distribution

evervault-2.2.0-py3-none-any.whl (22.2 kB view hashes)

Uploaded py3

Supported by

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