com.communote.server.core.user.security

Interface PasswordHashFunction

All Known Implementing Classes:

BcryptPasswordHashFunction, Md5PasswordHashFunction

public interface PasswordHashFunction

Since:

3.5

Author:

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

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(String passwordHash) Test whether the provided hash was generated by 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.
String	getIdentifier()
boolean	needsUpdate(String passwordHash) Test whether a password hash needs to be updated.

Method Detail

canHandle

boolean canHandle(String passwordHash)

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

Parameters:

passwordHash - a password hash

Returns:

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

check

boolean check(String passwordHash,
              String password)

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

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

String generate(String password)

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 (canHandle(String)) and to check the hash against a clear-text password in 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.

Parameters:

password - the clear text password to hash

Returns:

the generated hash with all relevant information

getIdentifier

String getIdentifier()

Returns:

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

needsUpdate

boolean needsUpdate(String passwordHash)

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 generate(String). This method will only be called if canHandle(String) for the hash returns true.

Parameters:

passwordHash - a hash generated by this function

Returns:

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