Package org.nuxeo.ecm.ui.web.auth.digest

Class DigestAuthenticator

java.lang.Object

org.nuxeo.ecm.ui.web.auth.digest.DigestAuthenticator

All Implemented Interfaces:

NuxeoAuthenticationPlugin

public class DigestAuthenticator
extends Object
implements NuxeoAuthenticationPlugin

Nuxeo Authenticator for HTTP Digest Access Authentication (RFC 2617).

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accessKey
protected static final String	BA_HEADER_NAME
protected static final String	CNONCE
protected static final long	DEFAULT_NONCE_VALIDITY_SECONDS
protected static final String	DEFAULT_REALMNAME
protected static final String	HTTP_METHOD
protected static final String	NC
protected static final String	NONCE
protected long	nonceValiditySeconds
protected static final String	QOP
protected static final String	REALM
protected static final String	REALM_NAME_KEY
protected String	realmName
protected static final String	URI

Constructor Summary

Constructors

Constructor	Description
DigestAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected static String	computeDigest(String ha1, String httpMethod, String uri, String qop, String nonce, String nc, String cnonce)
protected String	getStoredHA1(String username)
List<String>	getUnAuthenticatedURLPrefix()	Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.
protected String	getValidatedUsername(Map<String,String> headerMap)
Boolean	handleLoginPrompt(jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse, String baseURL)	Handles the Login Prompt.
UserIdentificationInfo	handleRetrieveIdentity(jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse)	Retrieves user identification information from the request.
void	initPlugin(Map<String,String> parameters)	Initializes the Plugin from parameters set in the XML descriptor.
Boolean	needLoginPrompt(jakarta.servlet.http.HttpServletRequest httpRequest)	Defines if the authentication plugin needs to do a login prompt.
static Map<String,String>	splitParameters(String auth)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_REALMNAME

protected static final String DEFAULT_REALMNAME

See Also:

• Constant Field Values

DEFAULT_NONCE_VALIDITY_SECONDS

protected static final long DEFAULT_NONCE_VALIDITY_SECONDS

See Also:

• Constant Field Values

REALM

protected static final String REALM

See Also:

• Constant Field Values

HTTP_METHOD

protected static final String HTTP_METHOD

See Also:

• Constant Field Values

URI

protected static final String URI

See Also:

• Constant Field Values

QOP

protected static final String QOP

See Also:

• Constant Field Values

NONCE

protected static final String NONCE

See Also:

• Constant Field Values

NC

protected static final String NC

See Also:

• Constant Field Values

CNONCE

protected static final String CNONCE

See Also:

• Constant Field Values

REALM_NAME_KEY

protected static final String REALM_NAME_KEY

See Also:

• Constant Field Values

BA_HEADER_NAME

protected static final String BA_HEADER_NAME

See Also:

• Constant Field Values

realmName

protected String realmName

nonceValiditySeconds

protected long nonceValiditySeconds

accessKey

protected String accessKey

Constructor Details

DigestAuthenticator

public DigestAuthenticator()

Method Details

handleLoginPrompt

public Boolean handleLoginPrompt(jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.http.HttpServletResponse httpResponse,
 String baseURL)

Description copied from interface: NuxeoAuthenticationPlugin

Handles the Login Prompt.

Specified by:

handleLoginPrompt in interface NuxeoAuthenticationPlugin

Parameters:

httpRequest - the request

httpResponse - the response

Returns:

true if AuthFilter must stop execution (ie: login prompt generated a redirect), false otherwise

handleRetrieveIdentity

public UserIdentificationInfo handleRetrieveIdentity(jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.http.HttpServletResponse httpResponse)

Description copied from interface: NuxeoAuthenticationPlugin

Retrieves user identification information from the request.

Specified by:

handleRetrieveIdentity in interface NuxeoAuthenticationPlugin

Parameters:

httpRequest - the request

httpResponse - the response

needLoginPrompt

public Boolean needLoginPrompt(jakarta.servlet.http.HttpServletRequest httpRequest)

Description copied from interface: NuxeoAuthenticationPlugin

Defines if the authentication plugin needs to do a login prompt.

Specified by:

needLoginPrompt in interface NuxeoAuthenticationPlugin

Returns:

true if LoginPrompt is used

initPlugin

public void initPlugin(Map<String,String> parameters)

Description copied from interface: NuxeoAuthenticationPlugin

Initializes the Plugin from parameters set in the XML descriptor.

Specified by:

initPlugin in interface NuxeoAuthenticationPlugin

getUnAuthenticatedURLPrefix

public List<String> getUnAuthenticatedURLPrefix()

Description copied from interface: NuxeoAuthenticationPlugin

Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.

Specified by:

getUnAuthenticatedURLPrefix in interface NuxeoAuthenticationPlugin

splitParameters

public static Map<String,String> splitParameters(String auth)

getValidatedUsername

protected String getValidatedUsername(Map<String,String> headerMap)

computeDigest

protected static String computeDigest(String ha1,
 String httpMethod,
 String uri,
 String qop,
 String nonce,
 String nc,
 String cnonce)
                               throws IllegalArgumentException

Throws:

IllegalArgumentException

getStoredHA1

protected String getStoredHA1(String username)