org.apereo.cas.authentication.handler.support

Class AbstractUsernamePasswordAuthenticationHandler

java.lang.Object

org.apereo.cas.authentication.AbstractAuthenticationHandler

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AcceptUsersAuthenticationHandler, JaasAuthenticationHandler

public abstract class AbstractUsernamePasswordAuthenticationHandler
extends AbstractPreAndPostProcessingAuthenticationHandler

Abstract class to override supports so that we don't need to duplicate the check for UsernamePasswordCredential.

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
AbstractUsernamePasswordAuthenticationHandler(java.lang.String name, org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.authentication.principal.PrincipalFactory principalFactory, java.lang.Integer order)

Method Summary

Modifier and Type	Method and Description
protected abstract org.apereo.cas.authentication.HandlerResult	authenticateUsernamePasswordInternal(UsernamePasswordCredential transformedCredential, java.lang.String originalPassword) Authenticates a username/password credential by an arbitrary strategy with extra parameter original credential password before encoding password.
protected org.apereo.cas.authentication.HandlerResult	doAuthentication(org.apereo.cas.authentication.Credential credential) Performs the details of authentication and returns an authentication handler result on success.
protected PasswordPolicyConfiguration	getPasswordPolicyConfiguration()
protected boolean	matches(java.lang.CharSequence charSequence, java.lang.String password) Used in case passwordEncoder is used to match raw password with encoded password.
void	setCredentialSelectionPredicate(java.util.function.Predicate<org.apereo.cas.authentication.Credential> credentialSelectionPredicate)
void	setPasswordEncoder(org.springframework.security.crypto.password.PasswordEncoder passwordEncoder)
void	setPasswordPolicyConfiguration(PasswordPolicyConfiguration passwordPolicyConfiguration)
void	setPrincipalNameTransformer(org.apereo.cas.authentication.handler.PrincipalNameTransformer principalNameTransformer)
boolean	supports(org.apereo.cas.authentication.Credential credential)

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

AbstractUsernamePasswordAuthenticationHandler

public AbstractUsernamePasswordAuthenticationHandler(java.lang.String name,
                                                     org.apereo.cas.services.ServicesManager servicesManager,
                                                     org.apereo.cas.authentication.principal.PrincipalFactory principalFactory,
                                                     java.lang.Integer order)

Method Detail

doAuthentication

protected org.apereo.cas.authentication.HandlerResult doAuthentication(org.apereo.cas.authentication.Credential credential)
                                                                throws java.security.GeneralSecurityException,
                                                                       org.apereo.cas.authentication.PreventedException

Description copied from class: AbstractPreAndPostProcessingAuthenticationHandler

Performs the details of authentication and returns an authentication handler result on success.

Specified by:

doAuthentication in class AbstractPreAndPostProcessingAuthenticationHandler

Parameters:

credential - Credential to authenticate.

Returns:

Authentication handler result on success.

Throws:

java.security.GeneralSecurityException - On authentication failure that is thrown out to the caller of AbstractPreAndPostProcessingAuthenticationHandler.authenticate(Credential).

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

authenticateUsernamePasswordInternal

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

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.

Parameters:

transformedCredential - 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.

getPasswordPolicyConfiguration

protected PasswordPolicyConfiguration getPasswordPolicyConfiguration()

setPasswordEncoder

public void setPasswordEncoder(org.springframework.security.crypto.password.PasswordEncoder passwordEncoder)

setCredentialSelectionPredicate

public void setCredentialSelectionPredicate(java.util.function.Predicate<org.apereo.cas.authentication.Credential> credentialSelectionPredicate)

setPrincipalNameTransformer

public void setPrincipalNameTransformer(org.apereo.cas.authentication.handler.PrincipalNameTransformer principalNameTransformer)

setPasswordPolicyConfiguration

public void setPasswordPolicyConfiguration(PasswordPolicyConfiguration passwordPolicyConfiguration)

supports

public boolean supports(org.apereo.cas.authentication.Credential credential)

matches

protected boolean matches(java.lang.CharSequence charSequence,
                          java.lang.String password)

Used in case passwordEncoder is used to match raw password with encoded password. Mainly for BCRYPT password encoders where each encoded password is different and we cannot use traditional compare of encoded strings to check if passwords match

Parameters:

charSequence - raw not encoded password

password - encoded password to compare with

Returns:

true in case charSequence matched encoded password