Package io.gravitee.am.service.authentication.crypto.password

Class MessageDigestPasswordEncoder

java.lang.Object

io.gravitee.am.service.authentication.crypto.password.MessageDigestPasswordEncoder

All Implemented Interfaces:

PasswordEncoder

Direct Known Subclasses:

MD5PasswordEncoder, SHAPasswordEncoder

public abstract class MessageDigestPasswordEncoder
extends Object
implements PasswordEncoder

Author:

Titouan COMPIEGNE (titouan.compiegne at graviteesource.com), GraviteeSource Team

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageDigestPasswordEncoder(String algorithm)

Method Summary

Modifier and Type	Method	Description
String	encode(CharSequence rawPassword)	Encode the raw password.
String	encode(CharSequence rawPassword, byte[] salt)	Encode the raw password.
boolean	matches(CharSequence rawPassword, String encodedPassword)	Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded.
boolean	matches(CharSequence rawPassword, String encodedPassword, byte[] salt)	Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded.
boolean	matches(CharSequence rawPassword, String encodedPassword, String salt)	Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded.
void	setAlgorithm(String algorithm)
void	setEncodeSaltAsBase64(boolean encodeSaltAsBase64)
void	setIterationsRounds(int iterationsRounds)
void	setPasswordSaltFormat(String passwordSaltFormat)
void	setSaltLength(int saltLength)

Methods inherited from class java.lang.Object

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

Constructor Details

MessageDigestPasswordEncoder

protected MessageDigestPasswordEncoder(String algorithm)

Method Details

encode

public String encode(CharSequence rawPassword)

Description copied from interface: PasswordEncoder

Encode the raw password. Generally, a good encoding algorithm applies a SHA-1 or greater hash combined with an 8-byte or greater randomly generated salt.

Specified by:

encode in interface PasswordEncoder

Parameters:

rawPassword - the raw password to encode

encode

public String encode(CharSequence rawPassword,
 byte[] salt)

Description copied from interface: PasswordEncoder

Encode the raw password. Generally, a good encoding algorithm applies a SHA-1 or greater hash combined with an 8-byte or greater randomly generated salt.

Specified by:

encode in interface PasswordEncoder

Parameters:

rawPassword - the raw password to encode

salt - the salt use to encode the rawPassword

matches

public boolean matches(CharSequence rawPassword,
 String encodedPassword)

Description copied from interface: PasswordEncoder

Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded. Returns true if the passwords match, false if they do not. The stored password itself is never decoded.

Specified by:

matches in interface PasswordEncoder

Parameters:

rawPassword - the raw password to encode and match

encodedPassword - the encoded password from storage to compare with

Returns:

true if the raw password, after encoding, matches the encoded password from storage

matches

public boolean matches(CharSequence rawPassword,
 String encodedPassword,
 byte[] salt)

Description copied from interface: PasswordEncoder

Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded. Returns true if the passwords match, false if they do not. The stored password itself is never decoded.

Specified by:

matches in interface PasswordEncoder

Parameters:

rawPassword - the raw password to encode and match

encodedPassword - the encoded password from storage to compare with

salt - the salt use to compare the rawPassword and the encodedPassword

Returns:

matches

public boolean matches(CharSequence rawPassword,
 String encodedPassword,
 String salt)

Description copied from interface: PasswordEncoder

Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded. Returns true if the passwords match, false if they do not. The stored password itself is never decoded.

Specified by:

matches in interface PasswordEncoder

Parameters:

rawPassword - the raw password to encode and match

encodedPassword - the encoded password from storage to compare with

salt - the salt use to compare the rawPassword and the encodedPassword

Returns:

setAlgorithm

public void setAlgorithm(String algorithm)

setEncodeSaltAsBase64

public void setEncodeSaltAsBase64(boolean encodeSaltAsBase64)

setSaltLength

public void setSaltLength(int saltLength)

setPasswordSaltFormat

public void setPasswordSaltFormat(String passwordSaltFormat)

setIterationsRounds

public void setIterationsRounds(int iterationsRounds)