Package org.keycloak.vault

Interface Summary

Interface	Description
VaultCharSecret	A CharBuffer based representation of the secret obtained from the vault that supports automated cleanup of memory.
VaultKeyResolver	VaultKeyResolver is a BiFunction whose implementation of the BiFunction.apply(Object, Object) method takes two Strings representing the realm name and the key name (as used in ${vault.key} expressions) and returns another String representing the final constructed key that is to be used when obtaining secrets from the vault.
VaultProvider	Provider interface for a vault.
VaultProviderFactory
VaultRawSecret	Raw representation of the secret obtained from vault that supports automated cleanup of memory.
VaultStringSecret	A String based representation of the secret obtained from the vault that supports automated cleanup of memory.
VaultTranscriber	A facade to the configured vault provider that exposes utility methods for obtaining the vault secrets in different formats (such as VaultRawSecret, VaultCharSecret or VaultStringSecret).

Class Summary

Class	Description
AbstractVaultProvider	Abstract class that is meant to be extended by implementations of VaultProvider that want to have support for key resolvers.
AbstractVaultProviderFactory	Abstract class that is meant to be extended by implementations of VaultProviderFactory that want to offer support for the configuration of key resolvers.
DefaultVaultCharSecret	Default VaultCharSecret implementation based on CharBuffer.
DefaultVaultRawSecret	Default raw secret implementation for byte[].
DefaultVaultStringSecret	Default VaultCharSecret implementation based on String.
DefaultVaultTranscriber	Default VaultTranscriber implementation that uses the configured VaultProvider to obtain raw secrets and convert them into other types.
FilesPlainTextVaultProvider	A text-based vault provider, which stores each secret in a separate file.
FilesPlainTextVaultProviderFactory	Creates and configures FilesPlainTextVaultProvider.
VaultSpi	SPI for a low-level vault access.

Enum Summary

Enum	Description
AbstractVaultProviderFactory.AvailableResolvers	Enum containing the available VaultKeyResolvers.

Exception Summary

Exception	Description
VaultConfigurationException	This exception is thrown when the factory fails to init due to a configuration error.
VaultNotFoundException	Thrown when a vault directory doesn't exist.