at.favre.lib.crypto.bcrypt

Class BCrypt.Verifyer

java.lang.Object

at.favre.lib.crypto.bcrypt.BCrypt.Verifyer

Enclosing class:

BCrypt

public static final class BCrypt.Verifyer
extends Object

Can verify bcrypt hashes

Method Summary

Modifier and Type	Method and Description
BCrypt.Result	verify(byte[] password, BCrypt.HashData bcryptHashData) Verify given raw byte arrays of salt, 23 byte bcrypt hash and password.
BCrypt.Result	verify(byte[] password, byte[] bcryptHash) Verify given bcrypt hash, which includes salt and cost factor with given raw password.
BCrypt.Result	verify(byte[] password, int cost, byte[] salt, byte[] rawBcryptHash23Bytes) Verify given raw byte arrays of salt, 23 byte bcrypt hash and password.
BCrypt.Result	verify(char[] password, char[] bcryptHash) Verify given bcrypt hash, which includes salt and cost factor with given raw password.
BCrypt.Result	verify(char[] password, CharSequence bcryptHash) Verify given bcrypt hash, which includes salt and cost factor with given raw password.
BCrypt.Result	verifyStrict(byte[] password, byte[] bcryptHash, BCrypt.Version expectedVersion) Verify given bcrypt hash, which includes salt and cost factor with given raw password requiring a specific version.
BCrypt.Result	verifyStrict(char[] password, char[] bcryptHash, BCrypt.Version expectedVersion) Verify given bcrypt hash, which includes salt and cost factor with given raw password requiring a specific version.

Methods inherited from class java.lang.Object

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

Method Detail

verifyStrict

public BCrypt.Result verifyStrict(byte[] password,
                                  byte[] bcryptHash,
                                  BCrypt.Version expectedVersion)

Verify given bcrypt hash, which includes salt and cost factor with given raw password requiring a specific version. If the version does not match, BCrypt.Result.verified will be false, even if the hash matches.

If given hash has an invalid format BCrypt.Result.validFormat will be false; see also BCrypt.Result.formatErrorMessage for easier debugging.

Parameters:

password - to compare against the hash

bcryptHash - to compare against the password

expectedVersion - will check for this version and wil not verify if versions do not match

Returns:

result object, see BCrypt.Result for more info

verify

public BCrypt.Result verify(byte[] password,
                            byte[] bcryptHash)

Verify given bcrypt hash, which includes salt and cost factor with given raw password. The result will have BCrypt.Result.verified true if they match. If given hash has an invalid format BCrypt.Result.validFormat will be false; see also BCrypt.Result.formatErrorMessage for easier debugging.

Parameters:

password - to compare against the hash

bcryptHash - to compare against the password

Returns:

result object, see BCrypt.Result for more info

verifyStrict

public BCrypt.Result verifyStrict(char[] password,
                                  char[] bcryptHash,
                                  BCrypt.Version expectedVersion)

Verify given bcrypt hash, which includes salt and cost factor with given raw password requiring a specific version. If the version does not match, BCrypt.Result.verified will be false, even if the hash matches.

If given hash has an invalid format BCrypt.Result.validFormat will be false; see also BCrypt.Result.formatErrorMessage for easier debugging.

Parameters:

password - to compare against the hash

bcryptHash - to compare against the password

expectedVersion - will check for this version and wil not verify if versions do not match

Returns:

result object, see BCrypt.Result for more info

verify

public BCrypt.Result verify(char[] password,
                            char[] bcryptHash)

Verify given bcrypt hash, which includes salt and cost factor with given raw password. The result will have BCrypt.Result.verified true if they match. If given hash has an invalid format BCrypt.Result.validFormat will be false; see also BCrypt.Result.formatErrorMessage for easier debugging.

Parameters:

password - to compare against the hash

bcryptHash - to compare against the password

Returns:

result object, see BCrypt.Result for more info

verify

public BCrypt.Result verify(char[] password,
                            CharSequence bcryptHash)

Verify given bcrypt hash, which includes salt and cost factor with given raw password. The result will have BCrypt.Result.verified true if they match. If given hash has an invalid format BCrypt.Result.validFormat will be false; see also BCrypt.Result.formatErrorMessage for easier debugging.

Same as calling verify(password, bcryptHash.toCharArray())

Parameters:

password - to compare against the hash

bcryptHash - to compare against the password (you may just pass a regular String)

Returns:

result object, see BCrypt.Result for more info

verify

public BCrypt.Result verify(byte[] password,
                            BCrypt.HashData bcryptHashData)

Verify given raw byte arrays of salt, 23 byte bcrypt hash and password. This is handy if the bcrypt messages are not packaged in the default Modular Crypt Format (see also BCrypt.Hasher.hashRaw(int, byte[], byte[]).

The result will have BCrypt.Result.verified true if they match. If given hash has an invalid format BCrypt.Result.validFormat will be false; see also BCrypt.Result.formatErrorMessage for easier debugging.

Note: This is part of the advanced APIs, only use if you know what you are doing.

Parameters:

password - to compare against the hash

bcryptHashData - containing the data of the bcrypt hash (cost, salt, version, etc.)

Returns:

result object, see BCrypt.Result for more info

verify

public BCrypt.Result verify(byte[] password,
                            int cost,
                            byte[] salt,
                            byte[] rawBcryptHash23Bytes)

Verify given raw byte arrays of salt, 23 byte bcrypt hash and password. This is handy if the bcrypt messages are not packaged in the default Modular Crypt Format (see also BCrypt.Hasher.hashRaw(int, byte[], byte[]).

The result will have BCrypt.Result.verified true if they match. If given hash has an invalid format BCrypt.Result.validFormat will be false; see also BCrypt.Result.formatErrorMessage for easier debugging.

Note: This is part of the advanced APIs, only use if you know what you are doing.

Parameters:

password - to compare against the hash

cost - cost (log2 factor) which was used to create the hash

salt - 16 byte raw hash value (not radix64 version) which was used to create the hash

rawBcryptHash23Bytes - 23 byte raw bcrypt hash value (not radix64 version)

Returns:

result object, see BCrypt.Result for more info