File(s): conf/relying-party.xml
Format: Native Spring
Overview
The SAML1.ArtifactResolution profile configuration bean enables support for the SAML 1.1 Artifact Resolution profile over SOAP. It is required when supporting the use of the Artifact profile with Browser SSO in order to deliver the full assertion. It should be disabled if not in use.
Configuration
The most typical options used are described in more detail below, but not every obscure option is discussed. See the javadoc for all of the possible configuration options for this profile (note that many of them are inherited from parent classes).
Virtually all the configuration options below can be set via two different properties: a static property that explicitly sets the value to use and a lookup strategy or predicate property that takes a Function or Predicate and returns the value to use. The dynamic property is generally named "propertyNamePredicate" or "propertyNameLookupStrategy" for Boolean- and non-Boolean-valued properties respectively.
Common
Options common to most/all profiles:
Name | Type | Default | Description |
|---|
securityConfiguration | SecurityConfiguration | Bean named shibboleth.DefaultSecurityConfiguration | An object containing all of the default security-related objects needed for peer authentication and encryption. See SecurityConfiguration for complete details. |
disallowedFeatures | Integer | 0 | A bitmask of features to disallow, the mask values being specific to individual profiles |
inboundInterceptorFlows | List<String> | | Ordered list of profile interceptor flows to run prior to message processing |
outboundInterceptorFlows | List<String> | | Ordered list of profile interceptor flows to run prior to outbound message handling |
Guidance
Modifying the security configuration is usually done to:
specify an alternate signing or decryption key to use
control signing or encryption algorithms (but for metadata you control, it's advisable to control algorithms by using an extension to specify supported algorithms).
The two interceptor lists allow the much less commonly used profile interceptor injection points to be used. This is largely a Java-based way of doing very low-level sorts of “message rewriting” hackery that might otherwise be impossible to pull off. One use case for the inbound side might be picking up non-standard parameters in a SAML request.
SAML
Options common to SAML profiles:
Name | Type | Default | Description |
|---|
signResponses | Boolean | varies by profile | Whether to sign responses |
signRequests | Boolean | false | Whether to sign requests |
messageHandler | Function<MessageContext,Exception> | | A function hook allowing modification of SAML messages before signing and transmission, useful for adding extensions |
Guidance
It isn't too common to need any of these options, and they should be changed only with care.
The signing defaults vary by profile, see the notes on the individual profile pages.
Profile-Specific
Name | Type | Default | Desription |
|---|
signAssertions | Boolean | false | Whether to sign assertions |
Notes
The default value of signResponses for this profile signs only if TLS isn't used (very unusual) or if the receiving port is 443. It assumes that traffic over 443 will be relying on message-based security measures, whereas traffic to an alternative TLS port like 8443 will be relying on mutual authentication and thus provide a secure channel.
Since SAML 1.1 does not support XML Encryption, all data is in plaintext, and therefore use of message-based security is not advisable.
If you need to enable the signAssertions option, and you control the SP's metadata, you should generally add the WantAssertionsSigned flag to it in place of using this option. Related, the idp.saml.honorWantAssertionsSigned property can be turned off to globally ignore that flag in metadata should you wish to do so.