You can use our PHP SDK to:

• Encrypt data server-side
• Decrypt data server-side
• Invoke Functions
• Proxy requests through Outbound Relay

Quickstart

Dependencies

The bindings also require the following extensions:

• openssl
• curl
• json
• mbstring

If you install the bindings using Composer, these should automatically be installed. Otherwise, ensure that the extensions are available on your system.

Install SDK

Our PHP SDK is distributed via Composer, or it can be installed manually.

1
$ composer require evervault/evervault-php

1
require_once('vendor/autoload.php');

Initialize SDK

The SDK needs to be initialized with an 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.

1
<?php
2
use \Evervault\Evervault;
3
4
$evervault = new Evervault('<APP_ID>', '<API_KEY>');

Encrypt a string

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

1
$encrypted = $evervault->encrypt('Hello, world!');

Full example

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.

1
<?php
2
use \Evervault\Evervault;
3
4
$evervault = new Evervault('<APP_ID>', '<API_KEY>');
5
6
$encryptedName = $evervault->encrypt('Alice');
7
8
$ch = curl_init();
9
curl_setopt($ch, CURLOPT_URL, 'https://example.com');
10
11
$evervault->enableOutboundRelay($ch);
12
$response = curl_exec($ch);
13
curl_close($ch);
14
15
echo $response;
16
17
// Decrypt previously encrypted data
18
$decryptedName = $evervault->encrypt($encryptedName);

Reference

$evervault->encrypt($data)

Encrypts data using Evervault Encryption. Evervault Strings can be used across all of our Primitives. To encrypt data using the PHP SDK, simply pass a string or array into the encrypt() method.

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

1
<?php
2
$evervault = new Evervault('<APP_ID>', '<API_KEY>');
3
4
$encrypted = $evervault->encrypt('Alice');
5
6
echo $encrypted;

$evervault->decrypt($encrypted)

Decrypts data previously encrypted with the encrypt() function or through Relay.

An API key with the decrypt permission must be used to perform this operation.

1
$decrypted = $evervault->decrypt($encrypted)

$evervault->createClientSideDecryptToken($payload, $expiry)

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.

1
<?php
2
$evervault = new Evervault('<APP_ID>', '<API_KEY>');
3
$encrypted = $evervault->encrypt('Alice');
4
$timeInFiveMinutes = time() + 5*60;
5
6
$token = $evervault->createClientSideDecryptToken($encrypted, $timeInFiveMinutes);

$evervault->run($functionName, $data)

Lets you invoke an Evervault Function with a given payload.

1
<?php
2
$evervault = new Evervault('<APP_ID>', '<API_KEY>');
3
4
$encrypted = $evervault->encrypt('Alice');
5
6
$result = $evervault->run(
7
    'hello-function',
8
    (object) [
9
        'name' => 'Claude Shannon',
10
        'ssn' => 'ev:encrypted_string'
11
    ]
12
);

Response

The run() function returns an associative array. This array includes a unique run ID, the status of the execution denoted as success or failure, and, in cases of a successful run, the output generated by the function.

1
{
2
  "id": "func_run_09413338da56",
3
  "status": "success",
4
  "result": {
5
    "message": "Hello from a Function! It seems you have 14 letters in your name",
6
    "name": "ev:RFVC:TTLHY04oVJlBuvPx:A7MeNriTKFES0Djl9uKaPvHCAn9PjSfOHu7tswXFCHF9:jwYKE13o3iQlr6Dn/DRk80XpNOGb:$"
7
  }
8
}

$evervault->createRunToken($functionName, $data)

Creates a single use, time bound token (5 minutes) for invoking an Evervault Function with a given payload. If the payload is an empty object, the Run Token will be valid for any payload.

Run Tokens can be used to invoke an Evervault Function client-side without providing a sensitive API Key.

1
<?php
2
$evervault = new Evervault('<APP_ID>', '<API_KEY>');
3
4
$runToken = $evervault->createRunToken(
5
    'hello-function',
6
    (object) [
7
        'name' => 'Claude Shannon',
8
        'ssn' => 'ev:encrypted_string'
9
    ]
10
);
11
12
var_dump($runToken);

Response

When you create a Run Token, the SDK will return a JSON object containing your token.

1
{
2
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsInZlciI6IjAuMCJ9.eyJhcHBVdWlkIjoiYXBwX2RmZGE3MmUwMTZiMCIsImZ1bmN0aW9uTmFtZSI6ImhlbGxvLWNhZ2UtdGFsbC13YWxscy10cmF2ZWwiLCJydW5JZCI6IjRiMjhmMzNlLWU3NjYtNDI2OC1iNmY2LTUyYzZkM2VmMGQzYyIsImV4cCI6MTY2Nzg3Njc2Nn0.gCiFw7UJ8gjZfeXNEaqX4H1Y9HBX9avjioZ4yDU8PTtmGT4QTzVOhnDV46v_yyXLxpO1BgzoBRpYbLciiW1_QXSLmx6cCuJy4vHUZwssHT13vB7AXIl_88Ab5R7w9vpOQIDoCjhPVWJsolwUiiGh_5yE4wGv6WPTIfSv249_hpJLMz3AAffXUckiLPxFporY73KXtTANQH_zniivB91KdBnyGhle7gTs1EXWLqpdMIrqOz9cmoXU31DGd-AgeMzM082s_XtdCFq7FNLLtg6Nx8Mx8Bjl0cKV41R-jbTpHSXxutLX-PSDmWn5wSqDhlQoEWdTLsoS6xp7qhZ2urYyYg"
3
}

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

curl https://api.evervault.com/functions/hello-function/runs \
     -X POST \
     -H 'Authorization: RunToken eyJ..Tg' \
     -H 'Content-Type: application/json' \
	 --data '{"payload": {"name": "Claude Shannon", "ssn": "ev:encrypted_string"} }'

$evervault->enableOutboundRelay($curlHandler)

Configures your application to proxy HTTP requests using Outbound Relay for any requests to Outbound Relay destinations sent using the cURL handler provided.

Outbound Relay must be enabled for a CurlHandle after the destination URL has been set, and before curl_exec() is called.

1
<?php
2
$evervault = new Evervault('<APP_ID>', '<API_KEY>');
3
4
$curlHandler = curl_init();
5
6
curl_setopt($ch, CURLOPT_URL, 'https://example.com');
7
$evervault->enableOutboundRelay($curlHandler);
8
9
$response = curl_exec($ch);
10
curl_close($ch);