For a Shibboleth Identity Provider to join one of the Tuakiri Federations (Test/Dev or Production), the following steps have to be done:
- Registering the IdP in the Federation Registry
- Configuring the IdP to load the federation metadata
- Configuring the IdP to release the attributes required by the federation.
There are two federations available, both fully operational:
- Tuakiri Test/Development Environment (Tuakiri-TEST) for testing deployments and developing new features
- Tuakiri Production Federation Service (Tuakiri) for ready-for-production Identity Providers and services.
We recommend first registering a Test system into Tuakiri-TEST and after successful testing, register a production-ready system into Tuakiri Production.
Registering an IdP into the Federation Registry
Go to the respecting Federation Registry URL and:
- Register an Organisation for your institution (if not already registered)
- For Contact Details, do not use a shared mailbox, alias or mailing list when entering an email address because the confirmation email contains a single-use link and may cause some confusion should more than one person attempt to use it.
- For Organization Name, enter your DNS domain name.
- For Organization Display Name, enter your actual organization name.
- Wait for the Organisation to be approved
- Register your IdP under that Organisation
If supporting ECP, advertise also your ECP SSO EndPoint:
As of version 2.6.0, the Federation Registry automatically registers the ECP endpoint on new registrations, so no explicit action should be required. To add an ECP endpoint to an existing IdP registration, perform the following:
In the Federation Registry registration for your IdP:
The IdP also needs to be configured to support ECP.
Configuring your IdP to load the federation metadata
The code snippets in this section have values for Tuakiri Production federation. Please update them accordingly as per the table above if configuring your IdP to join the Tuakiri TEST/DEV federation. (The key code snippets are for convenience given in the "Tuakiri-TEST specific" box below).
NOTE: Check what your IdP home directory is: the directory is typically called
shibboleth-idp - and on Debian and Ubuntu systems, it's commonly
/usr/local/shibboleth-idp, while on RedHat and CentOS it's
/opt/shibboleth-idp. The snippets below are referring to the IdP home directory as
To configure a 3.x IdP to Load the Tuakiri metadata:
For archival purposes, we also keep the original instructions for configuring the Tuakiri metadata into a 2.x IdP - unfold the box below to see the IdP 2.x compatible syntax:
Configure attribute release/filtering through the federation
To configure a 3.x IdP to Load the Tuakiri-managed attribute filter:
- Contact the federation administrators (by emailing firstname.lastname@example.org) and request a URL for the Attribute Filter for your IdP.
- In the request, please include:
- The name (hostname or entityID) of your IdP
- An email address that should receive notifications whenever the attribute filter changes (these are notifications only, no action will be required).
- The attribute filter may have to be manually added to the list of attribute filters published. Once created, the URL will have the form of:
For archival purposes, we also keep the original instructions for configuring the Tuakiri-managed attribute filter into a 2.x IdP - unfold the box below to see the IdP 2.x compatible syntax:
After requesting the attribute filter:
Add the following entry into
<srv:Service id="shibboleth.AttributeFilterEngine" in
$IDP_HOME/conf/service.xml(note that the URL varies for each IdP and has to be obtained from the federation administrators):
Note: if your
$IDP_HOME is different from
/opt/shibboleth-idp, change the file path in the above snippet accordingly.
If configuring this in Shibboleth IdP 2.1.x, do not use the srv: namespace prefix - i.e., use just:
We also strongly recommend you configure your IdP to periodically reload this file - we recommend at 2 hour intervals. This is documented in detail in the IdP Install Manual: Reloading configuration section and Load Attribute Filter sections. The simple step is to add the
configurationResourcePollingRetryAttempts="10" attributes to the
<srv:Service id="shibboleth.AttributeFilterEngine"element. If you already have these attributes set for reloading the local configuration file - with a shorter interval, please adjust them accordingly to 2 hours for the remotely loaded attribute filter:
+ configurationResourcePollingFrequency="PT2H0M0.000S" configurationResourcePollingRetryAttempts="10"
Now your IdP should be able to access service providers within the Tuakiri federation.
Appendix A - Alternative implementation
Loading the metadata and the attribute filter files from a remote URL makes the IdP depend on the accessibility of the remote URL. While for metadata itself, the IdP software should be sufficiently resilient, for attribute filter configuration, this is not the case. Tuakiri will be running their servers serving these XML files according to best practices. However, some sites may prefer not to take on the risk and put the XML file loading outside of the IdP, into a separate process. This section describes this alternative implementation. This implementation first downloads the XML file into a temporary file on the local machine. Once this is completed it then replaces the original configuration file with the new one, and this will be detected by the IdP and will cause a reload of this file.