You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

This guide describes how the Shibboleth v3 SP can be configured as a SAML Service Provider for eduTEAMS. 

Shibboleth (pronounced "Shibboleth") is the reference implementation of the OASIS SAML standard.

Setting up the Shibboleth Service Provider is beyond the scope of this document. Many resources are available, such as the Shibboleth Wiki (https://wiki.shibboleth.net) and the installation instructions supplied and maintained by SWITCH (https://www.switch.ch/aai/guides/sp/installation/).

It is assumed in the following that you are using Shibboleth's v3 SP alongside the Apache webserver.

Shibboleth configuration

Locate the file shibboleth2.xml. For example, using the switch.ch instructions (see above) for an Ubuntu Linux system, you will find the file at /etc/shibboleth/shibboleth2.xml.


We show to the right, sections of the file in which you will need to enter information relevant to your installation.




Enter your [your_sp_entity_id]:

eg https://example.com/shibboleth

<!-- By default, in-memory StorageService, ReplayCache, ArtifactMap, and SessionCache are used. See example-shibboleth2.xml for samples of explicitly configuring them. -->
<!-- The ApplicationDefaults element is where most of Shibboleth's SAML bits are defined. -->
<ApplicationDefaults entityID="[your_sp_entity_id]"
    REMOTE_USER="mail"
    cipherSuites="DEFAULT:!EXP:!LOW:!aNULL:!eNULL:!DES:!IDEA:!SEED:!RC4:!3DES:!kRSA:!SSLv2:!SSLv3:
                  !TLSv1:!TLSv1.1"
    >

Make sure handlerSSL="true" cookieProps="https" exist as follows:

        <Sessions lifetime="28800" timeout="3600" relayState="ss:mem"
                  checkAddress="false" handlerSSL="true" cookieProps="https">

Enter your [vo_entity_id]:

eg https://proxy.eduteams.org/saml2sp/sso/redirect 

<!--
Configures SSO for a default IdP. To properly allow for >1 IdP, remove
entityID property and adjust discoveryURL to point to discovery service.
You can also override entityID on /Login query string, or in RequestMap/htaccess.
-->
<SSO entityID="https://proxy.eduteams.org/saml2sp/sso/redirect">
SAML2
</SSO>


Enter both [vo_entity_id] and [your_sp_homepage]:

eg https://proxy.eduteams.org/saml2sp/sso/redirect 

and

https://example.com

<SessionInitiator type="Chaining" Location="/Login" isDefault="true" id="Login"
entityID="https://proxy.eduteams.org/saml2sp/sso/redirect"
target="[your_sp_homepage]"
relayState="cookie">
<SessionInitiator type="SAML2" template="bindingTemplate.html"/>
<SessionInitiator type="Shib1"/>
</SessionInitiator>


Enter [your_support_email_address]:

eg support@example.com

<!--
        Allows overriding of error template information/filenames. You can
        also add your own attributes with values that can be plugged into the
        templates, e.g., helpLocation below.
        -->
        <Errors supportContact="[your_support_email_address]"
            helpLocation="/about.html"
            styleSheet="/shibboleth-sp/main.css"/>


Please note the filenames used for the signing and encryption certificates. See note in this document for help with these if required.

        <!-- Simple file-based resolvers for separate signing/encryption keys. -->
        <CredentialResolver type="File" use="signing"
            key="sp-key.pem" certificate="sp-cert.pem"/>
        <CredentialResolver type="File" use="encryption"
            key="sp-key.pem" certificate="sp-cert.pem"/>

Shibboleth signing and encryption certificates

You can use the command shib-keygen to create the signing and encryption pairs.

shib-keygen -h [your_sp_domain]

eg

shib-keygen -h example.com


Apache configuration


You will need to configure Apache to recognize Shibboleth should act as an authorization "gatekeeper".


You can do this at the VirtualHost level, for example.

<VirtualHost example.com:443>

...

<Location />

AuthType shibboleth

<IfVersion < 2.3>

ShibCompatWith24 On

</IfVersion>

ShibRequestSetting requireSession false

require shibboleth

ShibRequestSetting requireSession 1
ShibUseEnvironment On
<RequireAny>
"GEANT_CO:GEANT Staff:CO_COU_GEANT Staff_members_active"
Require shib-attr member "GEANT_CO:GEANT Staff:CO_COU_GEANT Staff_members_active" "GEANT Staff:All"
</RequireAny>

</Location>


</VirtualHost>
  • No labels