NaN Producing Misery

    @evervault/sdk

    3.5.0 • Public • Published

    Evervault

    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 team's api key
    const evervaultClient = new Evervault('<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)

    Reference

    The Evervault Node.js SDK exposes four functions.

    evervault.encrypt()

    evervault.encrypt()encrypts data for use in your Functions. To encrypt data at the server, simply pass an object or string into the evervault.encrypt() function. Store the encrypted data in your database as normal.

    async evervault.encrypt(data: Object | String);
    Parameter Type Description
    data Object or String Data to be encrypted.

    evervault.run()

    evervault.run() invokes a Function with a given payload.

    async evervault.run(functionName: String, payload: Object[, options: Object]);
    Parameter Type Description
    functionName String Name of the Function to be run
    data Object Payload for the Function
    options Object Options for the Function run

    Function Run Options

    Options to control how your Function is run

    Option Type Default Description
    async Boolean false Run your Function in async mode. Async Function runs will be queued for processing.
    version Number undefined Specify the version of your Function to run. By default, the latest version will be run.

    evervault.createRunToken()

    evervault.createRunToken() creates a single use, time bound token for invoking a Function.

    async evervault.createRunToken(functionName: String, payload: Object);
    Parameter Type Description
    functionName String Name of the Function the run token should be created for
    data Object Payload that the token can be used with

    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])
    Option Type Default Description
    decryptionDomains Array undefined Requests sent to any of the domains listed will be proxied through Outbound Relay. This will override the configuration created in the Evervault dashboard.
    debugRequests Boolean False Output request domains and whether they were sent through Outbound Relay.

    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.

    Install

    npm i @evervault/sdk

    DownloadsWeekly Downloads

    2,676

    Version

    3.5.0

    License

    MIT

    Unpacked Size

    57.7 kB

    Total Files

    27

    Last publish

    Collaborators

    • narruc
    • boilsquid
    • lfarrelly
    • edmundojr_
    • evervault-deploy