at.favre.lib.crypto.bkdf

Class PasswordHashUpgrader.Default

java.lang.Object

at.favre.lib.crypto.bkdf.PasswordHashUpgrader.Default

All Implemented Interfaces:

PasswordHashUpgrader

Enclosing interface:

PasswordHashUpgrader

public static final class PasswordHashUpgrader.Default
extends Object
implements PasswordHashUpgrader

Default implementation

Nested Class Summary

Nested classes/interfaces inherited from interface at.favre.lib.crypto.bkdf.PasswordHashUpgrader

PasswordHashUpgrader.Default

Field Summary

Fields inherited from interface at.favre.lib.crypto.bkdf.PasswordHashUpgrader

COMPOUND_FORMAT_VERSION

Constructor Summary

Constructors

Constructor and Description
Default(SecureRandom secureRandom)

Method Summary

Modifier and Type	Method and Description
boolean	isCompoundHashMessage(String bkdfPasswordHashFormat2) Efficently checks a base64 string if it is in compound hash data format.
CompoundHashData	upgradePasswordHashTo(int costFactor, String bkdfPasswordHashFormat2) Upgrades the given hash to the given new cost factor.
CompoundHashData	upgradePasswordHashWith(Version version, int costFactor, String bkdfPasswordHashFormat2) Upgrades the given hash with the given new hash config (ie.
boolean	verifyCompoundHash(char[] password, String bkdfPasswordHashFormat2) Verify a hash in compound format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Default

public Default(SecureRandom secureRandom)

Method Detail

upgradePasswordHashWith

public CompoundHashData upgradePasswordHashWith(Version version,
                                                int costFactor,
                                                String bkdfPasswordHashFormat2)

Description copied from interface: PasswordHashUpgrader

Upgrades the given hash with the given new hash config (ie. version and cost factor).

This will chain the current hash with given hash exactly as defined by the the input paramters. E.g. if the current hash is [(VERSION_1, 4)] and the the following will be passed: (VERSION_2, 10), the resulting hash config is [(VERSION_1, 4), (VERSION_2, 10)].

Specified by:

upgradePasswordHashWith in interface PasswordHashUpgrader

Parameters:

version - of the BKDF password hash to be used

costFactor - to be used on the current hash

bkdfPasswordHashFormat2 - the current hash. Can be in compound or normal password hash format

Returns:

upgraded hash data

upgradePasswordHashTo

public CompoundHashData upgradePasswordHashTo(int costFactor,
                                              String bkdfPasswordHashFormat2)

Description copied from interface: PasswordHashUpgrader

Upgrades the given hash to the given new cost factor.

This will chain the current hash with possibly multiple hash configs to achieve the new final cost factor. E.g. if current cost-factor is 5 and new cost-factor should be 7, the following sequence of hashes will be applied: 5 + [5, 6]. Note that cost-factor is seen as 2^cost-factor therefore 5 equals 32 iterations and 7, 128 iterations.

Specified by:

upgradePasswordHashTo in interface PasswordHashUpgrader

Parameters:

costFactor - to be the new final cost factor

bkdfPasswordHashFormat2 - the current hash. Can be in compound or normal password hash format

Returns:

upgraded hash data

verifyCompoundHash

public boolean verifyCompoundHash(char[] password,
                                  String bkdfPasswordHashFormat2)

Description copied from interface: PasswordHashUpgrader

Verify a hash in compound format.

See also CompoundHashData and PasswordHashVerifier.verify(char[], HashData).

Specified by:

verifyCompoundHash in interface PasswordHashUpgrader

Parameters:

password - to verify against

bkdfPasswordHashFormat2 - containing the hash data

Returns:

true iff bcrypt hash in bkdfPasswordHashFormat2 can be computed with given user password

isCompoundHashMessage

public boolean isCompoundHashMessage(String bkdfPasswordHashFormat2)

Description copied from interface: PasswordHashUpgrader

Efficently checks a base64 string if it is in compound hash data format.

See PasswordHashUpgrader.COMPOUND_FORMAT_VERSION and CompoundHashData

Specified by:

isCompoundHashMessage in interface PasswordHashUpgrader

Parameters:

bkdfPasswordHashFormat2 - to possible be in compound hash format

Returns:

iff given data has the version identifier of a compound format