net.brabenetz.lib.securedproperties

Class SecuredProperties

java.lang.Object

net.brabenetz.lib.securedproperties.SecuredProperties

public final class SecuredProperties
extends Object

Encrypt and decrypt secret values in properties files with a secret key.

Example:
The Property file "myConfiguration.properties":

 mySecretPassword = test
 

The Java code:

 // prepare custom config
 final SecuredPropertiesConfig config = new SecuredPropertiesConfig().withSecretFile(new File("G:/mysecret.key")).initDefault();

 // auto-encrypt values in the property-file:
 SecuredProperties.encryptNonEncryptedValues(config,
         new File("myConfiguration.properties"), // The Property File
         "mySecretPassword"); // the property-key from "myConfiguration.properties"

 // read encrypted values from the property-file
 String secretValue = SecuredProperties.getSecretValue(config,
         new File("myConfiguration.properties"), // The Property File
         "mySecretPassword"); // the property-key from "myConfiguration.properties"
 

will return "test" as secretValue and automatically encrypt the value in the property file. After the first run the Property file will looks similar to the following:

  mySecretPassword = {wVtvW8lQrwCf8MA9sadwww==}
 

This encrypted password can now be read only in combination with the secret file "G:/mysecret.key"

Method Summary

Modifier and Type	Method and Description
static String	decrypt(SecuredPropertiesConfig config, String encryptedPassword) Encrypt the given password (will create the secret key if not already exist).
static String	encrypt(SecuredPropertiesConfig config, String plainTextValue) Encrypt the given value (will create the secret key if not already exist).
static void	encryptNonEncryptedValues(SecuredPropertiesConfig config, File[] propertyFiles, String... keys)
static void	encryptNonEncryptedValues(SecuredPropertiesConfig config, File propertyFile, String... keys)
static String	getSecretValue(SecuredPropertiesConfig config, File[] propertyFiles, String key)
static String	getSecretValue(SecuredPropertiesConfig config, File propertyFile, String key)
static Map<String,String>	getSecretValues(SecuredPropertiesConfig config, File[] propertyFiles, String... keys)
static Map<String,String>	getSecretValues(SecuredPropertiesConfig config, File propertyFile, String... keys)
static boolean	isEncryptedValue(String maybeEncryptedValue) Checks if the given String looks like an encrypted value.

Methods inherited from class java.lang.Object

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

Method Detail

getSecretValue

public static String getSecretValue(SecuredPropertiesConfig config,
                                    File propertyFile,
                                    String key)

Parameters:

config - the SecuredPropertiesConfig to control custom behavior.

propertyFile - The Properties file to with the encrypted value

key - The Property-Key of the encrypted value.

Returns:

The decrypted plain-text value.

See Also:

SecuredProperties

getSecretValue

public static String getSecretValue(SecuredPropertiesConfig config,
                                    File[] propertyFiles,
                                    String key)

Parameters:

config - the SecuredPropertiesConfig to control custom behavior.

propertyFiles - A list of Property file to with the encrypted value

key - The Property-Key of the encrypted value.

Returns:

The decrypted plain-text value.

See Also:

SecuredProperties

getSecretValues

public static Map<String,String> getSecretValues(SecuredPropertiesConfig config,
                                                 File propertyFile,
                                                 String... keys)

Parameters:

config - the SecuredPropertiesConfig to control custom behavior.

propertyFile - The Properties file to with the encrypted value

keys - The Property-Keys of the encrypted value.

Returns:

A Map with the decrypted plain-text values per key.

See Also:

SecuredProperties

getSecretValues

public static Map<String,String> getSecretValues(SecuredPropertiesConfig config,
                                                 File[] propertyFiles,
                                                 String... keys)

Parameters:

config - the SecuredPropertiesConfig to control custom behavior.

propertyFiles - A list of Property file to with the encrypted value

keys - The Property-Keys of the encrypted value.

Returns:

A Map with the decrypted plain-text values per key.

See Also:

SecuredProperties

encryptNonEncryptedValues

public static void encryptNonEncryptedValues(SecuredPropertiesConfig config,
                                             File propertyFile,
                                             String... keys)

Parameters:

config - the SecuredPropertiesConfig to control custom behavior.

propertyFile - The Properties file to with the encrypted value

keys - The Property-Keys of the encrypted value.

See Also:

SecuredProperties

encryptNonEncryptedValues

public static void encryptNonEncryptedValues(SecuredPropertiesConfig config,
                                             File[] propertyFiles,
                                             String... keys)

Parameters:

config - the SecuredPropertiesConfig to control custom behavior.

propertyFiles - A list of Property file to with the encrypted value

keys - The Property-Keys of the encrypted value.

See Also:

SecuredProperties

isEncryptedValue

public static boolean isEncryptedValue(String maybeEncryptedValue)

Checks if the given String looks like an encrypted value.

encrypt

public static String encrypt(SecuredPropertiesConfig config,
                             String plainTextValue)

Encrypt the given value (will create the secret key if not already exist).

Parameters:

config - the SecuredPropertiesConfig to control custom behavior.

plainTextValue - The value to encrypt

Returns:

the encrypted value.

decrypt

public static String decrypt(SecuredPropertiesConfig config,
                             String encryptedPassword)

Encrypt the given password (will create the secret key if not already exist).

Parameters:

config - the SecuredPropertiesConfig to control custom behavior.

encryptedPassword - The password to encrypt

Returns:

the encrypted value.