Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 3.35 KB

README.md

File metadata and controls

73 lines (53 loc) · 3.35 KB
Raw

edison-vault

Library to access Vault servers and inject secrets into Edison services.

Build Status

Usage

This library implements a Spring PropertySourcesPlaceholderConfigurer which extends and replaces the default one. It maps values from vault-secrets to properties which can then be easily accessed via @Value annotations. To use this library the secrets must be setup like described in the vault configuration section.

If your vault setup matches the requirements you just need to set the configuration properties in your application.properties file. You can find them in the application.properties configuration section.

Vault configuration

In Vault the App ID authentication backend has to be enabled. In this context tuples of app-ids and user-ids have to be created in Vault.

Each property you want to save in vault must be created as a single secret under an individual secret path sharing the same prefix. The last part of the secret-path will be the property key. The property value must be saved in the underlying JSON-Property named "value".

Example

GET http://yourVaultHostName:4001/v1/some/secret/path/secretOne 
{
  "value": "theSecretNumberOne"
}

GET http://yourVaultHostName:4001/v1/some/secret/path/secretTwo 
{
  "value": "theSecretNumberTwo"
}

In this example you will get two properties: secretOne=theSecretNumberOne and secretTwo=theSecretNumberTwo

For further vault documentation see http://www.vaultproject.io/

application.properties configuration

  • edison.vault.enabled enable edison-vault (default=false)
  • edison.vault.base-url url of vault server
  • edison.vault.secret-path vault secret path
  • edison.vault.properties comma-separated list of property keys to fetch from vault (default=empty).
  • edison.vault.token-source how to access the vault server token -- possible values are login,file or environment
  • edison.vault.appid app id to access the vault server (valid for token-source=login)
  • edison.vault.userid user id to access the vault server (valid for token-source=login)
  • edison.vault.environment-token environment-variable which holds the token (valid for token-source=environment)
  • edison.vault.file-token filename where the token is stored in, if not set then $HOME/.vault-token is used (valid for token-source=file)

Example

application.properties:

edison.vault.enabled=true
edison.vault.base-url=https://yourVaultHostName:8200
edison.vault.secret-path=/some/secret/path/
edison.vault.properties=someVaultPropertyKey,someOtherVaultPropertyKey
edison.vault.token-source=login
edison.vault.appid=aaaaaaaa-bbbb-cccc-dddd-eeeeeeffffff
edison.vault.userid=ffffffff-eeee-dddd-cccc-bbbbbbaaaaa

SomeClass.java:

public class SomeClass {
    
    @Value("${secretOne}")
    private String theSecretNumberOne;

    public void someMethod(@Value("${secretTwo}") String theSecretNumberTwo) {

    }
}