Available in 1.5 1.6 1.7 1.8 1.9 1.10 1.11 stable devel

IdP hosted metadata reference

Table of Contents

This is a reference for the metadata files metadata/saml20-idp-hosted.php and metadata/shib13-idp-hosted.php. Both files have the following format:

<?php
/* The index of the array is the entity ID of this IdP. */
$metadata['entity-id-1'] = array(
    'host' => 'idp.example.org',
    /* Configuration options for the first IdP. */
);
$metadata['entity-id-2'] = array(
    'host' => '__DEFAULT__',
    /* Configuration options for the default IdP. */
);
/* ... */

The entity ID should be an URI. It can, also be on the form __DYNAMIC:1__, __DYNAMIC:2__, .... In that case, the entity ID will be generated automatically.

The host option is the hostname of the IdP, and will be used to select the correct configuration. One entry in the metadata-list can have the host __DEFAULT__. This entry will be used when no other entry matches.

1 Common options

auth
Which authentication module should be used to authenticate users on this IdP.
authproc
Used to manipulate attributes, and limit access for each SP. See the authentication processing filter manual.
certificate
Certificate file which should be used by this IdP, in PEM format. The filename is relative to the cert/-directory.
host
The hostname for this IdP. One IdP can also have the host-option set to __DEFAULT__, and that IdP will be used when no other entries in the metadata matches.
OrganizationName
The name of the organization responsible for this IdP. This name does not need to be suitable for display to end users.

This option can be translated into multiple languages by specifying the value as an array of language-code to translated name:

'OrganizationName' => array(
    'en' => 'Example organization',
    'no' => 'Eksempel organisation',
),

Note: If you specify this option, you must also specify the OrganizationURL option.

OrganizationDisplayName
The name of the organization responsible for this IdP. This name must be suitable for display to end users. If this option isn't specified, OrganizationName will be used instead.

This option can be translated into multiple languages by specifying the value as an array of language-code to translated name.

Note: If you specify this option, you must also specify the OrganizationName option.

OrganizationURL
An URL the end user can access for more information about the organization.

This option can be translated into multiple languages by specifying the value as an array of language-code to translated URL.

Note: If you specify this option, you must also specify the OrganizationName option.

privacypolicy
This is an absolute URL for where an user can find a privacypolicy. If set, this will be shown on the consent page. %SPENTITYID% in the URL will be replaced with the entity id of the service the user is accessing.

Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

privatekey
Name of private key file for this IdP, in PEM format. The filename is relative to the cert/-directory.
privatekey_pass
Passphrase for the private key. Leave this option out if the private key is unencrypted.
scope
An array with scopes for this IdP. The scopes will be added to the generated XML metadata.
userid.attribute
The attribute name of an attribute which uniquely identifies the user. This attribute is used if simpleSAMLphp needs to generate a persistent unique identifier for the user. This option can be set in both the IdP-hosted and the SP-remote metadata. The value in the sp-remote metadata has the highest priority. The default value is eduPersonPrincipalName.

Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

2 SAML 2.0 options

The following SAML 2.0 options are available:

assertion.encryption
Whether assertions sent from this IdP should be encrypted. The default value is FALSE.

Note that this option can be set for each SP in the SP-remote metadata.

AttributeNameFormat
What value will be set in the Format field of attribute statements. This parameter can be configured multiple places, and the actual value used is fetched from metadata by the following priority:
  1. SP Remote Metadata

  2. IdP Hosted Metadata

The default value is: urn:oasis:names:tc:SAML:2.0:attrname-format:basic

Some examples of values specified in the SAML 2.0 Core Specification:

  • urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified

  • urn:oasis:names:tc:SAML:2.0:attrname-format:uri (The default in Shibboleth 2.0)

  • urn:oasis:names:tc:SAML:2.0:attrname-format:basic (The default in Sun Access Manager)

You can also define your own value.

Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

https.certificate
The certificate used by the webserver when handling connections. This certificate will be added to the generated metadata of the IdP, which is required by some SPs when using the HTTP-Artifact binding.
nameid.encryption
Whether NameIDs sent from this IdP should be encrypted. The default value is FALSE.

Note that this option can be set for each SP in the SP-remote metadata.

SingleSignOnService
Override the default URL for the SingleSignOnService for this IdP. This is an absolute URL. The default value is <simpleSAMLphp-root>/saml2/idp/SSOService.php

Note that this only changes the values in the generated metadata and in the messages sent to others. You must also configure your webserver to deliver this URL to the correct PHP page.

SingleLogoutService
Override the default URL for the SingleLogoutService for this IdP. This is an absolute URL. The default value is <simpleSAMLphp-root>/saml2/idp/SingleLogoutService.php

Note that this only changes the values in the generated metadata and in the messages sent to others. You must also configure your webserver to deliver this URL to the correct PHP page.

saml20.sendartifact
Set to TRUE to enable the IdP to send responses with the HTTP-Artifact binding. Defaults to FALSE.

Note that this requires a configured memcache server.

saml20.sign.response
Whether <samlp:Response> messages should be signed. Defaults toTRUE`.

Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

saml20.sign.assertion
Whether <saml:Assertion> elements should be signed. Defaults toTRUE`.

Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

sign.logout
Whether to sign logout messages sent from this IdP.

Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

validate.authnrequest
Whether we require signatures on authentication requests sent to this IdP.

Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

validate.logout
Whether we require signatures on logout messages sent to this IdP.

Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

2.1 Fields for signing and validating messages

simpleSAMLphp only signs authentication responses by default. Signing of logout requests and logout responses can be enabled by setting the redirect.sign option. Validation of received messages can be enabled by the redirect.validate option.

These options set the default for this IdP, but options for each SP can be set in saml20-sp-remote. Note that you need to add a certificate for each SP to be able to validate signatures on messages from that SP.

redirect.sign
Whether logout requests and logout responses sent from this IdP should be signed. The default is FALSE.
redirect.validate
Whether authentication requests, logout requests and logout responses received sent from this IdP should be validated. The default is FALSE

Example: Configuration for signed messages

 'redirect.sign' => true,

3 Shibboleth 1.3 options

The following options for Shibboleth 1.3 IdP's are avaiblable:

scopedattributes
Array with names of attributes which should be scoped. Scoped attributes will receive a Scope-attribute on the AttributeValue-element. The value of the Scope-attribute will be taken from the attribute value:

<AttributeValue>someuser@example.org</AttributeValue>

will be transformed into

<AttributeValue Scope="example.org">someuser</AttributeValue>

By default, no attributes are scoped. Note that this option also exists in the SP-remote metadata, and any value in the SP-remote metadata overrides the one configured in the IdP metadata.

4 Examples

These are some examples of IdP metadata

4.1 Minimal SAML 2.0 / Shibboleth 1.3 IdP

<?php
/*
 * We use the '__DYNAMIC:1__' entity ID so that the entity ID
 * will be autogenerated.
 */
$metadata['__DYNAMIC:1__'] = array(
    /*
     * We use '__DEFAULT__' as the hostname so we won't have to
     * enter a hostname.
     */
    'host' => '__DEFAULT__',

    /* The private key and certificate used by this IdP. */
    'certificate' => 'server.crt',
    'privatekey' => 'server.pem',

    /*
     * The authentication source for this IdP. Must be one
     * from config/authsources.php.
     */
    'auth' => 'example-userpass',
);