org.pac4j.saml.client

Class SAML2Client

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<C,U>

org.pac4j.core.client.IndirectClient<SAML2Credentials,SAML2Profile>

org.pac4j.saml.client.SAML2Client

All Implemented Interfaces:

Client<SAML2Credentials,SAML2Profile>

public class SAML2Client
extends IndirectClient<SAML2Credentials,SAML2Profile>

This class is the client to authenticate users with a SAML2 Identity Provider. This implementation relies on the Web Browser SSO profile with HTTP-POST binding. (http://docs.oasis-open.org/security/saml/v2.0/saml-profiles-2.0-os.pdf).

Since:

1.5.0

Author:

Michael Remond, Misagh Moayyed, Ruochao Zheng

Field Summary

Fields

Modifier and Type	Field and Description
protected SAML2ClientConfiguration	configuration
protected SAMLContextProvider	contextProvider
protected CredentialProvider	credentialProvider
protected org.opensaml.saml.saml2.encryption.Decrypter	decrypter
static java.lang.String	IDP_LOGOUT_REQUEST_EXTRA_PARAMETER
protected SAML2MetadataResolver	idpMetadataResolver
protected SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest>	profileHandler
protected SAML2ResponseValidator	responseValidator
protected SignatureSigningParametersProvider	signatureSigningParametersProvider
protected SAML2SignatureTrustEngineProvider	signatureTrustEngineProvider
protected SAML2MetadataResolver	spMetadataResolver
protected StateGenerator	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

Constructor Summary

Constructors

Constructor and Description
SAML2Client()
SAML2Client(SAML2ClientConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
protected void	clientInit()
SAML2ClientConfiguration	getConfiguration()
SAMLContextProvider	getContextProvider()
SAML2MetadataResolver	getIdentityProviderMetadataResolver()
java.lang.String	getIdentityProviderResolvedEntityId()
SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest>	getProfileHandler()
SAML2ResponseValidator	getResponseValidator()
SAML2MetadataResolver	getServiceProviderMetadataResolver()
java.lang.String	getServiceProviderResolvedEntityId()
SignatureSigningParametersProvider	getSignatureSigningParametersProvider()
SAML2SignatureTrustEngineProvider	getSignatureTrustEngineProvider()
StateGenerator	getStateGenerator()
protected org.opensaml.saml.metadata.resolver.ChainingMetadataResolver	initChainingMetadataResolver(org.opensaml.saml.metadata.resolver.MetadataResolver idpMetadataProvider, org.opensaml.saml.metadata.resolver.MetadataResolver spMetadataProvider)
protected void	initCredentialProvider()
protected void	initDecrypter()
protected org.opensaml.saml.metadata.resolver.MetadataResolver	initIdentityProviderMetadataResolver()
protected void	initSAMLContextProvider(org.opensaml.saml.metadata.resolver.MetadataResolver metadataManager)
protected void	initSAMLProfileHandler()
protected void	initSAMLResponseValidator()
protected org.opensaml.saml.metadata.resolver.MetadataResolver	initServiceProviderMetadataResolver()
protected void	initSignatureSigningParametersProvider()
protected void	initSignatureTrustEngineProvider(org.opensaml.saml.metadata.resolver.MetadataResolver metadataManager)
void	setConfiguration(SAML2ClientConfiguration configuration)
void	setStateGenerator(StateGenerator stateGenerator)

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

computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCredentials, getLogoutAction, getLogoutActionBuilder, getRedirectAction, getRedirectActionBuilder, getUrlResolver, internalInit, newDefaultCallbackUrlResolver, redirect, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setLogoutActionBuilder, setRedirectActionBuilder, setUrlResolver, toString

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

addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getUserProfile, notifySessionRenewal, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator

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

init

Methods inherited from class java.lang.Object

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

Field Detail

IDP_LOGOUT_REQUEST_EXTRA_PARAMETER

public static final java.lang.String IDP_LOGOUT_REQUEST_EXTRA_PARAMETER

See Also:

Constant Field Values

credentialProvider

protected CredentialProvider credentialProvider

contextProvider

protected SAMLContextProvider contextProvider

signatureSigningParametersProvider

protected SignatureSigningParametersProvider signatureSigningParametersProvider

profileHandler

protected SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest> profileHandler

responseValidator

protected SAML2ResponseValidator responseValidator

signatureTrustEngineProvider

protected SAML2SignatureTrustEngineProvider signatureTrustEngineProvider

idpMetadataResolver

protected SAML2MetadataResolver idpMetadataResolver

spMetadataResolver

protected SAML2MetadataResolver spMetadataResolver

decrypter

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

configuration

protected SAML2ClientConfiguration configuration

stateGenerator

protected StateGenerator stateGenerator

Constructor Detail

SAML2Client

public SAML2Client()

SAML2Client

public SAML2Client(SAML2ClientConfiguration configuration)

Method Detail

clientInit

protected void clientInit()

Specified by:

clientInit in class IndirectClient<SAML2Credentials,SAML2Profile>

initSAMLProfileHandler

protected void initSAMLProfileHandler()

initSAMLResponseValidator

protected void initSAMLResponseValidator()

initSignatureTrustEngineProvider

protected void initSignatureTrustEngineProvider(org.opensaml.saml.metadata.resolver.MetadataResolver metadataManager)

initSAMLContextProvider

protected void initSAMLContextProvider(org.opensaml.saml.metadata.resolver.MetadataResolver metadataManager)

initServiceProviderMetadataResolver

protected org.opensaml.saml.metadata.resolver.MetadataResolver initServiceProviderMetadataResolver()

initIdentityProviderMetadataResolver

protected org.opensaml.saml.metadata.resolver.MetadataResolver initIdentityProviderMetadataResolver()

initCredentialProvider

protected void initCredentialProvider()

initDecrypter

protected void initDecrypter()

initSignatureSigningParametersProvider

protected void initSignatureSigningParametersProvider()

initChainingMetadataResolver

protected org.opensaml.saml.metadata.resolver.ChainingMetadataResolver initChainingMetadataResolver(org.opensaml.saml.metadata.resolver.MetadataResolver idpMetadataProvider,
                                                                                                    org.opensaml.saml.metadata.resolver.MetadataResolver spMetadataProvider)

getResponseValidator

public final SAML2ResponseValidator getResponseValidator()

getServiceProviderMetadataResolver

public final SAML2MetadataResolver getServiceProviderMetadataResolver()

getIdentityProviderMetadataResolver

public final SAML2MetadataResolver getIdentityProviderMetadataResolver()

getIdentityProviderResolvedEntityId

public final java.lang.String getIdentityProviderResolvedEntityId()

getServiceProviderResolvedEntityId

public final java.lang.String getServiceProviderResolvedEntityId()

setConfiguration

public void setConfiguration(SAML2ClientConfiguration configuration)

getConfiguration

public final SAML2ClientConfiguration getConfiguration()

getContextProvider

public SAMLContextProvider getContextProvider()

getProfileHandler

public SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest> getProfileHandler()

getSignatureSigningParametersProvider

public SignatureSigningParametersProvider getSignatureSigningParametersProvider()

getSignatureTrustEngineProvider

public SAML2SignatureTrustEngineProvider getSignatureTrustEngineProvider()

getStateGenerator

public StateGenerator getStateGenerator()

setStateGenerator

public void setStateGenerator(StateGenerator stateGenerator)