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:

Closeable, AutoCloseable, org.pac4j.core.client.Client

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

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 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

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()	Constructor for SAML2Client.
SAML2Client(SAML2Configuration configuration)	Constructor for SAML2Client.

Method Summary

Modifier and Type	Method	Description
void	close()
void	destroy()	destroy.
final String	getIdentityProviderResolvedEntityId()	getIdentityProviderResolvedEntityId.
SAML2LogoutRequestMessageSender	getLogoutRequestMessageSender()	getLogoutRequestMessageSender.
final String	getServiceProviderResolvedEntityId()	getServiceProviderResolvedEntityId.
SAML2WebSSOMessageSender	getSSOMessageSender()	getSSOMessageSender.
protected void	initDecrypter()	initDecrypter.
protected void	initIdentityProviderMetadataResolver()	initIdentityProviderMetadataResolver.
protected void	initSAMLContextProvider()	initSAMLContextProvider.
protected void	initSAMLLogoutResponseValidator()	initSAMLLogoutResponseValidator.
protected void	initSAMLReplayCache()	initSAMLReplayCache.
protected void	initSAMLResponseValidator()	initSAMLResponseValidator.
protected void	initServiceProviderMetadataResolver()	initServiceProviderMetadataResolver.
protected void	initSignatureSigningParametersProvider()	initSignatureSigningParametersProvider.
protected void	initSignatureTrustEngineProvider()	initSignatureTrustEngineProvider.
protected void	initSOAPPipelineProvider()	initSOAPPipelineProvider.
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, isCheckAuthenticationAttempt, 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, isInitialized, 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

Constructor Details

SAML2Client

public SAML2Client()

Constructor for SAML2Client.

SAML2Client

public SAML2Client(SAML2Configuration configuration)

Constructor for SAML2Client.

Parameters:

configuration - a SAML2Configuration object

Method Details

internalInit

protected void internalInit(boolean forceReinit)

Specified by:

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

initSOAPPipelineProvider

protected void initSOAPPipelineProvider()

initSOAPPipelineProvider.

getLogoutRequestMessageSender

public SAML2LogoutRequestMessageSender getLogoutRequestMessageSender()

getLogoutRequestMessageSender.

Returns:

a SAML2LogoutRequestMessageSender object

getSSOMessageSender

public SAML2WebSSOMessageSender getSSOMessageSender()

getSSOMessageSender.

Returns:

a SAML2WebSSOMessageSender object

initSAMLLogoutResponseValidator

protected void initSAMLLogoutResponseValidator()

initSAMLLogoutResponseValidator.

initSAMLResponseValidator

protected void initSAMLResponseValidator()

initSAMLResponseValidator.

initSignatureTrustEngineProvider

protected void initSignatureTrustEngineProvider()

initSignatureTrustEngineProvider.

initSAMLContextProvider

protected void initSAMLContextProvider()

initSAMLContextProvider.

initServiceProviderMetadataResolver

protected void initServiceProviderMetadataResolver()

initServiceProviderMetadataResolver.

initIdentityProviderMetadataResolver

protected void initIdentityProviderMetadataResolver()

initIdentityProviderMetadataResolver.

initDecrypter

protected void initDecrypter()

initDecrypter.

initSignatureSigningParametersProvider

protected void initSignatureSigningParametersProvider()

initSignatureSigningParametersProvider.

initSAMLReplayCache

protected void initSAMLReplayCache()

initSAMLReplayCache.

destroy

public void destroy()

destroy.

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()

getIdentityProviderResolvedEntityId.

Returns:

a String object

getServiceProviderResolvedEntityId

public final String getServiceProviderResolvedEntityId()

getServiceProviderResolvedEntityId.

Returns:

a String object

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException