NameIDConsumptionConfiguration

Current File(s): conf/c14n/subject-c14n.xml, conf/c14n/subject-c14n.properties (V4.1+)
Format: Native Spring, Properties (V4.1+)

Overview

Mapping SAML identifiers into a user identity is one of the use cases for Subject Canonicalization. This mechanism is applied when a SAML 1 <NameIdentifier> or SAML 2 <NameID> element is passed into the IdP and needs to be mapped back into a username. The most common example is when an AttributeQuery message is received, and the IdP needs to recover the user's identity to pass into the attribute resolver. There are a few additional scenarios where this might happen, but they're substantially less common.

Each method of mapping SAML-carried identifiers into a username is implemented as a subflow and described using a descriptor bean that tells the IdP how to run that flow. The supplied flows handle all of the standard use cases for turning SAML Name Identifiers back into usernames, and little or no configuration is generally needed.

The subject-c14n.xml file includes the list of descriptors that describe the possible flows available, and some additional configuration. You might need to modify this file to enable the mapping of custom name identifier Formats into usernames, such as email addresses or DNs.

In V4.1+, there are also a couple of properties for global control over case folding added in subject-c14n.properties.

General Configuration

The shibboleth.SAMLSubjectCanonicalizationFlows bean is a list of the descriptor beans defining the SAML c14n flows available to run.

By default, it contains flows for both memory- and crypto-based transient identifier reversal, and non-functional stubs for mapping custom string-based identifiers back into usernames, optionally applying regular expression transforms (and in V4.1+, case folding). A commented out flow also exists for reversing storage-managed SAML 2 persistent identifiers.

In the majority of cases, you shouldn't need to add to this list of flows, but if you were to build some kind of custom flow that perhaps relied on a web service or something of that nature, this is where it would be added in order to control the order of the flows attempted.

If you want to allow reversal of persistent IDs, they must be generated using a storage-based strategy (see NameIDGenerationConfiguration) and you must uncomment the "c14n/SAML2Persistent" bean reference here.

Finally, if you wanted to disable the capability to reverse map transient IDs in various ways, you could comment out or remove the relevant references here. A very slight performance improvment might be gained, for example, by removing the flows corresponding to the transient-generation strategy you're not using.

Custom Identifier Mapping

It is generally a rare requirement to support reversing more customized Name Identifier formats, which are typically used for commercial SAML-enabled services that have no occasion to issue queries or other requests that would contain the identifiers.

In the event that this is required, the required components for this are already in place and just need to be turned on and configured by adjusting one or more of the other beans toward the end of the file.

The most important one is the shibboleth.NameTransformPredicate which controls the circumstances under which the custom mapping flow will be allowed to run. This is for security reasons, to prevent just any requester (even if trusted in general) from performing queries using a particular identifier. The bean itself must be a Predicate object. The example configuration demonstrates how to create a condition that requires the requester be one of a listed set of named entities, which given the rarity of this use case, may often be sufficient. But any Predicate can be used, even a script.

The shibboleth.NameTransformFormats bean is a list of the custom Name Identifier Format(s) that you want to support. The pre-existing list contains a number of Formats defined by SAML. You may need to add to it if you or some other party needs to exchange a custom Format.

This custom mapping flow supports some simple transform capability out of the box. The shibboleth.NameTransforms bean is a list of regular expression and replacement string pairs that can transform the input value into a different username value rather than importing it directly. V4.1 adds a couple of properties that allow case folding, which helps deal with comparison problems if the SP populates the value based on user input.

In the most unusual cases, V4.1 + adds support for injecting a custom object of your own creation that implements the NameIDDecoder (SAML 2.0) or NameIdentifierDecoder (SAML 1.1) interfaces to fully customize the decoding process. The bean names shibboleth.SAML2Transform.NameIDDecoder and shibboleth.SAML1Transform.NameIdentifierDecoder are reserved for this purpose.

Reference

Properties defined in conf/c14n/subject-c14n.properties are as follows:

Name

Type

Default

Description

Name

Type

Default

Description

idp.c14n.saml.lowercase

Boolean

false

Whether the incoming value should be lower-cased by the "c14n/SAML2Transform" and "c14n/SAML1Transform" flows

idp.c14n.saml.uppercase

Boolean

false

Whether the incoming value should be upper-cased by the "c14n/SAML2Transform" and "c14n/SAML1Transform" flows

Beans defined in conf/c14n/subject-c14n.xml are as follows:

Bean ID

Type

Description

Bean ID

Type

Description

shibboleth.SAMLSubjectCanonicalizationFlows                

List<NameIDCanonicalizationFlowDescriptor>

List of flow descriptors enumerating the canonicalization flows to run on incoming Name Identifiers

shibboleth.NameTransformFormats

List<String>

List of Format values to run the "c14n/SAML2Transform" and "c14n/SAML1Transform" flows against

shibboleth.NameTransformPredicate

Predicate<ProfileRequestContext>

Activation condition for the "c14n/SAML2Transform" and "c14n/SAML1Transform" flows

shibboleth.NameTransforms

List<String,String>

List of regular expression and replacement string pairs to apply to the input to the "c14n/SAML2Transform" and "c14n/SAML1Transform" flows

shibboleth.SAML2Transform.NameIDDecoder 4.1

NameIDDecoder

Custom decoder to use to implement the "c14n/SAML2Transform" flow's behavior

shibboleth.SAML1Transform.NameIdentifierDecoder 4.1

NameIdentifierDecoder

Custom decoder to use to implement the "c14n/SAML1Transform" flow's behavior

shibboleth.AbstractSAML1C14NFlowBean
shibboleth.AbstractSAML2C14NFlowBean

NameIDCanonicalizationFlowDescriptor

Parent beans for defining additional flow descriptors