Reference
PHP SDK
You can use our PHP SDK to:
- Encrypt data server-side
- Invoke Functions
- Decrypt data through Outbound Relay
Encrypting data with our backend SDKs instead of Inbound Relay may expose you to greater compliance burden because plaintext data touches your server before it is encrypted.
Instead you can:
- Use an Inbound Relay to encrypt data before it reaches your server.
- Use our client-side SDKs to encrypt data before sending it to your server.
Quickstart
Dependencies
The Evervault SDK requires PHP 7.1.0 or later.
The bindings also require the following extensions:
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.
Initialize SDK
The SDK needs to be initialized with an App's API Key. If you don't have one yet, you can get one by creating an App in the Evervault Dashboard.
Encrypt a string
Now that the SDK is initialized, we can encrypt a string.
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), run it in your own environment and run the encryption and decryption for yourself.
Reference
$evervault->encrypt($data)
Encrypts data using Evervault Encryption. Evervault Strings can be used across all of our products. 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.
$evervault->run($functionName, $data, $options)
Lets you invoke an Evervault Function with a given payload.
Additional options for running the function.
Run your Function in async
mode. Asynchronous Function runs will be queued for processing and return a 200 OK
response saying your run has been queued.
Response
Function runs will return a JSON object containing a Function Run ID and the result from your Function in the following format:
$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.
Response
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.
The payload used to invoke your Function must be identical to the payload used to create the Run Token.
$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.
If the destination URL has been added as an Outbound Relay destination in the Evervault Dashboard, any requests sent to this destination using the CurlHandle
provided will be proxied through Outbound Relay.