dk.heick.properties.types

Class PasswordPropertyType

java.lang.Object

dk.heick.properties.PropertyType<PasswordTypeVO>

dk.heick.properties.types.PasswordPropertyType

All Implemented Interfaces:

Encryption, MarkerPasswordPropertyType, PasswordEncryption, Serializable

public class PasswordPropertyType
extends PropertyType<PasswordTypeVO>
implements MarkerPasswordPropertyType

Implementation for IPasswordPropertyType.
Note: AutoEncrypt is per default False and no possible for a default value.
When a Property of type PasswordPropertyType is read a few things happens.

• The value for the Property is read as a string. (This happens before validation.)
• If the string value is NOT encrypted.
• If the following is true
• Property is not readonly.
• PropertyIO not null.
• PropertyIO is not readonly.
• isAutoEncrypt is true.
• PropertyFrameworkGlobals.doAutoEncryptPasswords() is true.
• Than the uncrypted password will be encrypted and set in the PropertyIO.

• When a string value for the Property is validated.
• Validates that the value is not null.
• If the string value is encrypted.
  • returns a new PasswordTypeVO() instance with the encrypted value.
• If the string value is NOT encrypted. (This happens when a new value is set.)
• The password is validated by the PasswordEvaluator is any is set.
• returns a new PasswordTypeVO() instance with the unencrypted value.

Constructor Example			Comments
Property<PasswordTypeVO> A_PROPERTY = new Property<PasswordTypeVO>("name", new PasswordPropertyType());			Creates PasswordPropertyType using AESEncryption. AutoEncrypt is false. No password validator.
Property<PasswordTypeVO> A_PROPERTY = new Property<PasswordTypeVO>("name", new PasswordPropertyType(new AESEncryption()));			Creates PasswordPropertyType using AESEncryption. AutoEncrypt is false. No password validator.
Property<PasswordTypeVO> A_PROPERTY = new Property<PasswordTypeVO>("name", new PasswordPropertyType(new MD5Encryption()));			Creates PasswordPropertyType using MD5Encryption. AutoEncrypt is false. No password validator.
Property<PasswordTypeVO> A_PROPERTY = new Property<PasswordTypeVO>("name", new PasswordPropertyType(new SHA512Encryption()));			Creates PasswordPropertyType using SHA512Encryption. AutoEncrypt is false. No password validator.
Property<PasswordTypeVO> A_PROPERTY = new Property<PasswordTypeVO>("name", new PasswordPropertyType(new MD5Encryption(),true));			Creates PasswordPropertyType using MD5Encryption. AutoEncrypt is true. No password validator.
Property<PasswordTypeVO> A_PROPERTY = new Property<PasswordTypeVO>("name", new PasswordPropertyType(new MD5Encryption(),false,new DefaultPasswordEvaluator(7))));			Creates PasswordPropertyType using MD5Encryption. AutoEncrypt is false. Using DefaultPasswordEvaluator password validator.
Type of value(s)	Examples	Result	Comments
Valid	cow	new PasswordTypeVO(new IPasswordPropertyType(),"cow")	Validate successfully.
Valid	«empty string»	new PasswordTypeVO(new IPasswordPropertyType(),"")	Validate successfully.
Invalid	null	null	Validate will throw an exception. Return null.

Since:

1.1

Author:

Frederik Heick

See Also:

PasswordEncryption, MD5Encryption, AESEncryption, SHA512Encryption, PasswordEvaluator, Serialized Form

Field Summary

Fields inherited from interface dk.heick.properties.types.custom.Encryption

ENCRYPTION_METHOD_END_CHAR, ENCRYPTION_METHOD_START_CHAR

Constructor Summary

Constructors

Constructor and Description
PasswordPropertyType() Constructor, the default "PasswordEncryption" is "new AESEncryption()", there is no default value of a PasswordPropertyType.
PasswordPropertyType(PasswordEncryption passwordEncryption) Constructor, has to define "PasswordEncryption", there is no default value of a PasswordPropertyType.
PasswordPropertyType(PasswordEncryption passwordEncryption, boolean autoEncrypt) Constructor, there is no default value of a PasswordPropertyType.
PasswordPropertyType(PasswordEncryption passwordEncryption, boolean autoEncrypt, PasswordEvaluator evaluator) Constructor, there is no default value of a PasswordPropertyType.

Method Summary

Modifier and Type	Method and Description
protected void	evaluatePassword(String propertyName, String value) Evaluates a new password.
String	getDecryptedValue(String value) Get the decrypted value if possible, otherwise a PropertyException is thrown.
String	getEncryptedValue(String value) Get the encrypted value if possible, otherwise a PropertyException is thrown.
String	getEncryptionMethod() Gets the encryption method identification short key.
PasswordEncryption	getPasswordEncryption() Gets the PasswordEncryption implementation
PasswordEvaluator	getPasswordEvaluator() A password evaluator, that will test if a new password is strong enough.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
boolean	isAutoEncrypt() Is autoEncrypt on or off.
boolean	isDecryptable() If the encryption method is decryptable or not (without password)
boolean	isEncrypted(String value) Evaluates if the string value is encrypted or not, if fails then throwing a PropertyException.
boolean	isSameKey(String password, String inputValue) Evaluates if the stored key (password) is the same as the inputValue, both can be encrypted or not.
protected String	postGetValueProcessing(String propertyName, String value, boolean propertyReadonly) Special method invoke by the Property.getValue(), to gives the ability to post processed the loaded value.
void	setAutoEncrypt(boolean autoEncrypt)
void	setEvaluator(PasswordEvaluator evaluator)
void	setPasswordEncryption(PasswordEncryption passwordEncryption)
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
PasswordTypeVO	validateValue(String propertyName, String value) Converts the string representation of to a typed value.

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toString, toType, validate, validateNullType

Methods inherited from class java.lang.Object

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

Constructor Detail

PasswordPropertyType

public PasswordPropertyType()

Constructor, the default "PasswordEncryption" is "new AESEncryption()", there is no default value of a PasswordPropertyType. Auto encrypt is false and no password evaluator.

See Also:

AESEncryption

PasswordPropertyType

public PasswordPropertyType(PasswordEncryption passwordEncryption)

Constructor, has to define "PasswordEncryption", there is no default value of a PasswordPropertyType. Auto encrypt is false and no password evaluator.

Parameters:

passwordEncryption - The implementation of the PasswordEncryption interface.

See Also:

PasswordEncryption, MD5Encryption, AESEncryption, SHA512Encryption

PasswordPropertyType

public PasswordPropertyType(PasswordEncryption passwordEncryption,
                            boolean autoEncrypt)

Constructor, there is no default value of a PasswordPropertyType. Auto encrypt is false and no password evaluator.

Parameters:

passwordEncryption - The implementation of the PasswordEncryption interface.

autoEncrypt - to auto encrypt the password on load time. The password will not be evaluated by the password evaluator at this point.

See Also:

PasswordEncryption, MD5Encryption, AESEncryption, SHA512Encryption

PasswordPropertyType

public PasswordPropertyType(PasswordEncryption passwordEncryption,
                            boolean autoEncrypt,
                            PasswordEvaluator evaluator)

Constructor, there is no default value of a PasswordPropertyType.

Parameters:

passwordEncryption - The implementation of the PasswordEncryption interface.

autoEncrypt - to auto encrypt the password on load time. The password will not be evaluated by the password evaluator at this point.

evaluator - the password evaluator instance use when setting new password.

See Also:

PasswordEncryption, MD5Encryption, AESEncryption, SHA512Encryption

Method Detail

getPasswordEvaluator

public final PasswordEvaluator getPasswordEvaluator()

Description copied from interface: MarkerPasswordPropertyType

A password evaluator, that will test if a new password is strong enough. This can be null. If its not, then it will be used in validating a new password.

Specified by:

getPasswordEvaluator in interface MarkerPasswordPropertyType

Returns:

the PasswordEvaluator, can be null.

setEvaluator

public void setEvaluator(PasswordEvaluator evaluator)

getPasswordEncryption

public final PasswordEncryption getPasswordEncryption()

Description copied from interface: MarkerPasswordPropertyType

Gets the PasswordEncryption implementation

Specified by:

getPasswordEncryption in interface MarkerPasswordPropertyType

Returns:

the PasswordEncryption instance.

setPasswordEncryption

public void setPasswordEncryption(PasswordEncryption passwordEncryption)

evaluatePassword

protected final void evaluatePassword(String propertyName,
                                      String value)
                               throws PropertyException

Evaluates a new password. If no PasswordEvaluator is set, nothing happens. This method will not be called on auto encrypt, only when setting a new password.

Parameters:

propertyName - the name of the property.

value - the new password.

Throws:

PropertyException - if a PasswordEvaluator is assigned, and the new password do not conform to its rules or PasswordEvaluator is null.

isAutoEncrypt

public final boolean isAutoEncrypt()

Description copied from interface: MarkerPasswordPropertyType

Is autoEncrypt on or off. If on the password will encrypted on load time, if its not encrypted an the PropertyIO is not read only.
On auto encrypt, will the PasswordEvaluator not be called.

Specified by:

isAutoEncrypt in interface MarkerPasswordPropertyType

Returns:

true if auto encrypt is on, otherwise false.

setAutoEncrypt

public final void setAutoEncrypt(boolean autoEncrypt)

validateValue

public final PasswordTypeVO validateValue(String propertyName,
                                          String value)
                                   throws PropertyException

Description copied from class: PropertyType

Converts the string representation of to a typed value.
Including validation of any restrictions the PropertyType might have.
See the individual property type class description for details on how it convert to a typed value.

IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.

Specified by:

validateValue in class PropertyType<PasswordTypeVO>

Parameters:

propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.

value - the string representation of the property

Returns:

the typed converted value.

Throws:

PropertyException - if the conversion failed.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Description copied from class: PropertyType

A PropertyType can have some constraints here is where they are validated.
The constraints of a PropertyType is always assumed to be valid, but what if they are not.
Example: What if you have define the MIN value to be larger than the MAX value. The result will be that no value will ever be validated successfully.
This is the method where we validate the constraints of a PropertyType before any value is actually validated.
Any many cases this will not be nessecary.
This method is call in Property.validate();

Overrides:

validateConstraints in class PropertyType<PasswordTypeVO>

Parameters:

propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues.

Throws:

PropertyException - if the constraints have invalid/conflicting values.

See Also:

Property.validate()

postGetValueProcessing

protected String postGetValueProcessing(String propertyName,
                                        String value,
                                        boolean propertyReadonly)

Description copied from class: PropertyType

Special method invoke by the Property.getValue(), to gives the ability to post processed the loaded value.
This is currently only used be the PasswordPropertyType to autoEncrypt passwords.

This method is empty per default and just returns value unmodified.
This is a method the specific PropertyTypes can choose to override or not.

Overrides:

postGetValueProcessing in class PropertyType<PasswordTypeVO>

Parameters:

propertyName - the name of the Property used for logging

value - the value.

propertyReadonly - if the the property is readonly or not.

Returns:

The modified value. Remember it still has to pass the validation method.

getRestrictions

public final List<String> getRestrictions()

Description copied from class: PropertyType

Gets a detailed description of the PropertyType with any constraints that might influence the validation.
This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.

Specified by:

getRestrictions in class PropertyType<PasswordTypeVO>

Returns:

the restrictions of the PropertyType as a list of strings.

getDecryptedValue

public String getDecryptedValue(String value)
                         throws PropertyException

Description copied from interface: MarkerPasswordPropertyType

Get the decrypted value if possible, otherwise a PropertyException is thrown.

Specified by:

getDecryptedValue in interface Encryption

Specified by:

getDecryptedValue in interface MarkerPasswordPropertyType

Parameters:

value - the string value

Returns:

the decrypted string, must be able to handle that "[method]" is a front the encrypted value.

Throws:

PropertyException - if value is null or decryption is not possible or an error during decryption as occurred.

getEncryptedValue

public String getEncryptedValue(String value)
                         throws PropertyException

Description copied from interface: MarkerPasswordPropertyType

Get the encrypted value if possible, otherwise a PropertyException is thrown.

Specified by:

getEncryptedValue in interface Encryption

Specified by:

getEncryptedValue in interface MarkerPasswordPropertyType

Parameters:

value - the string value

Returns:

return the encrypted string with "[method]encryptedvalue"

Throws:

PropertyException - if value is null or encryption is not possible or an error during encryption as occurred.

isDecryptable

public boolean isDecryptable()

Description copied from interface: MarkerPasswordPropertyType

If the encryption method is decryptable or not (without password)

Specified by:

isDecryptable in interface Encryption

Specified by:

isDecryptable in interface MarkerPasswordPropertyType

Returns:

true if it is decryptable, otherwise false.

isEncrypted

public boolean isEncrypted(String value)
                    throws PropertyException

Description copied from interface: MarkerPasswordPropertyType

Evaluates if the string value is encrypted or not, if fails then throwing a PropertyException.

Specified by:

isEncrypted in interface Encryption

Specified by:

isEncrypted in interface MarkerPasswordPropertyType

Parameters:

value - the string

Returns:

true if the string is encrypted otherwise false, also returns false if the value is null. Determines if "[method]" is a front the string value.

Throws:

PropertyException - if a the password is encrypted with another method.

getEncryptionMethod

public String getEncryptionMethod()

Description copied from interface: MarkerPasswordPropertyType

Gets the encryption method identification short key.

Specified by:

getEncryptionMethod in interface Encryption

Specified by:

getEncryptionMethod in interface MarkerPasswordPropertyType

Returns:

short encryption name.

isSameKey

public boolean isSameKey(String password,
                         String inputValue)
                  throws PropertyException

Description copied from interface: MarkerPasswordPropertyType

Evaluates if the stored key (password) is the same as the inputValue, both can be encrypted or not.

Specified by:

isSameKey in interface MarkerPasswordPropertyType

Specified by:

isSameKey in interface PasswordEncryption

Parameters:

password - the assumed password, which is stored in properties. This can either be encrypted or not encrypted.

inputValue - the user password. This can either be encrypted or not encrypted.

Returns:

true if the two string values encrypted is the same, otherwise false is returned, must be able to handle that "[method]" is a front the encrypted value.

Throws:

PropertyException - if either password> or inputValue is null, or if password encrypted for this propertyType isnt possible.