a3402d573f
- Rename HashResult to EncryptedPassword to reflect its broader use - Use EncryptedPassword in methods that require the hash and the salt, instead of passing them as strings separately - Store EncryptedPassword as field in PlayerAuth; updatePassword() thus processes the entire data in the EncryptedPassword object
60 lines
2.1 KiB
Java
60 lines
2.1 KiB
Java
package fr.xephi.authme.security.crypts;
|
|
|
|
/**
|
|
* Public interface for custom password encryption methods.
|
|
*/
|
|
public interface EncryptionMethod {
|
|
|
|
/**
|
|
* Hash the given password for the given player name.
|
|
*
|
|
* @param password The password to hash
|
|
* @param name The name of the player (sometimes required to generate a salt with)
|
|
*
|
|
* @return The hash result for the password.
|
|
* @see EncryptedPassword
|
|
*/
|
|
EncryptedPassword computeHash(String password, String name);
|
|
|
|
/**
|
|
* Hash the given password with the given salt for the given player.
|
|
*
|
|
* @param password The password to hash
|
|
* @param salt The salt to add to the hash
|
|
* @param name The player's name (sometimes required to generate a salt with)
|
|
*
|
|
* @return The hashed password
|
|
* @see #hasSeparateSalt()
|
|
*/
|
|
String computeHash(String password, String salt, String name);
|
|
|
|
/**
|
|
* Check whether the given hash matches the clear-text password.
|
|
*
|
|
* @param password The clear-text password to verify
|
|
* @param encryptedPassword The hash to check the password against
|
|
* @param name The player name to do the check for (sometimes required for generating the salt)
|
|
*
|
|
* @return True if the password matches, false otherwise
|
|
*/
|
|
boolean comparePassword(String password, EncryptedPassword encryptedPassword, String name);
|
|
|
|
/**
|
|
* Generate a new salt to hash a password with.
|
|
*
|
|
* @return The generated salt, null if the method does not use a random text-based salt
|
|
*/
|
|
String generateSalt();
|
|
|
|
/**
|
|
* Return whether the encryption method requires the salt to be stored separately and
|
|
* passed again to {@link #comparePassword(String, EncryptedPassword, String)}. Note that
|
|
* an encryption method returning {@code false} does not imply that it uses no salt; it
|
|
* may be embedded into the hash or it may use the username as salt.
|
|
*
|
|
* @return True if the salt has to be stored and retrieved separately, false otherwise
|
|
*/
|
|
boolean hasSeparateSalt();
|
|
|
|
}
|