cz.d1x.dxcrypto.props

Class SecureProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

cz.d1x.dxcrypto.props.SecureProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class SecureProperties
extends Properties

Extension of Properties that allows storing and reading encrypted values by given encryption algorithm. For recognition whether value is encrypted or not, default or given suffix is added at the end of encrypted value.

Author:

Zdenek Obst, zdenek.obst-at-gmail.com

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
SecureProperties(EncryptionAlgorithm encryptionAlgorithm) Creates a new properties that will use given encryption algorithm.
SecureProperties(EncryptionAlgorithm encryptionAlgorithm, String encryptedPropertySuffix) Creates a new properties that will use given encryption algorithm and given suffix will be used for recognition whether value is encrypted or not.
SecureProperties(Properties defaults, EncryptionAlgorithm encryptionAlgorithm) Creates a new properties that will use given encryption algorithm.
SecureProperties(Properties defaults, EncryptionAlgorithm encryptionAlgorithm, String encryptedPropertySuffix) Creates a new properties that will use given encryption algorithm and given suffix will be used for recognition whether value is encrypted or not.

Method Summary

Modifier and Type	Method and Description
String	getOriginalProperty(String key) Gets original property value under given key.
String	getProperty(String key)
String	getProperty(String key, String defaultValue)
boolean	isEncrypted(String key) Checks whether property under given key is encrypted.
Object	setEncryptedProperty(String key, String value) Have the same functionality as Properties.setProperty(String, String) but the value gets encrypted before it gets stored within properties.
boolean	validateValue(String key, String expectedValue) Validates whether given expected value is equal to the value in the properties under given key.

Methods inherited from class java.util.Properties

list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecureProperties

public SecureProperties(EncryptionAlgorithm encryptionAlgorithm)

Creates a new properties that will use given encryption algorithm. Default DEFAULT_ENCRYPTED_SUFFIX suffix will be used for recognition whether value is encrypted or not.

Parameters:

encryptionAlgorithm - algorithm used for encryption

SecureProperties

public SecureProperties(Properties defaults,
                        EncryptionAlgorithm encryptionAlgorithm)

Creates a new properties that will use given encryption algorithm. Default DEFAULT_ENCRYPTED_SUFFIX suffix will be used for recognition whether value is encrypted or not.

Parameters:

defaults - initial values for properties

encryptionAlgorithm - algorithm used for encryption

SecureProperties

public SecureProperties(EncryptionAlgorithm encryptionAlgorithm,
                        String encryptedPropertySuffix)

Creates a new properties that will use given encryption algorithm and given suffix will be used for recognition whether value is encrypted or not.

Parameters:

encryptionAlgorithm - algorithm used for encryption

encryptedPropertySuffix - suffix used for recognition of encrypted values (will be trimmed)

SecureProperties

public SecureProperties(Properties defaults,
                        EncryptionAlgorithm encryptionAlgorithm,
                        String encryptedPropertySuffix)

Creates a new properties that will use given encryption algorithm and given suffix will be used for recognition whether value is encrypted or not.

Parameters:

defaults - initial values for properties

encryptionAlgorithm - algorithm used for encryption

encryptedPropertySuffix - suffix used for recognition of encrypted values (will be trimmed)

Throws:

IllegalArgumentException - possible exception if given suffix is null or 0-length

Method Detail

setEncryptedProperty

public Object setEncryptedProperty(String key,
                                   String value)

Have the same functionality as Properties.setProperty(String, String) but the value gets encrypted before it gets stored within properties. The value gets automatically decrypted when getProperty(String) or getProperty(String, String) is called.

Parameters:

key - key of the property to be set

value - value to be encrypted and set

Returns:

previous value of property if was set

getOriginalProperty

public String getOriginalProperty(String key)

Gets original property value under given key. It means that encrypted properties are returned in its encrypted form. If you want retrieve property already decrypted, use getProperty(String) or getProperty(String, String) instead.

Parameters:

key - key of the property to be read

Returns:

value of given property or null if not present

getProperty

public String getProperty(String key)

If the property ends with given suffix (specified in constructor or default), it gets decrypted by defined encryption algorithm. Note that EncryptionException can be thrown if encrypted property cannot be decrypted by given algorithm.

Overrides:

getProperty in class Properties

Parameters:

key - key of the property to be read

Returns:

property value or null if not ste

getProperty

public String getProperty(String key,
                          String defaultValue)

If the property ends with given suffix (specified in constructor or default), it gets decrypted by defined encryption algorithm. Note that EncryptionException can be thrown if encrypted property cannot be decrypted by given algorithm.

Overrides:

getProperty in class Properties

Parameters:

key - key of the property to be read

defaultValue - default value if property is not set

Returns:

property value or default if not set

isEncrypted

public boolean isEncrypted(String key)

Checks whether property under given key is encrypted.

Parameters:

key - key of property to be checked

Returns:

true if property under given key is encrypted (unset properties are considered as not encrypted), otherwise false

validateValue

public boolean validateValue(String key,
                             String expectedValue)

Validates whether given expected value is equal to the value in the properties under given key.

Parameters:

key - key of property

expectedValue - expected value of property

Returns:

true if value of expected and the one in properties are equal, otherwise false.