Class SecretKeyCredentialHandler

java.lang.Object

org.apache.catalina.realm.DigestCredentialHandlerBase

org.apache.catalina.realm.SecretKeyCredentialHandler

All Implemented Interfaces:

CredentialHandler

public class SecretKeyCredentialHandler
extends DigestCredentialHandlerBase

A credential handler that uses a SecretKeyFactory (PBE) to hash credentials.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ALGORITHM	The default algorithm used for key derivation.
static final int	DEFAULT_ITERATIONS	The default number of iterations for key derivation.
static final int	DEFAULT_KEY_LENGTH	The default derived key length in bits.

Fields inherited from class DigestCredentialHandlerBase

DEFAULT_SALT_LENGTH, sm

Constructor Summary

Constructors

Constructor	Description
SecretKeyCredentialHandler()	Create a handler with the default algorithm.

Method Summary

Modifier and Type	Method	Description
String	getAlgorithm()	Get the algorithm used to convert input credentials to stored credentials.
protected int	getDefaultIterations()	Get the default number of iterations used by the CredentialHandler.
int	getKeyLength()	Returns the key length.
protected Log	getLog()	Get the logger for the CredentialHandler instance.
boolean	matches(String inputCredentials, String storedCredentials)	Checks to see if the input credentials match the stored credentials
protected String	mutate(String inputCredentials, byte[] salt, int iterations)	Generates the equivalent stored credentials for the given input credentials, salt and iterations.
protected String	mutate(String inputCredentials, byte[] salt, int iterations, int keyLength)	Generates the equivalent stored credentials for the given input credentials, salt, iterations and key length.
void	setAlgorithm(String algorithm)	Set the algorithm used to convert input credentials to stored credentials.
void	setKeyLength(int keyLength)	Sets the key length.

Methods inherited from class DigestCredentialHandlerBase

equals, equals, getDefaultSaltLength, getIterations, getLogInvalidStoredCredentials, getSaltLength, matchesSaltIterationsEncoded, mutate, setIterations, setLogInvalidStoredCredentials, setSaltLength

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_ALGORITHM

public static final String DEFAULT_ALGORITHM

The default algorithm used for key derivation.

See Also:

• Constant Field Values

DEFAULT_KEY_LENGTH

public static final int DEFAULT_KEY_LENGTH

The default derived key length in bits.

See Also:

• Constant Field Values

DEFAULT_ITERATIONS

public static final int DEFAULT_ITERATIONS

The default number of iterations for key derivation.

See Also:

• Constant Field Values

Constructor Details

SecretKeyCredentialHandler

public SecretKeyCredentialHandler()
                           throws NoSuchAlgorithmException

Create a handler with the default algorithm.

Throws:

NoSuchAlgorithmException - if the default algorithm is not available

Method Details

getAlgorithm

public String getAlgorithm()

Description copied from class: DigestCredentialHandlerBase

Get the algorithm used to convert input credentials to stored credentials.

Specified by:

getAlgorithm in class DigestCredentialHandlerBase

Returns:

the algorithm used to convert input credentials to stored credentials.

setAlgorithm

public void setAlgorithm(String algorithm)
                  throws NoSuchAlgorithmException

Description copied from class: DigestCredentialHandlerBase

Set the algorithm used to convert input credentials to stored credentials.

Specified by:

setAlgorithm in class DigestCredentialHandlerBase

Parameters:

algorithm - the algorithm

Throws:

NoSuchAlgorithmException - if the specified algorithm is not supported

getKeyLength

public int getKeyLength()

Returns the key length.

Returns:

the key length

setKeyLength

public void setKeyLength(int keyLength)

Sets the key length.

Parameters:

keyLength - the key length

matches

public boolean matches(String inputCredentials,
 String storedCredentials)

Description copied from interface: CredentialHandler

Checks to see if the input credentials match the stored credentials

Parameters:

inputCredentials - User provided credentials

storedCredentials - Credentials stored in the Realm

Returns:

true if the inputCredentials match the storedCredentials, otherwise false

mutate

protected String mutate(String inputCredentials,
 byte[] salt,
 int iterations)

Description copied from class: DigestCredentialHandlerBase

Generates 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:

mutate in 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 null if the generation fails

mutate

protected String mutate(String inputCredentials,
 byte[] salt,
 int iterations,
 int keyLength)

Description copied from class: DigestCredentialHandlerBase

Generates the equivalent stored credentials for the given input credentials, salt, iterations and key length. The default implementation calls ignores the key length and calls DigestCredentialHandlerBase.mutate(String, byte[], int). Subclasses that use the key length should override this method.

Overrides:

mutate in 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 null if the generation fails

getDefaultIterations

protected int getDefaultIterations()

Description copied from class: DigestCredentialHandlerBase

Get the default number of iterations used by the CredentialHandler.

Specified by:

getDefaultIterations in class DigestCredentialHandlerBase

Returns:

the default number of iterations used by the CredentialHandler.

getLog

protected Log getLog()

Description copied from class: DigestCredentialHandlerBase

Get the logger for the CredentialHandler instance.

Specified by:

getLog in class DigestCredentialHandlerBase

Returns:

the logger for the CredentialHandler instance.