com.helger.photon.basic.security.password.hash

Class PasswordHashCreatorDefault

java.lang.Object

com.helger.photon.basic.security.password.hash.AbstractPasswordHashCreator

com.helger.photon.basic.security.password.hash.PasswordHashCreatorDefault

All Implemented Interfaces:

IPasswordHashCreator

public final class PasswordHashCreatorDefault
extends AbstractPasswordHashCreator

The default implementation of IPasswordHashCreator.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM
static com.helger.commons.messagedigest.EMessageDigestAlgorithm	USER_PASSWORD_ALGO Hashing algorithm to use for user passwords - never change it!

Constructor Summary

Constructors

Constructor and Description
PasswordHashCreatorDefault()

Method Summary

Methods

Modifier and Type	Method and Description
String	createPasswordHash(IPasswordSalt aSalt, String sPlainTextPassword) The method to create a message digest hash from a password.
boolean	requiresSalt()

Methods inherited from class com.helger.photon.basic.security.password.hash.AbstractPasswordHashCreator

getAlgorithmName, toString

Methods inherited from class java.lang.Object

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

Field Detail

ALGORITHM

public static final String ALGORITHM

See Also:

Constant Field Values

USER_PASSWORD_ALGO

@Nonnull
public static final com.helger.commons.messagedigest.EMessageDigestAlgorithm USER_PASSWORD_ALGO

Hashing algorithm to use for user passwords - never change it!

Constructor Detail

PasswordHashCreatorDefault

public PasswordHashCreatorDefault()

Method Detail

requiresSalt

public boolean requiresSalt()

Returns:

true if this hash creator requires a salt, false if not.

createPasswordHash

@Nonnull
public String createPasswordHash(@Nullable
                                IPasswordSalt aSalt,
                                @Nonnull
                                String sPlainTextPassword)

Description copied from interface: IPasswordHashCreator

The method to create a message digest hash from a password.

Parameters:

aSalt - Optional salt to be used. This parameter is only null for backwards compatibility reasons.

sPlainTextPassword - Plain text password. May not be null.

Returns:

The String representation of the password hash. Must be valid to encode in UTF-8.