Package org.keycloak.credential

Class WebAuthnCredentialProvider

java.lang.Object

org.keycloak.credential.WebAuthnCredentialProvider

All Implemented Interfaces:

CredentialInputValidator, CredentialProvider<WebAuthnCredentialModel>, Provider

Direct Known Subclasses:

WebAuthnPasswordlessCredentialProvider

public class WebAuthnCredentialProvider
extends Object
implements CredentialProvider<WebAuthnCredentialModel>, CredentialInputValidator

Credential provider for WebAuthn 2-factor credential of the user

Constructor Summary

Constructors

Constructor	Description
WebAuthnCredentialProvider(KeycloakSession session, com.webauthn4j.converter.util.ObjectConverter objectConverter)

Method Summary

Modifier and Type	Method	Description
CredentialModel	createCredential(RealmModel realm, UserModel user, WebAuthnCredentialModel credentialModel)
boolean	deleteCredential(RealmModel realm, UserModel user, String credentialId)
void	dumpCredentialModel(WebAuthnCredentialModel credential, WebAuthnCredentialModelInput auth)
WebAuthnCredentialModel	getCredentialFromModel(CredentialModel model)
WebAuthnCredentialModel	getCredentialModelFromCredentialInput(CredentialInput input, String userLabel)	Convert WebAuthn credential input to the model, which can be saved in the persistent storage (DB)
CredentialTypeMetadata	getCredentialTypeMetadata(CredentialTypeMetadataContext metadataContext)
protected KeycloakSession	getKeycloakSession()
String	getType()
boolean	isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	isValid(RealmModel realm, UserModel user, CredentialInput input)	Tests whether a credential is valid
boolean	supportsCredentialType(String credentialType)

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, getCredentialMetadata, getDefaultCredential

Constructor Detail

WebAuthnCredentialProvider

public WebAuthnCredentialProvider(KeycloakSession session,
                                  com.webauthn4j.converter.util.ObjectConverter objectConverter)

Method Detail

createCredential

public CredentialModel createCredential(RealmModel realm,
                                        UserModel user,
                                        WebAuthnCredentialModel credentialModel)

Specified by:

createCredential in interface CredentialProvider<WebAuthnCredentialModel>

deleteCredential

public boolean deleteCredential(RealmModel realm,
                                UserModel user,
                                String credentialId)

Specified by:

deleteCredential in interface CredentialProvider<WebAuthnCredentialModel>

getCredentialFromModel

public WebAuthnCredentialModel getCredentialFromModel(CredentialModel model)

Specified by:

getCredentialFromModel in interface CredentialProvider<WebAuthnCredentialModel>

getCredentialModelFromCredentialInput

public WebAuthnCredentialModel getCredentialModelFromCredentialInput(CredentialInput input,
                                                                     String userLabel)

Convert WebAuthn credential input to the model, which can be saved in the persistent storage (DB)

Parameters:

input - should be typically WebAuthnCredentialModelInput

userLabel - label for the credential

supportsCredentialType

public boolean supportsCredentialType(String credentialType)

Specified by:

supportsCredentialType in interface CredentialInputValidator

isConfiguredFor

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

Specified by:

isConfiguredFor in interface CredentialInputValidator

isValid

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

Description copied from interface: CredentialInputValidator

Tests whether a credential is valid

Specified by:

isValid in interface CredentialInputValidator

Parameters:

realm - The realm in which to which the credential belongs to

user - The user for which to test the credential

input - the credential details to verify

Returns:

true if the passed secret is correct

getType

public String getType()

Specified by:

getType in interface CredentialProvider<WebAuthnCredentialModel>

dumpCredentialModel

public void dumpCredentialModel(WebAuthnCredentialModel credential,
                                WebAuthnCredentialModelInput auth)

getCredentialTypeMetadata

public CredentialTypeMetadata getCredentialTypeMetadata(CredentialTypeMetadataContext metadataContext)

Specified by:

getCredentialTypeMetadata in interface CredentialProvider<WebAuthnCredentialModel>

getKeycloakSession

protected KeycloakSession getKeycloakSession()