Stay safe. Stay home. www.sacoronavirus.co.za.

Requirements for SAML2 Service Providers

This page documents the history of SAFIRE’s Requirements for SAML2 Service Providers and will display the most recent version. You should always reference this page when linking to the Requirements for SAML2 Service Providers, unless you intend to link to a specific, versioned document.

Changes to the Requirements for SAML2 Service Providers that are purely technical in nature must reach rough consenus/no opposition at the SAFIRE Participants' Forum. Changes to the administrative requirements are synchronised with the Metadata Registration Practice Statement.

Version History

Requirements for SAML2 Service Providers v20210303

Changes to the Requirements for SAML2 Service Providers that are purely technical must reach rough consensus/no opposition at the SAFIRE Participants' Forum. Changes to the administrative requirements are synchronised with the Metadata Registration Practice Statement. This version reached rough consensus on 31 March 2021.

The following describes the technical and administrative checks made before a service provider is admitted into the SAFIRE federation within the SAML2 Technology Profile. It also serves as a checklist for service provider operators for assessing their readiness to participate.

Metadata

In order to be included in the federation registry, service provider metadata:-

  • MUST1 have an entityID that is a URL (well-known location). The URL SHOULD use the https scheme, and it is RECOMMENDED that valid metadata be available at this URL.
  • MUST use secure (https) end-points for any <md:AssertionConsumerService>, <md:SingleLogoutService> or <md:ArtifactResolutionService>.
  • MUST contain an <md:Organization> element, where:
    • <md:OrganizationName> MUST reflect the legal name of the juristic person.
    • <md:OrganizationDisplayName> MUST be present and SHOULD reflect a commonly known or shortened version of the organisation’s name
    • <md:OrganizationURL> MUST contain the organisation’s web site address.
  • MUST contain at least one <md:ContactPerson> of contactType="technical" and SHOULD contain one of contactType="support". Where <md:EmailAddress> is given this SHOULD be a role account rather than an individual.
  • SHOULD contain at least one <md:ContactPerson> conforming to the REFEDS Security Contact Metadata Extension that reflects the entity’s security contact(s). It is further RECOMMENDED that entities consider whether they can attest Sirtfi compliance.
  • MUST contain an <mdui:UIInfo>, with at least the following elements set:
    • <mdui:DisplayName> — meaningful name for service.
    • <mdui:Description> — short (max 140 chars) explanation of the purpose of the service, such that it is reasonably apparent why the attributes requested are required.
    • <mdui:PrivacyStatementURL> — web site containing a copy of the service provider’s privacy policy.
    • <mdui:Logo> – a logo representing the service. Logos MUST be either served from a secure (https) server or expressed as a data: URI2. At least one logo SHOULD have an aspect ratio as close to 1:1 as possible and SHOULD be at least 100x100 pixels (although 300x300 is RECOMMENDED). Ideally, logos should be smaller than 40KB.
  • SHOULD NOT contain a <mdrpi:RegistrationInfo> element (any existing one SHALL be removed by the federation agregator)
  • MUST contain <md:RequestedAttribute> entries.
  • SAML certificates included in metadata SHOULD be self-signed. RSA public keys MUST be at least 2048 bits in length, and EC public keys MUST be at least 256 bits in length. It is RECOMMENDED that new RSA deployments use key lengths of at least 3072 bits.
  • Web server certificates used for end-points MUST use PKI that is reasonably likely to be embedded in the browser of all users of the service. Unless an explanation is provided, these SHALL be tested against the root CA lists of common browsers.
  • Where cryptographic signatures are required in SAML, these MUST NOT use algorithms based on MD5 or SHA1; use of RSA-SHA256 is RECOMMENDED.

Note: SAFIRE curates metadata to ensure both technical correctness and compliance with administrative controls. Changes to metadata are not automatically propagated. Organisations that need to make changes to their metadata need to submit a change request..

Language and Localisation

The SAML metadata specification allows display elements such as <md:OrganizationName> to be localised by using the xml:lang attribute to specify a BCP 47 language code. In common with other federations worldwide, English (xml:lang="en") MUST always be included and will be used as the default when no localised version is available.

It is strongly RECOMMENDED that official translations of organisation, display, or service names be included in metadata. In particular, prominent South African languages such as isiZulu (zu), isiXhosa (xh) and/or Afrikaans (af) are encouraged.

Technical

  • Clocks MUST be synchronised via the Network Time Protocol (NTP; SNTP) or equivalent such that they ultimately derive their time from the South African master clock maintained by the National Metrology Institute of South Africa or an acceptable alternative (e.g. za.pool.ntp.org).
  • Logs of successful authentications MUST be retained for at least 184 days.
  • Federation metadata SHOULD be refreshed at least once per day and MUST be refreshed at least once per cacheDuration.

Administrative

  • Participants that are not already signatories of the REN Service Agreement MUST provide documentary proof of legal name by means of one of the following:
    • CIPC registration certificate;
    • Trust deed;
    • SARS tax clearance certificate;
    • NPO registration; OR
    • Any other mutually acceptable means.
  • Participants MUST have signed a Participation Agreement.
  • Above paperwork SHOULD only to be completed for the first <md:SPSSODescriptor>. A given Participant MAY register more than one service provider, and subsequent ones are assumed to be bound by the same agreement.
  • Each entity must be accompanied by a separate registration request form.

For each <md:SPSSODescriptor>, the Federation Operator and Particpant MUST agree on:

  • Statement of purpose to be reflected in <mdui:Description>.
  • Attribute release policy to be reflected as <md:RequestedAttribute> — note that per the principle of minimality, requested attributes MUST be adequate, relevant, and not excessive.
  • The basis for processing for any personal information (determining whether the transfer notice will inform or request consent)
  • Whether the entity meets the requirements for research and scholarship.
  • Whether the entity should be published into inter-federation metadata (opt-in).

  1. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119. ↩︎

  2. Masinter, L., “The ‘data’ URL scheme”, RFC 2397, August 1998. ↩︎

South African Identity Federation