com.communote.server.core.user.security

Class BcryptPasswordHashFunction

java.lang.Object

com.communote.server.core.user.security.BcryptPasswordHashFunction

All Implemented Interfaces:

PasswordHashFunction

public class BcryptPasswordHashFunction
extends Object
implements PasswordHashFunction

bcrypt password hash function which produces a string in modular crypt format.

Note: not using PHC string format as there is no definition for ID and parameters.

Since:

3.5

Author:

Communote Team - https://github.com/Communote

Constructor Summary

Constructors

Constructor and Description
BcryptPasswordHashFunction()

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(String passwordHash) Test whether the provided hash was generated by PasswordHashFunction.generate(String) of this hash function.
boolean	check(String passwordHash, String password) Test a clear text password against a password hash generated by this hash function.
String	generate(String password) Generate the hash of a clear text password.
int	getCostFactorFromHash(String passwordHash)
String	getIdentifier()
boolean	needsUpdate(String passwordHash) Test whether a password hash needs to be updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

BcryptPasswordHashFunction

public BcryptPasswordHashFunction()

Method Detail

canHandle

public boolean canHandle(String passwordHash)

Description copied from interface: PasswordHashFunction

Test whether the provided hash was generated by PasswordHashFunction.generate(String) of this hash function.

Specified by:

canHandle in interface PasswordHashFunction

Parameters:

passwordHash - a password hash

Returns:

true if the hash was generated by this function, false otherwise

check

public boolean check(String passwordHash,
                     String password)

Description copied from interface: PasswordHashFunction

Test a clear text password against a password hash generated by this hash function. This method will only be called if PasswordHashFunction.canHandle(String) for the hash returns true.

Specified by:

check in interface PasswordHashFunction

Parameters:

passwordHash - a hash generated by this function

password - the clear text password to validate

Returns:

true if the hash was created from the given password, false otherwise

generate

public String generate(String password)

Description copied from interface: PasswordHashFunction

Generate the hash of a clear text password. The resulting string has to contain information to determine whether the hash was generated by this function (PasswordHashFunction.canHandle(String)) and to check the hash against a clear-text password in PasswordHashFunction.check(String, String). The latter requires to include the salt and any parameters like cost factors or iterations in the created string. A recommended way to encode this information is the PHC string format.

Specified by:

generate in interface PasswordHashFunction

Parameters:

password - the clear text password to hash

Returns:

the generated hash with all relevant information

getCostFactorFromHash

public int getCostFactorFromHash(String passwordHash)

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface PasswordHashFunction

Returns:

a unique identifier of the hash function (key derivation function) or function family.

needsUpdate

public boolean needsUpdate(String passwordHash)

Description copied from interface: PasswordHashFunction

Test whether a password hash needs to be updated. If the function for instance has a configurable cost factor this method could check whether the cost factor used to generate the hash is up-to-date and return false if not. In case false is returned a new hash will be generated with a call to PasswordHashFunction.generate(String). This method will only be called if PasswordHashFunction.canHandle(String) for the hash returns true.

Specified by:

needsUpdate in interface PasswordHashFunction

Parameters:

passwordHash - a hash generated by this function

Returns:

true if the hash should be updated to adhere to newer/stronger security requirements