com.haulmont.cuba.core.global

Interface PasswordEncryption

All Known Implementing Classes:

PasswordEncryptionImpl

public interface PasswordEncryption

Encryption support for hashing passwords.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
boolean	checkPassword(User user, java.lang.String password) Check password for a user.
java.lang.String	generateRandomPassword()
HashDescriptor	getHash(java.lang.String content) Hashing string with salt.
java.lang.String	getHash(java.lang.String content, java.lang.String salt) Hashing string.
java.lang.String	getHashMethod()
java.lang.String	getPasswordHash(java.util.UUID userId, java.lang.String password) Hashing password to store it into DB.
java.lang.String	getPlainHash(java.lang.String content) Hashing string without salt.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

generateRandomPassword

java.lang.String generateRandomPassword()

Returns:

a random password with Base64 symbols

getHashMethod

java.lang.String getHashMethod()

Returns:

a hashing method in use

getHash

HashDescriptor getHash(java.lang.String content)

Hashing string with salt.

Parameters:

content - string for hashing

Returns:

hash with random salt. If the current HashMethod doesn't support salt, it is set to null.

getPasswordHash

java.lang.String getPasswordHash(java.util.UUID userId,
                                 java.lang.String password)

Hashing password to store it into DB.

Parameters:

userId - user id

password - content for hashing

Returns:

hash with salt, if it is supported by the current HashMethod

getHash

java.lang.String getHash(java.lang.String content,
                         java.lang.String salt)

Hashing string.

Parameters:

content - content for hashing

salt - salt

Returns:

hash with salt, if it is supported by the current HashMethod

getPlainHash

java.lang.String getPlainHash(java.lang.String content)

Hashing string without salt. This method must be used to encrypt password on a client tier before sending it to the middleware.

Parameters:

content - content for hashing

Returns:

hash

checkPassword

boolean checkPassword(User user,
                      java.lang.String password)

Check password for a user. This method is used on the middleware to compare password passed from a client with the one stored in the DB.

Parameters:

user - user

password - password to check. It must be previously encrypted with getPlainHash(String) method.

Returns:

true if the password is valid