...
Anchor | ||||
---|---|---|---|---|
|
Software Requirements
To release attributes to all current and future R&S SPs with a one-time configuration, an IdP leverages entity attributes (instead of entity IDs). Thus the configuration steps documented here require Shibboleth IdP v2.3.4 or later, which fully supports using entity attributes in SP metadata as part of an attribute release filter policy.
...
Anchor | ||||
---|---|---|---|---|
|
Basic R&S Configuration
Configure an IdP to Release Attributes Globally
Configure a Shibboleth IdP to release the R&S Attribute Bundle to all R&S SPs, including R&S SPs in other federations, as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
<afp:AttributeFilterPolicy id="releaseRandSAttributeBundle"> <!-- for Shib IdP V3, use type saml:EntityAttributeExactMatch instead --> <afp:PolicyRequirementRule xsi:type="saml:AttributeRequesterEntityAttributeExactMatch" attributeName="http://macedir.org/entity-category" attributeValue="http://refeds.org/category/research-and-scholarship"/> <!-- a fixed subset of the Research & Scholarship Attribute Bundle --> <afp:AttributeRule attributeID="eduPersonPrincipalName"> <afp:PermitValueRule xsi:type="basic:ANY"/> </afp:AttributeRule> <!-- if your deployment of ePPN is non-reassigned, release of ePTID is OPTIONAL --> <afp:AttributeRule attributeID="eduPersonTargetedID"> <afp:PermitValueRule xsi:type="basic:ANY"/> </afp:AttributeRule> <afp:AttributeRule attributeID="email"> <afp:PermitValueRule xsi:type="basic:ANY"/> </afp:AttributeRule> <!-- either displayName or (givenName and sn) is REQUIRED but all three are RECOMMENDED --> <afp:AttributeRule attributeID="displayName"> <afp:PermitValueRule xsi:type="basic:ANY"/> </afp:AttributeRule> <afp:AttributeRule attributeID="givenName"> <afp:PermitValueRule xsi:type="basic:ANY"/> </afp:AttributeRule> <afp:AttributeRule attributeID="surname"> <afp:PermitValueRule xsi:type="basic:ANY"/> </afp:AttributeRule> <!-- release of ePSA is OPTIONAL --> <afp:AttributeRule attributeID="eduPersonScopedAffiliation"> <afp:PermitValueRule xsi:type="basic:ANY"/> </afp:AttributeRule> </afp:AttributeFilterPolicy> |
Configure an IdP to Release Attributes Locally
This section is for existing R&S IdPs that want to continue to release attributes to R&S SPs registered by InCommon only.
...
Note that the registrars
XML attribute takes a space-separated list of registrar IDs and therefore the previous configuration is most flexible.
Advanced R&S Configuration
To release less than the full R&S Attribute Bundle, or to restrict attribute release in other ways, apply one or more of the advanced configurations documented in this section.
Choose a Subset of the R&S Bundle
Choose one of the following pair of policies to release a subset of the R&S Attribute Bundle to requesters.
Info | ||
---|---|---|
| ||
Shibboleth IdP v2.4.3 (or later) is required to release a dynamic subset of the R&S bundle as shown below. |
Release a Fixed Subset of the R&S Bundle
The following policy releases a fixed subset of the R&S Attribute Bundle to requesters.
...
Anchor | ||||
---|---|---|---|---|
|
Release a Dynamic Subset of the R&S Bundle
The following policy releases a dynamic subset of the R&S Attribute Bundle by filtering the actual release of attributes based on <md:RequestedAttribute>
elements in SP metadata.
...
Visit the Shibboleth wiki for more information about type saml:AttributeInMetadata
.
Choose the Target Group of R&S SPs
Warning | ||
---|---|---|
| ||
Read the R&S Entity Metadata topic to fully understand the consequences of restricting attribute release to a proper subset of all R&S SPs. |
Release Attributes to All R&S SPs
The following pair of policy rules release attributes to all R&S SPs, including R&S SPs in other federations.
For Shib IdP v3.0.0 and higher
For Shibboleth IdP V3, release attributes to all R&S SPs as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
<afp:PolicyRequirementRule xsi:type="saml:EntityAttributeExactMatch" attributeName="http://macedir.org/entity-category" attributeValue="http://refeds.org/category/research-and-scholarship"/> |
For Shib IdPs prior to v3.0.0
For Shibboleth IdP V2, release attributes to all R&S SPs as follows:
...
Anchor | ||||
---|---|---|---|---|
|
Release Attributes to R&S SPs Registered by InCommon
The following pair of policy rules release attributes to R&S SPs registered by InCommon only. These policies are based on the following extension element in InCommon metadata:
...
The value of the registrationAuthority
XML attribute is the registrar's ID. Every metadata registrar has a globally unique ID. For example, the InCommon registrar has the ID shown in the previous example, namely, "https://incommon.org".
For Shib IdP v3.0.0 and higher
For Shibboleth IdP V3, release attributes to R&S SPs registered by InCommon as follows:
...
Info |
---|
The registrars XML attribute in the previous example takes a space-separated list of registrar IDs and can therefore be generalized to include other registrars, either in InCommon or in other federations. |