Package org.keycloak.authentication.requiredactions

Class RecoveryAuthnCodesAction

java.lang.Object
org.keycloak.authentication.requiredactions.RecoveryAuthnCodesAction
All Implemented Interfaces:
org.keycloak.authentication.CredentialAction, org.keycloak.authentication.CredentialRegistrator, org.keycloak.authentication.RequiredActionFactory, org.keycloak.authentication.RequiredActionProvider, org.keycloak.provider.EnvironmentDependentProviderFactory, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>
public class RecoveryAuthnCodesAction extends Object implements org.keycloak.authentication.RequiredActionProvider, org.keycloak.authentication.RequiredActionFactory, org.keycloak.provider.EnvironmentDependentProviderFactory, org.keycloak.authentication.CredentialRegistrator

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROVIDER_ID
     
    static final int
    RECOVERY_CODES_WARNING_THRESHOLD_DEFAULT
     
    static final String
    WARNING_THRESHOLD
     

    Fields inherited from interface org.keycloak.authentication.RequiredActionFactory

    MAX_AUTH_AGE_CONFIG_PROPERTIES

  • Constructor Summary

    Constructors
    Constructor
    Description
    RecoveryAuthnCodesAction()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    org.keycloak.authentication.RequiredActionProvider
    create(org.keycloak.models.KeycloakSession session)
     
    protected org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel
    createFromValues(List<String> generatedCodes, Long generatedAtTime, String generatedUserLabel)
     
    void
    evaluateTriggers(org.keycloak.authentication.RequiredActionContext context)
     
    List<org.keycloak.provider.ProviderConfigProperty>
    getConfigMetadata()
     
    String
    getCredentialType(org.keycloak.models.KeycloakSession session, org.keycloak.sessions.AuthenticationSessionModel authenticationSession)
     
    String
    getDisplayText()
     
    String
    getId()
     
    void
    init(org.keycloak.Config.Scope config)
     
    org.keycloak.authentication.InitiatedActionSupport
    initiatedActionSupport()
     
    boolean
    isSupported(org.keycloak.Config.Scope config)
     
    void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     
    void
    processAction(org.keycloak.authentication.RequiredActionContext reqActionContext)
     
    void
    requiredActionChallenge(org.keycloak.authentication.RequiredActionContext context)
     
    void
    validateConfig(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.RequiredActionConfigModel model)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn, order

    Methods inherited from interface org.keycloak.authentication.RequiredActionFactory

    isConfigurable, isOneTimeAction

    Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

    getMaxAuthAge, getMaxAuthAge, initiatedActionCanceled

  • Field Details

    • PROVIDER_ID

      public static final String PROVIDER_ID

    • WARNING_THRESHOLD

      public static final String WARNING_THRESHOLD
      See Also:

    • RECOVERY_CODES_WARNING_THRESHOLD_DEFAULT

      public static final int RECOVERY_CODES_WARNING_THRESHOLD_DEFAULT
      See Also:

  • Constructor Details

    • RecoveryAuthnCodesAction

      public RecoveryAuthnCodesAction()

  • Method Details

    • getId

      public String getId()
      Specified by:
      getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • getCredentialType

      public String getCredentialType(org.keycloak.models.KeycloakSession session, org.keycloak.sessions.AuthenticationSessionModel authenticationSession)
      Specified by:
      getCredentialType in interface org.keycloak.authentication.CredentialAction

    • getDisplayText

      public String getDisplayText()
      Specified by:
      getDisplayText in interface org.keycloak.authentication.RequiredActionFactory

    • create

      public org.keycloak.authentication.RequiredActionProvider create(org.keycloak.models.KeycloakSession session)
      Specified by:
      create in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • init

      public void init(org.keycloak.Config.Scope config)
      Specified by:
      init in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • postInit

      public void postInit(org.keycloak.models.KeycloakSessionFactory factory)
      Specified by:
      postInit in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • initiatedActionSupport

      public org.keycloak.authentication.InitiatedActionSupport initiatedActionSupport()
      Specified by:
      initiatedActionSupport in interface org.keycloak.authentication.RequiredActionProvider

    • evaluateTriggers

      public void evaluateTriggers(org.keycloak.authentication.RequiredActionContext context)
      Specified by:
      evaluateTriggers in interface org.keycloak.authentication.RequiredActionProvider

    • requiredActionChallenge

      public void requiredActionChallenge(org.keycloak.authentication.RequiredActionContext context)
      Specified by:
      requiredActionChallenge in interface org.keycloak.authentication.RequiredActionProvider

    • processAction

      public void processAction(org.keycloak.authentication.RequiredActionContext reqActionContext)
      Specified by:
      processAction in interface org.keycloak.authentication.RequiredActionProvider

    • createFromValues

      protected org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel createFromValues(List<String> generatedCodes, Long generatedAtTime, String generatedUserLabel)

    • close

      public void close()
      Specified by:
      close in interface org.keycloak.provider.Provider
      Specified by:
      close in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • isSupported

      public boolean isSupported(org.keycloak.Config.Scope config)
      Specified by:
      isSupported in interface org.keycloak.provider.EnvironmentDependentProviderFactory

    • getConfigMetadata

      public List<org.keycloak.provider.ProviderConfigProperty> getConfigMetadata()
      Specified by:
      getConfigMetadata in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>
      Specified by:
      getConfigMetadata in interface org.keycloak.authentication.RequiredActionFactory

    • validateConfig

      public void validateConfig(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.RequiredActionConfigModel model)
      Specified by:
      validateConfig in interface org.keycloak.authentication.RequiredActionFactory