net.brabenetz.lib.securedproperties

Class SecuredPropertiesConfig

java.lang.Object

net.brabenetz.lib.securedproperties.SecuredPropertiesConfig

All Implemented Interfaces:

Config

public class SecuredPropertiesConfig
extends Object
implements Config

Configuration Object to control the behavior of SecuredProperties.

Constructor Summary

Constructors

Constructor and Description
SecuredPropertiesConfig()

Method Summary

Modifier and Type	Method and Description
SecuredPropertiesConfig	addAllowedAlgorithm(Algorithm... addedAllowedAlgorithm)
Algorithm[]	getAllowedAlgorithm()
int	getSaltLength()
File	getSecretFile() Return the SecretFile location which is needed to decrypt and encrypt your property-values.
SecuredPropertiesConfig	init(ConfigInitializer... configInitializers) The generic variant of initDefault().
SecuredPropertiesConfig	initDefault() Similar to Spring-Boot, Externalize your configuration so that you can work with the same application code in different environments.
boolean	isAutoCreateSecretKey()
SecuredPropertiesConfig	withAllowedAlgorithm(Algorithm... newAllowedAlgorithm)
SecuredPropertiesConfig	withAutoCreateSecretKey(boolean autoCreate)
SecuredPropertiesConfig	withSaltLength(int newSaltLength)
SecuredPropertiesConfig	withSecretFile(File newSecretFile) Overwrite the default location "%user_home%/.secret/securedProperties.key" for the secret key to encrypt and decrypt values.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecuredPropertiesConfig

public SecuredPropertiesConfig()

Method Detail

getSecretFile

public File getSecretFile()

Return the SecretFile location which is needed to decrypt and encrypt your property-values.

Default is $HOME/.secret/securedProperties.key

getSaltLength

public int getSaltLength()

isAutoCreateSecretKey

public boolean isAutoCreateSecretKey()

getAllowedAlgorithm

public Algorithm[] getAllowedAlgorithm()

initDefault

public SecuredPropertiesConfig initDefault()

Similar to Spring-Boot, Externalize your configuration so that you can work with the same application code in different environments.

1. Application property Files './application.properties'. If the File doesn't exist, it will be ignored.
2. Application property Files './config/application.properties'. If the File doesn't exist, it will be ignored.
3. OS environment variables.
4. Java System properties (System.getProperties()).

The last one has the highest priority and will overwrite properties before.

The Properties which can be configured can be found in ConfigKey.
The default prefix is "SECURED_PROPERTIES" and the keys must be configured formatted as:

• UPPER_CASE: Like "SECURED_PROPERTIES_SECRET_FILE" is used for OS environment variables.
• kebab-case: Like "secured-properties.secret-file" is used for System-Properties and Property-Files

Returns:

this for fluent style.

See Also:

"https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html"

init

public SecuredPropertiesConfig init(ConfigInitializer... configInitializers)

The generic variant of initDefault(). Just put your ConfigInitializers into it in the order you want.

The last one has the highest priority and will overwrite properties before.

Parameters:

configInitializers - your ConfigInitializers. See ConfigInitializers.

Returns:

this for fluent style.

withSecretFile

public SecuredPropertiesConfig withSecretFile(File newSecretFile)

Overwrite the default location "%user_home%/.secret/securedProperties.key" for the secret key to encrypt and decrypt values.

Specified by:

withSecretFile in interface Config

Parameters:

newSecretFile - the secret File

Returns:

this for fluent style.

withSaltLength

public SecuredPropertiesConfig withSaltLength(int newSaltLength)

Specified by:

withSaltLength in interface Config

withAllowedAlgorithm

public SecuredPropertiesConfig withAllowedAlgorithm(Algorithm... newAllowedAlgorithm)

Specified by:

withAllowedAlgorithm in interface Config

addAllowedAlgorithm

public SecuredPropertiesConfig addAllowedAlgorithm(Algorithm... addedAllowedAlgorithm)

withAutoCreateSecretKey

public SecuredPropertiesConfig withAutoCreateSecretKey(boolean autoCreate)

Specified by:

withAutoCreateSecretKey in interface Config