Package org.keycloak.utils

Class CredentialHelper

java.lang.Object
org.keycloak.utils.CredentialHelper
public class CredentialHelper extends Object
used to set an execution a state based on type.
Version:
$Revision: 1 $
Author:
Bill Burke

  • Constructor Summary

    Constructors
    Constructor
    Description
    CredentialHelper()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    createOTPCredential(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String totpCode, org.keycloak.models.credential.OTPCredentialModel credentialModel)
    Create OTP credential either in userStorage or local storage (Keycloak DB)
    static void
    createRecoveryCodesCredential(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel credentialModel, List<String> generatedCodes)
    Create RecoveryCodes credential either in userStorage or local storage (Keycloak DB)
    static org.keycloak.representations.idm.CredentialRepresentation
    createUserStorageCredentialRepresentation(String credentialProviderType)
    Create "dummy" representation of the credential.
    static ConfigurableAuthenticatorFactory
    getConfigurableAuthenticatorFactory(org.keycloak.models.KeycloakSession session, String providerId)
     
    static void
    setOrReplaceAuthenticationRequirement(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String type, org.keycloak.models.AuthenticationExecutionModel.Requirement requirement, org.keycloak.models.AuthenticationExecutionModel.Requirement currentRequirement)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CredentialHelper

      public CredentialHelper()

  • Method Details

    • setOrReplaceAuthenticationRequirement

      public static void setOrReplaceAuthenticationRequirement(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String type, org.keycloak.models.AuthenticationExecutionModel.Requirement requirement, org.keycloak.models.AuthenticationExecutionModel.Requirement currentRequirement)

    • getConfigurableAuthenticatorFactory

      public static ConfigurableAuthenticatorFactory getConfigurableAuthenticatorFactory(org.keycloak.models.KeycloakSession session, String providerId)

    • createOTPCredential

      public static boolean createOTPCredential(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String totpCode, org.keycloak.models.credential.OTPCredentialModel credentialModel)
      Create OTP credential either in userStorage or local storage (Keycloak DB)
      Returns:
      true if credential was successfully created either in the user storage or Keycloak DB. False if error happened (EG. during HOTP validation)

    • createRecoveryCodesCredential

      public static void createRecoveryCodesCredential(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.credential.RecoveryAuthnCodesCredentialModel credentialModel, List<String> generatedCodes)
      Create RecoveryCodes credential either in userStorage or local storage (Keycloak DB)

    • createUserStorageCredentialRepresentation

      public static org.keycloak.representations.idm.CredentialRepresentation createUserStorageCredentialRepresentation(String credentialProviderType)
      Create "dummy" representation of the credential. Typically used when credential is provided by userStorage and we don't know further details about the credential besides the type
      Parameters:
      credentialProviderType -
      Returns:
      dummy credential