Class AuthenticatorBase
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
org.apache.catalina.valves.ValveBase
org.apache.catalina.authenticator.AuthenticatorBase
- All Implemented Interfaces:
MBeanRegistration,RegistrationListener,Authenticator,Contained,JmxEnabled,Lifecycle,Valve
- Direct Known Subclasses:
BasicAuthenticator,DigestAuthenticator,FormAuthenticator,NonLoginAuthenticator,SpnegoAuthenticator,SSLAuthenticator
public abstract class AuthenticatorBase
extends ValveBase
implements Authenticator, RegistrationListener
Basic implementation of the Valve interface that enforces the
<security-constraint>
elements in the web application deployment descriptor. This functionality is implemented as a Valve so that it can be
omitted in environments that do not require these features. Individual implementations of each supported
authentication method can subclass this base class as required.
USAGE CONSTRAINT: When this class is utilized, the Context to which it is attached (or a parent Container in a hierarchy) must have an associated Realm that can be used for authenticating users and enumerating the roles to which they have been assigned.
USAGE CONSTRAINT: This Valve is only useful when processing HTTP requests. Requests of any other type will simply be passed through.
- Author:
- Craig R. McClanahan
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanShould a session always be used once a user is authenticated?protected static final StringAuthentication headerprotected booleanShould we cache authenticated Principals if the request is part of an HTTP session?protected booleanShould the session ID, if any, be changed upon a successful authentication to prevent a session fixation attack?protected ContextThe Context to which this Valve is attached.protected booleanFlag to determine if we disable proxy caching, or leave the issue up to the webapp developer.protected StringThe name of the JASPIC callback handler class.protected static final StringDefault authentication realm name.protected booleanFlag to determine if we disable proxy caching with headers incompatible with IE.protected StringThe name of the algorithm to use to create instances ofSecureRandomwhich are used to generate SSO session IDs.protected StringThe Java class name of the secure random number generator class to be used when generating SSO session identifiers.protected StringThe name of the provider to use to create instances ofSecureRandomwhich are used to generate session SSO IDs.protected booleanShould the auth information (remote user and auth type) be returned as response headers for a forwarded/proxied request?protected SessionIdGeneratorBaseprotected static final StringManagerThe string manager for this package.protected SingleSignOnThe SingleSignOn implementation in our request processing chain, if there is one.Fields inherited from class org.apache.catalina.valves.ValveBase
asyncSupported, container, containerLog, nextFields inherited from class org.apache.catalina.util.LifecycleMBeanBase
mserverFields inherited from interface org.apache.catalina.Lifecycle
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanallowCorsPreflightBypass(Request request) protected voidAssociate the specified single sign on identifier with the specified Session.booleanauthenticate(Request request, HttpServletResponse httpResponse) Authenticate the user making this request, based on the login configuration of theContextwith which this Authenticator is associated.protected StringchangeSessionID(Request request, Session session) protected booleancheckForCachedAuthentication(Request request, HttpServletResponse response, boolean useSSO) Check to see if the user has already been authenticated earlier in the processing chain or if there is enough information available to authenticate the user without requiring further user interaction.protected abstract booleandoAuthenticate(Request request, HttpServletResponse response) Provided for sub-classes to implement their specific authentication mechanism.protected PrincipalProcess the login request.booleanprotected abstract StringReturn the authentication method, which is vendor-specific and not defined by HttpServletRequest.booleangetCache()Return the cache authenticated Principals flag.booleanReturn the flag that states if we should change the session ID of an existing session upon successful authentication.Get theContainerwith which this instance is associated.booleanReturn the flag that states if we add headers to disable caching by proxies.Return the JASPIC callback handler class nameprotected static StringgetRealmName(Context context) booleanReturn the flag that states, if proxy caching is disabled, what headers we add to disable the caching.Return the secure random number generator algorithm name.Return the secure random number generator class name.Return the secure random number generator provider name.voidEnforce the security restrictions in the web application deployment descriptor of our associated Context.protected booleanisContinuationRequired(Request request) Does this authenticator require thatauthenticate(Request, HttpServletResponse)is called to continue an authentication process that started in a previous request?protected booleanisPreemptiveAuthPossible(Request request) Can the authenticator perform preemptive authentication for the given request?booleanReturns the flag whether authentication information will be sent to a reverse proxy on a forwarded request.voidvoidvoidprotected booleanreauthenticateFromSSO(String ssoId, Request request) Attempts reauthentication to theRealmusing the credentials included in argumententry.voidregister(Request request, HttpServletResponse response, Principal principal, String authType, String username, String password) Register an authenticated Principal and authentication type in our request, in the current session (if there is one), and with our SingleSignOn valve, if there is one.protected voidregister(Request request, HttpServletResponse response, Principal principal, String authType, String username, String password, boolean alwaysUseSession, boolean cache) Register an authenticated Principal and authentication type in our request, in the current session (if there is one), and with our SingleSignOn valve, if there is one.voidsetAllowCorsPreflight(String allowCorsPreflight) voidsetAlwaysUseSession(boolean alwaysUseSession) voidsetCache(boolean cache) Set the cache authenticated Principals flag.voidsetChangeSessionIdOnAuthentication(boolean changeSessionIdOnAuthentication) Set the value of the flag that states if we should change the session ID of an existing session upon successful authentication.voidsetContainer(Container container) Set theContainerwith which this instance is associated.voidsetDisableProxyCaching(boolean nocache) Set the value of the flag that states if we add headers to disable caching by proxies.voidsetJaspicCallbackHandlerClass(String jaspicCallbackHandlerClass) Set the JASPIC callback handler class namevoidsetSecurePagesWithPragma(boolean securePagesWithPragma) Set the value of the flag that states what headers we add to disable proxy caching.voidsetSecureRandomAlgorithm(String secureRandomAlgorithm) Set the secure random number generator algorithm name.voidsetSecureRandomClass(String secureRandomClass) Set the secure random number generator class name.voidsetSecureRandomProvider(String secureRandomProvider) Set the secure random number generator provider name.voidsetSendAuthInfoResponseHeaders(boolean sendAuthInfoResponseHeaders) Sets the flag whether authentication information will be send to a reverse proxy on a forwarded request.protected voidStart this component and implement the requirements ofLifecycleBase.startInternal().protected voidStop this component and implement the requirements ofLifecycleBase.stopInternal().Methods inherited from class org.apache.catalina.valves.ValveBase
backgroundProcess, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setNext, toStringMethods inherited from class org.apache.catalina.util.LifecycleMBeanBase
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisterMethods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
Field Details
-
sm
The string manager for this package. -
AUTH_HEADER_NAME
Authentication header- See Also:
-
REALM_NAME
Default authentication realm name.- See Also:
-
alwaysUseSession
protected boolean alwaysUseSessionShould a session always be used once a user is authenticated? This may offer some performance benefits since the session can then be used to cache the authenticated Principal, hence removing the need to authenticate the user via the Realm on every request. This may be of help for combinations such as BASIC authentication used with the JNDIRealm or DataSourceRealms. However there will also be the performance cost of creating and GC'ing the session. By default, a session will not be created. -
cache
protected boolean cacheShould we cache authenticated Principals if the request is part of an HTTP session? -
changeSessionIdOnAuthentication
protected boolean changeSessionIdOnAuthenticationShould the session ID, if any, be changed upon a successful authentication to prevent a session fixation attack? -
context
The Context to which this Valve is attached. -
disableProxyCaching
protected boolean disableProxyCachingFlag to determine if we disable proxy caching, or leave the issue up to the webapp developer. -
securePagesWithPragma
protected boolean securePagesWithPragmaFlag to determine if we disable proxy caching with headers incompatible with IE. -
secureRandomClass
The Java class name of the secure random number generator class to be used when generating SSO session identifiers. The random number generator class must be self-seeding and have a zero-argument constructor. If not specified, an instance ofSecureRandomwill be generated. -
secureRandomAlgorithm
The name of the algorithm to use to create instances ofSecureRandomwhich are used to generate SSO session IDs. If no algorithm is specified, SHA1PRNG is used. If SHA1PRNG is not available, the platform default will be used. To use the platform default (which may be SHA1PRNG), specify the empty string. If an invalid algorithm and/or provider is specified the SecureRandom instances will be created using the defaults. If that fails, the SecureRandom instances will be created using platform defaults. -
secureRandomProvider
The name of the provider to use to create instances ofSecureRandomwhich are used to generate session SSO IDs. If no provider is specified the platform default is used. If an invalid algorithm and/or provider is specified the SecureRandom instances will be created using the defaults. If that fails, the SecureRandom instances will be created using platform defaults. -
jaspicCallbackHandlerClass
The name of the JASPIC callback handler class. If none is specified the defaultCallbackHandlerImplwill be used. -
sendAuthInfoResponseHeaders
protected boolean sendAuthInfoResponseHeadersShould the auth information (remote user and auth type) be returned as response headers for a forwarded/proxied request? When theRemoteIpValveorRemoteIpFiltermark a forwarded request with theGlobals.REQUEST_FORWARDED_ATTRIBUTEthis authenticator can return the values ofHttpServletRequest.getRemoteUser()andHttpServletRequest.getAuthType()as response headersremote-userandauth-typeto a reverse proxy. This is useful, e.g., for access log consistency or other decisions to make. -
sessionIdGenerator
-
sso
The SingleSignOn implementation in our request processing chain, if there is one.
-
-
Constructor Details
-
AuthenticatorBase
public AuthenticatorBase()
-
-
Method Details
-
getRealmName
-
getAllowCorsPreflight
-
setAllowCorsPreflight
-
getAlwaysUseSession
public boolean getAlwaysUseSession() -
setAlwaysUseSession
public void setAlwaysUseSession(boolean alwaysUseSession) -
getCache
public boolean getCache()Return the cache authenticated Principals flag.- Returns:
trueif authenticated Principals will be cached, otherwisefalse
-
setCache
public void setCache(boolean cache) Set the cache authenticated Principals flag.- Parameters:
cache- The new cache flag
-
getContainer
Description copied from interface:ContainedGet theContainerwith which this instance is associated.- Specified by:
getContainerin interfaceContained- Overrides:
getContainerin classValveBase- Returns:
- The Container with which this instance is associated or
nullif not associated with a Container
-
setContainer
Description copied from interface:ContainedSet theContainerwith which this instance is associated.- Specified by:
setContainerin interfaceContained- Overrides:
setContainerin classValveBase- Parameters:
container- The Container instance with which this instance is to be associated, ornullto disassociate this instance from any Container
-
getDisableProxyCaching
public boolean getDisableProxyCaching()Return the flag that states if we add headers to disable caching by proxies.- Returns:
trueif the headers will be added, otherwisefalse
-
setDisableProxyCaching
public void setDisableProxyCaching(boolean nocache) Set the value of the flag that states if we add headers to disable caching by proxies.- Parameters:
nocache-trueif we add headers to disable proxy caching,falseif we leave the headers alone.
-
getSecurePagesWithPragma
public boolean getSecurePagesWithPragma()Return the flag that states, if proxy caching is disabled, what headers we add to disable the caching.- Returns:
trueif a Pragma header should be used, otherwisefalse
-
setSecurePagesWithPragma
public void setSecurePagesWithPragma(boolean securePagesWithPragma) Set the value of the flag that states what headers we add to disable proxy caching.- Parameters:
securePagesWithPragma-trueif we add headers which are incompatible with downloading office documents in IE under SSL but which fix a caching problem in Mozilla.
-
getChangeSessionIdOnAuthentication
public boolean getChangeSessionIdOnAuthentication()Return the flag that states if we should change the session ID of an existing session upon successful authentication.- Returns:
trueto change session ID upon successful authentication,falseto do not perform the change.
-
setChangeSessionIdOnAuthentication
public void setChangeSessionIdOnAuthentication(boolean changeSessionIdOnAuthentication) Set the value of the flag that states if we should change the session ID of an existing session upon successful authentication.- Parameters:
changeSessionIdOnAuthentication-trueto change session ID upon successful authentication,falseto do not perform the change.
-
getSecureRandomClass
Return the secure random number generator class name.- Returns:
- The fully qualified name of the SecureRandom implementation to use
-
setSecureRandomClass
Set the secure random number generator class name.- Parameters:
secureRandomClass- The new secure random number generator class name
-
getSecureRandomAlgorithm
Return the secure random number generator algorithm name.- Returns:
- The name of the SecureRandom algorithm used
-
setSecureRandomAlgorithm
Set the secure random number generator algorithm name.- Parameters:
secureRandomAlgorithm- The new secure random number generator algorithm name
-
getSecureRandomProvider
Return the secure random number generator provider name.- Returns:
- The name of the SecureRandom provider
-
setSecureRandomProvider
Set the secure random number generator provider name.- Parameters:
secureRandomProvider- The new secure random number generator provider name
-
getJaspicCallbackHandlerClass
Return the JASPIC callback handler class name- Returns:
- The name of the JASPIC callback handler
-
setJaspicCallbackHandlerClass
Set the JASPIC callback handler class name- Parameters:
jaspicCallbackHandlerClass- The new JASPIC callback handler class name
-
isSendAuthInfoResponseHeaders
public boolean isSendAuthInfoResponseHeaders()Returns the flag whether authentication information will be sent to a reverse proxy on a forwarded request.- Returns:
trueif response headers shall be sent,falseotherwise
-
setSendAuthInfoResponseHeaders
public void setSendAuthInfoResponseHeaders(boolean sendAuthInfoResponseHeaders) Sets the flag whether authentication information will be send to a reverse proxy on a forwarded request.- Parameters:
sendAuthInfoResponseHeaders-trueif response headers shall be sent,falseotherwise
-
invoke
Enforce the security restrictions in the web application deployment descriptor of our associated Context.- Specified by:
invokein interfaceValve- Parameters:
request- Request to be processedresponse- Response to be processed- Throws:
IOException- if an input/output error occursServletException- if thrown by a processing element
-
allowCorsPreflightBypass
-
authenticate
Description copied from interface:AuthenticatorAuthenticate the user making this request, based on the login configuration of theContextwith which this Authenticator is associated.- Specified by:
authenticatein interfaceAuthenticator- Parameters:
request- Request we are processinghttpResponse- Response we are populating- Returns:
trueif any specified constraints have been satisfied, orfalseif one more constraints were not satisfied (in which case an authentication challenge will have been written to the response).- Throws:
IOException- if an input/output error occurs
-
doAuthenticate
protected abstract boolean doAuthenticate(Request request, HttpServletResponse response) throws IOException Provided for sub-classes to implement their specific authentication mechanism.- Parameters:
request- The request that triggered the authenticationresponse- The response associated with the request- Returns:
trueif the the user was authenticated, otherwisefalse, in which case an authentication challenge will have been written to the response- Throws:
IOException- If an I/O problem occurred during the authentication process
-
isContinuationRequired
Does this authenticator require thatauthenticate(Request, HttpServletResponse)is called to continue an authentication process that started in a previous request?- Parameters:
request- The request currently being processed- Returns:
trueif authenticate() must be called, otherwisefalse
-
associate
Associate the specified single sign on identifier with the specified Session.- Parameters:
ssoId- Single sign on identifiersession- Session to be associated
-
checkForCachedAuthentication
protected boolean checkForCachedAuthentication(Request request, HttpServletResponse response, boolean useSSO) Check to see if the user has already been authenticated earlier in the processing chain or if there is enough information available to authenticate the user without requiring further user interaction.- Parameters:
request- The current requestresponse- The current responseuseSSO- Should information available from SSO be used to attempt to authenticate the current user?- Returns:
trueif the user was authenticated via the cache, otherwisefalse
-
reauthenticateFromSSO
Attempts reauthentication to theRealmusing the credentials included in argumententry.- Parameters:
ssoId- identifier of SingleSignOn session with which the caller is associatedrequest- the request that needs to be authenticated- Returns:
trueif the reauthentication from SSL occurred
-
register
public void register(Request request, HttpServletResponse response, Principal principal, String authType, String username, String password) Register an authenticated Principal and authentication type in our request, in the current session (if there is one), and with our SingleSignOn valve, if there is one. Set the appropriate cookie to be returned.- Parameters:
request- The servlet request we are processingresponse- The servlet response we are generatingprincipal- The authenticated Principal to be registeredauthType- The authentication type to be registeredusername- Username used to authenticate (if any)password- Password used to authenticate (if any)
-
register
protected void register(Request request, HttpServletResponse response, Principal principal, String authType, String username, String password, boolean alwaysUseSession, boolean cache) Register an authenticated Principal and authentication type in our request, in the current session (if there is one), and with our SingleSignOn valve, if there is one. Set the appropriate cookie to be returned.- Parameters:
request- The servlet request we are processingresponse- The servlet response we are generatingprincipal- The authenticated Principal to be registeredauthType- The authentication type to be registeredusername- Username used to authenticate (if any)password- Password used to authenticate (if any)alwaysUseSession- Should a session always be used once a user is authenticated?cache- Should we cache authenticated Principals if the request is part of an HTTP session?
-
changeSessionID
-
login
- Specified by:
loginin interfaceAuthenticator- Throws:
ServletException
-
getAuthMethod
Return the authentication method, which is vendor-specific and not defined by HttpServletRequest.- Returns:
- the authentication method, which is vendor-specific and not defined by HttpServletRequest.
-
doLogin
protected Principal doLogin(Request request, String username, String password) throws ServletException Process the login request.- Parameters:
request- Associated requestusername- The userpassword- The password- Returns:
- The authenticated Principal
- Throws:
ServletException- No principal was authenticated with the specified credentials
-
logout
- Specified by:
logoutin interfaceAuthenticator
-
startInternal
Description copied from class:ValveBaseStart this component and implement the requirements ofLifecycleBase.startInternal().- Overrides:
startInternalin classValveBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
stopInternal
Description copied from class:ValveBaseStop this component and implement the requirements ofLifecycleBase.stopInternal().- Overrides:
stopInternalin classValveBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
isPreemptiveAuthPossible
Can the authenticator perform preemptive authentication for the given request?- Parameters:
request- The request to check for credentials- Returns:
trueif preemptive authentication is possible, otherwisefalse
-
notify
- Specified by:
notifyin interfaceRegistrationListener
-