org.apache.nifi.vault.hashicorp

Interface HashiCorpVaultCommunicationService

All Known Implementing Classes:

StandardHashiCorpVaultCommunicationService

public interface HashiCorpVaultCommunicationService

A service to handle all communication with an instance of HashiCorp Vault.

See Also:

https://www.vaultproject.io/

Method Summary

Modifier and Type	Method and Description
byte[]	decrypt(String transitPath, String cipherText) Decrypts the given cipher text using Vault's Transit Secrets Engine.
String	encrypt(String transitPath, byte[] plainText) Encrypts the given plaintext using Vault's Transit Secrets Engine.
Optional<String>	readKeyValueSecret(String keyValuePath, String secretKey) Reads a single secret value from Vault's unversioned Key/Value Secrets Engine.
Map<String,String>	readKeyValueSecretMap(String keyValuePath, String secretKey) Reads a secret with multiple key/value pairs from Vault's unversioned Key/Value Secrets Engine.
void	writeKeyValueSecret(String keyValuePath, String secretKey, String value) Writes a single secret value using Vault's unversioned Key/Value Secrets Engine.
void	writeKeyValueSecretMap(String keyValuePath, String secretKey, Map<String,String> keyValues) Writes a secret with multiple key/value pairs using Vault's unversioned Key/Value Secrets Engine.

Method Detail

encrypt

String encrypt(String transitPath,
               byte[] plainText)

Encrypts the given plaintext using Vault's Transit Secrets Engine.

Parameters:

transitPath - The Vault path to use for the configured Transit Secrets Engine

plainText - The plaintext to encrypt

Returns:

The cipher text

See Also:

https://www.vaultproject.io/api-docs/secret/transit

decrypt

byte[] decrypt(String transitPath,
               String cipherText)

Decrypts the given cipher text using Vault's Transit Secrets Engine.

Parameters:

transitPath - The Vault path to use for the configured Transit Secrets Engine

cipherText - The cipher text to decrypt

Returns:

The decrypted plaintext

See Also:

https://www.vaultproject.io/api-docs/secret/transit

writeKeyValueSecret

void writeKeyValueSecret(String keyValuePath,
                         String secretKey,
                         String value)

Writes a single secret value using Vault's unversioned Key/Value Secrets Engine.

Parameters:

keyValuePath - The Vault path to use for the configured Key/Value v1 Secrets Engine

secretKey - The secret key

value - The secret value

See Also:

https://www.vaultproject.io/api-docs/secret/kv/kv-v1

readKeyValueSecret

Optional<String> readKeyValueSecret(String keyValuePath,
                                    String secretKey)

Reads a single secret value from Vault's unversioned Key/Value Secrets Engine.

Parameters:

keyValuePath - The Vault path to use for the configured Key/Value v1 Secrets Engine

secretKey - The secret key

Returns:

The secret value, or empty if not found

See Also:

https://www.vaultproject.io/api-docs/secret/kv/kv-v1

writeKeyValueSecretMap

void writeKeyValueSecretMap(String keyValuePath,
                            String secretKey,
                            Map<String,String> keyValues)

Writes a secret with multiple key/value pairs using Vault's unversioned Key/Value Secrets Engine.

Parameters:

keyValuePath - The Vault path to use for the configured Key/Value v1 Secrets Engine

keyValues - A map from key to value for keys/values that should be stored in the secret

See Also:

https://www.vaultproject.io/api-docs/secret/kv/kv-v1

readKeyValueSecretMap

Map<String,String> readKeyValueSecretMap(String keyValuePath,
                                         String secretKey)

Reads a secret with multiple key/value pairs from Vault's unversioned Key/Value Secrets Engine.

Parameters:

keyValuePath - The Vault path to use for the configured Key/Value v1 Secrets Engine

secretKey - The secret key

Returns:

A map from key to value from the secret key/values, or an empty map if not found

See Also:

https://www.vaultproject.io/api-docs/secret/kv/kv-v1