Changes between Initial Version and Version 1 of R&Ssupport


Ignore:
Timestamp:
07/09/12 16:38:03 (12 years ago)
Author:
dabantz@…
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • R&Ssupport

    v1 v1  
     1"Configuring a Shibboleth IdP to Release Attributes to an R&S SP" 
     2Configuring a Shibboleth IdP to Release Attributes to an R&S SP 
     3IdP 2.3.5 and above 
     4Always Release the Same Set of Attributes 
     5Release Only Those Attributes an SP Requests via Its Metadata Element 
     6Installation of the Plugin: 
     7Configure a Release Policy 
     8IdP Previous to v2.3.5 
     9Further Policy Controls 
     10A Shibboleth IdP can be configured -- once -- to release a set of attributes to any and every R&S SP (identified by an entity attribute), not specific SPs (identified by entityID). Local IdP policy determines which attributes and values will be released. The logistics for configuring a Shibboleth IdP to do this release varies, depending on which version of the IdP a site is using. 
     11 
     12IdP 2.3.5 and above 
     13An IdP can choose between possible configurations, depending on its policy needs: 
     14 
     15Always release the same set of attributes to every R&S SP. 
     16Release only those attributes an SP requests via its metadata element. 
     17Always Release the Same Set of Attributes 
     18The following configuration requires Shibboleth IdP v2.3.5 or later, which fully supports using entity attributes in SP metadata as part of an attribute release filter policy. 
     19 
     20Configure a new <AttributeFilterPolicy> element for R&S SPs.This example releases all of the R&S attributes; a campus should customize as appropriate (e.g., changing the attributeID values). 
     21 
     22<AttributeFilterPolicy id="releaseToRandS"> 
     23  <PolicyRequirementRule xsi:type="saml:AttributeRequesterEntityAttributeExactMatch" 
     24      attributeName="http://id.incommon.org/attribute/entity/category" 
     25      attributeValue="http://id.incommon.org/category/research-and-scholarship"/> 
     26  <AttributeRule attributeID="eduPersonPrincipalName"> 
     27    <PermitValueRule xsi:type="basic:ANY" /> 
     28  </AttributeRule> 
     29  <AttributeRule attributeID="email"> 
     30    <PermitValueRule xsi:type="basic:ANY" /> 
     31  </AttributeRule> 
     32  <AttributeRule attributeID="displayName"> 
     33    <PermitValueRule xsi:type="basic:ANY" /> 
     34  </AttributeRule> 
     35  <AttributeRule attributeID="givenName"> 
     36    <PermitValueRule xsi:type="basic:ANY" /> 
     37  </AttributeRule> 
     38  <AttributeRule attributeID="surName"> 
     39    <PermitValueRule xsi:type="basic:ANY" /> 
     40  </AttributeRule> 
     41  <AttributeRule attributeID="eduPersonScopedAffiliation"> 
     42    <PermitValueRule xsi:type="basic:ANY" /> 
     43  </AttributeRule> 
     44</AttributeFilterPolicy> 
     45Release Only Those Attributes an SP Requests via Its Metadata Element 
     46This approach relies on a plugin that is bundled with the uApprove add-on for Shibboleth. Information about uApprove is available at http://www.switch.ch/aai/support/tools/uApprove.html. It is NOT necessary for the site to run and use uApprove in order to take advantage of this plugin's capabilities. 
     47 
     48Installation of the Plugin: 
     49Follow these steps in order to use the plugin; it is NOT necessary to follow the full uApprove installation instructions: 
     50 
     51Download the uApprove package. 
     52Explode the package. 
     53(FIX) cp uApprove-2.2.1/idp-plugin-2.2.1/lib/* shibboleth-identityprovider-2.3.5/lib/. 
     54Run the standard IDP install steps (eg install.sh) 
     55Configure a Release Policy 
     56The following IdP configuration implicitly releases attributes to any R&S SP. An attribute is released if and only if it is listed in SP metadata. 
     57 
     58<AttributeFilterPolicy id="releaseToRandS"> 
     59  <PolicyRequirementRule xsi:type="saml:AttributeRequesterEntityAttributeExactMatch" 
     60      attributeName="http://id.incommon.org/attribute/entity/category" 
     61      attributeValue="http://id.incommon.org/category/research-and-scholarship"/> 
     62  <AttributeRule attributeID="eduPersonPrincipalName"> 
     63    <PermitValueRule xsi:type="ua:AttributeInMetadata" onlyIfRequired="false"/> 
     64  </AttributeRule> 
     65  <AttributeRule attributeID="email"> 
     66    <PermitValueRule xsi:type="ua:AttributeInMetadata" onlyIfRequired="false"/> 
     67  </AttributeRule> 
     68  <AttributeRule attributeID="displayName"> 
     69    <PermitValueRule xsi:type="ua:AttributeInMetadata" onlyIfRequired="false"/> 
     70  </AttributeRule> 
     71  <AttributeRule attributeID="givenName"> 
     72    <PermitValueRule xsi:type="ua:AttributeInMetadata" onlyIfRequired="false"/> 
     73  </AttributeRule> 
     74  <AttributeRule attributeID="surName"> 
     75    <PermitValueRule xsi:type="ua:AttributeInMetadata" onlyIfRequired="false"/> 
     76  </AttributeRule> 
     77  <AttributeRule attributeID="eduPersonScopedAffiliation"> 
     78    <PermitValueRule xsi:type="ua:AttributeInMetadata" onlyIfRequired="false"/> 
     79  </AttributeRule> 
     80</AttributeFilterPolicy> 
     81IdP Previous to v2.3.5 
     82These releases do not correctly support using entity attributes in SP metadata as part of an attribute release filter policy. For IdPs prior to v2.3.5, InCommon provides a tool that can be run on a regular basis to convert InCommon metadata into an explicit <AttributeFilterPolicy> element for R&S SPs. 
     83 
     84Further Policy Controls 
     85If a campus determines that it wants to block release of attributes for certain community members (e.g., students who have opted out under FERPA), IdP operators could create an additional attribute release policy to enforce this decision. An example is available on the Shibboleth wiki. IdP plugins, such as uApprove, that provide end-user control over attribute release may also be useful to satisfy additional controls.