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
Modifier and TypeFieldDescriptionprotected SAML2ResponseValidator
protected SAML2Configuration
protected SAMLContextProvider
protected org.opensaml.saml.saml2.encryption.Decrypter
protected SAML2MetadataResolver
protected SAML2ProfileHandler<org.opensaml.saml.saml2.core.LogoutRequest>
protected SAML2LogoutValidator
protected SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest>
protected ReplayCacheProvider
protected SignatureSigningParametersProvider
protected SAML2SignatureTrustEngineProvider
protected SOAPPipelineProvider
protected SAML2MetadataResolver
protected org.pac4j.core.util.generator.ValueGenerator
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
final SAML2Configuration
final SAML2MetadataResolver
final String
protected SAML2LogoutMessageReceiver
SAML2ProfileHandler<org.opensaml.saml.saml2.core.LogoutRequest>
protected SAML2LogoutRequestMessageSender
SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest>
final SAML2MetadataResolver
final String
org.pac4j.core.util.generator.ValueGenerator
protected void
protected void
protected void
protected void
protected void
protected void
protected void
protected void
protected void
protected void
protected void
protected void
protected void
internalInit
(boolean forceReinit) void
notifySessionRenewal
(String oldSessionId, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore) void
setConfiguration
(SAML2Configuration configuration) void
setLogoutProfileHandler
(SAML2ProfileHandler<org.opensaml.saml.saml2.core.LogoutRequest> logoutProfileHandler) void
setStateGenerator
(org.pac4j.core.util.generator.ValueGenerator stateGenerator) Methods inherited from class org.pac4j.core.client.IndirectClient
afterInternalInit, beforeInternalInit, computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setLogoutActionBuilderIfUndefined, setRedirectionActionBuilder, setRedirectionActionBuilderIfUndefined, setUrlResolver, toString
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, isMultiProfile, isMultiProfile, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession
Methods inherited from class org.pac4j.core.util.InitializableObject
getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize
-
Field Details
-
contextProvider
-
signatureSigningParametersProvider
-
profileHandler
-
logoutProfileHandler
-
authnResponseValidator
-
logoutValidator
-
signatureTrustEngineProvider
-
idpMetadataResolver
-
spMetadataResolver
-
decrypter
protected org.opensaml.saml.saml2.encryption.Decrypter decrypter -
configuration
-
stateGenerator
protected org.pac4j.core.util.generator.ValueGenerator stateGenerator -
replayCache
-
soapPipelineProvider
-
-
Constructor Details
-
SAML2Client
public SAML2Client() -
SAML2Client
-
-
Method Details
-
internalInit
protected void internalInit(boolean forceReinit) - Specified by:
internalInit
in classorg.pac4j.core.util.InitializableObject
-
initSOAPPipelineProvider
protected void initSOAPPipelineProvider() -
initSAMLProfileHandler
protected void initSAMLProfileHandler() -
initSAMLLogoutProfileHandler
protected void initSAMLLogoutProfileHandler() -
getLogoutMessageReceiver
-
getLogoutRequestMessageSender
-
initSAMLLogoutResponseValidator
protected void initSAMLLogoutResponseValidator() -
initSAMLResponseValidator
protected void initSAMLResponseValidator() -
initSignatureTrustEngineProvider
protected void initSignatureTrustEngineProvider() -
initSAMLContextProvider
protected void initSAMLContextProvider() -
initServiceProviderMetadataResolver
protected void initServiceProviderMetadataResolver() -
initIdentityProviderMetadataResolver
protected void initIdentityProviderMetadataResolver() -
initDecrypter
protected void initDecrypter() -
initSignatureSigningParametersProvider
protected void initSignatureSigningParametersProvider() -
initSAMLReplayCache
protected void initSAMLReplayCache() -
destroy
public void destroy() -
notifySessionRenewal
public void notifySessionRenewal(String oldSessionId, org.pac4j.core.context.WebContext context, org.pac4j.core.context.session.SessionStore sessionStore) - Overrides:
notifySessionRenewal
in classorg.pac4j.core.client.BaseClient
-
getAuthnResponseValidator
-
getServiceProviderMetadataResolver
-
getIdentityProviderMetadataResolver
-
getIdentityProviderResolvedEntityId
-
getServiceProviderResolvedEntityId
-
setConfiguration
-
getConfiguration
-
getContextProvider
-
getLogoutValidator
-
getIdpMetadataResolver
-
getSpMetadataResolver
-
getProfileHandler
-
getSignatureSigningParametersProvider
-
getSignatureTrustEngineProvider
-
getStateGenerator
public org.pac4j.core.util.generator.ValueGenerator getStateGenerator() -
setStateGenerator
public void setStateGenerator(org.pac4j.core.util.generator.ValueGenerator stateGenerator) -
getLogoutProfileHandler
-
setLogoutProfileHandler
public void setLogoutProfileHandler(SAML2ProfileHandler<org.opensaml.saml.saml2.core.LogoutRequest> logoutProfileHandler) -
getReplayCache
-