VaultSDK

VaultSDK is a secure Node.js SDK for managing secrets such as API keys, credentials, and sensitive data. It provides functionality to store, retrieve, update, and delete secrets within a vault.

Features

• Store Secrets: Securely store sensitive data with encryption.
• Retrieve Secrets: Fetch secrets and decrypt them using a master key.
• Update Secrets: Modify the value of stored secrets.
• Delete Secrets: Remove secrets from the vault.
• Retrieve All Secrets: Fetch all keys and their decrypted values.

Installation

npm install vault-sdk

Usage

Import and Initialize

import { VaultSDK } from "vault-sdk";

const vault = new VaultSDK("your-vault-id", "your-vault-key");

Methods

1. Store a secret

vault.storeSecret(keyName, value, masterKey)

Parameters:

• keyName (string): The name of the key to store.
• value (any): The value to associate with the key.
• masterKey (string): The encryption key used to secure the data.

Returns

• Returns: A promise that resolves to a success message or rejects with an error.

Example:

vault.storeSecret("dbPassword", "securePassword123", "master-key")
    .then(response => console.log(response))
    .catch(error => console.error(error));

2. Retrieve a Secret

vault.retrieveSecret(keyName, masterKey)

Parameters

• keyName (string): The name of the key to retrieve.
• masterKey (string): The decryption key.

Returns

• Returns: A promise that resolves to the decrypted value or rejects with an error.

Example:

vault.retrieveSecret("dbPassword", "master-key")
    .then(response => console.log(response.result))
    .catch(error => console.error(error));

3. Update a Secret

vault.updateSecret(keyName, newValue, masterKey)

Parameters

• keyName (string): The name of the key to update.
• newValue (any): The new value to store.
• masterKey (string): The encryption key.

Returns

• Returns: A promise that resolves to a success message or rejects with an error..

Example:

vault.updateSecret("dbPassword", "newSecurePassword456", "master-key")
    .then(response => console.log(response))
    .catch(error => console.error(error));

4. Retrieve All Secrets

vault.retrieveAllSecrets(masterKey)

Parameters

• masterKey (string): The decryption key.

Returns

• Returns: A promise that resolves to an array of objects containing keys and values.

Example:

vault.retrieveAllSecrets("master-key")
    .then(response => console.log(response.result))
    .catch(error => console.error(error));

5. Delete a secret

vault.deleteSecret(keyName)

Parameters

• keyName (string): The name of the key to delete.

Returns

• Returns: A promise that resolves to a success message or rejects with an error.

Example:

vault.deleteSecret("dbPassword")
    .then(response => console.log(response))
    .catch(error => console.error(error));

Need Help?

If you need assistance creating a vault or setting up your environment, please contact: [email protected]