Package org.springframework.security.crypto.bcrypt

Class BCryptPasswordEncoder

java.lang.Object

org.springframework.security.crypto.password.AbstractValidatingPasswordEncoder

org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder

All Implemented Interfaces:

PasswordEncoder

public class BCryptPasswordEncoder
extends AbstractValidatingPasswordEncoder

Implementation of PasswordEncoder that uses the BCrypt strong hashing function. Clients can optionally supply a "version" ($2a, $2b, $2y) and a "strength" (a.k.a. log rounds in BCrypt) and a SecureRandom instance. The larger the strength parameter the more work will have to be done (exponentially) to hash the passwords. The default value is 10.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BCryptPasswordEncoder.BCryptVersion	Stores the default bcrypt version for use in configuration.

Constructor Summary

Constructors

Constructor	Description
BCryptPasswordEncoder()
BCryptPasswordEncoder(int strength)
BCryptPasswordEncoder(int strength, @Nullable SecureRandom random)
BCryptPasswordEncoder(BCryptPasswordEncoder.BCryptVersion version)
BCryptPasswordEncoder(BCryptPasswordEncoder.BCryptVersion version, int strength)
BCryptPasswordEncoder(BCryptPasswordEncoder.BCryptVersion version, int strength, @Nullable SecureRandom random)
BCryptPasswordEncoder(BCryptPasswordEncoder.BCryptVersion version, @Nullable SecureRandom random)

Method Summary

Modifier and Type	Method	Description
protected String	encodeNonNullPassword(String rawPassword)
protected boolean	matchesNonNull(String rawPassword, String encodedPassword)
protected boolean	upgradeEncodingNonNull(String encodedPassword)

Methods inherited from class org.springframework.security.crypto.password.AbstractValidatingPasswordEncoder

encode, matches, upgradeEncoding

Methods inherited from class java.lang.Object

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

Constructor Details

BCryptPasswordEncoder

public BCryptPasswordEncoder()

BCryptPasswordEncoder

public BCryptPasswordEncoder(int strength)

Parameters:

strength - the log rounds to use, between 4 and 31

BCryptPasswordEncoder

public BCryptPasswordEncoder(BCryptPasswordEncoder.BCryptVersion version)

Parameters:

version - the version of bcrypt, can be 2a,2b,2y

BCryptPasswordEncoder

public BCryptPasswordEncoder(BCryptPasswordEncoder.BCryptVersion version,
 @Nullable SecureRandom random)

Parameters:

version - the version of bcrypt, can be 2a,2b,2y

random - the secure random instance to use

BCryptPasswordEncoder

public BCryptPasswordEncoder(int strength,
 @Nullable SecureRandom random)

Parameters:

strength - the log rounds to use, between 4 and 31

random - the secure random instance to use

BCryptPasswordEncoder

public BCryptPasswordEncoder(BCryptPasswordEncoder.BCryptVersion version,
 int strength)

Parameters:

version - the version of bcrypt, can be 2a,2b,2y

strength - the log rounds to use, between 4 and 31

BCryptPasswordEncoder

public BCryptPasswordEncoder(BCryptPasswordEncoder.BCryptVersion version,
 int strength,
 @Nullable SecureRandom random)

Parameters:

version - the version of bcrypt, can be 2a,2b,2y

strength - the log rounds to use, between 4 and 31

random - the secure random instance to use

Method Details

encodeNonNullPassword

protected String encodeNonNullPassword(String rawPassword)

Specified by:

encodeNonNullPassword in class AbstractValidatingPasswordEncoder

matchesNonNull

protected boolean matchesNonNull(String rawPassword,
 String encodedPassword)

Specified by:

matchesNonNull in class AbstractValidatingPasswordEncoder

upgradeEncodingNonNull

protected boolean upgradeEncodingNonNull(String encodedPassword)

Overrides:

upgradeEncodingNonNull in class AbstractValidatingPasswordEncoder