Interface MfaVerificationCheck

All Known Implementing Classes:
MfaTotpVerificationCheck

public interface MfaVerificationCheck
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    validate(RegisteredUser user, MfaAuthenticationToken authenticationToken)
    Validates the MFA Authentication credentials for the given RegisteredUser.
  • Method Details

    • validate

      boolean validate(RegisteredUser user, MfaAuthenticationToken authenticationToken) throws org.springframework.security.core.AuthenticationException
      Validates the MFA Authentication credentials for the given RegisteredUser. If the credentials are valid, return true. The user will be logged in and no further checks will take place. If this check is not applicable for this user, return false. The next check will then be tried. If the credentials are not valid (but this check *is* applicable for this user), throw an AuthenticationException.
      Parameters:
      user - User that is trying to log in.
      authenticationToken - Supplied authentication credentials (username, password, MFA token)
      Returns:
      Returns true if this authentication is valid
      Throws:
      org.springframework.security.core.AuthenticationException - if the supplied credentials are not valid