Package org.keycloak.credential
Class WebAuthnCredentialProvider
- java.lang.Object
-
- org.keycloak.credential.WebAuthnCredentialProvider
-
- All Implemented Interfaces:
org.keycloak.credential.CredentialInputValidator
,org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.WebAuthnCredentialModel>
,org.keycloak.provider.Provider
- Direct Known Subclasses:
WebAuthnPasswordlessCredentialProvider
public class WebAuthnCredentialProvider extends Object implements org.keycloak.credential.CredentialProvider<org.keycloak.models.credential.WebAuthnCredentialModel>, org.keycloak.credential.CredentialInputValidator
Credential provider for WebAuthn 2-factor credential of the user
-
-
Constructor Summary
Constructors Constructor Description WebAuthnCredentialProvider(org.keycloak.models.KeycloakSession session, com.webauthn4j.converter.util.ObjectConverter objectConverter)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.keycloak.credential.CredentialModel
createCredential(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.credential.WebAuthnCredentialModel credentialModel)
boolean
deleteCredential(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialId)
void
dumpCredentialModel(org.keycloak.models.credential.WebAuthnCredentialModel credential, WebAuthnCredentialModelInput auth)
org.keycloak.models.credential.WebAuthnCredentialModel
getCredentialFromModel(org.keycloak.credential.CredentialModel model)
org.keycloak.models.credential.WebAuthnCredentialModel
getCredentialModelFromCredentialInput(org.keycloak.credential.CredentialInput input, String userLabel)
Convert WebAuthn credential input to the model, which can be saved in the persistent storage (DB)org.keycloak.credential.CredentialTypeMetadata
getCredentialTypeMetadata(org.keycloak.credential.CredentialTypeMetadataContext metadataContext)
protected org.keycloak.models.KeycloakSession
getKeycloakSession()
String
getType()
boolean
isConfiguredFor(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialType)
boolean
isValid(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.credential.CredentialInput input)
boolean
supportsCredentialType(String credentialType)
-
-
-
Method Detail
-
createCredential
public org.keycloak.credential.CredentialModel createCredential(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.models.credential.WebAuthnCredentialModel credentialModel)
- Specified by:
createCredential
in interfaceorg.keycloak.credential.CredentialProvider<org.keycloak.models.credential.WebAuthnCredentialModel>
-
deleteCredential
public boolean deleteCredential(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialId)
- Specified by:
deleteCredential
in interfaceorg.keycloak.credential.CredentialProvider<org.keycloak.models.credential.WebAuthnCredentialModel>
-
getCredentialFromModel
public org.keycloak.models.credential.WebAuthnCredentialModel getCredentialFromModel(org.keycloak.credential.CredentialModel model)
- Specified by:
getCredentialFromModel
in interfaceorg.keycloak.credential.CredentialProvider<org.keycloak.models.credential.WebAuthnCredentialModel>
-
getCredentialModelFromCredentialInput
public org.keycloak.models.credential.WebAuthnCredentialModel getCredentialModelFromCredentialInput(org.keycloak.credential.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 WebAuthnCredentialModelInputuserLabel
- label for the credential
-
supportsCredentialType
public boolean supportsCredentialType(String credentialType)
- Specified by:
supportsCredentialType
in interfaceorg.keycloak.credential.CredentialInputValidator
-
isConfiguredFor
public boolean isConfiguredFor(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, String credentialType)
- Specified by:
isConfiguredFor
in interfaceorg.keycloak.credential.CredentialInputValidator
-
isValid
public boolean isValid(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.credential.CredentialInput input)
- Specified by:
isValid
in interfaceorg.keycloak.credential.CredentialInputValidator
-
getType
public String getType()
- Specified by:
getType
in interfaceorg.keycloak.credential.CredentialProvider<org.keycloak.models.credential.WebAuthnCredentialModel>
-
dumpCredentialModel
public void dumpCredentialModel(org.keycloak.models.credential.WebAuthnCredentialModel credential, WebAuthnCredentialModelInput auth)
-
getCredentialTypeMetadata
public org.keycloak.credential.CredentialTypeMetadata getCredentialTypeMetadata(org.keycloak.credential.CredentialTypeMetadataContext metadataContext)
- Specified by:
getCredentialTypeMetadata
in interfaceorg.keycloak.credential.CredentialProvider<org.keycloak.models.credential.WebAuthnCredentialModel>
-
getKeycloakSession
protected org.keycloak.models.KeycloakSession getKeycloakSession()
-
-