Configuring SAML2 Web Single-Sign-On

Expand the SAML2 Web SSO Configuration and click Configure.
Select one of the following modes:

Metadata and URL configuration

When configuring a service provider (SP) or a federated identity provider (Federated IdP), the user is required to enter configuration data to facilitate exchanging authentication and authorization data between entities in a standard way. Apart from manual entering of configuration data, WSO2 IS allows you to upload configuration data using a metadata XML file or refer to a metadata XML file located in a predetermined URL. These two methods of uploading configuration data enable faster entry of configuration data because it allows the user to use the same metadata xml file for multiple instances of entity configuration. In addition to SAML metadata upload, WSO2 IS also supports SAML metadata download for the resident identity provider.

Manual configuration

Select Manual Configuration and fill in the form that appears.
Click Register.

The following points should be taken into consideration when filling the above New Service Provider form.

Field	Description	Sample value
Issuer	Specify the Issuer. This is the `<saml:Issuer>` element that contains the unique identifier of the service provider. This is also the issuer value specified in the SAML Authentication Request issued by the service provider. When configuring single-sign-on across Carbon servers, ensure that this value is equal to the ServiceProviderID value mentioned in the `<IS_HOME>/repository/conf/security/authenticators.xml` file of the relying party Carbon server.	travelocity.com
Assertion Consumer URLs	Specify the Assertion Consumer URLs. This is the URL to which the browser should be redirected to after the authentication is successful. This is the Assertion Consumer Service (ACS) URL of the service provider. The identity provider redirects the SAML2 response to this ACS URL. However, if the SAML2 request is signed and SAML2 request contains the ACS URL, the Identity Server will honor the ACS URL of the SAML2 request. It should have this format: https://(host-name):(port)/acs. You can add multiple assertion consumer URLs for the service provider by entering the URL and clicking the Add button.	http://wso2is.local:8080/travelocity.com/home.jsp
Default Assertion Consumer URL	Since there can be multiple assertion consumer URLs, you must define a Default Assertion Consumer URL in case you are unable to retrieve it from the authentication request. Tip: In a service provider initiated single sign-on setup, the following needs to be considered. If no ACS URL is given in the <`AuthnRequest`>, the Identity Server sends the response to the default ACS URL of the service provider (whether the request is signed or not). If the ACS URL in <`AuthnRequest`> matches with one of the registered URLs, the Identity Server sends the response to the matched one. If the ACS URL in <`AuthnRequest`> does not match any of the registered ACS URLs and if the request is signed, the Identity Server sends the response to the ACS URL in the request only if the signature is valid. Alternatively, the <`AuthnRequest`> is rejected. In an identity provider initiated single sign-on setup, the following needs to be considered. If the “acs” query parameter is not present in the request, the Identity Server sends the response to default ACS URL of the service provider. If the "acs” parameter is present and the value of that parameter matches with any of the registered ACS URLs of the service provider, then the Identity Server sends the response to the matched one.	http://wso2is.local:8080/travelocity.com/home.jsp
NameID format	Specify the NameID format. This defines the name identifier formats supported by the identity provider. The service provider and identity provider usually communicate with each other regarding a specific subject. That subject should be identified through a Name-Identifier (NameID) , which should be in some format so that It is easy for the other party to identify it based on the format. Name identifiers are used to provide information regarding a user. About NameID formats For SSO interactions, you can use the following types of NameID formats. `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` `urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified` `urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName` `urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName` `urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos` `urn:oasis:names:tc:SAML:2.0:nameid-format:entity` This specifies the name identifier format that the Identity Server wants to receive in the subject of an assertion from a particular identity provider. The following is the default format used by the identity provider. `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`	urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
Certificate Alias	Select the Certificate Alias from the dropdown. This is used to validate the signature of SAML2 requests and is used to generate encryption. Basically the service provider’s certificate must be selected here. Note that this can also be the Identity Server tenant's public certificate in a scenario where you are doing a tenant specific configuration. From WSO2 IS 5.5.0 onwards, the .pem certificate can be updated via the Service Provider screen in the management console UI using the Application Certificate field. If the certificate has been entered in the Application Certifiate field, the system will use the certificate given there and override the certificate alias field. However, if the Application Certificate field has been left blank, the certificate specified in Certificate Alias will be used.	wso2carbon
Response Signing Algorithm	Specifies the ‘SignatureMethod’ algorithm to be used in the ‘Signature’ element in POST binding. The default value can be configured in the `<IS_HOME>/repository/conf/identity.xml` file, in the `SSOService` element with `SAMLDefaultSigningAlgorithmURI` tag. If it is not provided the default algorithm is RSASHA 1, at URI ‘ http://www.w3.org/2000/09/xmldsig#rsasha1' .	http://www.w3.org/2000/09/xmldsig#rsasha1
Response Digest Algorithm	Specifies the ‘DigestMethod’ algorithm to be used in the ‘Signature’ element in POST binding. The default value can be configured in the `<IS_HOME>/repository/conf/identity.xml` file, in the `SSOService` element with `SAMLDefaultDigestAlgorithmURI` tag. If it is not provided the default algorithm is SHA 1, at URI ‘ `http://www.w3.org/2000/09/xmldsig#sha1`’.	http://www.w3.org/2000/09/xmldsig#sha1
Assertion Encryption Algorithm	The algorithm that the SAML2 assertion is encrypted. The default value can be configured in the `<IS_HOME>/repository/conf/identity.xml` file, in the `SSOService` element with `SAMLDefaultAssertionEncryptionAlgorithm URI` tag. The default is http://www.w3.org/2001/04/xmlenc#aes256-cbc.	www.w3.org/2001/04/xmlenc#aes256-cbc
Key Encryption Algorithm	The algorithm that the SAML2 key is encrypted. The default value can be configured in the `<IS_HOME>/repository/conf/identity.xml` file, in the `SSOService` element with `SAMLDefaultKeyEncryptionAlgorithm` URI tag. The default algorithm is http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p	www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p
Enable Response Signing	Select Enable Response Signing to sign the SAML2 Responses returned after the authentication process.	Selected
Enable Signature Validation in Authentication Requests and Logout Requests	Select Enable Signature Validation in Authentication Requests and Logout Requests if you need this functionality configured. This specifies whether the identity provider must validate the signature of the SAML2 authentication request and the SAML2 logout request that are sent by the service provider.	Unselected
Enable Assertion Encryption	Enable Assertion Encryption, if you wish to encrypt the assertion.	Unselected
Enable Single Logout	Select Enable Single Logout so that all sessions are terminated once the user signs out from one server. If single logout is enabled, the identity provider sends logout requests to all service providers. Basically, the identity provider acts according to the single logout profile. If the service provider supports a different URL for logout, you can enter a SLO Response URL and SLO Request URL for logging out. These URLs indicate where the request and response should go to. If you do not specify this URL, the identity provider uses the Assertion Consumer Service (ACS) URL.	Selected
Enable Attribute Profile	Select Enable Attribute Profile to enable this and add a claim by entering the claim link and clicking the Add Claim button. The Identity Server provides support for a basic attribute profile where the identity provider can include the user’s attributes in the SAML Assertions as part of the attribute statement. Once you select the checkbox to Include Attributes in the Response Always, the identity provider always includes the attribute values related to the selected claims in the SAML attribute statement.	Unselected
Enable Audience Restriction	Select Enable Audience Restriction to restrict the audience. You may add audience members using the Audience text box and clicking the Add button.	Unselected
Enable Recipient Validation	Select this if you require validation from the recipient of the response.	Unselected
Enable IdP Initiated SSO	Select the Enable IdP Initiated SSO checkbox to enable this functionality. When this is enabled, the service provider is not required to send the SAML2 request.	Unselected
Enable IdP Initiated SLO	Select the Enable IdP Initiated SLO checkbox to enable this functionality. You must specify the URL.	Unselected
Enable Assertion Query Request Profile	Select the Enable Assertion Query Request Profile checkbox to query assertions that are persisted to the database when you login to the service provider application. For more information, see Querying SAML Assertions.	Unselected

Metadata file configuration

This option allows you to provide the configuration data required for configuring SAML2, by uploading a metadata .xml file instead of having to manually enter the values. This enables faster entry of configuration data and allows the user to use the same metadata XML file for multiple instances of entity configuration.

Select Metadata File Configuration.
Click Choose File, and select the .xml file containing the metadata for the service provider SAML configuration.

Click Upload.

From WSO2 IS 5.5.0 onwards, the certificate can be added via the Service Providers screen in the management console UI using the Application Certificate field. This means that certificates can now be directly added along with the service provider instead of having to import the certificate to the keystore and referring to it using the Certificate Alias field.

Therefore, when uploading a metadata file, the Application Certificate field in the Service Providers screen will automatically display the certificate that is embedded in the metatdata file. You can update or edit the certificate by editing the content within the Application Certificate field and uploading the metadata file again will override the existing certificate.

Click here to view a sample of the metadata configuration file

Service provider metadata file

<?xml version="1.0"?>
<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" validUntil="2018-07-25T04:49:17Z" cacheDuration="PT604800S" entityID="travelocity.com">
  <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="false" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
    <md:KeyDescriptor use="signing">
      <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
        <ds:X509Data>
          <ds:X509Certificate>MIIC+jCCAmOgAwIBAgIJAParOnPwEkKjMA0GCSqGSIb3DQEBBQUAMIGKMQswCQYDVQQGEwJMSzEQMA4GA1UECBMHV2VzdGVybjEQMA4GA1UEBxMHQ29sb21ibzEWMBQGA1UEChMNU29mdHdhcmUgVmlldzERMA8GA1UECxMIVHJhaW5pbmcxLDAqBgNVBAMTI1NvZnR3YXJlIFZpZXcgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MB4XDTEwMDcxMDA2MzMwM1oXDTI0MDMxODA2MzMwM1owdjELMAkGA1UEBhMCTEsxEDAOBgNVBAgTB1dlc3Rlcm4xEDAOBgNVBAcTB0NvbG9tYm8xFjAUBgNVBAoTDVNvZnR3YXJlIFZpZXcxETAPBgNVBAsTCFRyYWluaW5nMRgwFgYDVQQDEw9NeSBUZXN0IFNlcnZpY2UwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAN6bi0llFz+R+93nLLK5BmnuF48tbODpMBH7yGZ1/ESVUZoYm0GaPzg/ai3rX3r8BEr4TUrhhpKUKBpFxZvb2q+yREIeDEkDbHJuyVdS6hvtfa89WMJtwc7gwYYkY8AoVJ94gU54GP2B6XyNpgDTXPd0d3aH/Zt669xGAVoe/0iPAgMBAAGjezB5MAkGA1UdEwQCMAAwHQYDVR0OBBYEFNAwSamhuJSwXG0SJnWdIVF1PkW9MB8GA1UdIwQYMBaAFNa3YmhDO7BOwbUqmYU1k/U6p/UUMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQUFAAOBgQBwwC5H+U0a+ps4tDCicHQfC2SXRTgF7PlAu2rLfmJ7jyoDX+lFEoWDUoE5qkTpMjsR1q/+2j9eTyi9xGj5sby4yFvmXf8jS5L6zMkkezSb6QAvtSHcLfefKeidq6NDBJ8DhWHi/zvC9YbT0KkCToEgvCTBpRZgdSFxTJcUksqoFA==</ds:X509Certificate>
        </ds:X509Data>
      </ds:KeyInfo>
    </md:KeyDescriptor>
    <md:KeyDescriptor use="encryption">
      <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
        <ds:X509Data>
          <ds:X509Certificate>MIIC+jCCAmOgAwIBAgIJAParOnPwEkKjMA0GCSqGSIb3DQEBBQUAMIGKMQswCQYDVQQGEwJMSzEQMA4GA1UECBMHV2VzdGVybjEQMA4GA1UEBxMHQ29sb21ibzEWMBQGA1UEChMNU29mdHdhcmUgVmlldzERMA8GA1UECxMIVHJhaW5pbmcxLDAqBgNVBAMTI1NvZnR3YXJlIFZpZXcgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MB4XDTEwMDcxMDA2MzMwM1oXDTI0MDMxODA2MzMwM1owdjELMAkGA1UEBhMCTEsxEDAOBgNVBAgTB1dlc3Rlcm4xEDAOBgNVBAcTB0NvbG9tYm8xFjAUBgNVBAoTDVNvZnR3YXJlIFZpZXcxETAPBgNVBAsTCFRyYWluaW5nMRgwFgYDVQQDEw9NeSBUZXN0IFNlcnZpY2UwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAN6bi0llFz+R+93nLLK5BmnuF48tbODpMBH7yGZ1/ESVUZoYm0GaPzg/ai3rX3r8BEr4TUrhhpKUKBpFxZvb2q+yREIeDEkDbHJuyVdS6hvtfa89WMJtwc7gwYYkY8AoVJ94gU54GP2B6XyNpgDTXPd0d3aH/Zt669xGAVoe/0iPAgMBAAGjezB5MAkGA1UdEwQCMAAwHQYDVR0OBBYEFNAwSamhuJSwXG0SJnWdIVF1PkW9MB8GA1UdIwQYMBaAFNa3YmhDO7BOwbUqmYU1k/U6p/UUMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQUFAAOBgQBwwC5H+U0a+ps4tDCicHQfC2SXRTgF7PlAu2rLfmJ7jyoDX+lFEoWDUoE5qkTpMjsR1q/+2j9eTyi9xGj5sby4yFvmXf8jS5L6zMkkezSb6QAvtSHcLfefKeidq6NDBJ8DhWHi/zvC9YbT0KkCToEgvCTBpRZgdSFxTJcUksqoFA==</ds:X509Certificate>
        </ds:X509Data>
      </ds:KeyInfo>
    </md:KeyDescriptor>
    <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>
    <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="http://localhost:8080/travelocity.com/home.jsp" index="1"/>
  </md:SPSSODescriptor>
</md:EntityDescriptor>

URL configuration

Metadata for a service provider may be published in a well known location via a URI. This option allows you to provide the configuration data required for configuring SAML2, by providing a URI(Ex: "https://spconfigs.com/sample-sp.xml") instead of having to manually enter the values. This enables faster entry of configuration data and allows the user to use the same metadata XML file for multiple instances of entity configuration.

Select URL Configuration and enter the URL containing the service provider metadata.
Click Upload.

Additional configurations

Click here to expand for more information on signature algorithms.

The following table provides the list of signature algorithms available and their respective URI.

Signature algorithm name	Signature algorithm URI
DSA with SHA1	http://www.w3.org/2000/09/xmldsig#dsasha1
ECDSA with SHA1	http://www.w3.org/2001/04/xmldsigmore#ecdsasha1
ECDSA with SHA256	http://www.w3.org/2001/04/xmldsigmore#ecdsasha256
ECDSA with SHA384	http://www.w3.org/2001/04/xmldsigmore#ecdsasha384
ECDSA with SHA512	http://www.w3.org/2001/04/xmldsigmore#ecdsasha512
RSA with MD5	http://www.w3.org/2001/04/xmldsigmore#rsamd5
RSA with RIPEMD160	http://www.w3.org/2001/04/xmldsigmore#rsaripemd160
RSA with SHA1	http://www.w3.org/2000/09/xmldsig#rsasha1
RSA with SHA256	http://www.w3.org/2001/04/xmldsigmore#rsasha256
RSA with SHA384	http://www.w3.org/2001/04/xmldsigmore#rsasha384
RSA with SHA512	http://www.w3.org/2001/04/xmldsigmore#rsasha512

Click here to expand for more information on digest algorithms.

The following table provides the list of digest algorithms available and their respective URI.

Digest algorithm name	Digest algorithm URI
MD5	http://www.w3.org/2001/04/xmldsigmore#md5
RIPEMD160	http://www.w3.org/2001/04/xmlenc#ripemd160
SHA1	http://www.w3.org/2000/09/xmldsig#sha1
SHA256	http://www.w3.org/2001/04/xmlenc#sha256
SHA384	http://www.w3.org/2001/04/xmldsigmore#sha384
SHA512	http://www.w3.org/2001/04/xmlenc#sha512

If you need to sign the SAML response using an authenticated user's tenant keystore, please add the following configuration. (By default, the response is signed using the certificate that belongs to the tenant where the service provider is registered). This property must be added if the SAML authenticator version in the WSO2 Carbon products that you are using is 4.2.2 or higher (org.wso2.carbon.identity.authenticator.saml2.sso_4.2.2.jar).

Add the <UseAuthenticatedUserDomainCrypto> property available in the <IS_HOME>/repository/conf/identity.xml file as shown below.
```
<SSOService>
...
	<UseAuthenticatedUserDomainCrypto>true<UseAuthenticatedUserDomainCrypto>
</SSOService>
```

Related Topics

See SAML 2.0 Web SSO for more information on SAML2 single-sign-on and see the following topics for samples of configuring single-sign-on using SAML2.

See Using the SAML2 Toolkit for support on debugging issues with SAML2 configurations.