Evervault Node.js SDK

The Evervault Node.js SDK is a toolkit for encrypting data as it enters your server, and working with Functions. By default, initializing the SDK will result in all outbound HTTPS requests being intercepted and decrypted.

Getting Started

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

For full installation support, book time here.

Documentation

See the Evervault Node.js SDK documentation.

Installation

Our Node.js SDK is distributed via npm, and can be installed using your preferred package manager.

npm install --save @evervault/sdk

yarn add @evervault/sdk

Setup

To make Evervault available for use in your app:

const Evervault = require('@evervault/sdk');

// Initialize the client with your App ID and API Key
const evervaultClient = new Evervault('<APP_ID>', '<API_KEY>');

// Encrypt your sensitive data
const encrypted = await evervaultClient.encrypt({ ssn: '012-34-5678' });

// Process the encrypted data in a Function
const result = await evervaultClient.run('<FUNCTION_NAME>', encrypted);

// Send the decrypted data to a third-party API
await evervaultClient.enableOutboundRelay();
const response = await axios.post('https://example.com', encrypted);

// Use HTTPSProxyAgent to send data to a third-party
const httpsAgent = evervault.createRelayHttpsAgent();
const response = await axios.get('https://example.com', { 
  httpsAgent
});

// Decrypt the data
const decrypted = await evervaultClient.decrypt(encrypted);

// Enable the Cages beta client
await evervaultClient.enableCagesBeta({ 'my-cage': { pcr8: '...' } });
const response = await axios.post(
  'https://my-cage.my-app.cages.evervault.com',
  encrypted
); // This connection will be attested by the Cages beta client

Reference

The Evervault Node.js SDK exposes six functions.

evervault.encrypt()

evervault.encrypt() encrypts data. To encrypt data at the server, simply pass a string, boolean, number, array, object or buffer into the evervault.encrypt() function. Store the encrypted data in your database as normal.

async evervault.encrypt(data: string | boolean | number | Array | Object | Buffer);

evervault.decrypt()

evervault.decrypt() decrypts data previously encrypted with the encrypt() function or through Evervault's Relay (Evervault's encryption proxy). An API Key with the decrypt permission must be used to perform this operation.

async evervault.decrypt(encrypted: string | Array | Object | Buffer);

evervault.createClientSideDecryptToken()

evervault.createClientSideDecryptToken() creates a token that can be used to authenticate a decrypt() request from a frontend/client application. An API Key with the Create Token permission must be used to perform this operation.

async evervault.createClientSideDecryptToken(payload: string | Array | Object, expiry: Date);

evervault.run()

evervault.run() invokes a Function with a given payload. An API Key with the run function permission must be used to perform this operation.

async evervault.run(functionName: String, payload: Object[, options: Object]);

Function Run Options

Options to control how your Function is run

evervault.createRunToken()

evervault.createRunToken() creates a single use, time bound token for invoking a Function. An API Key with the create a run token permission must be used to perform this operation.

async evervault.createRunToken(functionName: String, payload: Object);

evervault.enableOutboundRelay()

evervault.enableOutboundRelay() 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.

async evervault.enableOutboundRelay([options: Object])

evervault.createRelayHttpsAgent()

evervault.createRelayHttpsAgent() will return a HttpsProxyAgent configred to proxy traffic through Relay.

async evervault.createRelayHttpsAgent([options: Object])

createRelayHttpsAgent axios example

const httpsAgent = evervault.createRelayHttpsAgent();
const response = await axios.get('https://example.com', { 
  httpsAgent
});

evervault.enableCagesBeta()

evervault.enableCagesBeta() configures your client to automatically attest any requests to Cages. See the Cage attestation docs to learn more.

async evervault.enableCagesBeta([cageAttestationData: Object])

Cages Beta Example

await evervault.enableCagesBeta({
  'hello-cage': {
    pcr8: '97c5395a83c0d6a04d53ff962663c714c178c24500bf97f78456ed3721d922cf3f940614da4bb90107c439bc4a1443ca',
  },
});

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/evervault/evervault-node.

Please see CONTRIBUTING.md for more details.

Feedback

Questions or feedback? Let us know.