The IdP's Attribute Filtering Engine is a policy engine that determines what information, expressed as attributes as described in the Attribute Resolver design document, is released by the IdP. This gives the author of the filtering policies the power to permit or deny the release of information regardless of what a requester may have asked for.
Anatomy of an Attribute Filter Policy
An attribute filter policy contains:
- an ID to identify the policy
- a policy requirement rule to determine if the policy applies to an attribute filter context
- attribute rules to permit or deny the release of attribute values
Anatomy of an Attribute Rule
An attribute rule contains:
- the ID of the attribute the rule applies to
- a matching function operating on the values
Rules may be for permitting values (releasing the values for which the matching function evaluates true) and denying values (blocking the values for which the matching function evaluates true).
The Filtering Process
The attribute filtering process is invoked with a given collection of attributes (probably having come from the attribute resolver) and proceeds as follows:
For every attribute filter policy loaded in to the engine:
- The policy requirement rule is evaluated. If the requirement rule is met, processing continues.
- For each attribute value filter within the policy
- the attribute referenced by the attribute value filter is looked up, if the attribute is present processing continues
- the value matching function is executed against the values of the attribute
- the matching attribute values are recorded as either values to be permitted or denied based on the value filter's flag
Once all of the filter policies have been processed then, for every attribute provided when the filtering engine was invoked
- All values which are not marked as permitted or which are specifically denied are removed.
- Any attributes which contain no values are removed from the collection
There are a couple things to note about this process. First, the value set of an attribute is not adjusted until the end of the filtering process is complete. This means that all policy requirement rules and attribute value filters operate on the full, unfiltered, set of values for attributes. Second, only those values that explicitly permitted and not denied are released by the filter engine. If a value is never matched by an attribute value filter it will never be released.
In V2 many different rules were implemented. Some were more applicable to policy rules (for instance
AttributeRequesterString) and some were more applicable to attributes rules (for instance
Nonetheless all sorts of rules were made (and documented to be) applicable in both roles. Somewhat arbitrary interpretations were imposed, for instance:
AttributeValueStringinside a <
PolicyRequirementRule/>was taken as "If any value of any attribute matches then this rule is true".
PrincipalNameString, when applied to be an
<AttributeRule/>was taken as "if it is true then return all values of the selected attribute".
These interpretations were coded up in the implementation of each individual rule, and so were not necessarily consistent.
Take 1, Take 2, Take 3, Take 4, Take 5, Take 6
In the schema a
<MatchFunctor/> can be placed either in a
<PolicyRequirementRule/> or in a
<PermitRule/> or a
In all IdP implementations to date this bimodality has been handled by having an interface with methods to support both types of operation. This implementation explicitly separates these two types which are now represented by two interfaces
This has a single method which takes a
FilterContext and returns a tristate (yes/no/fail)
This has a single method which takes a
FilterContext and an attribute and returns a (potentially empty) Set of attribute values with null representing the “fail” condition.
Logical operators (and/or/not)
Each of these have two implementations one of which implements
PolicyRequirement and the other of which implements
Matcher. The parsing code inspects the provided element and instructs Spring to create a bean of the correct sort. We need to ensure that the setter/getters are the same in both cases. Job done.
All other operators
These implement only one of
Matcher, whichever allows the more natural implementation.
Three bridging classes are available to convert between these two types:
PolicyRequirement(as a constructor parameter) and implements
Matcher(as a constructor parameter) and implements
PolicyFromMatcherId(or some such name) takes a Matcher and an Attribute Id (as constructor parameters) and implements Policy Requirement. This class is aimed at attribute value matchers which have an attribute Id specified.
Furnished with these three functions the parsers can “do the right thing” and the implementations can concentrate on implementing the natural functionality.
The parsers need to become slightly more complicated since they now have to detect what sort of interface need to be implemented and summon up the “bridging beans” – whilst ensuring that the Id generated make sense. Note that it may become necessary to doubly next the bridging classes.
<afp:PermitValueRule xmlns="urn:mace:shibboleth:2.0:afp:mf:basic" xsi:type="AttributeValueString" value="faculty" attributeId="affiliation"/>
Would be a
- Nested inside a
- Nested inside a
AttributeInMetadata will be implemented to be compatible with the V2.4 and later implementations.
The work will be done by comparing native IdP IdPAttribute and IdPAttributeValue objects. This means that we need to have a mechanism to convert from SAML2
<RequestedAttributes/> into native IdP IdPRequestedAttribute which extends IdPAttribute with appropriate values.
Doing this requires a reverse mapping (decoding). We will use (most of) the
urn:mace:shibboleth:2.0:attribute-map schema to define this mapping.
The decoding will be done by a stage prior to attribute filtering and the results inserted into the AttributeFilterContext as a multi map (from AttributeId to requested attribute).
The decoding need to take account of the types of the attribute values. The following types will be supported
The behavior of the filter is different between the case where the (SAML) RequestedAttribute had no values (if match by attribute name and format then pass all values) is very distinct from the case where the (SAML) RequestedAttribute had but they could not be decoded (if match by name and format then pass no values). Therefore if such a situation arises the multimap will have a null RequestedAttribute inserted for the given attribute.
As a final note, correct operation of this filter will require that the attribute values can be compared. All AttributeValue implementations explictly implement #equals(), but XMLObjectAttributeValue delegates to OpenSAML which tends to not implement #equals(), so we may seek to issue warnings in this case.
Filter rules have optional identifiers. In V3 we want to provide logging information based on these identifiers. The paradigm we will use is to general an identifier for anonymous rules when the filter is inititialized. We will log (at info level) the (random, run time) name given to the filter and a self-generated description. For instance:
Attribute Filter: Anonymous filter given name 'AB567F': Description "And filterRule of filters ["59C0F", "89034"].
Parameters to the Attribute Filter operation are provided by the AttributeFilterContext. In addtion, the AttributeFilterWorkContext is used as work space for the attribute filtering process; this context is entirely private to the specific implementation of attribute filtering.
Programming Guide to Attribute Filtering
A web flow that wishes to invoke the Attribute Filtering subsystem must do the following.
- Create an AttributeFilterContext and populate it with appropriate parameters (where relevant)
- The canonical Prinicipal name
- The entityID of the IdP and the SP
- The authentication method applied.
- Add a lookup strategy to allow relevant filters to navigate from the Attribute Filter Context to a SAMLMetadataContext via a call to setRequesterMetadataContextLookupStrategy
- Any requested attributed (converted into into internal names and IdPRequestedAttribute) should be populated via a call to setRequestedAttributes
- The attributes to be filteres should be populated via a call to setRequessetPrefilteredIdPAttributestedAttributes
- Locate an Attribute Filter. This would usually be done via a ReloadableSpringService. See Configuration, Resources and Reload.
- Call the filter. After filtering the result can be extracted via the getFilteredIdPAttributes method.
- If using a ReloadableSpringService. do not forget to call unpinComponent.