Package eu.rarogsoftware.rarog.platform.api.security.mfa

Interface MfaStore

All Known Implementing Classes:
SessionMfaStore
public interface MfaStore
Service stores state of MFA authentication for user that sent related request. It can be used by MFA methods to authenticate user or save MfaStatus Status is stored between the same user requests.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    authorize(jakarta.servlet.http.HttpServletRequest request)
    Stores MfaStatus.MFA_PASSED in store for provided request.
    Optional<MfaStatus>
    getStatus(jakarta.servlet.http.HttpServletRequest request)
    Gets current status of MFA authentication.
    void
    saveStatus(jakarta.servlet.http.HttpServletRequest request, MfaStatus status)
    Store custom MFA status.

  • Method Details

    • getStatus

      Optional<MfaStatus> getStatus(jakarta.servlet.http.HttpServletRequest request)
      Gets current status of MFA authentication. Useful to check if MFA is configured for current user or/and user bypassed MFA authentication.
      Parameters:
      request - related request (potentially current request)
      Returns:
      status of MFA authentication

    • authorize

      void authorize(jakarta.servlet.http.HttpServletRequest request)
      Stores MfaStatus.MFA_PASSED in store for provided request.
      Parameters:
      request - related request (potentially current request)

    • saveStatus

      void saveStatus(jakarta.servlet.http.HttpServletRequest request, MfaStatus status)
      Store custom MFA status. Useful to inform system that MFA requires reconfiguration.
      Parameters:
      request - related request (potentially current request)
      status - status to store for request