org.apereo.cas.services

Interface MultifactorAuthenticationProvider

All Superinterfaces:

org.springframework.core.Ordered, java.io.Serializable

All Known Subinterfaces:

DuoMultifactorAuthenticationProvider, VariegatedMultifactorAuthenticationProvider

All Known Implementing Classes:

AbstractMultifactorAuthenticationProvider, AuthyMultifactorAuthenticationProvider, AzureAuthenticatorMultifactorAuthenticationProvider, DefaultDuoMultifactorAuthenticationProvider, DefaultVariegatedMultifactorAuthenticationProvider, GoogleAuthenticatorMultifactorAuthenticationProvider, RadiusMultifactorAuthenticationProvider, SwivelMultifactorAuthenticationProvider, U2FMultifactorAuthenticationProvider, YubiKeyMultifactorAuthenticationProvider

public interface MultifactorAuthenticationProvider
extends java.io.Serializable, org.springframework.core.Ordered

This is MultifactorAuthenticationProvider that describes an external authentication entity/provider matched against a registered service. Providers may be given the ability to check authentication provider for availability before actually producing a relevant identifier.

Since:

5.0.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
default java.lang.String	createUniqueId() Creates a unique mark that identifies this provider instance.
RegisteredServiceMultifactorPolicy.FailureModes	failureMode() This method will return the failure mode for the provider.
MultifactorAuthenticationProviderBypass	getBypassEvaluator() Returns the configured bypass provider for this MFA provider.
java.lang.String	getFriendlyName() Gets the friendly-name for this provider.
java.lang.String	getId() Gets id for this provider.
boolean	isAvailable(RegisteredService service) Ensure the provider is available.
boolean	matches(java.lang.String identifier) Does provider match/support this identifier? The identifier passed may be formed as a regular expression.
default boolean	validateId(java.lang.String id) Validates that the passed mark was created by this provider.

Methods inherited from interface org.springframework.core.Ordered

getOrder

Method Detail

isAvailable

boolean isAvailable(RegisteredService service)
             throws AuthenticationException

Ensure the provider is available.

Parameters:

service - - the service

Returns:

true /false flag once verification is successful.

Throws:

AuthenticationException - the authentication exception

getBypassEvaluator

MultifactorAuthenticationProviderBypass getBypassEvaluator()

Returns the configured bypass provider for this MFA provider.

Returns:

- the bypass evaluator

getId

java.lang.String getId()

Gets id for this provider.

Returns:

the id

getFriendlyName

java.lang.String getFriendlyName()

Gets the friendly-name for this provider.

Returns:

the name

matches

boolean matches(java.lang.String identifier)

Does provider match/support this identifier? The identifier passed may be formed as a regular expression.

Parameters:

identifier - the identifier

Returns:

the boolean

failureMode

RegisteredServiceMultifactorPolicy.FailureModes failureMode()

This method will return the failure mode for the provider.

Returns:

the FailureMode

createUniqueId

default java.lang.String createUniqueId()

Creates a unique mark that identifies this provider instance.

Returns:

- the mark

validateId

default boolean validateId(java.lang.String id)

Validates that the passed mark was created by this provider.

Parameters:

id - - the id to validate

Returns:

- true if the mark was created by this provider