Package org.pac4j.saml.config

Class SAML2Configuration

java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.config.BaseClientConfiguration
org.pac4j.saml.config.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

  • Field Details

  • Constructor Details

    • SAML2Configuration

      public SAML2Configuration()

    • SAML2Configuration

      public SAML2Configuration(String keystorePath, String keystorePassword, String privateKeyPassword, String identityProviderMetadataPath)

    • SAML2Configuration

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

    • SAML2Configuration

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

    • SAML2Configuration

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

  • Method Details

    • newUrlResource

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

    • setCallbackUrl

      public void setCallbackUrl(String callbackUrl)

    • getRequestInitiatorUrl

      public String getRequestInitiatorUrl()

    • setRequestInitiatorUrl

      public void setRequestInitiatorUrl(String requestInitiatorUrl)

    • getAssertionConsumerServiceUrl

      public String getAssertionConsumerServiceUrl()

    • setAssertionConsumerServiceUrl

      public void setAssertionConsumerServiceUrl(String assertionConsumerServiceUrl)

    • internalInit

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

    • getKeystoreGenerator

      public SAML2KeystoreGenerator getKeystoreGenerator()

    • setKeystoreGenerator

      public void setKeystoreGenerator(SAML2KeystoreGenerator keystoreGenerator)

    • isNameIdPolicyAllowCreate

      public Boolean isNameIdPolicyAllowCreate()

    • setNameIdPolicyAllowCreate

      public void setNameIdPolicyAllowCreate(Boolean nameIdPolicyAllowCreate)

    • getContactPersons

      public List<SAML2MetadataContactPerson> getContactPersons()

    • setContactPersons

      public void setContactPersons(List<SAML2MetadataContactPerson> contactPersons)

    • getMetadataUIInfos

      public List<SAML2MetadataUIInfo> getMetadataUIInfos()

    • setMetadataUIInfos

      public void setMetadataUIInfos(List<SAML2MetadataUIInfo> metadataUIInfos)

    • getSupportedProtocols

      public List<String> getSupportedProtocols()

    • setSupportedProtocols

      public void setSupportedProtocols(List<String> supportedProtocols)

    • getCertificateSignatureAlg

      public String getCertificateSignatureAlg()

    • setCertificateSignatureAlg

      public void setCertificateSignatureAlg(String certificateSignatureAlg)

    • getCertificateExpirationPeriod

      public Period getCertificateExpirationPeriod()

    • setCertificateExpirationPeriod

      public void setCertificateExpirationPeriod(Period certificateExpirationPeriod)

    • getPrivateKeySize

      public int getPrivateKeySize()

    • setPrivateKeySize

      public void setPrivateKeySize(int privateKeySize)

    • getScopingIdentityProviders

      public List<SAML2ScopingIdentityProvider> getScopingIdentityProviders()

    • getRequestedServiceProviderAttributes

      public List<SAML2ServiceProviderRequestedAttribute> getRequestedServiceProviderAttributes()

    • setIdentityProviderMetadataResourceFilepath

      public void setIdentityProviderMetadataResourceFilepath(String path)

    • setIdentityProviderMetadataResourceClasspath

      public void setIdentityProviderMetadataResourceClasspath(String path)

    • setIdentityProviderMetadataResourceUrl

      public void setIdentityProviderMetadataResourceUrl(String url)

    • setIdentityProviderMetadataPath

      public void setIdentityProviderMetadataPath(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 String getIdentityProviderEntityId()

    • setIdentityProviderEntityId

      public void setIdentityProviderEntityId(String identityProviderEntityId)

    • setKeystoreAlias

      public void setKeystoreAlias(String keyStoreAlias)

    • setKeystoreType

      public void setKeystoreType(String keyStoreType)

    • setKeystoreResourceFilepath

      public void setKeystoreResourceFilepath(String path)

    • setKeystoreResourceClasspath

      public void setKeystoreResourceClasspath(String path)

    • setKeystoreResourceUrl

      public void setKeystoreResourceUrl(String url)

    • setKeystorePath

      public void setKeystorePath(String path)

    • getKeyStoreAlias

      public String getKeyStoreAlias()

    • getKeyStoreType

      public String getKeyStoreType()

    • getKeystoreResource

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

    • setKeystoreResource

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

    • getKeystorePassword

      public String getKeystorePassword()

    • setKeystorePassword

      public void setKeystorePassword(String keystorePassword)

    • getPrivateKeyPassword

      public String getPrivateKeyPassword()

    • setPrivateKeyPassword

      public void setPrivateKeyPassword(String privateKeyPassword)

    • getCertificateNameToAppend

      public String getCertificateNameToAppend()

    • setCertificateNameToAppend

      public void setCertificateNameToAppend(String certificateNameToAppend)

    • setServiceProviderMetadataResourceFilepath

      public void setServiceProviderMetadataResourceFilepath(String path)

    • setServiceProviderMetadataPath

      public void setServiceProviderMetadataPath(String path)

    • getServiceProviderMetadataResource

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

    • setServiceProviderMetadataResource

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

    • getServiceProviderEntityId

      public String getServiceProviderEntityId()

    • setServiceProviderEntityId

      public void setServiceProviderEntityId(String serviceProviderEntityId)

    • isPassive

      public boolean isPassive()

    • setPassive

      public void setPassive(boolean passive)

    • isForceAuth

      public boolean isForceAuth()

    • setForceAuth

      public void setForceAuth(boolean forceAuth)

    • getComparisonType

      public String getComparisonType()

    • setComparisonType

      public void setComparisonType(String comparisonType)

    • getAuthnRequestBindingType

      public String getAuthnRequestBindingType()

    • setAuthnRequestBindingType

      public void setAuthnRequestBindingType(String authnRequestBindingType)

    • getResponseBindingType

      public String getResponseBindingType()

    • setResponseBindingType

      public void setResponseBindingType(String responseBindingType)

    • getSpLogoutRequestBindingType

      public String getSpLogoutRequestBindingType()

    • setSpLogoutRequestBindingType

      public void setSpLogoutRequestBindingType(String spLogoutRequestBindingType)

    • getSpLogoutResponseBindingType

      public String getSpLogoutResponseBindingType()

    • setSpLogoutResponseBindingType

      public void setSpLogoutResponseBindingType(String spLogoutResponseBindingType)

    • getAuthnContextClassRefs

      public List<String> getAuthnContextClassRefs()

    • setAuthnContextClassRefs

      public void setAuthnContextClassRefs(List<String> authnContextClassRefs)

    • getUriComparator

      public net.shibboleth.shared.net.URIComparator getUriComparator()

    • setUriComparator

      public void setUriComparator(net.shibboleth.shared.net.URIComparator uriComparator)

    • getNameIdPolicyFormat

      public String getNameIdPolicyFormat()

    • setNameIdPolicyFormat

      public void setNameIdPolicyFormat(String nameIdPolicyFormat)

    • getMaximumAuthenticationLifetime

      public long getMaximumAuthenticationLifetime()

    • setMaximumAuthenticationLifetime

      public void setMaximumAuthenticationLifetime(long maximumAuthenticationLifetime)

    • isForceServiceProviderMetadataGeneration

      public boolean isForceServiceProviderMetadataGeneration()

    • setForceServiceProviderMetadataGeneration

      public void setForceServiceProviderMetadataGeneration(boolean forceServiceProviderMetadataGeneration)

    • getSamlMessageStoreFactory

      public SAMLMessageStoreFactory getSamlMessageStoreFactory()

    • setSamlMessageStoreFactory

      public void setSamlMessageStoreFactory(SAMLMessageStoreFactory samlMessageStoreFactory)

    • getBlackListedSignatureSigningAlgorithms

      public Collection<String> getBlackListedSignatureSigningAlgorithms()

    • setBlackListedSignatureSigningAlgorithms

      public void setBlackListedSignatureSigningAlgorithms(Collection<String> blackListedSignatureSigningAlgorithms)

    • getSignatureAlgorithms

      public List<String> getSignatureAlgorithms()

    • setSignatureAlgorithms

      public void setSignatureAlgorithms(List<String> signatureAlgorithms)

    • getSignatureReferenceDigestMethods

      public List<String> getSignatureReferenceDigestMethods()

    • setSignatureReferenceDigestMethods

      public void setSignatureReferenceDigestMethods(List<String> signatureReferenceDigestMethods)

    • getSignatureCanonicalizationAlgorithm

      public String getSignatureCanonicalizationAlgorithm()

    • setSignatureCanonicalizationAlgorithm

      public void setSignatureCanonicalizationAlgorithm(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 String getProviderName()

    • setProviderName

      public void setProviderName(String providerName)

    • getAuthnRequestExtensions

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

    • setAuthnRequestExtensions

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

    • getMetadataSigner

      public SAML2MetadataSigner getMetadataSigner()

    • setMetadataSigner

      public void setMetadataSigner(SAML2MetadataSigner metadataSigner)

    • getAttributeAsId

      public String getAttributeAsId()

    • setAttributeAsId

      public void setAttributeAsId(String attributeAsId)

    • isUseNameQualifier

      public boolean isUseNameQualifier()

    • setUseNameQualifier

      public void setUseNameQualifier(boolean useNameQualifier)

    • isSignMetadata

      public boolean isSignMetadata()

    • setSignMetadata

      public void setSignMetadata(boolean signMetadata)

    • getMappedAttributes

      public Map<String,String> getMappedAttributes()

    • setMappedAttributes

      public void setMappedAttributes(Map<String,String> mappedAttributes)

    • getLogoutHandler

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

    • setLogoutHandler

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

    • getPostLogoutURL

      public String getPostLogoutURL()

    • setPostLogoutURL

      public void setPostLogoutURL(String postLogoutURL)

    • getNameIdAttribute

      public String getNameIdAttribute()

    • setNameIdAttribute

      public void setNameIdAttribute(String nameIdAttribute)

    • getHostnameVerifier

      public HostnameVerifier getHostnameVerifier()

    • setHostnameVerifier

      public void setHostnameVerifier(HostnameVerifier hostnameVerifier)

    • getSslSocketFactory

      public SSLSocketFactory getSslSocketFactory()

    • setSslSocketFactory

      public void setSslSocketFactory(SSLSocketFactory sslSocketFactory)

    • findLogoutHandler

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

    • getIssuerFormat

      public String getIssuerFormat()

    • setIssuerFormat

      public void setIssuerFormat(String issuerFormat)

    • getSingleSignOutServiceUrl

      public String getSingleSignOutServiceUrl()

    • setSingleSignOutServiceUrl

      public void setSingleSignOutServiceUrl(String singleSignOutServiceUrl)

    • getHttpClient

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

    • setHttpClient

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

    • getCredentialProvider

      public CredentialProvider getCredentialProvider()

    • toMetadataGenerator

      public SAML2MetadataGenerator toMetadataGenerator()

    • determineSingleSignOutServiceUrl

      protected void determineSingleSignOutServiceUrl(BaseSAML2MetadataGenerator generator)

    • getMetadataGenerator

      public SAML2MetadataGenerator getMetadataGenerator()

    • setMetadataGenerator

      public void setMetadataGenerator(SAML2MetadataGenerator metadataGenerator)

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