org.keycloak.federation.sssd

Class SSSDFederationProvider

java.lang.Object

org.keycloak.federation.sssd.SSSDFederationProvider

All Implemented Interfaces:

CredentialInputUpdater, CredentialInputValidator, UserFederationProvider, Provider

public class SSSDFederationProvider
extends Object
implements UserFederationProvider

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.models.UserFederationProvider

UserFederationProvider.EditMode

Field Summary

Fields

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

Fields inherited from interface org.keycloak.models.UserFederationProvider

EMAIL, FIRST_NAME, LAST_NAME, USERNAME

Constructor Summary

Constructors

Constructor and Description
SSSDFederationProvider(KeycloakSession session, UserFederationProviderModel 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
List<UserModel>	getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
Set<String>	getSupportedCredentialTypes()
UserModel	getUserByEmail(RealmModel realm, String email)
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)
UserModel	register(RealmModel realm, UserModel user)
boolean	removeUser(RealmModel realm, UserModel user)
List<UserModel>	searchByAttributes(Map<String,String> attributes, RealmModel realm, int maxResults)
boolean	supportsCredentialType(String credentialType)
boolean	synchronizeRegistrations()
boolean	updateCredential(RealmModel realm, UserModel user, CredentialInput input)
UserModel	validateAndProxy(RealmModel realm, UserModel local)
CredentialValidationOutput	validCredentials(RealmModel realm, UserCredentialModel credential)

Methods inherited from class java.lang.Object

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

Field Detail

supportedCredentialTypes

protected static final Set<String> supportedCredentialTypes

session

protected KeycloakSession session

model

protected UserFederationProviderModel model

Constructor Detail

SSSDFederationProvider

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

Method Detail

getUserByUsername

public UserModel getUserByUsername(RealmModel realm,
                                   String username)

Specified by:

getUserByUsername in interface UserFederationProvider

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)

getUserByEmail

public UserModel getUserByEmail(RealmModel realm,
                                String email)

Specified by:

getUserByEmail in interface UserFederationProvider

searchByAttributes

public List<UserModel> searchByAttributes(Map<String,String> attributes,
                                          RealmModel realm,
                                          int maxResults)

Specified by:

searchByAttributes in interface UserFederationProvider

getGroupMembers

public List<UserModel> getGroupMembers(RealmModel realm,
                                       GroupModel group,
                                       int firstResult,
                                       int maxResults)

Specified by:

getGroupMembers in interface UserFederationProvider

preRemove

public void preRemove(RealmModel realm)

Specified by:

preRemove in interface UserFederationProvider

preRemove

public void preRemove(RealmModel realm,
                      RoleModel role)

Specified by:

preRemove in interface UserFederationProvider

preRemove

public void preRemove(RealmModel realm,
                      GroupModel group)

Specified by:

preRemove in interface UserFederationProvider

isValid

public boolean isValid(RealmModel realm,
                       UserModel local)

Specified by:

isValid in interface UserFederationProvider

getSupportedCredentialTypes

public Set<String> getSupportedCredentialTypes()

Specified by:

getSupportedCredentialTypes in interface UserFederationProvider

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

isValid

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

Specified by:

isValid in interface CredentialInputValidator

validCredentials

public CredentialValidationOutput validCredentials(RealmModel realm,
                                                   UserCredentialModel credential)

Specified by:

validCredentials in interface UserFederationProvider

validateAndProxy

public UserModel validateAndProxy(RealmModel realm,
                                  UserModel local)

Specified by:

validateAndProxy in interface UserFederationProvider

synchronizeRegistrations

public boolean synchronizeRegistrations()

Specified by:

synchronizeRegistrations in interface UserFederationProvider

register

public UserModel register(RealmModel realm,
                          UserModel user)

Specified by:

register in interface UserFederationProvider

removeUser

public boolean removeUser(RealmModel realm,
                          UserModel user)

Specified by:

removeUser in interface UserFederationProvider

close

public void close()

Specified by:

close in interface UserFederationProvider

Specified by:

close in interface Provider