org.keycloak.credential

Class OTPCredentialProvider

java.lang.Object

org.keycloak.credential.OTPCredentialProvider

All Implemented Interfaces:

CredentialInputUpdater, CredentialInputValidator, CredentialProvider, OnUserCache, Provider

public class OTPCredentialProvider
extends Object
implements CredentialProvider, CredentialInputValidator, CredentialInputUpdater, OnUserCache

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected KeycloakSession	session

Constructor Summary

Constructors

Constructor and Description
OTPCredentialProvider(KeycloakSession session)

Method Summary

Modifier and Type	Method and Description
protected boolean	configuredForHOTP(RealmModel realm, UserModel user)
protected boolean	configuredForTOTP(RealmModel realm, UserModel user)
void	disableCredentialType(RealmModel realm, UserModel user, String credentialType)
protected List<CredentialModel>	getCachedCredentials(UserModel user, String type)
protected UserCredentialStore	getCredentialStore()
boolean	isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	isValid(RealmModel realm, UserModel user, CredentialInput input)
void	onCache(RealmModel realm, CachedUserModel user, UserModel delegate)
boolean	supportsCredentialType(String credentialType)
boolean	updateCredential(RealmModel realm, UserModel user, CredentialInput input)
static boolean	validOTP(RealmModel realm, String token, String secret)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.credential.CredentialProvider

close

Field Detail

session

protected KeycloakSession session

Constructor Detail

OTPCredentialProvider

public OTPCredentialProvider(KeycloakSession session)

Method Detail

getCachedCredentials

protected List<CredentialModel> getCachedCredentials(UserModel user,
                                                     String type)

getCredentialStore

protected UserCredentialStore getCredentialStore()

onCache

public void onCache(RealmModel realm,
                    CachedUserModel user,
                    UserModel delegate)

Specified by:

onCache in interface OnUserCache

updateCredential

public boolean updateCredential(RealmModel realm,
                                UserModel user,
                                CredentialInput input)

Specified by:

updateCredential in interface CredentialInputUpdater

disableCredentialType

public void disableCredentialType(RealmModel realm,
                                  UserModel user,
                                  String credentialType)

Specified by:

disableCredentialType in interface CredentialInputUpdater

supportsCredentialType

public boolean supportsCredentialType(String credentialType)

Specified by:

supportsCredentialType in interface CredentialInputUpdater

Specified by:

supportsCredentialType in interface CredentialInputValidator

isConfiguredFor

public boolean isConfiguredFor(RealmModel realm,
                               UserModel user,
                               String credentialType)

Specified by:

isConfiguredFor in interface CredentialInputValidator

configuredForHOTP

protected boolean configuredForHOTP(RealmModel realm,
                                    UserModel user)

configuredForTOTP

protected boolean configuredForTOTP(RealmModel realm,
                                    UserModel user)

validOTP

public static boolean validOTP(RealmModel realm,
                               String token,
                               String secret)

isValid

public boolean isValid(RealmModel realm,
                       UserModel user,
                       CredentialInput input)

Specified by:

isValid in interface CredentialInputValidator