Package org.apereo.cas.authentication.bypass

Interface MultifactorAuthenticationProviderBypassEvaluator

All Superinterfaces:

org.apereo.cas.util.NamedObject, org.springframework.core.Ordered, Serializable

All Known Subinterfaces:

ChainingMultifactorAuthenticationProviderBypassEvaluator

public interface MultifactorAuthenticationProviderBypassEvaluator
extends Serializable, org.springframework.core.Ordered, org.apereo.cas.util.NamedObject

This is MultifactorAuthenticationProviderBypassEvaluator.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHENTICATION_ATTRIBUTE_BYPASS_MFA	bypass mfa authn attribute.
static final String	AUTHENTICATION_ATTRIBUTE_BYPASS_MFA_PROVIDER	bypass mfa for provider id authn attribute.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
Optional<MultifactorAuthenticationProviderBypassEvaluator>	belongsToMultifactorAuthenticationProvider(String providerId)	Indicate whether this bypass belongs to given multifactor authentication provider.
default void	forgetBypass(org.apereo.cas.authentication.Authentication authentication)	Method will remove any previous bypass set in the authentication.
String	getId()	Gets id.
default int	getOrder()
String	getProviderId()	Gets provider id of this bypass evaluator.
default boolean	isEmpty()	Is empty?.
default boolean	isMultifactorAuthenticationBypassed(org.apereo.cas.authentication.Authentication authentication, String requestedContext)	Indicates whether the authentication attempt carries information that would signal a bypassed attempt.
default void	rememberBypass(org.apereo.cas.authentication.Authentication authentication, MultifactorAuthenticationProvider provider)	Method will set the bypass into the authentication.
boolean	shouldMultifactorAuthenticationProviderExecute(org.apereo.cas.authentication.Authentication authentication, org.apereo.cas.services.RegisteredService registeredService, MultifactorAuthenticationProvider provider, jakarta.servlet.http.HttpServletRequest request, org.apereo.cas.authentication.principal.Service service)	Eval current bypass rules for the provider.
default int	size()	Size.

Methods inherited from interface org.apereo.cas.util.NamedObject

getName

Field Details

AUTHENTICATION_ATTRIBUTE_BYPASS_MFA

static final String AUTHENTICATION_ATTRIBUTE_BYPASS_MFA

bypass mfa authn attribute.

See Also:

• Constant Field Values

AUTHENTICATION_ATTRIBUTE_BYPASS_MFA_PROVIDER

static final String AUTHENTICATION_ATTRIBUTE_BYPASS_MFA_PROVIDER

bypass mfa for provider id authn attribute.

See Also:

• Constant Field Values

Method Details

shouldMultifactorAuthenticationProviderExecute

boolean shouldMultifactorAuthenticationProviderExecute(org.apereo.cas.authentication.Authentication authentication,
 org.apereo.cas.services.RegisteredService registeredService,
 MultifactorAuthenticationProvider provider,
 jakarta.servlet.http.HttpServletRequest request,
 org.apereo.cas.authentication.principal.Service service)

Eval current bypass rules for the provider.

Parameters:

authentication - the authentication

registeredService - the registered service in question

provider - the provider

request - the request

service - the service

Returns:

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

isMultifactorAuthenticationBypassed

default boolean isMultifactorAuthenticationBypassed(org.apereo.cas.authentication.Authentication authentication,
 String requestedContext)

Indicates whether the authentication attempt carries information that would signal a bypassed attempt.

Parameters:

authentication - the authentication

requestedContext - the requested context

Returns:

true/false

forgetBypass

default void forgetBypass(org.apereo.cas.authentication.Authentication authentication)

Method will remove any previous bypass set in the authentication.

Parameters:

authentication - - the authentication

rememberBypass

default void rememberBypass(org.apereo.cas.authentication.Authentication authentication,
 MultifactorAuthenticationProvider provider)

Method will set the bypass into the authentication.

Parameters:

authentication - - the authentication

provider - - the provider

getOrder

default int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

getProviderId

String getProviderId()

Gets provider id of this bypass evaluator.

Returns:

the id

getId

String getId()

Gets id.

Returns:

the id

size

default int size()

Size.

Returns:

the int

isEmpty

default boolean isEmpty()

Is empty?.

Returns:

true/false

belongsToMultifactorAuthenticationProvider

Optional<MultifactorAuthenticationProviderBypassEvaluator> belongsToMultifactorAuthenticationProvider(String providerId)

Indicate whether this bypass belongs to given multifactor authentication provider.

Parameters:

providerId - the provider id

Returns:

the provider if a match, otherwise, empty.