Java

Encrypting/Decrypting data with our backend SDKs may expose you to greater compliance burden because your server needs to handle plaintext data. Instead, we recommend using Relay or our Client-Side SDKs to encrypt data.

Getting started

Install the SDK

First, let's install the Evervault SDK using either gradle or maven.

1implementation 'com.evervault:lib:4.2.0'

Initialize the SDK

Now, let's initialize the SDK using our App's ID and API key. If you don't have one yet, you can get one by creating an App in the Evervault Dashboard.

1import com.evervault.Evervault;
2
3Evervault evervault = new Evervault("<APP_ID>", "<API_KEY>");

Encrypt a string

Now that the SDK is initialized, we can encrypt a string.

1String encrypted = (String) evervault.encrypt("Hello, world!");

Reference

Evervault()

The SDK constructor takes two parameters; your App's ID and API key.

1import com.evervault.Evervault;
2
3var evervault = new Evervault("<APP_ID>", "<API_KEY>");

Parameters

app_idRequiredString
Your Evervault App's ID.
api_keyRequiredString
Your Evervault App's API Key.

encrypt()

Encrypts data using Evervault Encryption. Evervault Strings can be used across all of our products.

To encrypt data using the Java SDK, simply pass a value into the evervault.encrypt() function. encrypt() will encrypt your data and return an object which is a String in case you passed a literal type like bool, String, int, float, char, byte.

The encrypted data can be stored in your database as normal and can be used with any of Evervault’s other services.

1import com.evervault.Evervault;
2
3Evervault evervault = new Evervault("<APP_ID>", "<API_KEY>");
4
5String result = (String) evervault.encrypt("Hello, world!");

Parameters

dataRequiredString | Map | int | float | char | bool | byte
The data to encrypt.

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.

1private static class Bar {
2    public String name;
3}
4
5void encryptAndDecrypt() throws EvervaultException {
6    Evervault evervault = new Evervault("<APP_ID>", "<API_KEY>");
7
8    // Encrypt some data
9    String encryptedName = (String) evervault.encrypt("foo");
10
11    // Decrypt the previously encrypted data
12    Map<String, String> dataToDecrypt = new HashMap<String, String>();
13    dataToDecrypt.put("name", encryptedName);
14
15    // Decrypts and deserialises the encrypted data into a `Bar` instance
16    Bar decryptedData = evervault.decrypt(dataToDecrypt, Bar.class);
17
18    System.out.println(decryptedData.name); // Prints `foo`
19}

Parameters

dataRequiredObject
The data to decrypt.
valueTypeRequiredClass<T>
The value type of the dat to deserialize into.

PCI Compliance

Decrypting data with our backend SDKs is not available if you are part of the PCI or HIPAA compliance use cases. Instead you can:

Use Relay to decrypt data before it reaches third-party services.
Use Functions or Enclaves to process encrypted data.

createClientSideDecryptToken()

Client Side Decrypt 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.

1String encryptedData = (String) evervault.encrypt("foo");
2Instant timeInFiveMinutes = Instant.now().plus(minutes, ChronoUnit.MINUTES);
3
4TokenResult token = evervault.createClientSideDecryptToken(encryptedData, timeInFiveMinutes);

Parameters

payloadRequiredObject
The payload containing encrypted data that the token will be used to decrypt.
expiryInstant
The time the token will expire. Defaults to 5 minutes in the future.

run()

Lets you invoke an Evervault Function with a given payload. The function result will be deserialized into an instance of responseType and will be returned.

1void runFunction() throws EvervaultException {
2    Evervault evervault = new Evervault("<APP_ID>", "<API_KEY>");
3
4    // Encrypt some data
5    String encryptedSsn = (String) evervault.encrypt("478-32-9183");
6
7    // Create the function payload
8    Map<String, String> functionPayload = new HashMap<String, String>();
9    functionPayload.put("ssn", encryptedSsn);
10
11    // Deserializes the function response into a `Result` instance
12    Result result = evervault.run("ssn-validation-function", functionPayload, Result.class);
13    System.out.println("Validation result": + result.isValid);
14}
15
16public class Result {
17    public boolean isValid;
18}

Parameters

functionNameRequiredString
The name of the function to invoke.
payloadRequiredObject
The payload to pass to the function.
responseTypeRequiredObject
The type into which the function's result will be serialized.
timeoutint
The request timeout defines the maximum duration the SDK will wait before aborting the function run if it has not completed.

createRunToken()

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.

1import com.evervault.Evervault;
2
3Evervault evervault = new Evervault("<APP_ID>", "<API_KEY>");
4
5Map<String, String> payload = new HashMap<String, String>();
6payload.put("ssn", "ev:encrypted_string")
7
8RunToken runToken = evervault.createRunToken(
9    "hello-function",
10    payload
11);

Parameters

functionNameRequiredString
The name of the function to invoke.
payloadObject
Payload that the token can be used with. If not provided, a run token will be created, and the payload will not be validated when the function is executed.

Run Tokens can then be used to authenticate Function runs from the client-side.

1fetch("https://api.evervault.com/functions/[function-name]/runs", {
2  method: "POST",
3  headers: {
4    "Content-Type": "application/json",
5    Authorization: `RunToken [run-token]`,
6  },
7  body: JSON.stringify({
8    payload: {
9      ssn: "encrypted_string",
10    },
11  }),
12});

Java

Parameters

Parameters

Parameters

PCI Compliance

Parameters

Parameters

Parameters

On this page