vaultex's Introduction

🔒 Vaultex

A very simple elixir client that authenticates, reads and writes secrets from HashiCorp's Vault. As listed on Vault Libraries.

Installation

The package can be installed as:

Add vaultex to your list of dependencies in mix.exs:

def deps do
  [{:vaultex, "~> 0.3"}]
end

Ensure vaultex is started before your application:

def application do
  [applications: [:vaultex]]
end

Configuration

You can configure your vault endpoint with a single environment variable:

VAULT_ADDR

Or a single application variable:

:vaultex, :vault_addr

An example value for VAULT_ADDR is http://127.0.0.1:8200.

Alternatively the vault endpoint can be specified with environment variables:

VAULT_HOST
VAULT_PORT
VAULT_SCHEME

Or application variables:

:vaultex, :host
:vaultex, :port
:vaultex, :scheme

These default to localhost, 8200, http respectively.

You can skip SSL certificate verification with :vaultex, ssl_skip_verify: true option or SSL_SKIP_VERIFY=true environment variable.

Usage

To read a secret you must provide the path to the secret and the authentication backend and credentials you will use to login. See the Vaultex.Client.auth/2 docs for supported auth backends.

...
iex> Vaultex.Client.auth(:app_id, {app_id, user_id})

iex> Vaultex.Client.auth(:userpass, {username, password})

iex> Vaultex.Client.auth(:github, {github_token})

iex> Vaultex.Client.auth(:approle, {role_id, secret_id})

...
iex> Vaultex.Client.read "secret/bar", :github, {github_token} #returns {:ok, %{"value" => bar"}}

...
iex> Vaultex.Client.write "secret/foo", %{"value" => "bar"}, :app_id, {app_id, user_id}

Recommend Projects