Package org.apereo.cas.authentication

Interface MultifactorAuthenticationProvider

All Superinterfaces:
org.springframework.core.Ordered, Serializable
All Known Subinterfaces:
ChainingMultifactorAuthenticationProvider
public interface MultifactorAuthenticationProvider extends 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
    Description
    MultifactorAuthenticationProviderBypassEvaluator
    getBypassEvaluator()
    Returns the configured bypass provider for this MFA provider.
    MultifactorAuthenticationDeviceManager
    getDeviceManager()
    Returns an instance of the device manager for this provider that is able to determine and track user registered devices.
    org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes
    getFailureMode()
    This method will return the failure mode for the provider.
    MultifactorAuthenticationFailureModeEvaluator
    getFailureModeEvaluator()
    Returns the configured failure mode evaluator for this MFA provider.
    String
    getFriendlyName()
    Gets the friendly-name for this provider.
    String
    getId()
    Gets id for this provider.
    boolean
    isAvailable(org.apereo.cas.services.RegisteredService service)
    Ensure the provider is available.
    boolean
    matches(String identifier)
    Does provider match/support this identifier? The identifier passed may be formed as a regular expression.

    Methods inherited from interface org.springframework.core.Ordered

    getOrder

  • Method Details

    • isAvailable

      boolean isAvailable(org.apereo.cas.services.RegisteredService service) throws org.apereo.cas.authentication.AuthenticationException
      Ensure the provider is available.
      Parameters:
      service - - the service
      Returns:
      true /false flag once verification is successful.
      Throws:
      org.apereo.cas.authentication.AuthenticationException - the authentication exception

    • getBypassEvaluator

      MultifactorAuthenticationProviderBypassEvaluator getBypassEvaluator()
      Returns the configured bypass provider for this MFA provider.
      Returns:
      - the bypass evaluator

    • getFailureModeEvaluator

      MultifactorAuthenticationFailureModeEvaluator getFailureModeEvaluator()
      Returns the configured failure mode evaluator for this MFA provider.
      Returns:
      the failuremode evaluator

    • getDeviceManager

      MultifactorAuthenticationDeviceManager getDeviceManager()
      Returns an instance of the device manager for this provider that is able to determine and track user registered devices.
      Returns:
      MFA device manager instance

    • getId

      String getId()
      Gets id for this provider.
      Returns:
      the id

    • getFriendlyName

      String getFriendlyName()
      Gets the friendly-name for this provider.
      Returns:
      the name

    • matches

      boolean matches(String identifier)
      Does provider match/support this identifier? The identifier passed may be formed as a regular expression.
      Parameters:
      identifier - the identifier
      Returns:
      true/false

    • getFailureMode

      org.apereo.cas.configuration.model.support.mfa.BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes getFailureMode()
      This method will return the failure mode for the provider.
      Returns:
      the FailureMode