Module io.inverno.mod.security

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

Class MessageDigestPassword.Encoder

java.lang.Object

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

All Implemented Interfaces:

Password.Encoder<MessageDigestPassword,MessageDigestPassword.Encoder>

Enclosing class:

MessageDigestPassword

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

A MessageDigest based password encoder implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ALGORITHM	The default algorithm: SHA-512.
static final int	DEFAULT_SALT_LENGTH	The default salt length in bytes: 16.
static final byte[]	DEFAULT_SECRET	The default secret: new byte[0].

Constructor Summary

Constructors

Constructor	Description
Encoder()	Creates a default message digest password encoder.
Encoder(String algorithm)	Creates a message digest password encoder using the specified algorithm.
Encoder(String algorithm, byte[] secret)	Creates a message digest password encoder using the specified algorithm and secret.
Encoder(String algorithm, byte[] secret, int saltLength)	Creates a message digest password encoder using the specified algorithm, secret and salt length.
Encoder(String algorithm, byte[] secret, int saltLength, SecureRandom secureRandom)	Creates a message digest password encoder using the specified algorithm, secret, salt length and secure random.

Method Summary

Modifier and Type	Method	Description
MessageDigestPassword	encode(String raw)	Encodes the specified raw password.
boolean	equals(Object obj)
String	getAlgorithm()	Returns the algorithm.
int	getSaltLength()	Returns the salt length in kikibytes.
byte[]	getSecret()	Returns the secret.
SecureRandom	getSecureRandom()	Returns the secure random.
int	hashCode()
boolean	matches(String raw, String encoded)	Matches the specified raw password with the specified encoded representation.
MessageDigestPassword	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_ALGORITHM

public static final String DEFAULT_ALGORITHM

The default algorithm: SHA-512.

See Also:

• Constant Field Values

DEFAULT_SECRET

public static final byte[] DEFAULT_SECRET

The default secret: new byte[0].

DEFAULT_SALT_LENGTH

public static final int DEFAULT_SALT_LENGTH

The default salt length in bytes: 16.

See Also:

• Constant Field Values

Constructor Details

Encoder

public Encoder()

Creates a default message digest password encoder.

Encoder

public Encoder(String algorithm)

Creates a message digest password encoder using the specified algorithm.

Parameters:

algorithm - the algorithm

Encoder

public Encoder(String algorithm,
 byte[] secret)

Creates a message digest password encoder using the specified algorithm and secret.

Parameters:

algorithm - the algorithm

secret - the secret

Encoder

public Encoder(String algorithm,
 byte[] secret,
 int saltLength)

Creates a message digest password encoder using the specified algorithm, secret and salt length.

Parameters:

algorithm - the algorithm

secret - the secret

saltLength - the salt length in kikibytes

Encoder

public Encoder(String algorithm,
 byte[] secret,
 int saltLength,
 SecureRandom secureRandom)

Creates a message digest password encoder using the specified algorithm, secret, salt length and secure random.

Parameters:

algorithm - the algorithm

secret - the secret

saltLength - the salt length in kikibytes

secureRandom - the secure random

Method Details

getAlgorithm

public String getAlgorithm()

Returns the algorithm.

Returns:

the algorithm

getSecret

public byte[] getSecret()

Returns the secret.

Returns:

the secret

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 MessageDigestPassword 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<MessageDigestPassword,MessageDigestPassword.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 MessageDigestPassword encode(String raw)
                             throws PasswordException

Description copied from interface: Password.Encoder

Encodes the specified raw password.

Specified by:

encode in interface Password.Encoder<MessageDigestPassword,MessageDigestPassword.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<MessageDigestPassword,MessageDigestPassword.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