Package com.atlassian.secrets.service.vault

Class VaultSecretBackend

java.lang.Object

com.atlassian.secrets.service.vault.VaultSecretBackend

All Implemented Interfaces:

SecretServiceBackend

public class VaultSecretBackend
extends Object
implements SecretServiceBackend

This class is an implementation of SecretServiceBackend for interacting with HashiCorp Vault. It provides methods to seal and unseal secrets.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SECRET_KEY

Constructor Summary

Constructors

Constructor	Description
VaultSecretBackend(String backendId, VaultConfig config)	Constructs a new VaultSecretService with the provided configuration.
VaultSecretBackend(String backendId, VaultConfig vaultConfig, VaultTemplateFactory templateFactory, VaultAuthenticationProvider authenticationProvider)	Constructs a new VaultSecretService with the provided configuration, template factory, and authentication provider.

Method Summary

Modifier and Type	Method	Description
void	delete(String identifier)
SecretServiceType	getType()
SealedSecret	seal(String identifier, String plainTextToSecure)	Seals a secret in HashiCorp Vault.
String	unseal(SealedSecret sealedSecret)	Unseals a secret from HashiCorp Vault.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SECRET_KEY

public static final String SECRET_KEY

See Also:

• Constant Field Values

Constructor Details

VaultSecretBackend

public VaultSecretBackend(String backendId,
 VaultConfig config)

Constructs a new VaultSecretService with the provided configuration. Uses default implementations for the template factory and authentication provider.

Parameters:

config - the configuration for the HashiCorp Vault

VaultSecretBackend

public VaultSecretBackend(String backendId,
 VaultConfig vaultConfig,
 VaultTemplateFactory templateFactory,
 VaultAuthenticationProvider authenticationProvider)

Constructs a new VaultSecretService with the provided configuration, template factory, and authentication provider. This constructor is useful for testing purposes.

Parameters:

vaultConfig - the configuration for the HashiCorp Vault

templateFactory - the factory to create VaultTemplates

authenticationProvider - the provider for Vault authentication

Method Details

seal

public SealedSecret seal(String identifier,
 String plainTextToSecure)
                  throws SecretServiceException

Seals a secret in HashiCorp Vault. The secret is stored at a path constructed from the identifier and the config.

Specified by:

seal in interface SecretServiceBackend

Parameters:

identifier - the identifier for the secret

plainTextToSecure - the secret to be sealed

Returns:

a SealedSecret representing the sealed secret

Throws:

SecretServiceException - if there is an error sealing the secret

unseal

public String unseal(SealedSecret sealedSecret)
              throws SecretServiceException

Unseals a secret from HashiCorp Vault. The secret is retrieved from a path constructed from the identifier of the sealed secret. This method only works with IdentifierBasedSecret.

Specified by:

unseal in interface SecretServiceBackend

Parameters:

sealedSecret - the sealed secret to be unsealed

Returns:

the unsealed secret

Throws:

SecretServiceException - if there is an error unsealing the secret

delete

public void delete(String identifier)
            throws SecretServiceException

Specified by:

delete in interface SecretServiceBackend

Throws:

SecretServiceException

getType

public SecretServiceType getType()

Specified by:

getType in interface SecretServiceBackend