org.antfarmer.ejce.password

Interface PasswordEncoder

All Known Subinterfaces:

ConfigurablePasswordEncoder

All Known Implementing Classes:

AbstractArgon2PasswordEncoder, AbstractBcryptPasswordEncoder, AbstractConfigurablePasswordEncoder, AbstractPbkdf2PasswordEncoder, AbstractScryptPasswordEncoder, Argon2JvmEncoder, BcBcryptEncoder, BcScryptEncoder, Pbkdf2Encoder, SpringBcryptEncoder, SpringPbkdf2Encoder, SpringScryptEncoder

public interface PasswordEncoder

Interface for password encoders to be used for the encoded password Hibernate type.

See Also:

EncodedPasswordType

Method Summary

Modifier and Type	Method and Description
String	encode(CharSequence rawPassword) 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.

Method Detail

encode

String encode(CharSequence rawPassword)

Encode the raw password. This should combine a message digest (hash) function with randomly generated salt.

Parameters:

rawPassword - the raw password to encode

Returns:

the encoded password

matches

boolean matches(CharSequence rawPassword,
                String encodedPassword)

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.

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