Package org.keycloak.authentication.requiredactions

Class UpdateTotp

java.lang.Object
org.keycloak.authentication.requiredactions.UpdateTotp
All Implemented Interfaces:
org.keycloak.authentication.CredentialAction, org.keycloak.authentication.CredentialRegistrator, org.keycloak.authentication.RequiredActionFactory, org.keycloak.authentication.RequiredActionProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>
public class UpdateTotp extends Object implements org.keycloak.authentication.RequiredActionProvider, org.keycloak.authentication.RequiredActionFactory, org.keycloak.authentication.CredentialRegistrator
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ADD_RECOVERY_CODES
     

    Fields inherited from interface org.keycloak.authentication.RequiredActionFactory

    MAX_AUTH_AGE_CONFIG_PROPERTIES

  • Constructor Summary

    Constructors
    Constructor
    Description
    UpdateTotp()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    org.keycloak.authentication.RequiredActionProvider
    create(org.keycloak.models.KeycloakSession session)
     
    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()
     
    void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     
    void
    processAction(org.keycloak.authentication.RequiredActionContext context)
     
    void
    requiredActionChallenge(org.keycloak.authentication.RequiredActionContext context)
     
    protected boolean
    validateOTPCredential(org.keycloak.authentication.RequiredActionContext context, String token, org.keycloak.models.credential.OTPCredentialModel credentialModel, org.keycloak.models.OTPPolicy policy)
     

    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, validateConfig

    Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

    getMaxAuthAge, getMaxAuthAge, initiatedActionCanceled

  • Field Details

  • Constructor Details

    • UpdateTotp

      public UpdateTotp()

  • Method Details

    • 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 context)
      Specified by:
      processAction in interface org.keycloak.authentication.RequiredActionProvider

    • validateOTPCredential

      protected boolean validateOTPCredential(org.keycloak.authentication.RequiredActionContext context, String token, org.keycloak.models.credential.OTPCredentialModel credentialModel, org.keycloak.models.OTPPolicy policy)

    • 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>

    • 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

    • 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>

    • getDisplayText

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

    • 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