Top Description Methods
io.undertow.security.idm

public Interface DigestCredential

extends Credential
Known Direct Implementers
io.undertow.security.impl.DigestAuthenticationMechanism.DigestCredentialImpl
An extension of Credential to provide some additional methods needed to enable verification of a request where io.undertow.security.impl.DigestAuthenticationMechanism is in use.
Author
Darran Lofthouse

Method Summary

Modifier and TypeMethod and Description
public DigestAlgorithm

Returns:

The DigestAlgorithm for the request being authenticated.
getAlgorithm()

Obtain the selected DigestAlgorithm for the request being authenticated.

public String

Returns:

The realm name.
getRealm()

Get the realm name the credential is being validated against.

public byte[]

Returns:

The session data.
getSessionData()

If the algorithm is session based return the session data to be included when generating the ha1.

public boolean

Returns:

true if verification was successful, false otherwise.
verifyHA1(final byte[]
- The hex encoded a1 value.
ha1)

Called by the IdentityManager implementation to pass in the hex encoded a1 representation for validation against the current request.

Method Detail

getAlgorithmback to summary
public DigestAlgorithm getAlgorithm()

Obtain the selected DigestAlgorithm for the request being authenticated.

Returns:DigestAlgorithm

The DigestAlgorithm for the request being authenticated.

getRealmback to summary
public String getRealm()

Get the realm name the credential is being validated against.

Returns:String

The realm name.

getSessionDataback to summary
public byte[] getSessionData()

If the algorithm is session based return the session data to be included when generating the ha1.

Returns:byte[]

The session data.

Exceptions
IllegalStateException:
where the algorithm is not session based.
verifyHA1back to summary
public boolean verifyHA1(final byte[] ha1)

Called by the IdentityManager implementation to pass in the hex encoded a1 representation for validation against the current request. The Credential is self validating based on the information passed in here, if verification is successful then the IdentityManager can return the appropriate Account representation.

Parameters
ha1:byte[]

- The hex encoded a1 value.

Returns:boolean

true if verification was successful, false otherwise.