org.keycloak.federation.kerberos

Class KerberosFederationProvider

java.lang.Object

org.keycloak.federation.kerberos.KerberosFederationProvider

All Implemented Interfaces:

UserFederationProvider, Provider

public class KerberosFederationProvider
extends Object
implements UserFederationProvider

Author:

Marek Posolda

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 KerberosFederationProviderFactory	factory
static String	KERBEROS_PRINCIPAL
protected KerberosConfig	kerberosConfig
protected UserFederationProviderModel	model
protected KeycloakSession	session

Fields inherited from interface org.keycloak.models.UserFederationProvider

EMAIL, FIRST_NAME, LAST_NAME, USERNAME

Constructor Summary

Constructors

Constructor and Description
KerberosFederationProvider(KeycloakSession session, UserFederationProviderModel model, KerberosFederationProviderFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected UserModel	findOrCreateAuthenticatedUser(RealmModel realm, String username) Called after successful authentication
Set<String>	getSupportedCredentialTypes()
Set<String>	getSupportedCredentialTypes(UserModel local)
UserModel	getUserByEmail(RealmModel realm, String email)
UserModel	getUserByUsername(RealmModel realm, String username)
protected UserModel	importUserToKeycloak(RealmModel realm, String username)
boolean	isValid(RealmModel realm, UserModel local)
void	preRemove(RealmModel realm)
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	synchronizeRegistrations()
UserModel	validateAndProxy(RealmModel realm, UserModel local)
CredentialValidationOutput	validCredentials(RealmModel realm, UserCredentialModel credential)
boolean	validCredentials(RealmModel realm, UserModel user, List<UserCredentialModel> input)
boolean	validCredentials(RealmModel realm, UserModel user, UserCredentialModel... input)
protected boolean	validPassword(String username, String password)

Methods inherited from class java.lang.Object

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

Field Detail

KERBEROS_PRINCIPAL

public static final String KERBEROS_PRINCIPAL

See Also:

Constant Field Values

session

protected KeycloakSession session

model

protected UserFederationProviderModel model

kerberosConfig

protected KerberosConfig kerberosConfig

factory

protected KerberosFederationProviderFactory factory

Constructor Detail

KerberosFederationProvider

public KerberosFederationProvider(KeycloakSession session,
                          UserFederationProviderModel model,
                          KerberosFederationProviderFactory factory)

Method Detail

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

getUserByUsername

public UserModel getUserByUsername(RealmModel realm,
                          String username)

Specified by:

getUserByUsername in interface UserFederationProvider

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

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

isValid

public boolean isValid(RealmModel realm,
              UserModel local)

Specified by:

isValid in interface UserFederationProvider

getSupportedCredentialTypes

public Set<String> getSupportedCredentialTypes(UserModel local)

Specified by:

getSupportedCredentialTypes in interface UserFederationProvider

getSupportedCredentialTypes

public Set<String> getSupportedCredentialTypes()

Specified by:

getSupportedCredentialTypes in interface UserFederationProvider

validCredentials

public boolean validCredentials(RealmModel realm,
                       UserModel user,
                       List<UserCredentialModel> input)

Specified by:

validCredentials in interface UserFederationProvider

validPassword

protected boolean validPassword(String username,
                    String password)

validCredentials

public boolean validCredentials(RealmModel realm,
                       UserModel user,
                       UserCredentialModel... input)

Specified by:

validCredentials in interface UserFederationProvider

validCredentials

public CredentialValidationOutput validCredentials(RealmModel realm,
                                          UserCredentialModel credential)

Specified by:

validCredentials in interface UserFederationProvider

close

public void close()

Specified by:

close in interface UserFederationProvider

Specified by:

close in interface Provider

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)