atg.security

Class DigestPasswordHasher

java.lang.Object

atg.security.DigestPasswordHasher

All Implemented Interfaces:

PasswordHasher, java.io.Serializable

public class DigestPasswordHasher
extends java.lang.Object
implements PasswordHasher

A password hasher that utilizes the java.security.MessageDigest mechanism for hashing passwords.

After digestifying the password it is then encoded using the binary-to-text encoding scheme specified by the encoding property ("base16" by default).

This hasher does not support one-time hashing (e.g. login passwords are encoded the same way every time).

See Also:

MessageDigest, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
DigestPasswordHasher()

Method Summary

Modifier and Type	Method and Description
boolean	checkPassword(java.lang.String pLoginPassword, java.lang.String pEncryptedPassword, java.lang.Object pHashKey) Returns true if the login password matches the encrypted password.
java.lang.String	encryptPassword(java.lang.String pPassword) Encrypts a password suitable for long-term storage.
java.lang.String	getAlgorithm() Returns the name of the digestifying algorithm used by this password hasher.
java.lang.String	getEncoding() Returns the name of the encoding scheme used to convert the encrypted password into a string.
PasswordHasher	getLoginPasswordHasher() Returns a password hasher instance useful for performing a login.
java.lang.Object	getPasswordHashKey() Returns the hash key (if any) that was used for hashing the password for login.
java.lang.String	getPwdHasherComponentPath() Returns the PasswordHasher component path.
java.lang.String	hashPasswordForLogin(java.lang.String pPassword) Performs the appropriate hashing function for a login process.
void	setAlgorithm(java.lang.String pAlgorithm) Changes the name of the digestifying algorithm used by this password hasher.
void	setEncoding(java.lang.String pMethod) Changes the encoding scheme used to convert the encrypted password into a string.
void	setPwdHasherComponentPath(java.lang.String pPwdHasherComponentPath) Sets the PasswordHasher component path used.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

DigestPasswordHasher

public DigestPasswordHasher()

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()

Returns the name of the digestifying algorithm used by this password hasher.

setAlgorithm

public void setAlgorithm(java.lang.String pAlgorithm)

Changes the name of the digestifying algorithm used by this password hasher.

getEncoding

public java.lang.String getEncoding()

Returns the name of the encoding scheme used to convert the encrypted password into a string.

See Also:

BinaryToTextEncoders

setEncoding

public void setEncoding(java.lang.String pMethod)

Changes the encoding scheme used to convert the encrypted password into a string.

See Also:

BinaryToTextEncoders

setPwdHasherComponentPath

public void setPwdHasherComponentPath(java.lang.String pPwdHasherComponentPath)

Sets the PasswordHasher component path used.

Parameters:

pPwdHasherComponentPath - the PasswordHasher component to set

getPwdHasherComponentPath

public java.lang.String getPwdHasherComponentPath()

Returns the PasswordHasher component path.

Specified by:

getPwdHasherComponentPath in interface PasswordHasher

Returns:

the pwdHasherComponentPath

encryptPassword

public java.lang.String encryptPassword(java.lang.String pPassword)

Encrypts a password suitable for long-term storage.

Specified by:

encryptPassword in interface PasswordHasher

checkPassword

public boolean checkPassword(java.lang.String pLoginPassword,
                             java.lang.String pEncryptedPassword,
                             java.lang.Object pHashKey)

Returns true if the login password matches the encrypted password.

Specified by:

checkPassword in interface PasswordHasher

hashPasswordForLogin

public java.lang.String hashPasswordForLogin(java.lang.String pPassword)

Performs the appropriate hashing function for a login process. This value will later be passed to checkPassword().

Specified by:

hashPasswordForLogin in interface PasswordHasher

getPasswordHashKey

public java.lang.Object getPasswordHashKey()

Returns the hash key (if any) that was used for hashing the password for login. This must be passed to checkPassword() to verify the validity of the hash.

Specified by:

getPasswordHashKey in interface PasswordHasher

getLoginPasswordHasher

public PasswordHasher getLoginPasswordHasher()

Returns a password hasher instance useful for performing a login. This instance may have a unique password hash key so that each login attempt is hashed differently.

Specified by:

getLoginPasswordHasher in interface PasswordHasher