org.apereo.cas.authentication

Class PolicyBasedAuthenticationManager

java.lang.Object

org.apereo.cas.authentication.PolicyBasedAuthenticationManager

All Implemented Interfaces:

org.apereo.cas.authentication.AuthenticationManager

public class PolicyBasedAuthenticationManager
extends java.lang.Object
implements org.apereo.cas.authentication.AuthenticationManager

This is PolicyBasedAuthenticationManager, which provides common operations around an authentication manager implementation.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apereo.cas.authentication.AuthenticationEventExecutionPlan	authenticationEventExecutionPlan Plan to execute the authentication transaction.
protected org.apereo.cas.authentication.AuthenticationHandlerResolver	authenticationHandlerResolver The Authentication handler resolver.
protected java.util.Collection<org.apereo.cas.authentication.AuthenticationPolicy>	authenticationPolicies Authentication security policy.
protected boolean	principalResolutionFailureFatal Indicate if principal resolution should totally fail and no fall back onto principal that is produced by the authentication handler.

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

AUTHENTICATION_METHOD_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan, org.apereo.cas.authentication.AuthenticationHandlerResolver authenticationHandlerResolver, java.util.Collection<org.apereo.cas.authentication.AuthenticationPolicy> authenticationPolicies) Creates a new authentication manager with a map of authentication handlers to the principal resolvers that should be used upon successful authentication if no principal is resolved by the authentication handler.
	PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan, org.apereo.cas.authentication.AuthenticationHandlerResolver authenticationHandlerResolver, java.util.Collection<org.apereo.cas.authentication.AuthenticationPolicy> authenticationPolicies, boolean principalResolutionFatal) Instantiates a new Policy based authentication manager.
	PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan, org.apereo.cas.services.ServicesManager servicesManager) Instantiates a new Policy based authentication manager.
	PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan, org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.authentication.AuthenticationPolicy policy)
	PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan, org.apereo.cas.services.ServicesManager servicesManager, java.util.Collection<org.apereo.cas.authentication.AuthenticationPolicy> authenticationPolicy) Instantiates a new Policy based authentication manager.

Method Summary

Modifier and Type	Method and Description
protected void	addAuthenticationMethodAttribute(org.apereo.cas.authentication.AuthenticationBuilder builder, org.apereo.cas.authentication.Authentication authentication) Add authentication method attribute.
org.apereo.cas.authentication.Authentication	authenticate(org.apereo.cas.authentication.AuthenticationTransaction transaction)
protected void	authenticateAndResolvePrincipal(org.apereo.cas.authentication.AuthenticationBuilder builder, org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.PrincipalResolver resolver, org.apereo.cas.authentication.AuthenticationHandler handler) Authenticate and resolve principal.
protected org.apereo.cas.authentication.AuthenticationBuilder	authenticateInternal(org.apereo.cas.authentication.AuthenticationTransaction transaction) Authenticate internal authentication builder.
protected org.apache.commons.lang3.tuple.Pair<java.lang.Boolean,java.util.Set<java.lang.Throwable>>	evaluateAuthenticationPolicies(org.apereo.cas.authentication.Authentication authentication) Evaluate authentication policies.
protected void	evaluateFinalAuthentication(org.apereo.cas.authentication.AuthenticationBuilder builder, org.apereo.cas.authentication.AuthenticationTransaction transaction) Evaluate produced authentication context.
protected java.util.Set<org.apereo.cas.authentication.AuthenticationHandler>	getAuthenticationHandlersForThisTransaction(org.apereo.cas.authentication.AuthenticationTransaction transaction) Gets authentication handlers for this transaction.
protected java.util.Collection<org.apereo.cas.authentication.AuthenticationMetaDataPopulator>	getAuthenticationMetadataPopulatorsForTransaction(org.apereo.cas.authentication.AuthenticationTransaction transaction) Gets authentication metadata populators for transaction.
protected org.apereo.cas.authentication.principal.PrincipalResolver	getPrincipalResolverLinkedToHandlerIfAny(org.apereo.cas.authentication.AuthenticationHandler handler, org.apereo.cas.authentication.AuthenticationTransaction transaction) Gets principal resolver linked to the handler if any.
protected void	handleAuthenticationException(java.lang.Throwable e, java.lang.String name, org.apereo.cas.authentication.AuthenticationBuilder builder) Handle authentication exception.
protected void	invokeAuthenticationPostProcessors(org.apereo.cas.authentication.AuthenticationBuilder builder, org.apereo.cas.authentication.AuthenticationTransaction transaction) Populate authentication metadata attributes.
protected void	populateAuthenticationMetadataAttributes(org.apereo.cas.authentication.AuthenticationBuilder builder, org.apereo.cas.authentication.AuthenticationTransaction transaction) Populate authentication metadata attributes.
protected void	publishEvent(org.springframework.context.ApplicationEvent event) Publish event.
protected org.apereo.cas.authentication.principal.Principal	resolvePrincipal(org.apereo.cas.authentication.AuthenticationHandler handler, org.apereo.cas.authentication.principal.PrincipalResolver resolver, org.apereo.cas.authentication.Credential credential, org.apereo.cas.authentication.principal.Principal principal) Resolve principal.

Methods inherited from class java.lang.Object

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

Field Detail

authenticationEventExecutionPlan

protected final org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan

Plan to execute the authentication transaction.

authenticationHandlerResolver

protected final org.apereo.cas.authentication.AuthenticationHandlerResolver authenticationHandlerResolver

The Authentication handler resolver.

principalResolutionFailureFatal

protected boolean principalResolutionFailureFatal

Indicate if principal resolution should totally fail and no fall back onto principal that is produced by the authentication handler.

authenticationPolicies

protected java.util.Collection<org.apereo.cas.authentication.AuthenticationPolicy> authenticationPolicies

Authentication security policy.

Constructor Detail

PolicyBasedAuthenticationManager

protected PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan,
                                           org.apereo.cas.authentication.AuthenticationHandlerResolver authenticationHandlerResolver,
                                           java.util.Collection<org.apereo.cas.authentication.AuthenticationPolicy> authenticationPolicies)

Creates a new authentication manager with a map of authentication handlers to the principal resolvers that should be used upon successful authentication if no principal is resolved by the authentication handler. If the order of evaluation of authentication handlers is important, a map that preserves insertion order (e.g. LinkedHashMap) should be used.

Parameters:

authenticationEventExecutionPlan - Describe the execution plan for this manager

authenticationHandlerResolver - the authentication handler resolver

authenticationPolicies - the authentication policies

PolicyBasedAuthenticationManager

public PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan,
                                        org.apereo.cas.authentication.AuthenticationHandlerResolver authenticationHandlerResolver,
                                        java.util.Collection<org.apereo.cas.authentication.AuthenticationPolicy> authenticationPolicies,
                                        boolean principalResolutionFatal)

Instantiates a new Policy based authentication manager.

Parameters:

authenticationEventExecutionPlan - the execution plan

authenticationHandlerResolver - the authentication handler resolver

authenticationPolicies - the authentication policy

principalResolutionFatal - the principal resolution fatal

PolicyBasedAuthenticationManager

public PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan,
                                        org.apereo.cas.services.ServicesManager servicesManager,
                                        java.util.Collection<org.apereo.cas.authentication.AuthenticationPolicy> authenticationPolicy)

Instantiates a new Policy based authentication manager.

Parameters:

authenticationEventExecutionPlan - the authentication event execution plan

servicesManager - the services manager

authenticationPolicy - the authentication policy

PolicyBasedAuthenticationManager

public PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan,
                                        org.apereo.cas.services.ServicesManager servicesManager)

Instantiates a new Policy based authentication manager.

Parameters:

authenticationEventExecutionPlan - the authentication event execution plan

servicesManager - the services manager

PolicyBasedAuthenticationManager

public PolicyBasedAuthenticationManager(org.apereo.cas.authentication.AuthenticationEventExecutionPlan authenticationEventExecutionPlan,
                                        org.apereo.cas.services.ServicesManager servicesManager,
                                        org.apereo.cas.authentication.AuthenticationPolicy policy)

Method Detail

invokeAuthenticationPostProcessors

protected void invokeAuthenticationPostProcessors(org.apereo.cas.authentication.AuthenticationBuilder builder,
                                                  org.apereo.cas.authentication.AuthenticationTransaction transaction)

Populate authentication metadata attributes.

Parameters:

builder - the builder

transaction - the transaction

populateAuthenticationMetadataAttributes

protected void populateAuthenticationMetadataAttributes(org.apereo.cas.authentication.AuthenticationBuilder builder,
                                                        org.apereo.cas.authentication.AuthenticationTransaction transaction)

Populate authentication metadata attributes.

Parameters:

builder - the builder

transaction - the transaction

addAuthenticationMethodAttribute

protected void addAuthenticationMethodAttribute(org.apereo.cas.authentication.AuthenticationBuilder builder,
                                                org.apereo.cas.authentication.Authentication authentication)

Add authentication method attribute.

Parameters:

builder - the builder

authentication - the authentication

resolvePrincipal

protected org.apereo.cas.authentication.principal.Principal resolvePrincipal(org.apereo.cas.authentication.AuthenticationHandler handler,
                                                                             org.apereo.cas.authentication.principal.PrincipalResolver resolver,
                                                                             org.apereo.cas.authentication.Credential credential,
                                                                             org.apereo.cas.authentication.principal.Principal principal)

Resolve principal.

Parameters:

handler - the handler name

resolver - the resolver

credential - the credential

principal - the current authenticated principal from a handler, if any.

Returns:

the principal

authenticate

@Timed(name="AUTHENTICATE_TIMER")
 @Metered(name="AUTHENTICATE_METER")
 @Counted(name="AUTHENTICATE_COUNT",
         monotonic=true)
public org.apereo.cas.authentication.Authentication authenticate(org.apereo.cas.authentication.AuthenticationTransaction transaction)
                                                                                                                                                                                                   throws org.apereo.cas.authentication.AuthenticationException

Specified by:

authenticate in interface org.apereo.cas.authentication.AuthenticationManager

Throws:

org.apereo.cas.authentication.AuthenticationException

authenticateAndResolvePrincipal

protected void authenticateAndResolvePrincipal(org.apereo.cas.authentication.AuthenticationBuilder builder,
                                               org.apereo.cas.authentication.Credential credential,
                                               org.apereo.cas.authentication.principal.PrincipalResolver resolver,
                                               org.apereo.cas.authentication.AuthenticationHandler handler)
                                        throws java.security.GeneralSecurityException,
                                               org.apereo.cas.authentication.PreventedException

Authenticate and resolve principal.

Parameters:

builder - the builder

credential - the credential

resolver - the resolver

handler - the handler

Throws:

java.security.GeneralSecurityException - the general security exception

PreventedException - the prevented exception

getAuthenticationHandlersForThisTransaction

protected java.util.Set<org.apereo.cas.authentication.AuthenticationHandler> getAuthenticationHandlersForThisTransaction(org.apereo.cas.authentication.AuthenticationTransaction transaction)

Gets authentication handlers for this transaction.

Parameters:

transaction - the transaction

Returns:

the authentication handlers for this transaction

getPrincipalResolverLinkedToHandlerIfAny

protected org.apereo.cas.authentication.principal.PrincipalResolver getPrincipalResolverLinkedToHandlerIfAny(org.apereo.cas.authentication.AuthenticationHandler handler,
                                                                                                             org.apereo.cas.authentication.AuthenticationTransaction transaction)

Gets principal resolver linked to the handler if any.

Parameters:

handler - the handler

transaction - the transaction

Returns:

the principal resolver linked to handler if any, or null.

getAuthenticationMetadataPopulatorsForTransaction

protected java.util.Collection<org.apereo.cas.authentication.AuthenticationMetaDataPopulator> getAuthenticationMetadataPopulatorsForTransaction(org.apereo.cas.authentication.AuthenticationTransaction transaction)

Gets authentication metadata populators for transaction.

Parameters:

transaction - the transaction

Returns:

the authentication metadata populators for transaction

publishEvent

protected void publishEvent(org.springframework.context.ApplicationEvent event)

Publish event.

Parameters:

event - the event

authenticateInternal

protected org.apereo.cas.authentication.AuthenticationBuilder authenticateInternal(org.apereo.cas.authentication.AuthenticationTransaction transaction)
                                                                            throws org.apereo.cas.authentication.AuthenticationException

Authenticate internal authentication builder.

Parameters:

transaction - the transaction

Returns:

the authentication builder

Throws:

AuthenticationException - the authentication exception

evaluateFinalAuthentication

protected void evaluateFinalAuthentication(org.apereo.cas.authentication.AuthenticationBuilder builder,
                                           org.apereo.cas.authentication.AuthenticationTransaction transaction)
                                    throws org.apereo.cas.authentication.AuthenticationException

Evaluate produced authentication context. We apply an implicit security policy of at least one successful authentication. Then, we apply the configured security policy.

Parameters:

builder - the builder

transaction - the transaction

Throws:

AuthenticationException - the authentication exception

evaluateAuthenticationPolicies

protected org.apache.commons.lang3.tuple.Pair<java.lang.Boolean,java.util.Set<java.lang.Throwable>> evaluateAuthenticationPolicies(org.apereo.cas.authentication.Authentication authentication)

Evaluate authentication policies.

Parameters:

authentication - the authentication

Returns:

true /false

handleAuthenticationException

protected void handleAuthenticationException(java.lang.Throwable e,
                                             java.lang.String name,
                                             org.apereo.cas.authentication.AuthenticationBuilder builder)

Handle authentication exception.

Parameters:

e - the exception

name - the name

builder - the builder