BCrypt.Version (BCrypt Password Hashing Function 0.10.2 API)

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
`int`	`allowedMaxPwLength` The max allowed length of password in bcrypt, longer than that `LongPasswordStrategy` will be activated.
`boolean`	`appendNullTerminator` Since OpenBSD bcrypt version $2a$ a null-terminator byte must be append to the hash.
`static int`	`DEFAULT_MAX_PW_LENGTH_BYTE` Deprecated. this will return 71 which is not correct, the null terminator should not count towards the full length if the pw is exactly 72. Use `MAX_PW_LENGTH_BYTE` instead. See https://github.com/patrickfav/bcrypt/pull/44
`BCryptFormatter`	`formatter` The formatter for the bcrypt message digest
`static int`	`MAX_PW_LENGTH_BYTE` Absolutely maximum length bcrypt can support (18x32bit).
`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_2Y_NO_NULL_TERMINATOR` $2y$ (2011) without the null terminator
`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, int allowedMaxPwLength, BCryptFormatter formatter, BCryptParser parser)` Create a new version.

Method Summary

All Methods Instance Methods Concrete Methods
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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`toString()`

- Field Detail
  - MAX_PW_LENGTH_BYTE
```
public static final int MAX_PW_LENGTH_BYTE
```
    Absolutely maximum length bcrypt can support (18x32bit). Shorter passwords are repeated cyclically, possibly with NUL bytes separating each occurrence (but the NUL byte should not count against the limit: if the password is exactly this length then all characters are used and no repetition needs to happen, so no NUL needs to be inserted).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_PW_LENGTH_BYTE
```
@Deprecated
public static final int DEFAULT_MAX_PW_LENGTH_BYTE
```
    Deprecated. this will return 71 which is not correct, the null terminator should not count towards the full length if the pw is exactly 72. Use MAX_PW_LENGTH_BYTE instead. See https://github.com/patrickfav/bcrypt/pull/44
    
    The max length of the password in bytes excluding lats null-terminator byte.
    
    See Also:
    
    Constant Field Values
  - 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_2Y_NO_NULL_TERMINATOR
```
public static final BCrypt.Version VERSION_2Y_NO_NULL_TERMINATOR
```
    $2y$ (2011) without the null terminator
    See VERSION_2Y
  - 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.
  - allowedMaxPwLength
```
public final int allowedMaxPwLength
```
    The max allowed length of password in bcrypt, longer than that LongPasswordStrategy will be activated. Usual lengths are between 50 and 72 bytes, most often are 56, 71 or 72 bytes. See https://security.stackexchange.com/a/39851
  - 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,
               int allowedMaxPwLength,
               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
    
    allowedMaxPwLength - the max allowed length of password in bcrypt, longer than that LongPasswordStrategy will be activated
    
    formatter - the formatter responsible for formatting the out hash message digest
    
    parser - responsible for parsing the message format
- 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

Class BCrypt.Version

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_PW_LENGTH_BYTE

DEFAULT_MAX_PW_LENGTH_BYTE

VERSION_2A

VERSION_2B

VERSION_2X

VERSION_2Y

VERSION_2Y_NO_NULL_TERMINATOR

VERSION_BC

SUPPORTED_VERSIONS

versionIdentifier

useOnly23bytesForHash

appendNullTerminator

allowedMaxPwLength

formatter

parser

Constructor Detail

Version

Method Detail

equals

hashCode

toString