Module io.inverno.mod.security

Package io.inverno.mod.security.authentication.password

Class BCryptPassword.Encoder

java.lang.Object

io.inverno.mod.security.authentication.password.BCryptPassword.Encoder

All Implemented Interfaces:

Password.Encoder<BCryptPassword,BCryptPassword.Encoder>

Enclosing class:

BCryptPassword

public static class BCryptPassword.Encoder
extends Object
implements Password.Encoder<BCryptPassword,BCryptPassword.Encoder>

A Bcrypt password encoder implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_COST	The default cost: 10.
static final int	SALT_LENGTH	The default salt length in kikibytes: 16.

Constructor Summary

Constructors

Constructor	Description
Encoder()	Creates a default Bcrypt password encoder.
Encoder(int cost, int saltLength)	Creates a Bcrypt password encoder with the specified cost and salt length.
Encoder(int cost, int saltLength, SecureRandom secureRandom)	Creates a Bcrypt password encoder with the specified cost, salt length and secure random.

Method Summary

Modifier and Type	Method	Description
BCryptPassword	encode(String raw)	Encodes the specified raw password.
boolean	equals(Object obj)
int	getCost()	Returns the cost.
int	getSaltLength()	Returns the salt length in kikibytes.
SecureRandom	getSecureRandom()	Returns the secure random.
int	hashCode()
boolean	matches(String raw, String encoded)	Matches the specified raw password with the specified encoded representation.
BCryptPassword	recover(String encoded)	Recovers a password from its encoded representation generated with this encoder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.security.authentication.password.Password.Encoder

matches

Field Details

DEFAULT_COST

public static final int DEFAULT_COST

The default cost: 10.

See Also:

• Constant Field Values

SALT_LENGTH

public static final int SALT_LENGTH

The default salt length in kikibytes: 16.

See Also:

• Constant Field Values

Constructor Details

Encoder

public Encoder()

Creates a default Bcrypt password encoder.

Encoder

public Encoder(int cost,
 int saltLength)
        throws IllegalArgumentException

Creates a Bcrypt password encoder with the specified cost and salt length.

Parameters:

cost - the cost

saltLength - the salt length in kikibytes

Throws:

IllegalArgumentException - if specified parameters are incorrect

Encoder

public Encoder(int cost,
 int saltLength,
 SecureRandom secureRandom)
        throws IllegalArgumentException

Creates a Bcrypt password encoder with the specified cost, salt length and secure random.

Parameters:

cost - the cost

saltLength - the salt length in kikibytes

secureRandom - the secure random

Throws:

IllegalArgumentException - if specified parameters are incorrect

Method Details

getCost

public int getCost()

Returns the cost.

Returns:

the cost

getSaltLength

public int getSaltLength()

Returns the salt length in kikibytes.

Returns:

the salt length

getSecureRandom

public SecureRandom getSecureRandom()

Returns the secure random.

Returns:

the secure random

recover

public BCryptPassword recover(String encoded)
                       throws PasswordException

Description copied from interface: Password.Encoder

Recovers a password from its encoded representation generated with this encoder.

Specified by:

recover in interface Password.Encoder<BCryptPassword,BCryptPassword.Encoder>

Parameters:

encoded - an encoded password representation

Returns:

a password

Throws:

PasswordException - if there was an error recovering the password or if the specified encoded representation was not generated with this encoder

encode

public BCryptPassword encode(String raw)
                      throws PasswordException

Description copied from interface: Password.Encoder

Encodes the specified raw password.

Specified by:

encode in interface Password.Encoder<BCryptPassword,BCryptPassword.Encoder>

Parameters:

raw - a raw password

Returns:

an encoded password

Throws:

PasswordException - if there was an error encoding the password

matches

public boolean matches(String raw,
 String encoded)
                throws PasswordException

Description copied from interface: Password.Encoder

Matches the specified raw password with the specified encoded representation.

Specified by:

matches in interface Password.Encoder<BCryptPassword,BCryptPassword.Encoder>

Parameters:

raw - a raw password

encoded - an encoded password

Returns:

true if passwords match, false otherwise

Throws:

PasswordException - if there was an error matching passwords

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object