Module dev.orne.config

Package dev.orne.config.impl

Class DefaultConfigCryptoProvider

java.lang.Object

dev.orne.config.impl.AbstractConfigCryptoProvider

dev.orne.config.impl.DefaultConfigCryptoProvider

All Implemented Interfaces:

ConfigCryptoProvider

@API(status=STABLE,
     since="1.0")
public class DefaultConfigCryptoProvider
extends AbstractConfigCryptoProvider

Default implementation of ConfigCryptoProvider based on ConfigCryptoEngine with synchronized Cipher.

Since:

0.2

Version:

1.0, 2020-08

Author:

(w) Iker Hernaez

See Also:

• ConfigCryptoProvider
• ConfigCryptoEngine

Constructor Summary

Constructors

Constructor	Description
DefaultConfigCryptoProvider(CryptoProviderOptions options)	Creates a new instance with specified builder configuration options.

Method Summary

Modifier and Type	Method	Description
@Nullable String	decrypt(@Nullable String value)	Decrypts the specified encrypted configuration value.
void	destroy()	Destroys all secret information.
@Nullable String	encrypt(@Nullable String value)	Encrypts the specified plain configuration value.
protected Cipher	getCipher()	Returns the shared Cipher to use during encryption and decryption.

Methods inherited from class dev.orne.config.impl.AbstractConfigCryptoProvider

checkDestroyed, decrypt, encrypt, getEngine, getSecretKey, isDestroyed, isDestroyEngine

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultConfigCryptoProvider

@API(status=INTERNAL,
     since="1.0")
public DefaultConfigCryptoProvider(CryptoProviderOptions options)

Creates a new instance with specified builder configuration options.

Parameters:

options - The configured builder options.

Method Details

getCipher

protected Cipher getCipher()
                    throws ConfigCryptoProviderException

Returns the shared Cipher to use during encryption and decryption.

Returns:

The Cipher to use during encryption and decryption

Throws:

ConfigCryptoProviderException - If an error occurs creating the shared Cipher

encrypt

public @Nullable String encrypt(@Nullable String value)
                         throws ConfigCryptoProviderException

Encrypts the specified plain configuration value.

Parameters:

value - The plain configuration value

Returns:

The encrypted configuration value

Throws:

ConfigCryptoProviderException - If an exception occurs during the encryption process

decrypt

public @Nullable String decrypt(@Nullable String value)
                         throws ConfigCryptoProviderException

Decrypts the specified encrypted configuration value.

Parameters:

value - The encrypted configuration value

Returns:

The plain configuration value

Throws:

ConfigCryptoProviderException - If an exception occurs during the decryption process

destroy

public void destroy()

Description copied from class: AbstractConfigCryptoProvider

Destroys all secret information. Any further call to the instance will throw an IllegalStateException.

Specified by:

destroy in interface ConfigCryptoProvider

Overrides:

destroy in class AbstractConfigCryptoProvider