org.keycloak.federation.sssd

Class SSSDFederationProvider

java.lang.Object

org.keycloak.federation.sssd.SSSDFederationProvider

All Implemented Interfaces:

CredentialInputUpdater, CredentialInputUpdater.Streams, CredentialInputValidator, Provider, ImportedUserValidation, UserLookupProvider, UserLookupProvider.Streams, UserStorageProvider

public class SSSDFederationProvider
extends Object
implements UserStorageProvider, UserLookupProvider.Streams, CredentialInputUpdater.Streams, CredentialInputValidator, ImportedUserValidation

SPI provider implementation to retrieve data from SSSD and authenticate against PAM

Version:

$Revision: 1 $

Author:

Bruno Oliveira

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.storage.UserStorageProvider

UserStorageProvider.EditMode

Nested classes/interfaces inherited from interface org.keycloak.storage.user.UserLookupProvider

UserLookupProvider.Streams

Nested classes/interfaces inherited from interface org.keycloak.credential.CredentialInputUpdater

CredentialInputUpdater.Streams

Field Summary

Fields

Modifier and Type	Field and Description
protected UserStorageProviderModel	model
protected KeycloakSession	session
protected static Set<String>	supportedCredentialTypes

Constructor Summary

Constructors

Constructor and Description
SSSDFederationProvider(KeycloakSession session, UserStorageProviderModel model, SSSDFederationProviderFactory sssdFederationProviderFactory)

Method Summary

Modifier and Type	Method and Description
void	close()
void	disableCredentialType(RealmModel realm, UserModel user, String credentialType)
protected UserModel	findOrCreateAuthenticatedUser(RealmModel realm, String username) Called after successful authentication
Stream<String>	getDisableableCredentialTypesStream(RealmModel realm, UserModel user)
UserModel	getUserByEmail(RealmModel realm, String email)
UserModel	getUserById(RealmModel realm, String id)
UserModel	getUserByUsername(RealmModel realm, String username)
protected UserModel	importUserToKeycloak(RealmModel realm, String username)
boolean	isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	isValid(RealmModel realm, UserModel local)
boolean	isValid(RealmModel realm, UserModel user, CredentialInput input)
void	preRemove(RealmModel realm)
void	preRemove(RealmModel realm, GroupModel group)
void	preRemove(RealmModel realm, RoleModel role)
boolean	supportsCredentialType(String credentialType)
boolean	updateCredential(RealmModel realm, UserModel user, CredentialInput input)
UserModel	validate(RealmModel realm, UserModel user)
UserModel	validateAndProxy(RealmModel realm, UserModel local)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.storage.user.UserLookupProvider.Streams

getUserByEmail, getUserById, getUserByUsername

Methods inherited from interface org.keycloak.credential.CredentialInputUpdater.Streams

getDisableableCredentialTypes

Field Detail

supportedCredentialTypes

protected static final Set<String> supportedCredentialTypes

session

protected KeycloakSession session

model

protected UserStorageProviderModel model

Constructor Detail

SSSDFederationProvider

public SSSDFederationProvider(KeycloakSession session,
                              UserStorageProviderModel model,
                              SSSDFederationProviderFactory sssdFederationProviderFactory)

Method Detail

getUserByUsername

public UserModel getUserByUsername(RealmModel realm,
                                   String username)

Specified by:

getUserByUsername in interface UserLookupProvider

Specified by:

getUserByUsername in interface UserLookupProvider.Streams

validate

public UserModel validate(RealmModel realm,
                          UserModel user)

Specified by:

validate in interface ImportedUserValidation

findOrCreateAuthenticatedUser

protected UserModel findOrCreateAuthenticatedUser(RealmModel realm,
                                                  String username)

Called after successful authentication

Parameters:

realm - realm

username - username without realm prefix

Returns:

user if found or successfully created. Null if user with same username already exists, but is not linked to this provider

importUserToKeycloak

protected UserModel importUserToKeycloak(RealmModel realm,
                                         String username)

getUserById

public UserModel getUserById(RealmModel realm,
                             String id)

Specified by:

getUserById in interface UserLookupProvider

Specified by:

getUserById in interface UserLookupProvider.Streams

getUserByEmail

public UserModel getUserByEmail(RealmModel realm,
                                String email)

Specified by:

getUserByEmail in interface UserLookupProvider

Specified by:

getUserByEmail in interface UserLookupProvider.Streams

preRemove

public void preRemove(RealmModel realm)

Specified by:

preRemove in interface UserStorageProvider

preRemove

public void preRemove(RealmModel realm,
                      RoleModel role)

Specified by:

preRemove in interface UserStorageProvider

preRemove

public void preRemove(RealmModel realm,
                      GroupModel group)

Specified by:

preRemove in interface UserStorageProvider

isValid

public boolean isValid(RealmModel realm,
                       UserModel local)

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

isValid

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

Specified by:

isValid in interface CredentialInputValidator

validateAndProxy

public UserModel validateAndProxy(RealmModel realm,
                                  UserModel local)

close

public void close()

Specified by:

close in interface Provider

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)

Specified by:

getDisableableCredentialTypesStream in interface CredentialInputUpdater

Specified by:

getDisableableCredentialTypesStream in interface CredentialInputUpdater.Streams