Package org.pac4j.saml.config

Class SAML2Configuration

  • public class SAML2Configuration
extends org.pac4j.core.client.config.BaseClientConfiguration
    The class is responsible for capturing client settings and passing them around.
    Since:
    1.7
    Author:
    Misagh Moayyed, Jerome Leleu

    • Constructor Detail

      • SAML2Configuration

        public SAML2Configuration()

      • SAML2Configuration

        public SAML2Configuration​(java.lang.String keystorePath,
                          java.lang.String keystorePassword,
                          java.lang.String privateKeyPassword,
                          java.lang.String identityProviderMetadataPath)

      • SAML2Configuration

        public SAML2Configuration​(org.springframework.core.io.Resource keystoreResource,
                          java.lang.String keystorePassword,
                          java.lang.String privateKeyPassword,
                          org.springframework.core.io.Resource identityProviderMetadataResource)

      • SAML2Configuration

        public SAML2Configuration​(org.springframework.core.io.Resource keystoreResource,
                          java.lang.String keyStoreAlias,
                          java.lang.String keyStoreType,
                          java.lang.String keystorePassword,
                          java.lang.String privateKeyPassword,
                          org.springframework.core.io.Resource identityProviderMetadataResource)

      • SAML2Configuration

        protected SAML2Configuration​(java.lang.String keyStoreAlias,
                             java.lang.String keyStoreType,
                             org.springframework.core.io.Resource keystoreResource,
                             java.lang.String keystorePassword,
                             java.lang.String privateKeyPassword,
                             org.springframework.core.io.Resource identityProviderMetadataResource,
                             java.lang.String identityProviderEntityId,
                             java.lang.String serviceProviderEntityId,
                             java.lang.String providerName,
                             java.util.function.Supplier<java.util.List<org.opensaml.core.xml.schema.XSAny>> authnRequestExtensions,
                             java.lang.String attributeAsId)

    • Method Detail

      • newUrlResource

        protected static org.springframework.core.io.UrlResource newUrlResource​(java.lang.String url)

      • setCallbackUrl

        public void setCallbackUrl​(java.lang.String callbackUrl)

      • internalInit

        protected void internalInit​(boolean forceReinit)
        Specified by:
        internalInit in class org.pac4j.core.util.InitializableObject

      • isNameIdPolicyAllowCreate

        public java.lang.Boolean isNameIdPolicyAllowCreate()

      • setNameIdPolicyAllowCreate

        public void setNameIdPolicyAllowCreate​(java.lang.Boolean nameIdPolicyAllowCreate)

      • setMetadataUIInfos

        public void setMetadataUIInfos​(java.util.List<SAML2MetadataUIInfo> metadataUIInfos)

      • getSupportedProtocols

        public java.util.List<java.lang.String> getSupportedProtocols()

      • setSupportedProtocols

        public void setSupportedProtocols​(java.util.List<java.lang.String> supportedProtocols)

      • getCertificateSignatureAlg

        public java.lang.String getCertificateSignatureAlg()

      • setCertificateSignatureAlg

        public void setCertificateSignatureAlg​(java.lang.String certificateSignatureAlg)

      • getCertificateExpirationPeriod

        public java.time.Period getCertificateExpirationPeriod()

      • setCertificateExpirationPeriod

        public void setCertificateExpirationPeriod​(java.time.Period certificateExpirationPeriod)

      • getPrivateKeySize

        public int getPrivateKeySize()

      • setPrivateKeySize

        public void setPrivateKeySize​(int privateKeySize)

      • setIdentityProviderMetadataResourceFilepath

        public void setIdentityProviderMetadataResourceFilepath​(java.lang.String path)

      • setIdentityProviderMetadataResourceClasspath

        public void setIdentityProviderMetadataResourceClasspath​(java.lang.String path)

      • setIdentityProviderMetadataResourceUrl

        public void setIdentityProviderMetadataResourceUrl​(java.lang.String url)

      • setIdentityProviderMetadataPath

        public void setIdentityProviderMetadataPath​(java.lang.String path)

      • getAssertionConsumerServiceIndex

        public int getAssertionConsumerServiceIndex()

      • setAssertionConsumerServiceIndex

        public void setAssertionConsumerServiceIndex​(int assertionConsumerServiceIndex)

      • isForceKeystoreGeneration

        public boolean isForceKeystoreGeneration()

      • setForceKeystoreGeneration

        public void setForceKeystoreGeneration​(boolean forceKeystoreGeneration)

      • getAcceptedSkew

        public long getAcceptedSkew()

      • setAcceptedSkew

        public void setAcceptedSkew​(long acceptedSkew)

      • getIdentityProviderMetadataResource

        public org.springframework.core.io.Resource getIdentityProviderMetadataResource()

      • setIdentityProviderMetadataResource

        public void setIdentityProviderMetadataResource​(org.springframework.core.io.Resource identityProviderMetadataResource)

      • getIdentityProviderEntityId

        public java.lang.String getIdentityProviderEntityId()

      • setIdentityProviderEntityId

        public void setIdentityProviderEntityId​(java.lang.String identityProviderEntityId)

      • setKeystoreAlias

        public void setKeystoreAlias​(java.lang.String keyStoreAlias)

      • setKeystoreType

        public void setKeystoreType​(java.lang.String keyStoreType)

      • setKeystoreResourceFilepath

        public void setKeystoreResourceFilepath​(java.lang.String path)

      • setKeystoreResourceClasspath

        public void setKeystoreResourceClasspath​(java.lang.String path)

      • setKeystoreResourceUrl

        public void setKeystoreResourceUrl​(java.lang.String url)

      • setKeystorePath

        public void setKeystorePath​(java.lang.String path)

      • getKeyStoreAlias

        public java.lang.String getKeyStoreAlias()

      • getKeyStoreType

        public java.lang.String getKeyStoreType()

      • getKeystoreResource

        public org.springframework.core.io.Resource getKeystoreResource()

      • setKeystoreResource

        public void setKeystoreResource​(org.springframework.core.io.Resource keystoreResource)

      • getKeystorePassword

        public java.lang.String getKeystorePassword()

      • setKeystorePassword

        public void setKeystorePassword​(java.lang.String keystorePassword)

      • getPrivateKeyPassword

        public java.lang.String getPrivateKeyPassword()

      • setPrivateKeyPassword

        public void setPrivateKeyPassword​(java.lang.String privateKeyPassword)

      • getCertificateNameToAppend

        public java.lang.String getCertificateNameToAppend()

      • setCertificateNameToAppend

        public void setCertificateNameToAppend​(java.lang.String certificateNameToAppend)

      • setServiceProviderMetadataResourceFilepath

        public void setServiceProviderMetadataResourceFilepath​(java.lang.String path)

      • setServiceProviderMetadataPath

        public void setServiceProviderMetadataPath​(java.lang.String path)

      • getServiceProviderMetadataResource

        public org.springframework.core.io.Resource getServiceProviderMetadataResource()

      • setServiceProviderMetadataResource

        public void setServiceProviderMetadataResource​(org.springframework.core.io.Resource serviceProviderMetadataResource)

      • getServiceProviderEntityId

        public java.lang.String getServiceProviderEntityId()

      • setServiceProviderEntityId

        public void setServiceProviderEntityId​(java.lang.String serviceProviderEntityId)

      • isPassive

        public boolean isPassive()

      • setPassive

        public void setPassive​(boolean passive)

      • isForceAuth

        public boolean isForceAuth()

      • setForceAuth

        public void setForceAuth​(boolean forceAuth)

      • getComparisonType

        public java.lang.String getComparisonType()

      • setComparisonType

        public void setComparisonType​(java.lang.String comparisonType)

      • getAuthnRequestBindingType

        public java.lang.String getAuthnRequestBindingType()

      • setAuthnRequestBindingType

        public void setAuthnRequestBindingType​(java.lang.String authnRequestBindingType)

      • getResponseBindingType

        public java.lang.String getResponseBindingType()

      • setResponseBindingType

        public void setResponseBindingType​(java.lang.String responseBindingType)

      • getSpLogoutRequestBindingType

        public java.lang.String getSpLogoutRequestBindingType()

      • setSpLogoutRequestBindingType

        public void setSpLogoutRequestBindingType​(java.lang.String spLogoutRequestBindingType)

      • getSpLogoutResponseBindingType

        public java.lang.String getSpLogoutResponseBindingType()

      • setSpLogoutResponseBindingType

        public void setSpLogoutResponseBindingType​(java.lang.String spLogoutResponseBindingType)

      • getAuthnContextClassRefs

        public java.util.List<java.lang.String> getAuthnContextClassRefs()

      • setAuthnContextClassRefs

        public void setAuthnContextClassRefs​(java.util.List<java.lang.String> authnContextClassRefs)

      • getUriComparator

        public net.shibboleth.utilities.java.support.net.URIComparator getUriComparator()

      • setUriComparator

        public void setUriComparator​(net.shibboleth.utilities.java.support.net.URIComparator uriComparator)

      • getNameIdPolicyFormat

        public java.lang.String getNameIdPolicyFormat()

      • setNameIdPolicyFormat

        public void setNameIdPolicyFormat​(java.lang.String nameIdPolicyFormat)

      • getMaximumAuthenticationLifetime

        public long getMaximumAuthenticationLifetime()

      • setMaximumAuthenticationLifetime

        public void setMaximumAuthenticationLifetime​(long maximumAuthenticationLifetime)

      • isForceServiceProviderMetadataGeneration

        public boolean isForceServiceProviderMetadataGeneration()

      • setForceServiceProviderMetadataGeneration

        public void setForceServiceProviderMetadataGeneration​(boolean forceServiceProviderMetadataGeneration)

      • setSamlMessageStoreFactory

        public void setSamlMessageStoreFactory​(SAMLMessageStoreFactory samlMessageStoreFactory)

      • getBlackListedSignatureSigningAlgorithms

        public java.util.Collection<java.lang.String> getBlackListedSignatureSigningAlgorithms()

      • setBlackListedSignatureSigningAlgorithms

        public void setBlackListedSignatureSigningAlgorithms​(java.util.Collection<java.lang.String> blackListedSignatureSigningAlgorithms)

      • getSignatureAlgorithms

        public java.util.List<java.lang.String> getSignatureAlgorithms()

      • setSignatureAlgorithms

        public void setSignatureAlgorithms​(java.util.List<java.lang.String> signatureAlgorithms)

      • getSignatureReferenceDigestMethods

        public java.util.List<java.lang.String> getSignatureReferenceDigestMethods()

      • setSignatureReferenceDigestMethods

        public void setSignatureReferenceDigestMethods​(java.util.List<java.lang.String> signatureReferenceDigestMethods)

      • getSignatureCanonicalizationAlgorithm

        public java.lang.String getSignatureCanonicalizationAlgorithm()

      • setSignatureCanonicalizationAlgorithm

        public void setSignatureCanonicalizationAlgorithm​(java.lang.String signatureCanonicalizationAlgorithm)

      • isWantsAssertionsSigned

        public boolean isWantsAssertionsSigned()

      • setWantsAssertionsSigned

        public void setWantsAssertionsSigned​(boolean wantsAssertionsSigned)

      • isWantsResponsesSigned

        public boolean isWantsResponsesSigned()

      • setWantsResponsesSigned

        public void setWantsResponsesSigned​(boolean wantsResponsesSigned)

      • isAuthnRequestSigned

        public boolean isAuthnRequestSigned()

      • setAuthnRequestSigned

        public void setAuthnRequestSigned​(boolean authnRequestSigned)

      • isSpLogoutRequestSigned

        public boolean isSpLogoutRequestSigned()

      • setSpLogoutRequestSigned

        public void setSpLogoutRequestSigned​(boolean spLogoutRequestSigned)

      • isAllSignatureValidationDisabled

        public boolean isAllSignatureValidationDisabled()

      • setAllSignatureValidationDisabled

        public void setAllSignatureValidationDisabled​(boolean allSignatureValidationDisabled)
        Disables all signature validation. DO NOT ENABLE THIS IN PRODUCTION! This option is only provided for development purposes.
        Parameters:
        allSignatureValidationDisabled -

      • setResponseDestinationAttributeMandatory

        public void setResponseDestinationAttributeMandatory​(boolean mandatory)
        SAML specification states the Response `Destination` attribute is optional. Providing a value is recommended to prevent malicious forwarding of responses to unintended recipients.

      • isResponseDestinationAttributeMandatory

        public boolean isResponseDestinationAttributeMandatory()

      • getAttributeConsumingServiceIndex

        public int getAttributeConsumingServiceIndex()

      • setAttributeConsumingServiceIndex

        public void setAttributeConsumingServiceIndex​(int attributeConsumingServiceIndex)

      • getProviderName

        public java.lang.String getProviderName()

      • setProviderName

        public void setProviderName​(java.lang.String providerName)

      • getAuthnRequestExtensions

        public java.util.function.Supplier<java.util.List<org.opensaml.core.xml.schema.XSAny>> getAuthnRequestExtensions()

      • setAuthnRequestExtensions

        public void setAuthnRequestExtensions​(java.util.function.Supplier<java.util.List<org.opensaml.core.xml.schema.XSAny>> authnRequestExtensions)

      • getAttributeAsId

        public java.lang.String getAttributeAsId()

      • setAttributeAsId

        public void setAttributeAsId​(java.lang.String attributeAsId)

      • isUseNameQualifier

        public boolean isUseNameQualifier()

      • setUseNameQualifier

        public void setUseNameQualifier​(boolean useNameQualifier)

      • isSignMetadata

        public boolean isSignMetadata()

      • setSignMetadata

        public void setSignMetadata​(boolean signMetadata)

      • getMappedAttributes

        public java.util.Map<java.lang.String,​java.lang.String> getMappedAttributes()

      • setMappedAttributes

        public void setMappedAttributes​(java.util.Map<java.lang.String,​java.lang.String> mappedAttributes)

      • getLogoutHandler

        public org.pac4j.core.logout.handler.LogoutHandler getLogoutHandler()

      • setLogoutHandler

        public void setLogoutHandler​(org.pac4j.core.logout.handler.LogoutHandler logoutHandler)

      • getPostLogoutURL

        public java.lang.String getPostLogoutURL()

      • setPostLogoutURL

        public void setPostLogoutURL​(java.lang.String postLogoutURL)

      • getNameIdAttribute

        public java.lang.String getNameIdAttribute()

      • setNameIdAttribute

        public void setNameIdAttribute​(java.lang.String nameIdAttribute)

      • getHostnameVerifier

        public javax.net.ssl.HostnameVerifier getHostnameVerifier()

      • setHostnameVerifier

        public void setHostnameVerifier​(javax.net.ssl.HostnameVerifier hostnameVerifier)

      • getSslSocketFactory

        public javax.net.ssl.SSLSocketFactory getSslSocketFactory()

      • setSslSocketFactory

        public void setSslSocketFactory​(javax.net.ssl.SSLSocketFactory sslSocketFactory)

      • findLogoutHandler

        public org.pac4j.core.logout.handler.LogoutHandler findLogoutHandler()

      • getIssuerFormat

        public java.lang.String getIssuerFormat()

      • setIssuerFormat

        public void setIssuerFormat​(java.lang.String issuerFormat)

      • getSingleSignOutServiceUrl

        public java.lang.String getSingleSignOutServiceUrl()

      • setSingleSignOutServiceUrl

        public void setSingleSignOutServiceUrl​(java.lang.String singleSignOutServiceUrl)

      • getHttpClient

        public org.apache.http.client.HttpClient getHttpClient()

      • setHttpClient

        public void setHttpClient​(org.apache.http.client.HttpClient httpClient)

      • getMetadataGenerator

        public SAML2MetadataGenerator getMetadataGenerator()
                                            throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getIdentityProviderMetadataResolver

        public SAML2MetadataResolver getIdentityProviderMetadataResolver()

      • setIdentityProviderMetadataResolver

        public void setIdentityProviderMetadataResolver​(SAML2MetadataResolver identityProviderMetadataResolver)

      • isPartialLogoutTreatedAsSuccess

        public boolean isPartialLogoutTreatedAsSuccess()

      • setPartialLogoutTreatedAsSuccess

        public void setPartialLogoutTreatedAsSuccess​(boolean partialLogoutTreatedAsSuccess)

      • getSamlAttributeConverter

        public org.pac4j.core.profile.converter.AttributeConverter getSamlAttributeConverter()

      • setSamlAttributeConverter

        public void setSamlAttributeConverter​(org.pac4j.core.profile.converter.AttributeConverter samlAttributeConverter)

      • getIdentityProviderMetadataConnectTimeout

        public int getIdentityProviderMetadataConnectTimeout()

      • setIdentityProviderMetadataConnectTimeout

        public void setIdentityProviderMetadataConnectTimeout​(int identityProviderMetadataConnectTimeout)

      • getIdentityProviderMetadataReadTimeout

        public int getIdentityProviderMetadataReadTimeout()

      • setIdentityProviderMetadataReadTimeout

        public void setIdentityProviderMetadataReadTimeout​(int identityProviderMetadataReadTimeout)