org.apereo.cas.authentication

Class AcceptUsersAuthenticationHandler

java.lang.Object

org.apereo.cas.authentication.AbstractAuthenticationHandler

org.apereo.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

org.apereo.cas.authentication.handler.support.AbstractUsernamePasswordAuthenticationHandler

org.apereo.cas.authentication.AcceptUsersAuthenticationHandler

All Implemented Interfaces:

org.apereo.cas.authentication.AuthenticationHandler, org.apereo.cas.authentication.PrePostAuthenticationHandler, org.springframework.core.Ordered

public class AcceptUsersAuthenticationHandler
extends AbstractUsernamePasswordAuthenticationHandler

Handler that contains a list of valid users and passwords. Useful if there is a small list of users that we wish to allow. An example use case may be if there are existing handlers that make calls to LDAP, etc. but there is a need for additional users we don't want in LDAP. With the chain of command processing of handlers, this handler could be added to check before LDAP and provide the list of additional users. The list of acceptable users is stored in a map. The key of the map is the username and the password is the object retrieved from doing map.get(KEY).

Since:

3.0.0

Field Summary

Fields inherited from class org.apereo.cas.authentication.AbstractAuthenticationHandler

principalFactory, servicesManager

Fields inherited from interface org.apereo.cas.authentication.AuthenticationHandler

SUCCESSFUL_AUTHENTICATION_HANDLERS

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AcceptUsersAuthenticationHandler(java.lang.String name) Instantiates a new Accept users authentication handler.
AcceptUsersAuthenticationHandler(java.lang.String name, org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.authentication.principal.PrincipalFactory principalFactory, java.lang.Integer order, java.util.Map<java.lang.String,java.lang.String> users) Instantiates a new Accept users authentication handler.

Method Summary

Modifier and Type	Method and Description
protected org.apereo.cas.authentication.HandlerResult	authenticateUsernamePasswordInternal(UsernamePasswordCredential credential, java.lang.String originalPassword) Authenticates a username/password credential by an arbitrary strategy with extra parameter original credential password before encoding password.
void	setUsers(java.util.Map<java.lang.String,java.lang.String> users)

Methods inherited from class org.apereo.cas.authentication.handler.support.AbstractUsernamePasswordAuthenticationHandler

doAuthentication, getPasswordPolicyConfiguration, matches, setCredentialSelectionPredicate, setPasswordEncoder, setPasswordPolicyConfiguration, setPrincipalNameTransformer, supports

Methods inherited from class org.apereo.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

authenticate, createHandlerResult

Methods inherited from class org.apereo.cas.authentication.AbstractAuthenticationHandler

getName, getOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.authentication.PrePostAuthenticationHandler

postAuthenticate, preAuthenticate

Methods inherited from interface org.apereo.cas.authentication.AuthenticationHandler

getName

Methods inherited from interface org.springframework.core.Ordered

getOrder

Constructor Detail

AcceptUsersAuthenticationHandler

public AcceptUsersAuthenticationHandler(java.lang.String name)

Instantiates a new Accept users authentication handler.

Parameters:

name - the name

AcceptUsersAuthenticationHandler

public AcceptUsersAuthenticationHandler(java.lang.String name,
                                        org.apereo.cas.services.ServicesManager servicesManager,
                                        org.apereo.cas.authentication.principal.PrincipalFactory principalFactory,
                                        java.lang.Integer order,
                                        java.util.Map<java.lang.String,java.lang.String> users)

Instantiates a new Accept users authentication handler.

Parameters:

name - the name

servicesManager - the services manager

principalFactory - the principal factory

order - the order

users - the users

Method Detail

authenticateUsernamePasswordInternal

protected org.apereo.cas.authentication.HandlerResult authenticateUsernamePasswordInternal(UsernamePasswordCredential credential,
                                                                                           java.lang.String originalPassword)
                                                                                    throws java.security.GeneralSecurityException,
                                                                                           org.apereo.cas.authentication.PreventedException

Description copied from class: AbstractUsernamePasswordAuthenticationHandler

Authenticates a username/password credential by an arbitrary strategy with extra parameter original credential password before encoding password. Override it if implementation need to use original password for authentication.

Specified by:

authenticateUsernamePasswordInternal in class AbstractUsernamePasswordAuthenticationHandler

Parameters:

credential - the credential object bearing the transformed username and password.

originalPassword - original password from credential before password encoding

Returns:

HandlerResult resolved from credential on authentication success or null if no principal could be resolved from the credential.

Throws:

java.security.GeneralSecurityException - On authentication failure.

org.apereo.cas.authentication.PreventedException - On the indeterminate case when authentication is prevented.

setUsers

public void setUsers(java.util.Map<java.lang.String,java.lang.String> users)

Parameters:

users - The users to set.