public final class ConfigurablePasswordEncryptor extends java.lang.Object implements PasswordEncryptor
Utility class for easily performing password digesting and checking.
This class internally holds a StandardStringDigester
which can be configured by the user by optionally choosing the algorithm
to be used, the output format (BASE64 or hexadecimal) the mechanism of
encryption (plain digests vs. use of random salt
and iteration count (default)) and even use a DigesterConfig object for
more advanced configuration.
The results obtained when encoding with this class are encoded in BASE64 form.
The required steps to use it are:
encryptPassword(String) or
checkPassword(String, String)
operations.This class is thread-safe
| Modifier and Type | Field and Description |
|---|---|
private StandardStringDigester |
digester |
| Constructor and Description |
|---|
ConfigurablePasswordEncryptor()
Creates a new instance of ConfigurablePasswordEncryptor
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
checkPassword(java.lang.String plainPassword,
java.lang.String encryptedPassword)
Checks an unencrypted (plain) password against an encrypted one
(a digest) to see if they match.
|
java.lang.String |
encryptPassword(java.lang.String password)
Encrypts (digests) a password.
|
void |
setAlgorithm(java.lang.String algorithm)
Sets the algorithm to be used for digesting, like MD5
or SHA-1.
|
void |
setConfig(DigesterConfig config)
Lets the user configure this encryptor with a
DigesterConfig
object, like if he/she were using a StandardStringDigester object
directly. |
void |
setPlainDigest(boolean plainDigest)
Lets the user specify if he/she wants a plain digest used as an
encryption mechanism (no salt or iterations, as with
MessageDigest), or rather use the
jasypt's usual stronger mechanism for password encryption (based
on the use of a salt and the iteration of the hash function). |
void |
setProvider(java.security.Provider provider)
Sets the security provider to be asked for the digest algorithm.
|
void |
setProviderName(java.lang.String providerName)
Sets the name of the security provider to be asked for the
digest algorithm.
|
void |
setStringOutputType(java.lang.String stringOutputType)
Sets the the form in which String output
will be encoded.
|
private final StandardStringDigester digester
public ConfigurablePasswordEncryptor()
public void setConfig(DigesterConfig config)
DigesterConfig
object, like if he/she were using a StandardStringDigester object
directly.config - the DigesterConfig object to be set for configuration.StandardStringDigester.setConfig(DigesterConfig)public void setAlgorithm(java.lang.String algorithm)
Sets the algorithm to be used for digesting, like MD5 or SHA-1.
This algorithm has to be supported by your security infrastructure, and it should be allowed as an algorithm for creating java.security.MessageDigest instances.
If you are specifying a security provider with setProvider(Provider) or
setProviderName(String), this algorithm should be
supported by your specified provider.
If you are not specifying a provider, you will be able to use those algorithms provided by the default security provider of your JVM vendor. For valid names in the Sun JVM, see Java Cryptography Architecture API Specification & Reference.
algorithm - the name of the algorithm to be used.StandardStringDigester.setAlgorithm(String)public void setProviderName(java.lang.String providerName)
Sets the name of the security provider to be asked for the digest algorithm. This security provider has to be registered beforehand at the JVM security framework.
The provider can also be set with the setProvider(Provider)
method, in which case it will not be necessary neither registering
the provider beforehand,
nor calling this setProviderName(String) method to specify
a provider name.
Note that a call to setProvider(Provider) overrides any value
set by this method.
If no provider name / provider is explicitly set, the default JVM provider will be used.
providerName - the name of the security provider to be asked
for the digest algorithm.AlreadyInitializedException - if it has already been initialized,
this is, if encryptPassword(String) or
checkPassword(String, String) have been called at least
once.public void setProvider(java.security.Provider provider)
Sets the security provider to be asked for the digest algorithm. The provider does not have to be registered at the security infrastructure beforehand, and its being used here will not result in it being registered.
If this method is called, calling setProviderName(String)
becomes unnecessary.
If no provider name / provider is explicitly set, the default JVM provider will be used.
provider - the provider to be asked for the chosen algorithmAlreadyInitializedException - if it has already been initialized,
this is, if encryptPassword(String) or
checkPassword(String, String) have been called at least
once.public void setPlainDigest(boolean plainDigest)
MessageDigest), or rather use the
jasypt's usual stronger mechanism for password encryption (based
on the use of a salt and the iteration of the hash function).plainDigest - true for using plain digests, false for the strong
salt and iteration count based mechanism.public void setStringOutputType(java.lang.String stringOutputType)
Sets the the form in which String output will be encoded. Available encoding types are:
stringOutputType - the string output type.public java.lang.String encryptPassword(java.lang.String password)
encryptPassword in interface PasswordEncryptorpassword - the password to be encrypted.StandardStringDigester.digest(String)public boolean checkPassword(java.lang.String plainPassword,
java.lang.String encryptedPassword)
checkPassword in interface PasswordEncryptorplainPassword - the plain password to check.encryptedPassword - the digest against which to check the password.StandardStringDigester.matches(String, String)