The DARIAH Authentication and Authorization Infrastructure (DARIAH AAI) is based on SAML and Shibboleth in the European higher education identity inter-federation eduGAIN and its members. See AARC Federations 101 Training Module or the DASISH Training on AAI for a gentle introduction to the underlying concepts.
For setting up a service in the DARIAH AAI, you want to protect it with a Shibboleth Service Provider, e.g. by following this SWITCHaai Tutorial. Other SP software following the SAML v2 standard can be used as well. In order to integrate better with the DARIAH AAI, follow this presentation on DARIAH AAI. See below for Service Developer Resources.
Researchers and students in organizations that do not operate an federated Identity Provider can request a DARIAH "homeless" account using the DARIAH SelfService. It can be accessed here: https://auth.dariah.eu/cgi-bin/selfservice/ldapportal.pl.
For administrators, there is a DARIAH User Administration which can be accessed here. It allows you to create and manage "homeless" and federated accounts, assign users to authorization groups, e.g. DARIAH Wiki spaces, and manage organizations in a country. See the DARIAH User Administration manual. If you have a question to the admins, please send e-Mail to firstname.lastname@example.org.
DARIAH AAI is integrated in Higher Education Federations using the SAML standard. This means any Web application should integrate with a so-called SAML Service Provider (SP). The SP will protect your application, driving the log-in process and providing your application with attributes about the user who has logged in using a SAML Identity Provider (IdP) at another organization. Be sure you understand these concepts well, perhaps using the Federations 101 article that is linked above.
In the following, we concentrate on securing your Web application using the Shibboleth SP, which is a widely used and flexible, programming language independent Apache- oder IIS-based module. However, there are other popular Open Source SAML SPs around, such as simpleSAMLphp, pySAML2, mod_auth_mellon, or Spring-Security-SAML, or even commercial ones.
Refer to Example Shibboleth SP Configuration for some example configuration files for all use-cases described below.
The Shibboleth SP will do all processing of SAML requests and handling of SAML responses for you. An application only needs to decide on when login should occur, evaluate user attributes (provided as environment variables to the application) and base its access decisions upon it. For a first overview, you can follow this SWITCHaai Tutorial. It sums up to two steps:
If you are using puppet, there is a puppet module created by SUB Göttingen that has some DARIAH AAI specifics and can be found at https://github.com/DARIAH-DE/puppetmodule-dariahshibboleth.
Since Summer 2018, DARIAH has run an AAI Proxy. Any DARIAH service provider can use the Proxy's Identity Provider component for authentication. The Proxy's SP component, however, is registered in the eduGAIN meta-federation and will allow researchers with any IdP in eduGAIN to log in.
Here is what needs to be done to connect to the DARIAH AAI Proxy:
<Attribute name="urn:oid:184.108.40.206.4.1.59220.127.116.11.13" id="unique-id"><AttributeDecoder xsi:type="ScopedAttributeDecoder"/></Attribute>
The DARIAH AAI has been designed with several goals in mind.
Here's a diagram of how the architecture looks like.
See the following sections for a description of the dariah-specific attributes teh DARIAH AAI Proxy sends.
These attributes need to be available in the attribute-map.xml configuration file of your Shibboleth SP (usually under /etc/shibboleth).
Some of these attributes are already present there and you only need to remove the comments around them.
The DARIAH-specific attributes need to be added entirely. The order is not relevant.
|Attribute name||Attribute oid||Example value||Description|
Unique identifier within the DARIAH AAI. Recommended for personalisation in services.
Is only different from eduPersonUniqueID for legacy DARIAH accounts;
Might contain scopes different from "@dariah.eu" for these accounts.
|eduPersonScopedAffiliation||urn:oid:email@example.com||Might contain scopes different from "@dariah.eu"|
|eduPersonAffiliation||urn:oid:18.104.22.168.4.1.5922.214.171.124.1||member||Will only contain "member" since this attribute is unscoped.|
The following code is an excerpt of the attribute definitions done in the attribute-map.xml configuration file:
<!-- eduPerson attributes --> <Attribute name="urn:oid:126.96.36.199.4.1.59188.8.131.52.13" id="unique-id"> <AttributeDecoder xsi:type="ScopedAttributeDecoder"/> </Attribute> <Attribute name="urn:oid:184.108.40.206.4.1.59220.127.116.11.6" id="eppn"> <AttributeDecoder xsi:type="ScopedAttributeDecoder"/> </Attribute> <Attribute name="urn:oid:18.104.22.168.4.1.5922.214.171.124.9" id="affiliation"> <AttributeDecoder xsi:type="ScopedAttributeDecoder"/> </Attribute> <Attribute name="urn:oid:126.96.36.199.4.1.59188.8.131.52.1" id="unscoped-affiliation"/> <Attribute name="urn:oid:184.108.40.206.4.1.59220.127.116.11.7" id="entitlement"/> <!-- standard attributes --> <Attribute name="urn:oid:18.104.22.168" id="cn"/> <!-- common name --> <Attribute name="urn:oid:22.214.171.124" id="givenName"/> <Attribute name="urn:oid:126.96.36.199" id="sn"/> <!-- surname --> <Attribute name="urn:oid:2.16.840.1.1137188.8.131.52" id="displayName"/> <Attribute name="urn:oid:2.16.840.1.1137184.108.40.206" id="preferredLanguage"/> <Attribute name="urn:oid:220.127.116.11" id="o"/> <!-- organization --> <Attribute name="urn:oid:0.9.2342.19200300.100.1.3" id="mail"/> <Attribute name="urn:oid:18.104.22.168.4.1.2522.214.171.124" id="schacCountryOfCitizenship"/> <!-- DARIAH-specific --> <Attribute name="urn:oid:126.96.36.199.4.1.59188.8.131.52.1" id="isMemberOf"/> <Attribute name="urn:oid:184.108.40.206.4.1.10220.127.116.11.2" id="dariahRole"/> <Attribute name="urn:oid:18.104.22.168.4.1.1022.214.171.124.15" id="dariahTermsOfUse"/>
Some attributes in the DARIAH AAI are scoped, i.e. they contain the domain of the issuing IdP:
The SP must be configured in a way that it will accept scopes different from @dariah.eu for these two attributes from the AAI proxy. This is done by commenting some lines in attribute-policy.xml:
[...] <afp:AttributeRule attributeID="affiliation"> <afp:PermitValueRule xsi:type="AND"> <RuleReference ref="eduPersonAffiliationValues"/> <!-- accept any scope <RuleReference ref="ScopingRules"/> --> </afp:PermitValueRule> </afp:AttributeRule> [...] <!-- accept any scope for legacy users, i.e. comment the eppn policy fully <afp:AttributeRule attributeID="eppn"> <afp:PermitValueRuleReference ref="ScopingRules"/> </afp:AttributeRule> --> [...]
DARIAH Administrators can assign users to groups, such as "texgrid-users", or "dariah-de-contributors". Such groups can be open for anybody, or upon request - see the DARIAH Self Service Documentation. The central DARIAH directory (DARIAH LDAP server) holds these authorization group information. Your service can use this multi-valued attribute in order to implement fine-grained access restrictions.
<Attribute name="urn:oid:126.96.36.199.4.1.59188.8.131.52.1" id="isMemberOf"/>
Consequently your Shibboleth SP will provide all values it receives as an Apache environment variable with the name isMemberOf. Please refer to the according documentation on how to use this in your application. It is also possible to use this information as Apache Access rules.
isMemberOf is a multi-valued attribute, meaning, that it includes all groups the user is a member of with the individual values separanted by semicola ;.
Example: consider a user that is member of the groups textgrid-users and dariah-de-contributors. The resulting value of isMemberOf would be "texgrid-users;dariah-de-contributors".
DARIAH adminstrators can operate on a global or national level, or just for a single organization. See the DARIAH User Administration Documentation for the concept of the implementation. The central DARIAH directory (DARIAH LDAP server) holds this information as well. Your service can use this multi-valued attribute in a similar way.
<Attribute name="184.108.40.206.4.1.10220.127.116.11.2" id="dariahRole"/>
The value of the dariahRole attribute will include all roles the user is a member of in the DARIAH LDAP server, once again separated by semicola and in their context, as they do on the LDAP directory.
Example: consider a user with three different roles in the DARIAH LDAP directory:
The resulting value of dariahRole would be "cn=DCO-admin;cn=National Representative,c=DE;cn=orgadmin,o=SUB,c=DE".
If your application needs personal data, e.g. the e-mail address, or displayName, the DARIAH AA can provide this. With the e-mail as an example, one would
<Attribute name="urn:oid:0.9.2342.19200300.100.1.3" id="mail"/>
In order to check for your Service's Custom Terms, do the following:
<Attribute name="urn:oid:18.104.22.168.4.1.1022.214.171.124.15" id="dariahTermsOfUse"/>
The recommended way of connecting a service with DARIAH is via the AAI proxy, see above. However, in some exceptional cases you might want to set up direct trust with the DARIAH "homeless" IdP. This might apply if:
The recipe to configure your Shibboleth SP is as follows: