public class DigestAuthenticator extends AuthenticatorBase
Modifier and Type | Field and Description |
---|---|
protected int |
cnonceCacheSize
Maximum number of client nonces to keep in the cache.
|
protected java.util.Map<java.lang.String,org.apache.catalina.authenticator.DigestAuthenticator.NonceInfo> |
cnonces
List of client nonce values currently being tracked
|
protected static java.lang.String |
info
Descriptive information about this implementation.
|
protected java.lang.String |
key
Private key.
|
protected static MD5Encoder |
md5Encoder
The MD5 helper object for this class.
|
protected static java.security.MessageDigest |
md5Helper
MD5 message digest provider.
|
protected long |
nonceValidity
How long server nonces are valid for in milliseconds.
|
protected java.lang.String |
opaque
Opaque string.
|
protected static java.lang.String |
QOP
Tomcat's DIGEST implementation only supports auth quality of protection.
|
protected boolean |
validateUri
Should the URI be validated as required by RFC2617?
|
alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, disableProxyCaching, REALM_NAME, securePagesWithPragma, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, sessionIdGenerator, sm, sso
asyncSupported, container, containerLog, next
mserver
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
Constructor and Description |
---|
DigestAuthenticator() |
Modifier and Type | Method and Description |
---|---|
boolean |
authenticate(Request request,
HttpServletResponse response,
LoginConfig config)
Authenticate the user making this request, based on the specified
login configuration.
|
protected java.lang.String |
generateNonce(Request request)
Generate a unique token.
|
protected java.lang.String |
getAuthMethod() |
int |
getCnonceCacheSize() |
java.lang.String |
getInfo()
Return descriptive information about this Valve implementation.
|
java.lang.String |
getKey() |
long |
getNonceValidity() |
java.lang.String |
getOpaque() |
boolean |
isValidateUri() |
protected java.lang.String |
parseUsername(java.lang.String authorization)
Parse the username from the specified authorization string.
|
protected static java.lang.String |
removeQuotes(java.lang.String quotedString)
Removes the quotes on a string.
|
protected static java.lang.String |
removeQuotes(java.lang.String quotedString,
boolean quotesRequired)
Removes the quotes on a string.
|
protected void |
setAuthenticateHeader(HttpServletRequest request,
HttpServletResponse response,
LoginConfig config,
java.lang.String nonce,
boolean isNonceStale)
Generates the WWW-Authenticate header.
|
void |
setCnonceCacheSize(int cnonceCacheSize) |
void |
setKey(java.lang.String key) |
void |
setNonceValidity(long nonceValidity) |
void |
setOpaque(java.lang.String opaque) |
void |
setValidateUri(boolean validateUri) |
protected void |
startInternal()
Start this component and implement the requirements
of
LifecycleBase.startInternal() . |
associate, authenticate, doLogin, getAlwaysUseSession, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, invoke, login, logout, reauthenticateFromSSO, register, setAlwaysUseSession, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider, stopInternal
backgroundProcess, event, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setNext, toString
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop
protected static final MD5Encoder md5Encoder
protected static final java.lang.String info
protected static final java.lang.String QOP
protected static volatile java.security.MessageDigest md5Helper
protected java.util.Map<java.lang.String,org.apache.catalina.authenticator.DigestAuthenticator.NonceInfo> cnonces
protected int cnonceCacheSize
protected java.lang.String key
protected long nonceValidity
protected java.lang.String opaque
protected boolean validateUri
public java.lang.String getInfo()
getInfo
in interface Valve
getInfo
in class AuthenticatorBase
public int getCnonceCacheSize()
public void setCnonceCacheSize(int cnonceCacheSize)
public java.lang.String getKey()
public void setKey(java.lang.String key)
public long getNonceValidity()
public void setNonceValidity(long nonceValidity)
public java.lang.String getOpaque()
public void setOpaque(java.lang.String opaque)
public boolean isValidateUri()
public void setValidateUri(boolean validateUri)
public boolean authenticate(Request request, HttpServletResponse response, LoginConfig config) throws java.io.IOException
true
if any specified
constraint has been satisfied, or false
if we have
created a response challenge already.authenticate
in interface Authenticator
authenticate
in class AuthenticatorBase
request
- Request we are processingresponse
- Response we are creatingconfig
- Login configuration describing how authentication
should be performedjava.io.IOException
- if an input/output error occursprotected java.lang.String getAuthMethod()
getAuthMethod
in class AuthenticatorBase
protected java.lang.String parseUsername(java.lang.String authorization)
null
authorization
- Authorization string to be parsedprotected static java.lang.String removeQuotes(java.lang.String quotedString, boolean quotesRequired)
protected static java.lang.String removeQuotes(java.lang.String quotedString)
protected java.lang.String generateNonce(Request request)
request
- HTTP Servlet requestprotected void setAuthenticateHeader(HttpServletRequest request, HttpServletResponse response, LoginConfig config, java.lang.String nonce, boolean isNonceStale)
The header MUST follow this template :
WWW-Authenticate = "WWW-Authenticate" ":" "Digest" digest-challenge digest-challenge = 1#( realm | [ domain ] | nonce | [ digest-opaque ] |[ stale ] | [ algorithm ] ) realm = "realm" "=" realm-value realm-value = quoted-string domain = "domain" "=" <"> 1#URI <"> nonce = "nonce" "=" nonce-value nonce-value = quoted-string opaque = "opaque" "=" quoted-string stale = "stale" "=" ( "true" | "false" ) algorithm = "algorithm" "=" ( "MD5" | token )
request
- HTTP Servlet requestresponse
- HTTP Servlet responseconfig
- Login configuration describing how authentication
should be performednonce
- nonce tokenprotected void startInternal() throws LifecycleException
AuthenticatorBase
LifecycleBase.startInternal()
.startInternal
in class AuthenticatorBase
LifecycleException
- if this component detects a fatal error
that prevents this component from being usedCopyright © 2000-2012 Apache Software Foundation. All Rights Reserved.