You can use our Python SDK to:
- Encrypt data server-side
- Decrypt data server-side
- Invoke Functions
- Proxy requests through Outbound Relay
Encrypting/Decrypting data with our backend SDKs instead of Inbound Relay may expose you to greater compliance burden because your server handles plaintext data.
Instead you can:
Our Python SDK is distributed via pypi, and can be installed using
Now, let's initialize the SDK using our App's ID and our App's API key. If you don't have an API key yet, you can get one by creating an App in the Evervault Dashboard.
Now that the SDK is initialized, we can encrypt a string.
Pulling all of this together leaves us with the following working example. You can copy and paste the code below (using a sandbox API key, and App ID), run it in your own environment and run the encryption and decryption for yourself.
Initializes the SDK with your API Key and App ID.
Encrypts data using Evervault Encryption.
To encrypt a string using the Python SDK, simply pass a
str or a
dict into the
evervault.encrypt() function. To encrypt a file, pass a
The encrypted data can be stored in your database or file storage as normal. Evervault Strings can be used across all of our Primitives. Evervault File Encryption is currently in Beta, and files can only be decrypted with Outbound Relay.
evervault.decrypt() decrypts the data previously encrypted with the
encrypt() function or through Relay.
An API key with the
decrypt permission must be used to perform this operation.
evervault.run() lets you invoke an Evervault Function with a given payload.
Successful Function runs will return a dictionary containing a Function Run ID and the result from your Function in the following format:
Creates a single use, time bound token (5 minutes) for invoking an Evervault Function with a given payload. Run Tokens can be used to invoke an Evervault Function client-side without providing a sensitive API Key.
Client Side Decyrpt Tokens are versatile and short-lived tokens that frontend applications can utilise to decrypt data previously encrypted through Evervault. Client Side Decrypt Tokens are restricted to specific payloads.
By default, a Client Side Decrypt Token will live for 5 minutes into the future. The maximum time to live of the token is 10 minutes into the future.
The payload containing encrypted data that the token will be used to decrypt.
When you create a Run Token, the SDK will return a JSON object containing your token.
Run Tokens can then be used to authenticate Function runs from the client-side.
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.
Requests sent to any of the domains listed will be proxied through Outbound Relay. This will override the configuration created using the Evervault dashboard.
The aiohttp client session to enable outbound relay on. Requires Python 3.11+.
Requests session with will attest your Enclave during the TLS handshake.
By default the client will attest the Enclave using the attestation document but will not make any assertions about the values of the PCRs. The attestation can be further scoped to the software running in your enclave by passing a
dict mapping Enclave names to their corresponding PCRs.
Optional constraints to assert that the PCRs present in the Enclave's attestation doc match the expected values. This can be either a single dict, or a list of dicts to allow roll-over between different sets of PCRs.
You can also provide a callback function which returns a set of PCRs for an Enclave. This can make it easier to migrate your clients across Enclave deployments as the PCRs inevitably change.
The Evervault API exposes an endpoint to retrieve the PCRs for all active deployments of an Enclave. This can be used to keep your Client in sync with your Enclave across deployments.