Package org.apache.catalina.realm
Class RealmBase
- java.lang.Object
-
- org.apache.catalina.util.LifecycleBase
-
- org.apache.catalina.util.LifecycleMBeanBase
-
- org.apache.catalina.realm.RealmBase
-
- All Implemented Interfaces:
MBeanRegistration,Contained,JmxEnabled,Lifecycle,Realm
- Direct Known Subclasses:
AuthenticatedUserRealm,CombinedRealm,DataSourceRealm,JAASRealm,JNDIRealm,MemoryRealm,NullRealm,UserDatabaseRealm
public abstract class RealmBase extends LifecycleMBeanBase implements Realm
Simple implementation of Realm that reads an XML file to configure the valid users, passwords, and roles. The file format (and default file location) are identical to those currently supported by Tomcat 3.X.- Author:
- Craig R. McClanahan
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classRealmBase.AllRolesMode-
Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse
-
-
Field Summary
Fields Modifier and Type Field Description protected RealmBase.AllRolesModeallRolesModeThe all role mode.protected ContainercontainerThe Container with which this Realm is associated.protected LogcontainerLogContainer logprotected StringrealmPathprotected static StringManagersmThe string manager for this package.protected booleanstripRealmForGssWhen processing users authenticated via the GSS-API, should any "@..." be stripped from the end of the user name?protected PropertyChangeSupportsupportThe property change support for this component.protected booleanvalidateShould we validate client certificate chains when they are presented?protected X509UsernameRetrieverx509UsernameRetrieverThe object that will extract user names from X509 client certificates.protected Stringx509UsernameRetrieverClassNameThe name of the class to use for retrieving user names from X509 certificates.-
Fields 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 Constructor Description RealmBase()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddPropertyChangeListener(PropertyChangeListener listener)Add a property change listener to this component.Principalauthenticate(String username)Return the Principal associated with the specified username, if there is one; otherwise returnnull.Principalauthenticate(String username, String credentials)Return the Principal associated with the specified username and credentials, if there is one; otherwise returnnull.Principalauthenticate(String username, String clientDigest, String nonce, String nc, String cnonce, String qop, String realm, String md5a2)Try to authenticate with the specified username, which matches the digest calculated using the given parameters using the method described in RFC 2617 (which is a superset of RFC 2069).Principalauthenticate(X509Certificate[] certs)Return the Principal associated with the specified chain of X509 client certificates.Principalauthenticate(GSSContext gssContext, boolean storeCred)Try to authenticate using aGSSContextPrincipalauthenticate(GSSName gssName, GSSCredential gssCredential)Try to authenticate using aGSSNamevoidbackgroundProcess()Execute a periodic task, such as reloading, etc.SecurityConstraint[]findSecurityConstraints(Request request, Context context)Return the SecurityConstraints configured to guard the request URI for this request, ornullif there is no such constraint.StringgetAllRolesMode()Return the all roles mode.ContainergetContainer()Return the Container with which this Realm has been associated.CredentialHandlergetCredentialHandler()protected StringgetDigest(String username, String realmName)Return the digest associated with given principal's user name.StringgetDomainInternal()Method implemented by sub-classes to identify the domain in which MBeans should be registered.StringgetObjectNameKeyProperties()Allow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.protected abstract StringgetPassword(String username)Get the password for the specified user.protected abstract PrincipalgetPrincipal(String username)Get the principal associated with the specified user.protected PrincipalgetPrincipal(X509Certificate usercert)Get the principal associated with the specified certificate.protected PrincipalgetPrincipal(GSSName gssName, GSSCredential gssCredential)Get the principal associated with the specifiedGSSName.StringgetRealmPath()protected StringgetRealmSuffix()protected ServergetServer()Return the Server object that is the ultimate parent for the container with which this Realm is associated.intgetTransportGuaranteeRedirectStatus()booleangetValidate()Return the "validate certificate chains" flag.StringgetX509UsernameRetrieverClassName()Gets the name of the class that will be used to extract user names from X509 client certificates.protected booleanhasMessageDigest()booleanhasResourcePermission(Request request, Response response, SecurityConstraint[] constraints, Context context)Perform access control based on the specified authorization constraint.booleanhasRole(Wrapper wrapper, Principal principal, String role)Check if the specified Principal has the specified security role, within the context of this Realm.protected booleanhasRoleInternal(Principal principal, String role)Check if the specified Principal has the specified security role, within the context of this Realm.booleanhasUserDataPermission(Request request, Response response, SecurityConstraint[] constraints)Enforce any user data constraint required by the security constraint guarding this request URI.protected voidinitInternal()Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.booleanisStripRealmForGss()static voidmain(String[] args)Generate a stored credential string for the given password and associated parameters.voidremovePropertyChangeListener(PropertyChangeListener listener)Remove a property change listener from this component.voidsetAllRolesMode(String allRolesMode)Set the all roles mode.voidsetContainer(Container container)Set the Container with which this Realm has been associated.voidsetCredentialHandler(CredentialHandler credentialHandler)Set the CredentialHandler to be used by this Realm.voidsetRealmPath(String theRealmPath)voidsetStripRealmForGss(boolean stripRealmForGss)voidsetTransportGuaranteeRedirectStatus(int transportGuaranteeRedirectStatus)Set the HTTP status code used when the container needs to issue an HTTP redirect to meet the requirements of a configured transport guarantee.voidsetValidate(boolean validate)Set the "validate certificate chains" flag.voidsetX509UsernameRetrieverClassName(String className)Sets the name of the class that will be used to extract user names from X509 client certificates.protected voidstartInternal()Prepare for the beginning of active use of the public methods of this component and implement the requirements ofLifecycleBase.startInternal().protected voidstopInternal()Gracefully terminate the active use of the public methods of this component and implement the requirements ofLifecycleBase.stopInternal().StringtoString()Return a String representation of this component.-
Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister
-
Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.catalina.Realm
isAvailable
-
-
-
-
Field Detail
-
container
protected Container container
The Container with which this Realm is associated.
-
containerLog
protected Log containerLog
Container log
-
sm
protected static final StringManager sm
The string manager for this package.
-
support
protected final PropertyChangeSupport support
The property change support for this component.
-
validate
protected boolean validate
Should we validate client certificate chains when they are presented?
-
x509UsernameRetrieverClassName
protected String x509UsernameRetrieverClassName
The name of the class to use for retrieving user names from X509 certificates.
-
x509UsernameRetriever
protected X509UsernameRetriever x509UsernameRetriever
The object that will extract user names from X509 client certificates.
-
allRolesMode
protected RealmBase.AllRolesMode allRolesMode
The all role mode.
-
stripRealmForGss
protected boolean stripRealmForGss
When processing users authenticated via the GSS-API, should any "@..." be stripped from the end of the user name?
-
realmPath
protected String realmPath
-
-
Method Detail
-
getTransportGuaranteeRedirectStatus
public int getTransportGuaranteeRedirectStatus()
- Returns:
- The HTTP status code used when the container needs to issue an HTTP redirect to meet the requirements of a configured transport guarantee.
-
setTransportGuaranteeRedirectStatus
public void setTransportGuaranteeRedirectStatus(int transportGuaranteeRedirectStatus)
Set the HTTP status code used when the container needs to issue an HTTP redirect to meet the requirements of a configured transport guarantee.- Parameters:
transportGuaranteeRedirectStatus- The status to use. This value is not validated
-
getCredentialHandler
public CredentialHandler getCredentialHandler()
- Specified by:
getCredentialHandlerin interfaceRealm- Returns:
- the CredentialHandler configured for this Realm.
-
setCredentialHandler
public void setCredentialHandler(CredentialHandler credentialHandler)
Description copied from interface:RealmSet the CredentialHandler to be used by this Realm.- Specified by:
setCredentialHandlerin interfaceRealm- Parameters:
credentialHandler- theCredentialHandlerto use
-
getContainer
public Container getContainer()
Return the Container with which this Realm has been associated.- Specified by:
getContainerin interfaceContained- Returns:
- The Container with which this instance is associated or
nullif not associated with a Container
-
setContainer
public void setContainer(Container container)
Set the Container with which this Realm has been associated.- Specified by:
setContainerin interfaceContained- Parameters:
container- The associated Container
-
getAllRolesMode
public String getAllRolesMode()
Return the all roles mode.- Returns:
- A string representation of the current all roles mode
-
setAllRolesMode
public void setAllRolesMode(String allRolesMode)
Set the all roles mode.- Parameters:
allRolesMode- A string representation of the new all roles mode
-
getValidate
public boolean getValidate()
Return the "validate certificate chains" flag.- Returns:
- The value of the validate certificate chains flag
-
setValidate
public void setValidate(boolean validate)
Set the "validate certificate chains" flag.- Parameters:
validate- The new validate certificate chains flag
-
getX509UsernameRetrieverClassName
public String getX509UsernameRetrieverClassName()
Gets the name of the class that will be used to extract user names from X509 client certificates.- Returns:
- The name of the class that will be used to extract user names from X509 client certificates.
-
setX509UsernameRetrieverClassName
public void setX509UsernameRetrieverClassName(String className)
Sets the name of the class that will be used to extract user names from X509 client certificates. The class must implement X509UsernameRetriever.- Parameters:
className- The name of the class that will be used to extract user names from X509 client certificates.- See Also:
X509UsernameRetriever
-
isStripRealmForGss
public boolean isStripRealmForGss()
-
setStripRealmForGss
public void setStripRealmForGss(boolean stripRealmForGss)
-
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.- Specified by:
addPropertyChangeListenerin interfaceRealm- Parameters:
listener- The listener to add
-
authenticate
public Principal authenticate(String username)
Return the Principal associated with the specified username, if there is one; otherwise returnnull.- Specified by:
authenticatein interfaceRealm- Parameters:
username- Username of the Principal to look up- Returns:
- the associated principal, or
nullif none is associated.
-
authenticate
public Principal authenticate(String username, String credentials)
Return the Principal associated with the specified username and credentials, if there is one; otherwise returnnull.- Specified by:
authenticatein interfaceRealm- Parameters:
username- Username of the Principal to look upcredentials- Password or other credentials to use in authenticating this username- Returns:
- the associated principal, or
nullif there is none.
-
authenticate
public Principal authenticate(String username, String clientDigest, String nonce, String nc, String cnonce, String qop, String realm, String md5a2)
Try to authenticate with the specified username, which matches the digest calculated using the given parameters using the method described in RFC 2617 (which is a superset of RFC 2069).- Specified by:
authenticatein interfaceRealm- Parameters:
username- Username of the Principal to look upclientDigest- Digest which has been submitted by the clientnonce- Unique (or supposedly unique) token which has been used for this requestnc- the nonce countercnonce- the client chosen nonceqop- the "quality of protection" (ncandcnoncewill only be used, ifqopis notnull).realm- Realm namemd5a2- Second MD5 digest used to calculate the digest : MD5(Method + ":" + uri)- Returns:
- the associated principal, or
nullif there is none.
-
authenticate
public Principal authenticate(X509Certificate[] certs)
Return the Principal associated with the specified chain of X509 client certificates. If there is none, returnnull.- Specified by:
authenticatein interfaceRealm- Parameters:
certs- Array of client certificates, with the first one in the array being the certificate of the client itself.- Returns:
- the associated principal, or
nullif there is none
-
authenticate
public Principal authenticate(GSSContext gssContext, boolean storeCred)
Try to authenticate using aGSSContext- Specified by:
authenticatein interfaceRealm- Parameters:
gssContext- The gssContext processed by theAuthenticator.storeCred- Should the realm attempt to store the delegated credentials in the returned Principal?- Returns:
- the associated principal, or
nullif there is none
-
authenticate
public Principal authenticate(GSSName gssName, GSSCredential gssCredential)
Try to authenticate using aGSSName- Specified by:
authenticatein interfaceRealm- Parameters:
gssName- TheGSSNameof the principal to look upgssCredential- TheGSSCredentialof the principal, may benull- Returns:
- the associated principal, or
nullif there is none
-
backgroundProcess
public void backgroundProcess()
Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.- Specified by:
backgroundProcessin interfaceRealm
-
findSecurityConstraints
public SecurityConstraint[] findSecurityConstraints(Request request, Context context)
Return the SecurityConstraints configured to guard the request URI for this request, ornullif there is no such constraint.- Specified by:
findSecurityConstraintsin interfaceRealm- Parameters:
request- Request we are processingcontext- Context the Request is mapped to- Returns:
- the configured
SecurityConstraint, ofnullif there is none
-
hasResourcePermission
public boolean hasResourcePermission(Request request, Response response, SecurityConstraint[] constraints, Context context) throws IOException
Perform access control based on the specified authorization constraint. Returntrueif this constraint is satisfied and processing should continue, orfalseotherwise.- Specified by:
hasResourcePermissionin interfaceRealm- Parameters:
request- Request we are processingresponse- Response we are creatingconstraints- Security constraint we are enforcingcontext- The Context to which client of this class is attached.- Returns:
trueif this constraint is satisfied and processing should continue, orfalseotherwise- Throws:
IOException- if an input/output error occurs
-
hasRole
public boolean hasRole(Wrapper wrapper, Principal principal, String role)
Check if the specified Principal has the specified security role, within the context of this Realm. This method orhasRoleInternal(Principal, String)can be overridden by Realm implementations, but the default is adequate when an instance ofGenericPrincipalis used to represent authenticated Principals from this Realm.- Specified by:
hasRolein interfaceRealm- Parameters:
wrapper- wrapper context for evaluating roleprincipal- Principal for whom the role is to be checkedrole- Security role to be checked- Returns:
trueif the specified Principal has the specified security role, within the context of this Realm; otherwise returnfalse.
-
hasRoleInternal
protected boolean hasRoleInternal(Principal principal, String role)
Check if the specified Principal has the specified security role, within the context of this Realm. This method orhasRoleInternal(Principal, String)can be overridden by Realm implementations, but the default is adequate when an instance ofGenericPrincipalis used to represent authenticated Principals from this Realm.- Parameters:
principal- Principal for whom the role is to be checkedrole- Security role to be checked- Returns:
trueif the specified Principal has the specified security role, within the context of this Realm; otherwise returnfalse.
-
hasUserDataPermission
public boolean hasUserDataPermission(Request request, Response response, SecurityConstraint[] constraints) throws IOException
Enforce any user data constraint required by the security constraint guarding this request URI. Returntrueif this constraint was not violated and processing should continue, orfalseif we have created a response already.- Specified by:
hasUserDataPermissionin interfaceRealm- Parameters:
request- Request we are processingresponse- Response we are creatingconstraints- Security constraint being checked- Returns:
trueif this constraint was not violated and processing should continue, orfalseif we have created a response already.- Throws:
IOException- if an input/output error occurs
-
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.- Specified by:
removePropertyChangeListenerin interfaceRealm- Parameters:
listener- The listener to remove
-
initInternal
protected void initInternal() throws LifecycleExceptionDescription copied from class:LifecycleMBeanBaseSub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.- Overrides:
initInternalin classLifecycleMBeanBase- Throws:
LifecycleException- If the initialisation fails
-
startInternal
protected void startInternal() throws LifecycleExceptionPrepare for the beginning of active use of the public methods of this component and implement the requirements ofLifecycleBase.startInternal().- Specified by:
startInternalin classLifecycleBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
stopInternal
protected void stopInternal() throws LifecycleExceptionGracefully terminate the active use of the public methods of this component and implement the requirements ofLifecycleBase.stopInternal().- Specified by:
stopInternalin classLifecycleBase- Throws:
LifecycleException- if this component detects a fatal error that needs to be reported
-
toString
public String toString()
Return a String representation of this component.
-
hasMessageDigest
protected boolean hasMessageDigest()
-
getDigest
protected String getDigest(String username, String realmName)
Return the digest associated with given principal's user name.- Parameters:
username- the user namerealmName- the realm name- Returns:
- the digest for the specified user
-
getPassword
protected abstract String getPassword(String username)
Get the password for the specified user.- Parameters:
username- The user name- Returns:
- the password associated with the given principal's user name.
-
getPrincipal
protected Principal getPrincipal(X509Certificate usercert)
Get the principal associated with the specified certificate.- Parameters:
usercert- The user certificate- Returns:
- the Principal associated with the given certificate.
-
getPrincipal
protected abstract Principal getPrincipal(String username)
Get the principal associated with the specified user.- Parameters:
username- The user name- Returns:
- the Principal associated with the given user name.
-
getPrincipal
protected Principal getPrincipal(GSSName gssName, GSSCredential gssCredential)
Get the principal associated with the specifiedGSSName.- Parameters:
gssName- The GSS namegssCredential- the GSS credential of the principal- Returns:
- the principal associated with the given user name.
-
getServer
protected Server getServer()
Return the Server object that is the ultimate parent for the container with which this Realm is associated. If the server cannot be found (eg because the container hierarchy is not complete),nullis returned.- Returns:
- the Server associated with the realm
-
main
public static void main(String[] args)
Generate a stored credential string for the given password and associated parameters.The following parameters are supported:
- -a - The algorithm to use to generate the stored credential. If not specified a default of SHA-512 will be used.
- -e - The encoding to use for any byte to/from character conversion that may be necessary. If not
specified, the system encoding (
Charset.defaultCharset()) will be used. - -i - The number of iterations to use when generating the stored credential. If not specified, the default for the CredentialHandler will be used.
- -s - The length (in bytes) of salt to generate and store as part of the credential. If not specified, the default for the CredentialHandler will be used.
- -k - The length (in bits) of the key(s), if any, created while generating the credential. If not specified, the default for the CredentialHandler will be used.
- -h - The fully qualified class name of the CredentialHandler to use. If not specified, the built-in handlers will be tested in turn and the first one to accept the specified algorithm will be used.
This generation process currently supports the following CredentialHandlers, the correct one being selected based on the algorithm specified:
- Parameters:
args- The parameters passed on the command line
-
getObjectNameKeyProperties
public String getObjectNameKeyProperties()
Description copied from class:LifecycleMBeanBaseAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.- Specified by:
getObjectNameKeyPropertiesin classLifecycleMBeanBase- Returns:
- The string representation of the key properties component of the
desired
ObjectName
-
getDomainInternal
public String getDomainInternal()
Description copied from class:LifecycleMBeanBaseMethod implemented by sub-classes to identify the domain in which MBeans should be registered.- Specified by:
getDomainInternalin classLifecycleMBeanBase- Returns:
- The name of the domain to use to register MBeans.
-
getRealmPath
public String getRealmPath()
-
setRealmPath
public void setRealmPath(String theRealmPath)
-
getRealmSuffix
protected String getRealmSuffix()
-
-