Package org.apache.catalina.realm
Class SecretKeyCredentialHandler
- java.lang.Object
- 
- org.apache.catalina.realm.DigestCredentialHandlerBase
- 
- org.apache.catalina.realm.SecretKeyCredentialHandler
 
 
- 
- All Implemented Interfaces:
- CredentialHandler
 
 public class SecretKeyCredentialHandler extends DigestCredentialHandlerBase 
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.StringDEFAULT_ALGORITHMstatic intDEFAULT_ITERATIONSstatic intDEFAULT_KEY_LENGTH- 
Fields inherited from class org.apache.catalina.realm.DigestCredentialHandlerBaseDEFAULT_SALT_LENGTH, sm
 
- 
 - 
Constructor SummaryConstructors Constructor Description SecretKeyCredentialHandler()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetAlgorithm()protected intgetDefaultIterations()intgetKeyLength()protected LoggetLog()booleanmatches(java.lang.String inputCredentials, java.lang.String storedCredentials)Checks to see if the input credentials match the stored credentialsprotected java.lang.Stringmutate(java.lang.String inputCredentials, byte[] salt, int iterations)Generates the equivalent stored credentials for the given input credentials, salt and iterations.protected java.lang.Stringmutate(java.lang.String inputCredentials, byte[] salt, int iterations, int keyLength)Generates the equivalent stored credentials for the given input credentials, salt, iterations and key length.voidsetAlgorithm(java.lang.String algorithm)Set the algorithm used to convert input credentials to stored credentials.voidsetKeyLength(int keyLength)- 
Methods inherited from class org.apache.catalina.realm.DigestCredentialHandlerBaseequals, equals, getDefaultSaltLength, getIterations, getLogInvalidStoredCredentials, getSaltLength, matchesSaltIterationsEncoded, mutate, setIterations, setLogInvalidStoredCredentials, setSaltLength
 
- 
 
- 
- 
- 
Field Detail- 
DEFAULT_ALGORITHMpublic static final java.lang.String DEFAULT_ALGORITHM - See Also:
- Constant Field Values
 
 - 
DEFAULT_KEY_LENGTHpublic static final int DEFAULT_KEY_LENGTH - See Also:
- Constant Field Values
 
 - 
DEFAULT_ITERATIONSpublic static final int DEFAULT_ITERATIONS - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getAlgorithmpublic java.lang.String getAlgorithm() - Specified by:
- getAlgorithmin class- DigestCredentialHandlerBase
- Returns:
- the algorithm used to convert input credentials to stored credentials.
 
 - 
setAlgorithmpublic void setAlgorithm(java.lang.String algorithm) throws java.security.NoSuchAlgorithmExceptionDescription copied from class:DigestCredentialHandlerBaseSet the algorithm used to convert input credentials to stored credentials.- Specified by:
- setAlgorithmin class- DigestCredentialHandlerBase
- Parameters:
- algorithm- the algorithm
- Throws:
- java.security.NoSuchAlgorithmException- if the specified algorithm is not supported
 
 - 
getKeyLengthpublic int getKeyLength() 
 - 
setKeyLengthpublic void setKeyLength(int keyLength) 
 - 
matchespublic boolean matches(java.lang.String inputCredentials, java.lang.String storedCredentials)Description copied from interface:CredentialHandlerChecks to see if the input credentials match the stored credentials- Parameters:
- inputCredentials- User provided credentials
- storedCredentials- Credentials stored in the- Realm
- Returns:
- trueif the inputCredentials match the storedCredentials, otherwise- false
 
 - 
mutateprotected java.lang.String mutate(java.lang.String inputCredentials, byte[] salt, int iterations)Description copied from class:DigestCredentialHandlerBaseGenerates the equivalent stored credentials for the given input credentials, salt and iterations. If the algorithm requires a key length, the default will be used.- Specified by:
- mutatein class- DigestCredentialHandlerBase
- Parameters:
- inputCredentials- User provided credentials
- salt- Salt, if any
- iterations- Number of iterations of the algorithm associated with this CredentialHandler applied to the inputCredentials to generate the equivalent stored credentials
- Returns:
- The equivalent stored credentials for the given input
          credentials or nullif the generation fails
 
 - 
mutateprotected java.lang.String mutate(java.lang.String inputCredentials, byte[] salt, int iterations, int keyLength)Description copied from class:DigestCredentialHandlerBaseGenerates the equivalent stored credentials for the given input credentials, salt, iterations and key length. The default implementation calls ignores the key length and callsDigestCredentialHandlerBase.mutate(String, byte[], int). Sub-classes that use the key length should override this method.- Overrides:
- mutatein class- DigestCredentialHandlerBase
- Parameters:
- inputCredentials- User provided credentials
- salt- Salt, if any
- iterations- Number of iterations of the algorithm associated with this CredentialHandler applied to the inputCredentials to generate the equivalent stored credentials
- keyLength- Length of the produced digest in bits for implementations where it's applicable
- Returns:
- The equivalent stored credentials for the given input
          credentials or nullif the generation fails
 
 - 
getDefaultIterationsprotected int getDefaultIterations() - Specified by:
- getDefaultIterationsin class- DigestCredentialHandlerBase
- Returns:
- the default number of iterations used by the
 CredentialHandler.
 
 - 
getLogprotected Log getLog() - Specified by:
- getLogin class- DigestCredentialHandlerBase
- Returns:
- the logger for the CredentialHandler instance.
 
 
- 
 
-