Modifier and Type	Class and Description
private static class	DigestAuthenticationMechanism.DigestContext
private class	DigestAuthenticationMechanism.DigestCredentialImpl
public static class	DigestAuthenticationMechanism.Factory

Field Summary

Modifier and Type	Field and Description
private static final byte	COLON
private static final String	DEFAULT_NAME
private static final String	DIGEST_PREFIX
private final String	domain
public static final AuthenticationMechanismFactory	FACTORY
private final IdentityManager	identityManager
private static final Set<DigestAuthorizationToken>	MANDATORY_REQUEST_TOKENS
private final String	mechanismName
private final NonceManager	nonceManager
private static final String	OPAQUE_VALUE
private static final int	PREFIX_LENGTH
private final String	qopString
private final String	realmName
private final List<DigestAlgorithm>	supportedAlgorithms The `List` of supported algorithms, this is assumed to be in priority order.
private final List<DigestQop>	supportedQops

Constructor Summary

Access	Constructor and Description
public	DigestAuthenticationMechanism(final List<DigestAlgorithm> supportedAlgorithms, final List<DigestQop> supportedQops, final String realmName, final String domain, final NonceManager nonceManager)
public	DigestAuthenticationMechanism(final List<DigestAlgorithm> supportedAlgorithms, final List<DigestQop> supportedQops, final String realmName, final String domain, final NonceManager nonceManager, final String mechanismName)
public	DigestAuthenticationMechanism(final List<DigestAlgorithm> supportedAlgorithms, final List<DigestQop> supportedQops, final String realmName, final String domain, final NonceManager nonceManager, final String mechanismName, final IdentityManager identityManager)
public	DigestAuthenticationMechanism(final String realmName, final String domain, final String mechanismName)
public	DigestAuthenticationMechanism(final String realmName, final String domain, final String mechanismName, final IdentityManager identityManager)

Method Summary

Modifier and Type	Method and Description
public AuthenticationMechanism.AuthenticationMechanismOutcome	authenticate(final HttpServerExchange The exchange exchange, final SecurityContext securityContext) Implements io.undertow.security.api.AuthenticationMechanism.authenticate. Perform authentication of the request.
private byte[]	createHA2Auth(final DigestAuthenticationMechanism.DigestContext context, Map<DigestAuthorizationToken, String> parsedHeader)
private byte[]	createHA2Auth(final DigestAuthenticationMechanism.DigestContext context)
private byte[]	createHA2AuthInt()
private byte[]	createRFC2069RequestDigest(final byte[] ha1, final byte[] ha2, final DigestAuthenticationMechanism.DigestContext context)
private byte[]	createRFC2617RequestDigest(final byte[] ha1, final byte[] ha2, final DigestAuthenticationMechanism.DigestContext context)
private IdentityManager	getIdentityManager(SecurityContext securityContext)
private AuthenticationMechanism.AuthenticationMechanismOutcome	handleDigestHeader(HttpServerExchange exchange, final SecurityContext securityContext)
public void	sendAuthenticationInfoHeader(final HttpServerExchange exchange)
public AuthenticationMechanism.ChallengeResult	sendChallenge(final HttpServerExchange The exchange exchange, final SecurityContext The security context securityContext) Implements io.undertow.security.api.AuthenticationMechanism.sendChallenge. Send an authentication challenge to the remote client.
private boolean	validateNonceUse(DigestAuthenticationMechanism.DigestContext context, Map<DigestAuthorizationToken, String> parsedHeader, final HttpServerExchange exchange)
private boolean	validateRequest(final DigestAuthenticationMechanism.DigestContext context, final byte[] ha1)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

COLON	back to summary
private static final byte COLON

DEFAULT_NAME	back to summary
private static final String DEFAULT_NAME

DIGEST_PREFIX	back to summary
private static final String DIGEST_PREFIX

domain	back to summary
private final String domain

FACTORY	back to summary
public static final AuthenticationMechanismFactory FACTORY

identityManager	back to summary
private final IdentityManager identityManager

MANDATORY_REQUEST_TOKENS	back to summary
private static final Set<DigestAuthorizationToken> MANDATORY_REQUEST_TOKENS

mechanismName	back to summary
private final String mechanismName

nonceManager	back to summary
private final NonceManager nonceManager

OPAQUE_VALUE	back to summary
private static final String OPAQUE_VALUE

PREFIX_LENGTH	back to summary
private static final int PREFIX_LENGTH

qopString	back to summary
private final String qopString

realmName	back to summary
private final String realmName

supportedAlgorithms	back to summary
private final List<DigestAlgorithm> supportedAlgorithms The `List` of supported algorithms, this is assumed to be in priority order.

supportedQops	back to summary
private final List<DigestQop> supportedQops

Constructor Detail

DigestAuthenticationMechanism	back to summary
public DigestAuthenticationMechanism(final List<DigestAlgorithm> supportedAlgorithms, final List<DigestQop> supportedQops, final String realmName, final String domain, final NonceManager nonceManager)

DigestAuthenticationMechanism	back to summary
public DigestAuthenticationMechanism(final List<DigestAlgorithm> supportedAlgorithms, final List<DigestQop> supportedQops, final String realmName, final String domain, final NonceManager nonceManager, final String mechanismName)

DigestAuthenticationMechanism	back to summary
public DigestAuthenticationMechanism(final List<DigestAlgorithm> supportedAlgorithms, final List<DigestQop> supportedQops, final String realmName, final String domain, final NonceManager nonceManager, final String mechanismName, final IdentityManager identityManager)

DigestAuthenticationMechanism	back to summary
public DigestAuthenticationMechanism(final String realmName, final String domain, final String mechanismName)

DigestAuthenticationMechanism	back to summary
public DigestAuthenticationMechanism(final String realmName, final String domain, final String mechanismName, final IdentityManager identityManager)

Method Detail

authenticate	back to summary
public AuthenticationMechanism.AuthenticationMechanismOutcome authenticate(final HttpServerExchange exchange, final SecurityContext securityContext) Implements io.undertow.security.api.AuthenticationMechanism.authenticate. Doc from io.undertow.security.api.AuthenticationMechanism.authenticate. Perform authentication of the request. Any potentially blocking work should be performed in the handoff executor provided Parameters exchange:HttpServerExchange The exchange

authenticate

back to summary

public AuthenticationMechanism.AuthenticationMechanismOutcome authenticate(final HttpServerExchange exchange, final SecurityContext securityContext)

Implements io.undertow.security.api.AuthenticationMechanism.authenticate.

Doc from io.undertow.security.api.AuthenticationMechanism.authenticate.

Perform authentication of the request. Any potentially blocking work should be performed in the handoff executor provided

Parameters

exchange:HttpServerExchange: The exchange

createHA2Auth	back to summary
private byte[] createHA2Auth(final DigestAuthenticationMechanism.DigestContext context, Map<DigestAuthorizationToken, String> parsedHeader)

createHA2Auth	back to summary
private byte[] createHA2Auth(final DigestAuthenticationMechanism.DigestContext context)

createHA2AuthInt	back to summary
private byte[] createHA2AuthInt()

createRFC2069RequestDigest	back to summary
private byte[] createRFC2069RequestDigest(final byte[] ha1, final byte[] ha2, final DigestAuthenticationMechanism.DigestContext context)

createRFC2617RequestDigest	back to summary
private byte[] createRFC2617RequestDigest(final byte[] ha1, final byte[] ha2, final DigestAuthenticationMechanism.DigestContext context)

getIdentityManager	back to summary
private IdentityManager getIdentityManager(SecurityContext securityContext) Annotations @SuppressWarnings:deprecation

handleDigestHeader	back to summary
private AuthenticationMechanism.AuthenticationMechanismOutcome handleDigestHeader(HttpServerExchange exchange, final SecurityContext securityContext)

sendAuthenticationInfoHeader	back to summary
public void sendAuthenticationInfoHeader(final HttpServerExchange exchange)

sendChallenge back to summary

sendChallenge	back to summary
public AuthenticationMechanism.ChallengeResult sendChallenge(final HttpServerExchange exchange, final SecurityContext securityContext) Implements io.undertow.security.api.AuthenticationMechanism.sendChallenge. Doc from io.undertow.security.api.AuthenticationMechanism.sendChallenge. Send an authentication challenge to the remote client. The individual mechanisms should update the response headers and body of the message as appropriate however they should not set the response code, instead that should be indicated in the `ChallengeResult` and the most appropriate overall response code will be selected. This method should not return `null`. Parameters exchange:HttpServerExchange The exchange securityContext:SecurityContext The security context Returns:AuthenticationMechanism.ChallengeResult A `ChallengeResult` indicating if a challenge was sent and the desired response code. Annotations @Override

public AuthenticationMechanism.ChallengeResult sendChallenge(final HttpServerExchange exchange, final SecurityContext securityContext)

Implements io.undertow.security.api.AuthenticationMechanism.sendChallenge.

Doc from io.undertow.security.api.AuthenticationMechanism.sendChallenge.

Send an authentication challenge to the remote client.

The individual mechanisms should update the response headers and body of the message as appropriate however they should not set the response code, instead that should be indicated in the ChallengeResult and the most appropriate overall response code will be selected. This method should not return null.

Parameters

exchange:HttpServerExchange: The exchange
securityContext:SecurityContext: The security context

Returns:AuthenticationMechanism.ChallengeResult

A ChallengeResult indicating if a challenge was sent and the desired response code.

Annotations

@Override

validateNonceUse	back to summary
private boolean validateNonceUse(DigestAuthenticationMechanism.DigestContext context, Map<DigestAuthorizationToken, String> parsedHeader, final HttpServerExchange exchange)

validateRequest	back to summary
private boolean validateRequest(final DigestAuthenticationMechanism.DigestContext context, final byte[] ha1)

io.undertow.security.impl back to summary

private Class DigestAuthenticationMechanism.DigestContext

Class Inheritance

extends Object

java.lang.Object
io.undertow.security.impl.DigestAuthenticationMechanism.DigestContext

Field Summary

Modifier and Type	Field and Description
private DigestAlgorithm	algorithm
pack-priv static final AttachmentKey<DigestAuthenticationMechanism.DigestContext>	ATTACHMENT_KEY
private MessageDigest	digest
private byte[]	ha1
private String	method
private String	nonce
pack-priv Map<DigestAuthorizationToken, String>	parsedHeader
private DigestQop	qop
private boolean	stale

Constructor Summary

Access	Constructor and Description
private	DigestContext()

Method Summary

Modifier and Type	Method and Description
pack-priv DigestAlgorithm	getAlgorithm()
pack-priv MessageDigest	getDigest()
pack-priv byte[]	getHa1()
pack-priv String	getMethod()
pack-priv String	getNonce()
pack-priv Map<DigestAuthorizationToken, String>	getParsedHeader()
pack-priv DigestQop	getQop()
pack-priv boolean	isStale()
pack-priv void	markStale()
pack-priv void	setAlgorithm(DigestAlgorithm algorithm)
pack-priv void	setHa1(byte[] ha1)
pack-priv void	setMethod(String method)
pack-priv void	setNonce(String nonce)
pack-priv void	setParsedHeader(Map<DigestAuthorizationToken, String> parsedHeader)
pack-priv void	setQop(DigestQop qop)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algorithm	back to summary
private DigestAlgorithm algorithm

ATTACHMENT_KEY	back to summary
pack-priv static final AttachmentKey<DigestAuthenticationMechanism.DigestContext> ATTACHMENT_KEY

digest	back to summary
private MessageDigest digest

ha1	back to summary
private byte[] ha1

method	back to summary
private String method

nonce	back to summary
private String nonce

parsedHeader	back to summary
pack-priv Map<DigestAuthorizationToken, String> parsedHeader

qop	back to summary
private DigestQop qop

stale	back to summary
private boolean stale

Constructor Detail

DigestContext	back to summary
private DigestContext()

Method Detail

getAlgorithm	back to summary
pack-priv DigestAlgorithm getAlgorithm()

getDigest	back to summary
pack-priv MessageDigest getDigest()

getHa1	back to summary
pack-priv byte[] getHa1()

getMethod	back to summary
pack-priv String getMethod()

getNonce	back to summary
pack-priv String getNonce()

getParsedHeader	back to summary
pack-priv Map<DigestAuthorizationToken, String> getParsedHeader()

getQop	back to summary
pack-priv DigestQop getQop()

isStale	back to summary
pack-priv boolean isStale()

markStale	back to summary
pack-priv void markStale()

setAlgorithm	back to summary
pack-priv void setAlgorithm(DigestAlgorithm algorithm) throws NoSuchAlgorithmException

setHa1	back to summary
pack-priv void setHa1(byte[] ha1)

setMethod	back to summary
pack-priv void setMethod(String method)

setNonce	back to summary
pack-priv void setNonce(String nonce)

setParsedHeader	back to summary
pack-priv void setParsedHeader(Map<DigestAuthorizationToken, String> parsedHeader)

setQop	back to summary
pack-priv void setQop(DigestQop qop)

io.undertow.security.impl back to summary

private Class DigestAuthenticationMechanism.DigestCredentialImpl

Class Inheritance

extends Object
implements DigestCredential

java.lang.Object
io.undertow.security.impl.DigestAuthenticationMechanism.DigestCredentialImpl

All Implemented Interfaces

io.undertow.security.idm.DigestCredential, io.undertow.security.idm.Credential

Field Summary

Modifier and Type	Field and Description
private final DigestAuthenticationMechanism.DigestContext	context

Constructor Summary

Access	Constructor and Description
private	DigestCredentialImpl(final DigestAuthenticationMechanism.DigestContext digestContext)

Method Summary

Modifier and Type	Method and Description
public DigestAlgorithm	getAlgorithm() Implements io.undertow.security.idm.DigestCredential.getAlgorithm. Obtain the selected `DigestAlgorithm` for the request being authenticated.
public String	getRealm() Implements io.undertow.security.idm.DigestCredential.getRealm. Get the realm name the credential is being validated against.
public byte[]	getSessionData() Implements io.undertow.security.idm.DigestCredential.getSessionData. If the algorithm is session based return the session data to be included when generating the ha1.
public boolean	verifyHA1(byte[] - The hex encoded a1 value. ha1) Implements io.undertow.security.idm.DigestCredential.verifyHA1. Called by the `IdentityManager` implementation to pass in the hex encoded a1 representation for validation against the current request.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

context	back to summary
private final DigestAuthenticationMechanism.DigestContext context

Constructor Detail

DigestCredentialImpl	back to summary
private DigestCredentialImpl(final DigestAuthenticationMechanism.DigestContext digestContext)

Method Detail

getAlgorithm back to summary

public DigestAlgorithm getAlgorithm()

Implements io.undertow.security.idm.DigestCredential.getAlgorithm.

Doc from io.undertow.security.idm.DigestCredential.getAlgorithm.

Obtain the selected DigestAlgorithm for the request being authenticated.

Returns:DigestAlgorithm

The DigestAlgorithm for the request being authenticated.

Annotations

@Override

getRealm

back to summary

public String getRealm()

Implements io.undertow.security.idm.DigestCredential.getRealm.

Doc from io.undertow.security.idm.DigestCredential.getRealm.

Get the realm name the credential is being validated against.

Returns:String

The realm name.

Annotations

@Override

getSessionData

back to summary

public byte[] getSessionData()

Implements io.undertow.security.idm.DigestCredential.getSessionData.

Doc from io.undertow.security.idm.DigestCredential.getSessionData.

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

Returns:byte[]

The session data.

Annotations

@Override

verifyHA1 back to summary

public boolean verifyHA1(byte[] ha1)

Implements io.undertow.security.idm.DigestCredential.verifyHA1.

Doc from io.undertow.security.idm.DigestCredential.verifyHA1.

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.

Annotations

@Override

io.undertow.security.impl back to summary

public final Class DigestAuthenticationMechanism.Factory

Class Inheritance

extends Object
implements AuthenticationMechanismFactory

java.lang.Object
io.undertow.security.impl.DigestAuthenticationMechanism.Factory

All Implemented Interfaces

io.undertow.security.api.AuthenticationMechanismFactory

Constructor Summary

Access	Constructor and Description
public	Factory(IdentityManager identityManager) Deprecated
public	Factory()

Method Summary

Modifier and Type

Method and Description

public AuthenticationMechanism

create(String

The name under which this factory was registered

mechanismName, IdentityManager

the IdentityManager instance asscociated with the deployment

identityManager, FormParserFactory

Parser to create a form data parser for a given request.

formParserFactory, Map<String, String>

The properties

properties)

Overrides default io.undertow.security.api.AuthenticationMechanismFactory.create.

Creates an authentication mechanism that needs access to the deployment IdentityManager and specified properties

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Factory	back to summary
public Factory(IdentityManager identityManager) Deprecated Annotations @Deprecated

Factory	back to summary
public Factory()

Method Detail

create

back to summary

public AuthenticationMechanism create(String mechanismName, IdentityManager identityManager, FormParserFactory formParserFactory, Map<String, String> properties)

Overrides default io.undertow.security.api.AuthenticationMechanismFactory.create.

Doc from io.undertow.security.api.AuthenticationMechanismFactory.create.

Creates an authentication mechanism that needs access to the deployment IdentityManager and specified properties

Parameters

mechanismName:String: The name under which this factory was registered
identityManager:IdentityManager: the IdentityManager instance asscociated with the deployment
formParserFactory:FormParserFactory: Parser to create a form data parser for a given request.
properties:Map<String, String>: The properties

Returns:AuthenticationMechanism

The mechanism

Annotations

@Override

public Class DigestAuthenticationMechanism

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DigestAuthenticationMechanism.DigestContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DigestAuthenticationMechanism.DigestCredentialImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class DigestAuthenticationMechanism.Factory

Constructor Summary

Method Summary

Constructor Detail

Method Detail