SimpleSAMLphp Identity Provider QuickStart
$Id: simplesamlphp-idp.txt 2711 2011-01-12 14:25:46Z olavmrk $
Table of Contents
- 1 Enabling the Identity Provider functionality
- 2 Authentication module
- 3 Configuring the authentication module
- 4 Configuring the IdP
- 5 Using the
uriNameFormat on attributes
- 6 Adding SPs to the IdP
- 7 Creating a SSL self signed certificate
- 8 Adding this IdP to other SPs
- 9 Testing the IdP
- 10 Support
- 11 A. IdP-first setup
This guide will describe how to configure simpleSAMLphp as an identity provider (IdP). You should previously have installed simpleSAMLphp as described in the simpleSAMLphp installation instructions
The first that must be done is to enable the identity provider functionality. This is done by editing
config/config.php. The options
enable.shib13-idp controls whether SAML 2.0 and Shibboleth 1.3 support is enabled. Enable one or both of those by assigning
true to them:
'enable.saml20-idp' => true, 'enable.shib13-idp' => true,
The next step is to configure the way users authenticate on your IdP. Various modules in the
modules/ directory provides methods for authenticating your users. This is an overview of those that are included in the simpleSAMLphp distribution:
- Authenticate against a LDAP database with a SSL client certificate.
- Authenticate against a list of usernames and passwords.
- Automatically log in as a user with a set of attributes.
- Authenticates an user to a LDAP server.
- Authenticates an user to one of several LDAP server. The user can choose the LDAP server from a dropdown list.
- Authenticate an user against a database.
- Authenticates an user to a Radius server.
- Authenticate with an InfoCard.
- Allow the user to select from a list of authentication sources.
- Authenticate against an OpenID provider.
- Authenticate against a SAML IdP. Can be used for bridging.
- Authenticate with an YubiKey.
- Authenticate with a Facebook ID.
- Authenticate with your Twitter account using the Twitter OAuth API.
In this guide, we will use the
exampleauth:UserPass authentication module. This module does not have any dependencies, and is therefore simple to set up.
exampleauth:UserPass authentication module is part of the
exampleauth module. This module isn't enabled by default, so you will have to enable it. This is done by creating a file named
On unix, this can be done by running (from the simpleSAMLphp installation directory):
The next step is to create an authentication source with this module. An authentication source is an authentication module with a specific configuration. Each authentication source has a name, which is used to refer to this specific configuration in the IdP configuration. Configuration for authentication sources can be found in
In this setup, this file should contain a single entry:
<?php $config = array( 'example-userpass' => array( 'exampleauth:UserPass', 'student:studentpass' => array( 'uid' => array('student'), 'eduPersonAffiliation' => array('member', 'student'), ), 'employee:employeepass' => array( 'uid' => array('employee'), 'eduPersonAffiliation' => array('member', 'employee'), ), ), );
This configuration creates two users -
employee, with the passwords
employeepass. The username and password is stored in the array index (
student:studentpass for the
student-user. The attributes for each user is configured in the array referenced by the index. For the student user, these are:
array( 'uid' => array('student'), 'eduPersonAffiliation' => array('member', 'student'), ),
The attributes will be returned by the IdP when the user logs on.
The IdP is configured by the metadata stored in
This is a minimal configuration of a SAML 2.0 IdP:
<?php $metadata['__DYNAMIC:1__'] = array( /* * The hostname for this IdP. This makes it possible to run multiple * IdPs from the same configuration. '__DEFAULT__' means that this one * should be used by default. */ 'host' => '__DEFAULT__', /* * The private key and certificate to use when signing responses. * These are stored in the cert-directory. */ 'privatekey' => 'server.pem', 'certificate' => 'server.crt', /* * The authentication source which should be used to authenticate the * user. This must match one of the entries in config/authsources.php. */ 'auth' => 'example-userpass', );
For more information about available options in the idp-hosted metadata files, see the IdP hosted reference.
The interoperable SAML 2 profile specifies that attributes should be delivered using the
We therefore recommended enabling this in new installations.
This can be done by adding the following to the saml20-idp-hosted configuration:
'AttributeNameFormat' => 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri', 'authproc' => array( // Convert LDAP names to oids. 100 => array('class' => 'core:AttributeMap', 'name2oid'), ),
The identity provider you are configuring needs to know about the service providers you are going to connect to it.
This is configured by metadata stored in
This is a minimal example of a
metadata/saml20-sp-remote.php metadata file for a simpleSAMLphp SP:
<?php $metadata['https://sp.example.org/simplesaml/module.php/saml/sp/metadata.php/default-sp'] = array( 'AssertionConsumerService' => 'https://sp.example.org/simplesaml/module.php/saml/sp/saml2-acs.php/default-sp', 'SingleLogoutService' => 'https://sp.example.org/simplesaml/module.php/saml/sp/saml2-logout.php/default-sp', );
Note that the URI in the entityID and the URLs to the AssertionConsumerService and SingleLogoutService endpoints change between different service providers.
If you have the metadata of the remote SP as an XML file, you can use the built-in XML to simpleSAMLphp metadata converter, which by default is available as
/admin/metadata-converter.php in your simpleSAMLphp installation.
For more information about available options in the sp-remote metadata files, see the SP remote reference.
For test purposes, you can skip this section, and use the certificate included in the simpleSAMLphp distribution.
Here is an example of an
openssl-command which can be used to generate a new private key key and the corresponding self-signed certificate.
This key and certificate can be used to sign SAML messages:
openssl req -newkey rsa:2048 -new -x509 -days 3652 -nodes -out example.org.crt -keyout example.org.pem
The certificate above will be valid for 10 years.
simpleSAMLphp will only work with RSA certificates. DSA certificates are not supported.
The certificate that is included in the simpleSAMLphp distribution must NEVER be used in production, as the private key is also included in the package and can be downloaded by anyone.
The method for adding this IdP to a SP varies between different types of SPs. In general, most SPs need some metadata from the IdP. This should be available from
The simplest way to test the IdP is to configure a simpleSAMLphp SP on the same machine. See the instructions for configuring simpleSAMLphp as an SP.
When running a simpleSAMLphp IdP and a simpleSAMLphp SP on the same computer, the SP and IdP MUST be configured with different hostnames. This prevents cookies from the SP to interfere with cookies from the IdP.
If you need help to make this work, or want to discuss simpleSAMLphp with other users of the software, you are fortunate: Around simpleSAMLphp there is a great Open source community, and you are welcome to join! The forums are open for you to ask questions, contribute answers other further questions, request improvements or contribute with code or plugins of your own.
- simpleSAMLphp homepage (at Feide RnD)
- List of all available simpleSAMLphp documentation
- Join the simpleSAMLphp user's mailing list
- Visit and contribute to the simpleSAMLphp wiki
If you do not want to start the SSO flow at the SP, you may use the IdP-first setup. To do this, redirect the user to the SSOService endpoint on the IdP with one parameter
spentityid that match the SP EntityId that the user should be logged into.
Here is an example of such an url:
If the SP is a simpleSAMLphp SP, you must also specify a
RelayState parameter for the SP.
This must be set to an URL the user should be redirected to after authentication.
RelayState parameter can be specified in the SP configuration, or it can be sent from the IdP.
To send the RelayState parameter from a simpleSAMLphp IdP, specify it in the query string to SSOService.php:
To set it in the SP configuration, add it to
'default-sp' => array( 'saml:SP', 'RelayState' => 'https://sp.example.org/welcome.php', ),