Skip to content
Dashboard
Theme
Theme

Shibboleth SAML single sign-on

Set up SAML single sign-on with Shibboleth

View Markdown

Register this app as a SAML 2.0 service provider on your Shibboleth server from our metadata, release the user attributes and share your identity provider metadata with us.

The values in braces, such as {metadata_url}, are specific to your connection. The setup link from the application you are connecting shows them with a copy button. The same steps appear there.

  1. On your Shibboleth server, add this app as a SAML 2.0 service provider by loading its metadata from {metadata_url}. The metadata carries the ACS URL, the entity ID and our signing certificate, so you do not type them in.

    Paste into Shibboleth:

    • SP metadata URL: {metadata_url}
  2. Confirm that the service provider’s entity ID is {sp_entity_id} and its ACS URL is {acs_url}. If you configure service providers by hand instead of from metadata, enter these two values.

    Paste into Shibboleth:

    • SP entity ID: {sp_entity_id}
    • ACS URL: {acs_url}

    Fixes: saml_destination_mismatch, saml_audience_mismatch

  3. Release a persistent name ID to this service provider, so each user keeps the same identifier over time. If your policy prefers it, release the email address as the name ID instead.

    Fixes: saml_nameid_missing

  4. Release mail (urn:oid:0.9.2342.19200300.100.1.3), givenName (urn:oid:2.5.4.42) and sn (urn:oid:2.5.4.4) to this service provider. To send groups, also release isMemberOf (urn:oid:1.3.6.1.4.1.5923.1.5.1.1).

    Fixes: saml_email_missing

  5. Make sure Shibboleth signs the SAML response, the assertion or both, and uses SHA-256 (RSA-SHA256) as the signature algorithm.

    Fixes: saml_signature_missing, saml_signature_algorithm_weak

  6. Add your server’s identity provider metadata to this setup. It is usually published at an address of the form “https://your-host/idp/shibboleth”. Do this again whenever the signing certificate changes, unless this setup reads it from the URL.

    Fixes: saml_signature_invalid, saml_issuer_mismatch

  7. Run a test sign-in in this setup, signing in as a user you assigned to the app.

If our main network ever has an outage, sign-ins can continue through a standby address. Our metadata at {metadata_url} lists it as a second ACS URL, so a server that loads the metadata accepts it. Reload the metadata if you entered the values by hand, check that {standby_acs_url} is listed, then confirm in this setup that you added it.

Paste into Shibboleth:

  • SP metadata URL: {metadata_url}
  • Standby ACS URL: {standby_acs_url}

This step is optional. See standby route behavior for what the standby address does during an outage.