Package org.pac4j.saml.client

Class SAML2Client

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient

org.pac4j.core.client.IndirectClient

org.pac4j.saml.client.SAML2Client

All Implemented Interfaces:

org.pac4j.core.client.Client

public class SAML2Client
extends org.pac4j.core.client.IndirectClient

This class is the client to authenticate and logout users with a SAML2 Identity Provider.

Since:

1.5.0

Author:

Michael Remond, Misagh Moayyed, Ruochao Zheng, Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
protected SAML2ResponseValidator	authnResponseValidator
protected SAML2Configuration	configuration
protected SAMLContextProvider	contextProvider
protected org.opensaml.saml.saml2.encryption.Decrypter	decrypter
protected SAML2MetadataResolver	identityProviderMetadataResolver
protected SAML2LogoutRequestMessageSender	logoutRequestMessageSender
protected SAML2LogoutValidator	logoutValidator
protected ReplayCacheProvider	replayCache
protected SAML2MetadataResolver	serviceProviderMetadataResolver
protected SignatureSigningParametersProvider	signatureSigningParametersProvider
protected SAML2SignatureTrustEngineProvider	signatureTrustEngineProvider
protected SOAPPipelineProvider	soapPipelineProvider
protected org.pac4j.core.util.generator.ValueGenerator	stateGenerator
protected SAML2WebSSOMessageSender	webSsoMessageSender

Fields inherited from class org.pac4j.core.client.IndirectClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver

Fields inherited from class org.pac4j.core.client.BaseClient

logger, saveProfileInSession

Constructor Summary

Constructors

Constructor	Description
SAML2Client(SAML2Configuration configuration)

Method Summary

Modifier and Type	Method	Description
final String	getIdentityProviderResolvedEntityId()
final String	getServiceProviderResolvedEntityId()
protected void	initAuthenticator(boolean forceReinit)
protected void	initCredentialExtractor(boolean forceReinit)
protected void	initDecrypter(boolean forceReinit)
protected void	initIdentityProviderMetadataResolver(boolean forceReinit)
protected void	initLogoutActionBuilder(boolean forceReinit)
protected void	initLogoutProcessor(boolean forceReinit)
protected void	initLogoutRequestMessageSender(boolean forceReinit)
protected void	initRedirectActionBuilder(boolean forceReinit)
protected void	initSAMLContextProvider(boolean forceReinit)
protected void	initSAMLLogoutResponseValidator(boolean forceReinit)
protected void	initSAMLReplayCache(boolean forceReinit)
protected void	initSAMLResponseValidator(boolean forceReinit)
protected void	initServiceProviderMetadataResolver(boolean forceReinit)
protected void	initSignatureSigningParametersProvider(boolean forceReinit)
protected void	initSignatureTrustEngineProvider(boolean forceReinit)
protected void	initSOAPPipelineProvider(boolean forceReinit)
protected void	initStateGenerator(boolean forceReinit)
protected void	initWebSSOMessageSender(boolean forceReinit)
protected void	internalInit(boolean forceReinit)
void	notifySessionRenewal(org.pac4j.core.context.CallContext ctx, String oldSessionId)

Methods inherited from class org.pac4j.core.client.IndirectClient

afterInternalInit, beforeInternalInit, checkCredentials, computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getLogoutAction, getLogoutActionBuilder, getLogoutProcessor, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, initUrlResolvers, isCheckAuthenticationAttempt, isLogoutActionBuilderUndefined, newDefaultCallbackUrlResolver, processLogout, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setLogoutActionBuilderIfUndefined, setLogoutProcessor, setLogoutProcessorIfUndefined, setRedirectionActionBuilder, setRedirectionActionBuilderIfUndefined, setUrlResolver, toString

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, addAuthorizationGenerators, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, validateCredentials

Methods inherited from class org.pac4j.core.util.InitializableObject

getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, init, init, isInitialized, isInitializing, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize

Methods inherited from class java.lang.Object

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

Field Details

contextProvider

protected SAMLContextProvider contextProvider

signatureSigningParametersProvider

protected SignatureSigningParametersProvider signatureSigningParametersProvider

authnResponseValidator

protected SAML2ResponseValidator authnResponseValidator

logoutValidator

protected SAML2LogoutValidator logoutValidator

signatureTrustEngineProvider

protected SAML2SignatureTrustEngineProvider signatureTrustEngineProvider

identityProviderMetadataResolver

protected SAML2MetadataResolver identityProviderMetadataResolver

serviceProviderMetadataResolver

protected SAML2MetadataResolver serviceProviderMetadataResolver

decrypter

protected org.opensaml.saml.saml2.encryption.Decrypter decrypter

configuration

protected SAML2Configuration configuration

stateGenerator

protected org.pac4j.core.util.generator.ValueGenerator stateGenerator

replayCache

protected ReplayCacheProvider replayCache

soapPipelineProvider

protected SOAPPipelineProvider soapPipelineProvider

logoutRequestMessageSender

protected SAML2LogoutRequestMessageSender logoutRequestMessageSender

webSsoMessageSender

protected SAML2WebSSOMessageSender webSsoMessageSender

Constructor Details

SAML2Client

public SAML2Client(SAML2Configuration configuration)

Method Details

internalInit

protected void internalInit(boolean forceReinit)

Specified by:

internalInit in class org.pac4j.core.util.InitializableObject

initStateGenerator

protected void initStateGenerator(boolean forceReinit)

initWebSSOMessageSender

protected void initWebSSOMessageSender(boolean forceReinit)

initLogoutRequestMessageSender

protected void initLogoutRequestMessageSender(boolean forceReinit)

initLogoutActionBuilder

protected void initLogoutActionBuilder(boolean forceReinit)

initRedirectActionBuilder

protected void initRedirectActionBuilder(boolean forceReinit)

initCredentialExtractor

protected void initCredentialExtractor(boolean forceReinit)

initAuthenticator

protected void initAuthenticator(boolean forceReinit)

initLogoutProcessor

protected void initLogoutProcessor(boolean forceReinit)

initSOAPPipelineProvider

protected void initSOAPPipelineProvider(boolean forceReinit)

initSAMLLogoutResponseValidator

protected void initSAMLLogoutResponseValidator(boolean forceReinit)

initSAMLResponseValidator

protected void initSAMLResponseValidator(boolean forceReinit)

initSignatureTrustEngineProvider

protected void initSignatureTrustEngineProvider(boolean forceReinit)

initSAMLContextProvider

protected void initSAMLContextProvider(boolean forceReinit)

initServiceProviderMetadataResolver

protected void initServiceProviderMetadataResolver(boolean forceReinit)

initIdentityProviderMetadataResolver

protected void initIdentityProviderMetadataResolver(boolean forceReinit)

initDecrypter

protected void initDecrypter(boolean forceReinit)

initSignatureSigningParametersProvider

protected void initSignatureSigningParametersProvider(boolean forceReinit)

initSAMLReplayCache

protected void initSAMLReplayCache(boolean forceReinit)

notifySessionRenewal

public void notifySessionRenewal(org.pac4j.core.context.CallContext ctx,
 String oldSessionId)

Overrides:

notifySessionRenewal in class org.pac4j.core.client.BaseClient

getIdentityProviderResolvedEntityId

public final String getIdentityProviderResolvedEntityId()

getServiceProviderResolvedEntityId

public final String getServiceProviderResolvedEntityId()