File(s): conf/relying-party.xml, conf/idp.properties
Format: Native Spring / Deprecated Custom Schema
Legacy V2 File(s): conf/relying-party.xml
The relying-party.xml file is used to specify the SAML (or other) functions you want the IdP to support (these are termed "profiles"), and to customize IdP or profile settings based on the identity or other characteristics of a relying party service.
You might modify this file to:
- control which profiles are supported for particular partners (or for anonymous requests)
- alter default profile or global settings
- define and attach custom security configurations at various levels, such as:
- 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.
When using the deprecated syntax for compatibility with V2, refer to the older documentation. For those with an understanding of that syntax, you will find a significant attempt to overlap/emulate that structure, hopefully with some simplifications that Spring's more general syntax makes possible.
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 in the default configuration files by making use of conventions, parent beans, and fixed bean IDs to limit the amount of wiring you have to perform to make useful changes.
You MUST define three beans:
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 last one is a list bean for any overrides, again of that type. Those beans will generally contain an
activationCondition property that determines whether one applies to a request or not, such that the first applicable override bean is used. More on that below.
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
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.
In V2, there were essentially two kinds of
<RelyingParty> overrides, both sharing a
Name attribute; matching was done based on the entityID of the SP, or by walking SAML metadata to locate matching containing
With V3, this is generalized to allow for arbitrary conditions attached to an override definition. The arbitrary nature of these conditions are the main reason we've avoided the use of custom XML schema in various places in the IdP; it would be impossible to express everything without a great deal of work, and it would make the job of creating new conditions much harder for developers. But the downside is that defining and attaching a condition can require more than a few lines of Spring wiring in some cases.
To simplify this in a few common scenarios, we have included additional template beans that can be inherited from to more easily express some conditions. Right now, we have three such examples, emulating the two conditions supported by V2 and adding a third:
Examples of how to use these follow:
(Note that the second example above uses a Spring Expression Language inline list.)
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 going to change over time and are very limiting.
V3.4 introduces 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.
An alternative grouping strategy is based on
<EntityAttributes> metadata extension tags.
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 in relying-party.xml. 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.
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 use 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:
- SAML2.Logout 3.2
They are all active by default because they 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 to enable the CAS protocol, 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.
Overriding Default Settings Statically
To override a default profile option, you can replace a
<ref> element with a bean definition like so:
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.
Overriding Default Settings Dynamically 3.3
With V3.3 and above, most profile settings can be derived at runtime using Java functions or scripts, termed "lookup strategies", instead of declaring them statically. This can be done for default or overridden relying party configurations, and provides a powerful way of combining different kinds of rules.
This is a useful trick to use 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.
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. In particular, it becomes possible to create discrete (even centrally maintained) scripts to check for tags and return particular settings, and then apply all the scripts together to a single relying party configuration, once, and then never modify the scripts or the relying party configuration on a routine basis. Instead, you apply a setting by attaching a tag to metadata, which may be manageable upstream of the IdP by a federation or locally using some kind of metadata management tool.
In the long run, building tools to manage metadata or a single configuration file like the metadata configuration is more practical than building tools to manage many different files, and there is more potential for standardization and use across software products.
As an example, the same case above handled using tags might look something like this:
It doesn't appear vastly simpler or shorter, but the scripts are a bit simpler and more importantly, changing the set of entities the scripts apply to can be managed through metadata and not by updating the scripts or conditions.
Custom Profile Defaults
If custom profile defaults are needed for several categories of relying party, it is helpful to define top-level profile beans and reference them in the relying parties instead of the system default beans. This approach reduces duplication and produces a more readable configuration. A concrete example is instructive: suppose that an IdP needs to declare custom NameID precedence for SSO profiles for the default relying party and several overrides. The following configuration excerpt demonstrates the approach applied to that case.
Beans defined in relying-party.xml and related system configuration follow:
|shibboleth.UnverifiedRelyingParty||RelyingPartyConfiguration||Configures IdP behavior for unauthenticated/unverifiable requests|
|shibboleth.DefaultRelyingParty||RelyingPartyConfiguration||Configures default IdP behavior for authenticated/verified requests|
|shibboleth.RelyingPartyOverrides||List<RelyingPartyConfiguration>||Configures non-default IdP behavior for requests that meet activation conditions attached to overrides|
|RelyingParty||RelyingPartyConfiguration||A template bean for use in defining RelyingParty overrides by hand|
|RelyingPartyByName||RelyingPartyConfiguration||A template bean for defining RelyingParty overrides based on matching by name|
|RelyingPartyByGroup||RelyingPartyConfiguration||A template bean for defining RelyingParty overrides based on matching by |
|RelyingPartyByTag||RelyingPartyConfiguration||A template bean for defining RelyingParty overrides based on matching |
|TagCandidate||EntityAttributesPredicate.Candidate||A template bean for defining EntityAttribute matching rules for injection into beans based on RelyingPartyByTag|
|BrowserSSOProfileConfiguration||Default configuration for SAML 1.1 SSO profile|
|AttributeQueryProfileConfiguration||Default configuration for SAML 1.1 Attribute Query profile|
|ArtifactResolutionProfileConfiguration||Default configuration for SAML 1.1 Artifact Resolution profile|
|BrowserSSOProfileConfiguration||Default configuration for SAML 2.0 SSO profile|
|ECPProfileConfiguration||Default configuration for SAML 2.0 Enhanced Client/Proxy profile|
|SAML2.Logout||Default configuration for SAML 2.0 Single Logout profile|
|AttributeQueryProfileConfiguration||Default configuration for SAML 2.0 Attribute Query profile|
|ArtifactResolutionProfileConfiguration||Default configuration for SAML 2.0 Artifact Resolution profile|
|SSOSProfileConfiguration||Default configuration for Liberty ID-WSF Delegated SSO profile|
|CAS.LoginConfiguration||LoginConfiguration||Default configuration for CAS login prototol|
|CAS.ProxyConfiguration||ProxyConfiguration||Default configuration for CAS proxy login protocol|
|CAS.ValidateConfiguration||ValidateConfiguration||Default configuration for CAS ticket validation protocol|
|shibboleth.DefaultArtifactConfiguration||BasicSAMLArtifactConfiguration||Default configuration for SAML Artifact usage, injected into artifact-supporting SAML profile beans|
Properties defined in idp.properties directly related to this configuration area follow:
|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 |
System Profile Defaults
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
- signedRequestsPredicate = alwaysFalse
- signAssertionsPredicate = alwaysFalse
- signRequestsPredicate =
The V3 IdP supports the deprecated V2 relying-party.xml schema for compatibility and ease of upgrades, but deployers are encouraged to plan for migration off of this format, as it will cease to be supported in a future version. The IdP should load any existing V2 relying-party.xml file and configure itself in an expected manner. This can also potentially overlap with and SecurityConfiguration, but not all of the file is actually processed; all of the content related to security policy rules at the end of the file is ignored and no changes made to that section will affect the IdP. A warning is issued when this legacy content is ignored.
In order to load a legacy relying-party.xml file, a special set of resources must be loaded in services.xml to ensure proper compatibility support. This is intended to be triggered by setting "idp.service.relyingparty.resources = shibboleth.LegacyRelyingPartyResolverResources" in services.properties, which is done for you when an upgraded installation is performed.
The support for the legacy format is limited in that not all new IdP features can be supported. In particular, specifying custom or advanced rules for when to activate particular
<RelyingParty> elements is not possible, nor is it possible to specify per-RelyingParty use of signing or encryption algorithms. Essentially you get the V2 feature set when using the old syntax.