at.favre.lib.crypto.bcrypt

Class BCrypt.Version

java.lang.Object

at.favre.lib.crypto.bcrypt.BCrypt.Version

Enclosing class:

BCrypt

public static final class BCrypt.Version
extends Object

The supported version identifiers for bcrypt according to the modular crypt format.

See: https://passlib.readthedocs.io/en/stable/modular_crypt_format.html

Field Summary

Fields

Modifier and Type	Field and Description
boolean	appendNullTerminator Since OpenBSD bcrypt version $2a$ a null-terminator byte must be append to the hash.
BCryptFormatter	formatter The formatter for the bcrypt message digest
BCryptParser	parser The parser used to parse a bcrypt message
static List<BCrypt.Version>	SUPPORTED_VERSIONS List of supported versions
boolean	useOnly23bytesForHash Due to a bug the OpenBSD implemenation only uses 23 bytes (184 bit) of the possible 24 byte output from blowfish.
static BCrypt.Version	VERSION_2A $2a$
static BCrypt.Version	VERSION_2B $2b$ (2014/02)
static BCrypt.Version	VERSION_2X $2x$ (2011)
static BCrypt.Version	VERSION_2Y $2y$ (2011)
static BCrypt.Version	VERSION_BC This mirrors how Bouncy Castle creates bcrypt hashes: with 24 byte out and without null-terminator.
byte[]	versionIdentifier Version identifier byte array, eg.{0x32, 0x61} for '2a'

Constructor Summary

Constructors

Constructor and Description
Version(byte[] versionIdentifier, boolean useOnly23bytesForHash, boolean appendNullTerminator, BCryptFormatter formatter, BCryptParser parser) Create a new version.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VERSION_2A

public static final BCrypt.Version VERSION_2A

$2a$

The original specification did not define how to handle non-ASCII character, nor how to handle a null terminator. The specification was revised to specify that when hashing strings: - the string must be UTF-8 encoded - the null terminator must be included

VERSION_2B

public static final BCrypt.Version VERSION_2B

$2b$ (2014/02)

A bug was discovered in the OpenBSD implementation of bcrypt. They were storing the length of their strings in an unsigned char (i.e. 8-bit Byte). If a password was longer than 255 characters, it would overflow and wrap at 255. To recognize possible incorrect hashes, a new version was created.

VERSION_2X

public static final BCrypt.Version VERSION_2X

$2x$ (2011)

Due to a bug in crypt_blowfish, a PHP implementation of BCrypt, a new version string was introduced to recognize old hashes. It was mis-handling characters with the 8th bit set. Nobody else, including canonical OpenBSD, adopted the idea of 2x/2y so this version marker change was limited to crypt_blowfish.

Nobody else, including canonical OpenBSD, adopted the idea of 2x/2y. This version marker change was limited to crypt_blowfish.

VERSION_2Y

public static final BCrypt.Version VERSION_2Y

$2y$ (2011)

See VERSION_2X

VERSION_BC

public static final BCrypt.Version VERSION_BC

This mirrors how Bouncy Castle creates bcrypt hashes: with 24 byte out and without null-terminator. Gets a fake version descriptor.

SUPPORTED_VERSIONS

public static final List<BCrypt.Version> SUPPORTED_VERSIONS

List of supported versions

versionIdentifier

public final byte[] versionIdentifier

Version identifier byte array, eg.{0x32, 0x61} for '2a'

useOnly23bytesForHash

public final boolean useOnly23bytesForHash

Due to a bug the OpenBSD implemenation only uses 23 bytes (184 bit) of the possible 24 byte output from blowfish. Set this to false if you want the full 24 byte out (which makes it incompatible with most other impl)

appendNullTerminator

public final boolean appendNullTerminator

Since OpenBSD bcrypt version $2a$ a null-terminator byte must be append to the hash. This flag decides if that will be done during hashing.

formatter

public final BCryptFormatter formatter

The formatter for the bcrypt message digest

parser

public final BCryptParser parser

The parser used to parse a bcrypt message

Constructor Detail

Version

public Version(byte[] versionIdentifier,
               boolean useOnly23bytesForHash,
               boolean appendNullTerminator,
               BCryptFormatter formatter,
               BCryptParser parser)

Create a new version. Only use this if you are know what you are doing, most common versions are already available with VERSION_2A, VERSION_2Y etc.

Parameters:

versionIdentifier - version as UTF-8 encoded byte array, e.g. '2a' = new byte[]{0x32, 0x61}, do not included the separator '$'

useOnly23bytesForHash - set to false if you want the full 24 byte out for the hash (otherwise will be truncated to 23 byte according to OpenBSD impl)

appendNullTerminator - as defined in $2a$+ a null terminator is appended to the password, pass false if you want avoid this

formatter - the formatter responsible for formatting the out hash message digest

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object