org.apache.catalina.realm

Class LockOutRealm

public class LockOutRealm extends CombinedRealm

This class extends the CombinedRealm (hence it can wrap other Realms) to provide a user lock out mechanism if there are too many failed authentication attempts in a given period of time. To ensure correct operation, there is a reasonable degree of synchronisation in this Realm. This Realm does not require modification to the underlying Realms or the associated user storage mecahisms. It achieves this by recording all failed logins, including those for users that do not exist. To prevent a DOS by deliberating making requests with invalid users (and hence causing this cache to grow) the size of the list of users that have failed authentication is limited.
Nested Class Summary
protected classLockOutRealm.LockRecord
Field Summary
protected intcacheRemovalWarningTime
If a failed user is removed from the cache because the cache is too big before it has been in the cache for at least this period of time (in seconds) a warning message will be logged.
protected intcacheSize
Number of users that have failed authentication to keep in cache.
protected Map<String,LockOutRealm.LockRecord>failedUsers
Users whose last authentication attempt failed.
protected intfailureCount
The number of times in a row a user has to fail authentication to be locked out.
protected intlockOutTime
The time (in seconds) a user is locked out for after too many authentication failures.
Method Summary
Principalauthenticate(String username, byte[] credentials)
Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.
Principalauthenticate(String username, String clientDigest, String once, String nc, String cnonce, String qop, String realmName, String md5a2)
Return the Principal associated with the specified username, which matches the digest calculated using the given parameters using the method described in RFC 2069; otherwise return null.
Principalauthenticate(String username, String credentials)
Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.
Principalauthenticate(X509Certificate[] certs)
Return the Principal associated with the specified chain of X509 client certificates.
intgetCacheRemovalWarningTime()
Get the minimum period a failed authentication must remain in the cache to avoid generating a warning if it is removed from the cache to make space for a new entry.
intgetCacheSize()
Get the maximum number of users for which authentication failure will be kept in the cache.
intgetFailureCount()
Get the number of failed authentication attempts required to lock the user account.
intgetLockOutTime()
Get the period for which an account will be locked.
voidsetCacheRemovalWarningTime(int cacheRemovalWarningTime)
Set the minimum period a failed authentication must remain in the cache to avoid generating a warning if it is removed from the cache to make space for a new entry.
voidsetCacheSize(int cacheSize)
Set the maximum number of users for which authentication failure will be kept in the cache.
voidsetFailureCount(int failureCount)
Set the number of failed authentication attempts required to lock the user account.
voidsetLockOutTime(int lockOutTime)
Set the period for which an account will be locked.
voidstart()
Prepare for the beginning of active use of the public methods of this component.
voidunlock(String username)
Unlock the specified username.

Field Detail

cacheRemovalWarningTime

protected int cacheRemovalWarningTime
If a failed user is removed from the cache because the cache is too big before it has been in the cache for at least this period of time (in seconds) a warning message will be logged. Defaults to 3600 (1 hour).

cacheSize

protected int cacheSize
Number of users that have failed authentication to keep in cache. Over time the cache will grow to this size and may not shrink. Defaults to 1000.

failedUsers

protected Map<String,LockOutRealm.LockRecord> failedUsers
Users whose last authentication attempt failed. Entries will be ordered in access order from least recent to most recent.

failureCount

protected int failureCount
The number of times in a row a user has to fail authentication to be locked out. Defaults to 5.

lockOutTime

protected int lockOutTime
The time (in seconds) a user is locked out for after too many authentication failures. Defaults to 300 (5 minutes).

Method Detail

authenticate

public Principal authenticate(String username, byte[] credentials)
Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.

Parameters: username Username of the Principal to look up credentials Password or other credentials to use in authenticating this username

authenticate

public Principal authenticate(String username, String clientDigest, String once, String nc, String cnonce, String qop, String realmName, String md5a2)
Return the Principal associated with the specified username, which matches the digest calculated using the given parameters using the method described in RFC 2069; otherwise return null.

Parameters: username Username of the Principal to look up clientDigest Digest which has been submitted by the client nOnce Unique (or supposedly unique) token which has been used for this request realm Realm name md5a2 Second MD5 digest used to calculate the digest : MD5(Method + ":" + uri)

authenticate

public Principal authenticate(String username, String credentials)
Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.

Parameters: username Username of the Principal to look up credentials Password or other credentials to use in authenticating this username

authenticate

public Principal authenticate(X509Certificate[] certs)
Return the Principal associated with the specified chain of X509 client certificates. If there is none, return null.

Parameters: certs Array of client certificates, with the first one in the array being the certificate of the client itself.

getCacheRemovalWarningTime

public int getCacheRemovalWarningTime()
Get the minimum period a failed authentication must remain in the cache to avoid generating a warning if it is removed from the cache to make space for a new entry.

Returns: the cacheRemovalWarningTime

getCacheSize

public int getCacheSize()
Get the maximum number of users for which authentication failure will be kept in the cache.

Returns: the cacheSize

getFailureCount

public int getFailureCount()
Get the number of failed authentication attempts required to lock the user account.

Returns: the failureCount

getLockOutTime

public int getLockOutTime()
Get the period for which an account will be locked.

Returns: the lockOutTime

setCacheRemovalWarningTime

public void setCacheRemovalWarningTime(int cacheRemovalWarningTime)
Set the minimum period a failed authentication must remain in the cache to avoid generating a warning if it is removed from the cache to make space for a new entry.

Parameters: cacheRemovalWarningTime the cacheRemovalWarningTime to set

setCacheSize

public void setCacheSize(int cacheSize)
Set the maximum number of users for which authentication failure will be kept in the cache.

Parameters: cacheSize the cacheSize to set

setFailureCount

public void setFailureCount(int failureCount)
Set the number of failed authentication attempts required to lock the user account.

Parameters: failureCount the failureCount to set

setLockOutTime

public void setLockOutTime(int lockOutTime)
Set the period for which an account will be locked.

Parameters: lockOutTime the lockOutTime to set

start

public void start()
Prepare for the beginning of active use of the public methods of this component. This method should be called before any of the public methods of this component are utilized. It should also send a LifecycleEvent of type START_EVENT to any registered listeners.

Throws: LifecycleException if this component detects a fatal error that prevents this component from being used

unlock

public void unlock(String username)
Unlock the specified username. This will remove all records of authentication failures for this user.

Parameters: username The user to unlock

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.