org.apereo.cas.authentication

Class DefaultMultifactorAuthenticationProviderBypass

java.lang.Object

org.apereo.cas.authentication.DefaultMultifactorAuthenticationProviderBypass

All Implemented Interfaces:

java.io.Serializable, MultifactorAuthenticationProviderBypass

Direct Known Subclasses:

GroovyMultifactorAuthenticationProviderBypass, RestMultifactorAuthenticationProviderBypass

public class DefaultMultifactorAuthenticationProviderBypass
extends java.lang.Object
implements MultifactorAuthenticationProviderBypass

This is DefaultMultifactorAuthenticationProviderBypass.

Since:

5.0.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties	bypassProperties Bypass settings for this provider.

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

AUTHENTICATION_ATTRIBUTE_BYPASS_MFA, AUTHENTICATION_ATTRIBUTE_BYPASS_MFA_PROVIDER

Constructor Summary

Constructors

Constructor and Description
DefaultMultifactorAuthenticationProviderBypass(org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties bypassProperties)

Method Summary

Modifier and Type	Method and Description
protected boolean	locateMatchingAttributeBasedOnAuthenticationAttributes(org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties bypass, org.apereo.cas.authentication.Authentication authn) Skip bypass and support event based on authentication attributes.
protected boolean	locateMatchingAttributeBasedOnPrincipalAttributes(org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties bypass, org.apereo.cas.authentication.principal.Principal principal) Skip bypass and support event based on principal attributes.
protected boolean	locateMatchingAttributeValue(java.lang.String attrName, java.lang.String attrValue, java.util.Map<java.lang.String,java.lang.Object> attributes) Locate matching attribute value boolean.
protected boolean	locateMatchingAttributeValue(java.lang.String attrName, java.lang.String attrValue, java.util.Map<java.lang.String,java.lang.Object> attributes, boolean matchIfNoValueProvided) Evaluate attribute rules for bypass.
protected boolean	locateMatchingCredentialType(org.apereo.cas.authentication.Authentication authentication, java.lang.String credentialClassType) Locate matching credential type boolean.
protected boolean	locateMatchingHttpRequest(org.apereo.cas.authentication.Authentication authentication, javax.servlet.http.HttpServletRequest request) Locate matching http request and determine if bypass should be enabled.
protected boolean	locateMatchingRegisteredServiceForBypass(org.apereo.cas.authentication.Authentication authentication, org.apereo.cas.services.RegisteredService registeredService) Locate matching registered service property boolean.
boolean	shouldMultifactorAuthenticationProviderExecute(org.apereo.cas.authentication.Authentication authentication, org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.services.MultifactorAuthenticationProvider provider, javax.servlet.http.HttpServletRequest request) Eval current bypass rules for the provider.

Methods inherited from class java.lang.Object

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

Field Detail

bypassProperties

protected final org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties bypassProperties

Bypass settings for this provider.

Constructor Detail

DefaultMultifactorAuthenticationProviderBypass

public DefaultMultifactorAuthenticationProviderBypass(org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties bypassProperties)

Method Detail

shouldMultifactorAuthenticationProviderExecute

public boolean shouldMultifactorAuthenticationProviderExecute(org.apereo.cas.authentication.Authentication authentication,
                                                              org.apereo.cas.services.RegisteredService registeredService,
                                                              org.apereo.cas.services.MultifactorAuthenticationProvider provider,
                                                              javax.servlet.http.HttpServletRequest request)

Description copied from interface: MultifactorAuthenticationProviderBypass

Eval current bypass rules for the provider.

Specified by:

shouldMultifactorAuthenticationProviderExecute in interface MultifactorAuthenticationProviderBypass

Parameters:

authentication - the authentication

registeredService - the registered service in question

provider - the provider

request - the request

Returns:

false is request isn't supported and can be bypassed. true otherwise.

locateMatchingRegisteredServiceForBypass

protected boolean locateMatchingRegisteredServiceForBypass(org.apereo.cas.authentication.Authentication authentication,
                                                           org.apereo.cas.services.RegisteredService registeredService)

Locate matching registered service property boolean.

Parameters:

authentication - the authentication

registeredService - the registered service

Returns:

true/false

locateMatchingCredentialType

protected boolean locateMatchingCredentialType(org.apereo.cas.authentication.Authentication authentication,
                                               java.lang.String credentialClassType)

Locate matching credential type boolean.

Parameters:

authentication - the authentication

credentialClassType - the credential class type

Returns:

the boolean

locateMatchingAttributeBasedOnAuthenticationAttributes

protected boolean locateMatchingAttributeBasedOnAuthenticationAttributes(org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties bypass,
                                                                         org.apereo.cas.authentication.Authentication authn)

Skip bypass and support event based on authentication attributes.

Parameters:

bypass - the bypass settings for the provider.

authn - the authn

Returns:

the boolean

locateMatchingAttributeBasedOnPrincipalAttributes

protected boolean locateMatchingAttributeBasedOnPrincipalAttributes(org.apereo.cas.configuration.model.support.mfa.MultifactorAuthenticationProviderBypassProperties bypass,
                                                                    org.apereo.cas.authentication.principal.Principal principal)

Skip bypass and support event based on principal attributes.

Parameters:

bypass - the bypass properties

principal - the principal

Returns:

the boolean

locateMatchingAttributeValue

protected boolean locateMatchingAttributeValue(java.lang.String attrName,
                                               java.lang.String attrValue,
                                               java.util.Map<java.lang.String,java.lang.Object> attributes)

Locate matching attribute value boolean.

Parameters:

attrName - the attr name

attrValue - the attr value

attributes - the attributes

Returns:

true/false

locateMatchingAttributeValue

protected boolean locateMatchingAttributeValue(java.lang.String attrName,
                                               java.lang.String attrValue,
                                               java.util.Map<java.lang.String,java.lang.Object> attributes,
                                               boolean matchIfNoValueProvided)

Evaluate attribute rules for bypass.

Parameters:

attrName - the attr name

attrValue - the attr value

attributes - the attributes

matchIfNoValueProvided - the force match on value

Returns:

true a matching attribute name/value is found

locateMatchingHttpRequest

protected boolean locateMatchingHttpRequest(org.apereo.cas.authentication.Authentication authentication,
                                            javax.servlet.http.HttpServletRequest request)

Locate matching http request and determine if bypass should be enabled.

Parameters:

authentication - the authentication

request - the request

Returns:

true /false