The relying-party.xml file is used to specify the functional features (SAML and otherwise) you want the IdP to support (these are termed "profiles"), and to customize IdP or profile settings based on the identity, or a few other characteristics, of a relying party service.
You can modify this file to:
control which profiles are supported for particular partners (or for anonymous requests)
turning off encryption of assertions and other content
changing which layer signing is performed (responses vs. assertions)
supporting multiple signing credentials
customizing algorithms
The goal of any deployment is to reduce the number of customizations used, so the ideal is to rarely have to modify this configuration. Further, there are more modern techniques that allow many or most uses of this file to be replaced by MetadataDrivenConfiguration; that is, instead of creating explicit rules in this file, it's usually cleaner in the long run to add information to SP metadata to effect the change desired. Over time, it becomes easier to get a feel for when it's easier to use metadata and when it's easier to use overrides.
General Configuration
While the native Spring syntax can ultimately be used to wire up any beans you choose to define, we have abstracted this to some degree by making use of conventions, parent beans, and pre-defined bean names to limit the amount of XML needed to make useful changes.
The absolute rule is that the file MUST contain three named beans:
shibboleth.UnverifiedRelyingParty
shibboleth.DefaultRelyingParty
shibboleth.RelyingPartyOverrides
All three are defined for you by default.
The first two must define beans that derive from the RelyingPartyConfiguration class, but this is automatically done by inheriting (via the parent attribute) from the bean named RelyingParty.
The "unverified" RP bean controls how to handle requests from peers with no metadata or other mechanism in place to authenticate/verify the request. By default, no profiles are enabled, signified by the empty profileConfigurations list.
The "default" RP bean applies to requests from peers that do not fit the conditions attached to any overrides, and are thus handled with default settings. By default, this relies on a variety of built-in settings, and activates a number of the usual profiles, though the exact list may vary over time with particular releases (things that used to be common may become rare).
The last bean is a List<RelyingPartyConfiguration> for any overrides. Those beans will generally be of special types that determine their applicability, or will generically contain an activationCondition property that determines whether one applies to a request or not.
The first applicable override bean is used, and there is no merging of settings between any of the beans.
Overrides
Overrides allow for arbitrary conditions to be evaluated to assign behavior to a request. In the general case these conditions can be complex scripts or Java code.
To simplify this in the most common scenarios, we have included additional parent beans that can be inherited from to more easily express these conditions. Right now, we have these built-in helpers:
RelyingPartyByName
RelyingPartyByGroup
RelyingPartyByEntitiesDescriptor 4.1
RelyingPartyByTag
RelyingPartyByMappedTag
Examples
<!-- Example matching one SP -->
<bean parent="RelyingPartyByName" c:relyingPartyIds="https://sp.example.org/sp">
<property name="profileConfigurations">
<list>
<!-- Your refs or beans here. -->
</list>
</property>
</bean>
<!-- Example matching two SPs -->
<bean parent="RelyingPartyByName" c:relyingPartyIds="#{{'https://sp.example.org/sp', 'https://another.example.org/sp'}}">
<property name="profileConfigurations">
<list>
<!-- Your refs or beans here. -->
</list>
</property>
</bean>
<!-- Example matching three (or more) SPs -->
<bean parent="RelyingPartyByName">
<constructor-arg name="relyingPartyIds">
<list>
<value>https://sp.example.org/sp</value>
<value>https://another.example.org/sp</value>
<value>https://still.another.example.org/sp</value>
</list>
</constructor-arg>
<property name="profileConfigurations">
<list>
<!-- Your refs or beans here. -->
</list>
</property>
</bean
(Note that the second example above uses a Spring Expression Language inline list. This can get arbitrarily long, so the third example shows this in a more readable syntax for longer lists.)
The following example notwithstanding, it's not advisable to create policy based on groups because those hierarchies are very dependent on metadata aggregation and publishing approaches that are much less common today.
<bean parent="RelyingPartyByGroup" c:groupNames="urn:mace:incommon">
<property name="profileConfigurations">
<list>
<!-- Your refs or beans here. -->
</list>
</property>
</bean>
There is also support for group matching based on a SAML metadata feature called an <AffiliationDescriptor>, and you are able to create locally (or even remotely) expressed group memberships using that technique, by supplying supplemental metadata to the system. If you want to optimize by ignoring the possibility of <AffiliationDescriptor> use, the RelyingPartyByEntitiesDescriptor bean has been added (as of V4.1) to bypass that step and suppress some logging that shows up during the affiliation lookup.
An alternative grouping strategy is based on <EntityAttributes> metadata extension tags. The tag-based approach is a generally recommended way of doing simple overrides that might apply to a large number of systems, and is a bridge between the "explicit" syntax and the more generic MetadataDrivenConfiguration approach.
In addition to the original bean, the RelyingPartyByMappedTag bean allows you to optimize tag-based overrides by relying on the decoding of tags in the metadata into internal IdPAttribute objects via the AttributeRegistryConfiguration. Even without dedicated rules, the system can auto-decode URI-named SAML Attribute extensions into IdPAttributes with a corresponding name "as is", so generally the mapped variant should work the same way and will be faster.
Finally, the most general example involves defining your own bean and a custom condition. An example using a regular expression:
If more than one override is defined, then it is possible for the activation conditions of multiple overrides to be satisfied by a request. Overrides have "first one wins" match semantics whose ordering is determined by their position in the shibboleth.RelyingPartyOverrides list bean. This leads to a rule of thumb for overrides: more general matches (i.e. by group) should be placed after more specific matches (i.e. by name).
The first override with an ActivationCondition that returns true will be in effect. Multiple matching overrides are not merged or combined in any way. However, it's possible to combine different "dimensions" of conditions by using dynamically-derived profile settings, a feature discussed in the next section and in the MetadataDrivenConfiguration topic.
Profile Configuration
Every relying party configuration (default or override) has a profileConfigurations property whose value is a list of ProfileConfiguration beans that determine which profiles can be used. Any profile not explicitly listed will be disabled and requests for it will fail internally with an error.
Profiles are activated within relying party configurations in most cases by referencing beans defined within the system that apply the default settings for each profile. This wouldn't apply to custom profiles defined in extensions, but it does apply to the built-in feature set. We've pre-defined beans for the built-in profiles as follows:
Liberty.SSOS (this undocumented feature supports SAML-based security delegation, has been deprecated in this release, and will be removed in the next major version)
They ones that are active by default are included in the shibboleth.DefaultRelyingParty bean's profileConfigurations property, by reference. You can turn them on or off using comments or by deleting them.
Additional profile beans are available when the CAS module is enabled; see CasProtocolConfiguration.
As with all relying party settings, an override does not inherit the profiles enabled by default. An override essentially turns everything off unless its own profileConfigurations property enables it.
To statically override a default profile option, you can replace a <ref> element pointing to a profile with a new bean definition like so:
The parent attribute lets you pull in the pre-defined bean definition for a profile and just override what you want to. You can mix these beans with <ref> elements that rely on default behavior with other profiles.
All of the profile settings that can be set statically can also be computed via functions or predicates/conditions that execute at runtime. It's a better idea to look into MetadataDrivenConfiguration then to explore this feature. This is the low-level feature that makes metadata-driven settings possible but using metadata is usually more elegant and the system does all the fancy wiring for you.
The use of this feature helps if you want to apply "cross-cutting" conditions to get around the limitation that overrides don't get merged. For example, consider the following use cases:
You want to enable consent for attribute release for a specific set of relying parties.
You want to downgrade to the use of SHA-1 for a specific set of relying parties.
Of course, if these two sets don't overlap, and you have nothing else unusual to specify, you could create two overrides for each set individually. But what if the two sets overlap, with some relying parties in one, some in the other, and some in both? Now you need three overrides. Now consider that a third set requires an additional non-default setting and overlaps with some of the first two sets. The number of overrides will get out of hand quickly and start to get very confusing to manage.
As an example, let's tackle the cases above by using scripts to derive the settings involved. This can potentially be done with no overrides at all, as below, though that's a matter of style.
Use of scripts to derive profile settings
<!-- Whether to run attribute release interceptor. -->
<bean id="InterceptorScript" parent="shibboleth.ContextFunctions.Scripted" factory-method="inlineScript">
<constructor-arg>
<value>
<![CDATA[
interceptors = null;
rpid = "";
rpCtx = input.getSubcontext("net.shibboleth.idp.profile.context.RelyingPartyContext");
if (rpCtx != null) {
rpid = rpCtx.getRelyingPartyId();
}
if (rpid.equals("https://sp1.example.org/sp") ||
rpid.equals("https://sp2.example.org/sp") ||
rpid.equals("https://sp3.example.org/sp")) {
listType = Java.type("java.util.ArrayList");
interceptors = new listType(1);
interceptors.add("attribute-release");
}
interceptors;
]]>
</value>
</constructor-arg>
</bean>
<!-- Map of security configurations for use by next script. -->
<util:map id="SecurityConfigMap">
<entry key="SHA2" value-ref="shibboleth.DefaultSecurityConfiguration"/>
<entry key="SHA1" value-ref="shibboleth.SecurityConfiguration.SHA1" />
</util:map>
<!-- Whether to use SHA-1. -->
<bean id="SecurityConfigScript" parent="shibboleth.ContextFunctions.Scripted"
factory-method="inlineScript"
p:customObject-ref="SecurityConfigMap">
<constructor-arg>
<value>
<![CDATA[
rpid = "";
rpCtx = input.getSubcontext("net.shibboleth.idp.profile.context.RelyingPartyContext");
if (rpCtx != null) {
rpid = rpCtx.getRelyingPartyId();
}
securityConfig = custom["SHA2"];
if (rpid.equals("https://sp2.example.org/sp") ||
rpid.equals("https://sp3.example.org/sp") ||
rpid.equals("https://sp4.example.org/sp")) {
securityConfig = custom["SHA1"];
}
securityConfig;
]]>
</value>
</constructor-arg>
</bean>
<!-- Apply the scripts to derive settings. -->
<bean id="shibboleth.DefaultRelyingParty" parent="RelyingParty">
<property name="profileConfigurations">
<list>
<bean parent="Shibboleth.SSO"
p:postAuthenticationFlowsLookupStrategy-ref="InterceptorScript"
p:securityConfigurationLookupStrategy-ref="SecurityConfigScript" />
<bean parent="SAML2.SSO"
p:postAuthenticationFlowsLookupStrategy-ref="InterceptorScript"
p:securityConfigurationLookupStrategy-ref="SecurityConfigScript" />
<ref bean="SAML2.ECP"
p:securityConfigurationLookupStrategy-ref="SecurityConfigScript" />
<ref bean="SAML2.Logout"
p:securityConfigurationLookupStrategy-ref="SecurityConfigScript" />
</list>
</property>
</bean>
Obviously the example above is somewhat contrived. It's longer than just creating three overrides, but it illustrates the general idea and once you get comfortable using scripts, it isn't as bad as it looks. It's also possible to put scripts in separate files, which makes the XML much shorter.
This becomes much more powerful when combined with other techniques, particularly the use of tag-based conditions based on <EntityAttribute> extensions in SAML metadata, which can be applied by metadata registrars or locally using a metadata filter.
A built-in way of doing this is described in the MetadataDrivenConfiguration topic, and this is the generally-advisable means of handling complex configuration of behavior now.
Reference
Properties defined in idp.properties directly related to this configuration area follow:
Property
Type
Default
Function
Property
Type
Default
Function
idp.entityID
URI
None
The unique name of the IdP, used as the "issuer" in all SAML profiles
idp.artifact.enabled
Boolean
true
Whether to allow use of the SAML artifact bindings when sending messages
idp.artifact.secureChannel
Boolean
true
Whether preparation of messages to be communicated via SAML artifact should assume use of a secure channel (allowing signing and encryption to be skipped)
idp.artifact.endpointIndex
Integer
2
Identifies the <ArtifactResolutionService> endpoint in SAML metadata associated with artifacts issued by a server node
idp.bindings.inMetadataOrder 4.1
Boolean
true
Controls whether the outbound binding selection is ordered by the SP's metadata or the IdP's preferred bindings (the inbuilt default order is Redirect -> POST -> Artifact -> SOAP). Set to false to leave artifact support on, but favor use of POST. Set also to false to favor the front channel over back channel for Logout.
Beans defined in relying-party.xml and related system configuration follow:
A template bean for defining RelyingParty overrides based on matching by <EntitiesDescriptor> groups or SAML metadata-based <AffiliationDescriptor> groups
A template bean for defining RelyingParty overrides based on matching <EntityAttributes> extension content that has been mapped via the AttributeRegistryConfiguration
Default configuration for SAML Artifact usage, injected into artifact-supporting SAML profile beans
Without stepping fully into the SecurityConfiguration topic, the following defaults are used when enabling individual profiles. In addition, an appropriate "security policy" flow is enabled during request processing to enforce appropriate security guarantees.
All SAML Profiles
includeConditionsNotBefore = true
assertionLifetime = PT5M
signedRequests = false
signAssertions = false
Shibboleth.SSO
includeAttributeStatement = false
signResponses = true
use of type 1 SAML artifacts where required
SAML1.AttributeQuery and SAML1.ArtifactResolution
signResponses = true if TLS isn't used or port 443 is used
SAML2.SSO and SAML2.ECP
includeAttributeStatement = true
skipEndpointValidationWhenSigned = false
maximumSPSessionLifetime = 0
signResponses = true
encryptAssertions = true
encryptNameIDs = false
encryptAttributes = false
use of type 4 SAML artifacts where required with an endpoint index of %{idp.artifact.endpointIndex:2}
SAML2.Logout
signRequests = true on front channel, if TLS isn't used or port 443 is used on back channel
signResponses = true on front channel, if TLS isn't used or port 443 is used on back channel
encryptNameIDs = true on front channel, if TLS isn't used or port 443 is used on back channel
use of type 4 SAML artifacts where required with an endpoint index of %{idp.artifact.endpointIndex:2}
SAML2.AttributeQuery and SAML2.ArtifactResolution
signResponses = true if TLS isn't used or port 443 is used
encryptAssertions = true if TLS isn't used or port 443 is used