Package org.keycloak.credential

Class PasswordCredentialProvider

java.lang.Object

org.keycloak.credential.PasswordCredentialProvider

All Implemented Interfaces:

CredentialInputUpdater, CredentialInputValidator, CredentialProvider<PasswordCredentialModel>, Provider

public class PasswordCredentialProvider
extends Object
implements CredentialProvider<PasswordCredentialModel>, CredentialInputUpdater, CredentialInputValidator

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected final KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
PasswordCredentialProvider(KeycloakSession session, io.micrometer.core.instrument.Meter.MeterProvider<io.micrometer.core.instrument.Counter> meterProvider, boolean metricsEnabled, boolean withRealmInMetric, boolean withAlgorithmInMetric, boolean withHashingStrengthInMetric, boolean withOutcomeInMetric)

Method Summary

Modifier and Type	Method	Description
boolean	createCredential(RealmModel realm, UserModel user, String password)
CredentialModel	createCredential(RealmModel realm, UserModel user, PasswordCredentialModel credentialModel)
boolean	deleteCredential(RealmModel realm, UserModel user, String credentialId)
void	disableCredentialType(RealmModel realm, UserModel user, String credentialType)
PasswordCredentialModel	getCredentialFromModel(CredentialModel model)
CredentialTypeMetadata	getCredentialTypeMetadata(CredentialTypeMetadataContext metadataContext)
Stream<String>	getDisableableCredentialTypesStream(RealmModel realm, UserModel user)	Obtains the set of credential types that can be disabled via disableCredentialType.
protected PasswordHashProvider	getHashProvider(PasswordPolicy policy)
PasswordCredentialModel	getPassword(RealmModel realm, UserModel user)
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)
boolean	updateCredential(RealmModel realm, UserModel user, CredentialInput input)

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.CredentialInputUpdater

getCredentials

Methods inherited from interface org.keycloak.credential.CredentialProvider

close, getCredentialForPresentationFromModel, getCredentialMetadata, getDefaultCredential, supportsCredentialType

Field Details

session

protected final KeycloakSession session

Constructor Details

PasswordCredentialProvider

public PasswordCredentialProvider(KeycloakSession session,
 io.micrometer.core.instrument.Meter.MeterProvider<io.micrometer.core.instrument.Counter> meterProvider,
 boolean metricsEnabled,
 boolean withRealmInMetric,
 boolean withAlgorithmInMetric,
 boolean withHashingStrengthInMetric,
 boolean withOutcomeInMetric)

Method Details

getPassword

public PasswordCredentialModel getPassword(RealmModel realm,
 UserModel user)

createCredential

public boolean createCredential(RealmModel realm,
 UserModel user,
 String password)

createCredential

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

Specified by:

createCredential in interface CredentialProvider<PasswordCredentialModel>

deleteCredential

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

Specified by:

deleteCredential in interface CredentialProvider<PasswordCredentialModel>

getCredentialFromModel

public PasswordCredentialModel getCredentialFromModel(CredentialModel model)

Specified by:

getCredentialFromModel in interface CredentialProvider<PasswordCredentialModel>

getHashProvider

protected PasswordHashProvider getHashProvider(PasswordPolicy policy)

supportsCredentialType

public boolean supportsCredentialType(String credentialType)

Specified by:

supportsCredentialType in interface CredentialInputUpdater

Specified by:

supportsCredentialType in interface CredentialInputValidator

Specified by:

supportsCredentialType in interface CredentialProvider<PasswordCredentialModel>

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

getDisableableCredentialTypesStream

public Stream<String> getDisableableCredentialTypesStream(RealmModel realm,
 UserModel user)

Description copied from interface: CredentialInputUpdater

Obtains the set of credential types that can be disabled via disableCredentialType.

Specified by:

getDisableableCredentialTypesStream in interface CredentialInputUpdater

Parameters:

realm - a reference to the realm.

user - the user whose credentials are being searched.

Returns:

a non-null Stream of credential types.

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

getCredentialTypeMetadata

public CredentialTypeMetadata getCredentialTypeMetadata(CredentialTypeMetadataContext metadataContext)

Specified by:

getCredentialTypeMetadata in interface CredentialProvider<PasswordCredentialModel>