Skip to main content

TWIN Vault Connector Hashicorp

Vault connector implementation using Hashicorp.

Installation​

npm install @twin.org/vault-connector-hashicorp

Testing​

The tests developed are functional tests and need an instance of Hashicorp Vault up and running. To run Hashicorp Vault locally:

docker run -d --name twin-vault-hashicorp --cap-add=IPC_LOCK -e 'VAULT_DEV_ROOT_TOKEN_ID=root' -p 8200:8200 hashicorp/vault:1.18.0

After starting the vault, you need to do the following steps within the docker shell, launch the shell using:

docker exec -t -i twin-vault-hashicorp sh
  1. Set the environment variables for the vault address and token:
export VAULT_ADDR="http://127.0.0.1:8200"
export VAULT_TOKEN="root"
  1. Enable the transit secret engine:
vault secrets enable -address="http://127.0.0.1:8200" transit

Afterwards you can run the tests from your development environment as follows:

npm run test

Examples​

Usage of the APIs is shown in the examples docs/examples.md

Reference​

Detailed reference documentation for the API can be found in docs/reference/index.md

Changelog​

The changes between each version can be found in docs/changelog.md