org.apereo.cas.adaptors.jdbc

Class QueryDatabaseAuthenticationHandler

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.adaptors.jdbc.AbstractJdbcUsernamePasswordAuthenticationHandler

org.apereo.cas.adaptors.jdbc.QueryDatabaseAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler, PrePostAuthenticationHandler, org.springframework.core.Ordered

public class QueryDatabaseAuthenticationHandler
extends AbstractJdbcUsernamePasswordAuthenticationHandler

Class that if provided a query that returns a password (parameter of query must be username) will compare that password to a translated version of the password provided by the user. If they match, then authentication succeeds. Default password translator is plaintext translator.

Since:

3.0.0

Field Summary

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

passwordPolicyHandlingStrategy

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

credentialSelectionPredicate, 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
QueryDatabaseAuthenticationHandler(java.lang.String name, ServicesManager servicesManager, PrincipalFactory principalFactory, java.lang.Integer order, javax.sql.DataSource dataSource, java.lang.String sql, java.lang.String fieldPassword, java.lang.String fieldExpired, java.lang.String fieldDisabled, java.util.Map<java.lang.String,java.lang.Object> attributes)

Method Summary

Modifier and Type	Method and Description
protected AuthenticationHandlerExecutionResult	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.

Methods inherited from class org.apereo.cas.adaptors.jdbc.AbstractJdbcUsernamePasswordAuthenticationHandler

getDataSource, getJdbcTemplate, getNamedJdbcTemplate

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

doAuthentication, matches, supports

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

authenticate, createHandlerResult, createHandlerResult

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, getOrder

Constructor Detail

QueryDatabaseAuthenticationHandler

public QueryDatabaseAuthenticationHandler(java.lang.String name,
                                          ServicesManager servicesManager,
                                          PrincipalFactory principalFactory,
                                          java.lang.Integer order,
                                          javax.sql.DataSource dataSource,
                                          java.lang.String sql,
                                          java.lang.String fieldPassword,
                                          java.lang.String fieldExpired,
                                          java.lang.String fieldDisabled,
                                          java.util.Map<java.lang.String,java.lang.Object> attributes)

Method Detail

authenticateUsernamePasswordInternal

protected AuthenticationHandlerExecutionResult authenticateUsernamePasswordInternal(UsernamePasswordCredential credential,
                                                                                    java.lang.String originalPassword)
                                                                             throws java.security.GeneralSecurityException,
                                                                                    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:

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

Throws:

java.security.GeneralSecurityException - On authentication failure.

PreventedException - On the indeterminate case when authentication is prevented.