Package org.keycloak.broker.saml

Class SAMLIdentityProvider

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProvider<SAMLIdentityProviderConfig>

org.keycloak.broker.saml.SAMLIdentityProvider

All Implemented Interfaces:

IdentityProvider<SAMLIdentityProviderConfig>, Provider

public class SAMLIdentityProvider
extends AbstractIdentityProvider<SAMLIdentityProviderConfig>

Author:

Pedro Igor

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.broker.provider.IdentityProvider

IdentityProvider.AuthenticationCallback

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.jboss.logging.Logger	logger

Fields inherited from class org.keycloak.broker.provider.AbstractIdentityProvider

ACCOUNT_LINK_URL, BROKER_REGISTERED_NEW_USER, session, UPDATE_PROFILE_EMAIL_CHANGED, UPDATE_PROFILE_USERNAME_CHANGED

Fields inherited from interface org.keycloak.broker.provider.IdentityProvider

EXTERNAL_IDENTITY_PROVIDER, FEDERATED_ACCESS_TOKEN

Constructor Summary

Constructors

Constructor	Description
SAMLIdentityProvider(KeycloakSession session, SAMLIdentityProviderConfig config, DestinationValidator destinationValidator)

Method Summary

Modifier and Type	Method	Description
void	authenticationFinished(AuthenticationSessionModel authSession, BrokeredIdentityContext context)
void	backchannelLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)
protected ArtifactResolveType	buildArtifactResolveRequest(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String artifactServiceUrl, String artifact, SamlProtocolExtensionsAwareBuilder.NodeGenerator... extensions)
protected LogoutRequestType	buildLogoutRequest(UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String singleLogoutServiceUrl, SamlProtocolExtensionsAwareBuilder.NodeGenerator... extensions)
Object	callback(RealmModel realm, IdentityProvider.AuthenticationCallback callback, EventBuilder event)
jakarta.ws.rs.core.Response	export(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format)
IdentityProviderDataMarshaller	getMarshaller()
SignatureAlgorithm	getSignatureAlgorithm()
jakarta.ws.rs.core.Response	keycloakInitiatedBrowserLogout(KeycloakSession session, UserSessionModel userSession, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm)
jakarta.ws.rs.core.Response	performLogin(AuthenticationRequest request)
boolean	reloadKeys()
SAMLDocumentHolder	resolveArtifact(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String relayState, String samlArt)
jakarta.ws.rs.core.Response	retrieveToken(KeycloakSession session, FederatedIdentityModel identity)
boolean	supportsLongStateParameter()

Methods inherited from class org.keycloak.broker.provider.AbstractIdentityProvider

close, exchangeErrorResponse, exchangeNotLinked, exchangeNotLinkedNoStore, exchangeNotSupported, exchangeTokenExpired, exchangeUnsupportedRequiredType, getConfig, getLinkingUrl, importNewUser, preprocessFederatedIdentity, setEmailVerified, updateBrokeredUser, updateEmail

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.broker.provider.IdentityProvider

isMapperSupported

Field Details

logger

protected static final org.jboss.logging.Logger logger

Constructor Details

SAMLIdentityProvider

public SAMLIdentityProvider(KeycloakSession session,
 SAMLIdentityProviderConfig config,
 DestinationValidator destinationValidator)

Method Details

callback

public Object callback(RealmModel realm,
 IdentityProvider.AuthenticationCallback callback,
 EventBuilder event)

Specified by:

callback in interface IdentityProvider<SAMLIdentityProviderConfig>

Overrides:

callback in class AbstractIdentityProvider<SAMLIdentityProviderConfig>

performLogin

public jakarta.ws.rs.core.Response performLogin(AuthenticationRequest request)

Specified by:

performLogin in interface IdentityProvider<SAMLIdentityProviderConfig>

Overrides:

performLogin in class AbstractIdentityProvider<SAMLIdentityProviderConfig>

authenticationFinished

public void authenticationFinished(AuthenticationSessionModel authSession,
 BrokeredIdentityContext context)

Specified by:

authenticationFinished in interface IdentityProvider<SAMLIdentityProviderConfig>

Overrides:

authenticationFinished in class AbstractIdentityProvider<SAMLIdentityProviderConfig>

retrieveToken

public jakarta.ws.rs.core.Response retrieveToken(KeycloakSession session,
 FederatedIdentityModel identity)

backchannelLogout

public void backchannelLogout(KeycloakSession session,
 UserSessionModel userSession,
 jakarta.ws.rs.core.UriInfo uriInfo,
 RealmModel realm)

Specified by:

backchannelLogout in interface IdentityProvider<SAMLIdentityProviderConfig>

Overrides:

backchannelLogout in class AbstractIdentityProvider<SAMLIdentityProviderConfig>

keycloakInitiatedBrowserLogout

public jakarta.ws.rs.core.Response keycloakInitiatedBrowserLogout(KeycloakSession session,
 UserSessionModel userSession,
 jakarta.ws.rs.core.UriInfo uriInfo,
 RealmModel realm)

Specified by:

keycloakInitiatedBrowserLogout in interface IdentityProvider<SAMLIdentityProviderConfig>

Overrides:

keycloakInitiatedBrowserLogout in class AbstractIdentityProvider<SAMLIdentityProviderConfig>

buildLogoutRequest

protected LogoutRequestType buildLogoutRequest(UserSessionModel userSession,
 jakarta.ws.rs.core.UriInfo uriInfo,
 RealmModel realm,
 String singleLogoutServiceUrl,
 SamlProtocolExtensionsAwareBuilder.NodeGenerator... extensions)
                                        throws ConfigurationException

Throws:

ConfigurationException

export

public jakarta.ws.rs.core.Response export(jakarta.ws.rs.core.UriInfo uriInfo,
 RealmModel realm,
 String format)

Specified by:

export in interface IdentityProvider<SAMLIdentityProviderConfig>

Overrides:

export in class AbstractIdentityProvider<SAMLIdentityProviderConfig>

getSignatureAlgorithm

public SignatureAlgorithm getSignatureAlgorithm()

getMarshaller

public IdentityProviderDataMarshaller getMarshaller()

Specified by:

getMarshaller in interface IdentityProvider<SAMLIdentityProviderConfig>

Overrides:

getMarshaller in class AbstractIdentityProvider<SAMLIdentityProviderConfig>

reloadKeys

public boolean reloadKeys()

supportsLongStateParameter

public boolean supportsLongStateParameter()

resolveArtifact

public SAMLDocumentHolder resolveArtifact(KeycloakSession session,
 jakarta.ws.rs.core.UriInfo uriInfo,
 RealmModel realm,
 String relayState,
 String samlArt)

buildArtifactResolveRequest

protected ArtifactResolveType buildArtifactResolveRequest(jakarta.ws.rs.core.UriInfo uriInfo,
 RealmModel realm,
 String artifactServiceUrl,
 String artifact,
 SamlProtocolExtensionsAwareBuilder.NodeGenerator... extensions)
                                                   throws ConfigurationException

Throws:

ConfigurationException