This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, go to https://wso2.com/documentation/.
Configuring SAML 2.0 Web SSO
In a single sign on system there are two roles; Service Providers and Identity Providers. The important characteristic of a single sign on system is the pre-defined trust relationship between the service providers and the identity providers. Service providers trust the assertions issued by the identity providers and the identity providers issue assertions based on the results of authentication and authorization of principles which access services on the service provider's side.
SAML 2.0 web browser-based single-sign-on profile is defined under the SAML 2.0 Profiles specification. In a web browser-based SSO system, the flow can be started by the user either by attempting to access a service at the service provider, or by directly accessing the identity provider itself.
To navigate to the federated authenticators configuration section, do the following.
- Sign in. Enter your username and password to log on to the Management Console.
- Navigate to the Main menu to access the Identity menu. Click Add under Identity Providers.
For more information, see Configuring an Identity Provider. Fill in the details in the Basic Information section.
You can configure the following federated authenticators by expanding the Federated Authenticators section followed by the required subsections.
- Expand the SAML2 Web SSO Configuration form. The following appears.
Fill in the following fields where relevant. The * indicates required fields.
Field Description Sample value Enable SAML2 Web SSO Selecting this option enables SAML2 Web SSO to be used as an authenticator for users provisioned to the Identity Server. Selected Default Selecting the Default checkbox signifies that SAML2 Web SSO is the main/default form of authentication. This removes the selection made for any other Default checkboxes for other authenticators. Selected Identity Provider Entity Id This is basically the entity Id of the identity provider you are configuring. It must be unique among identity providers, for example, you cannot configure another identity provider with this same value. https://idp.example.org/idp/shibboleth Service Provider Entity Id This is the entity Id of the Identity Server. This is useful when differentiating between tenants. This can be any value but it is the value that should be configured in the identity provider to communicate with the Identity Server. So when configuring the Identity Server as a service provider in the identity provider side, this is the value to be configured wso2is SSO URL This is the URL that you want to send the SAML request to. It should have this format: https://(host-name):(port)/acs.Enable Authentication Request Signing Selecting this checkbox enables you to sign the authentication request. If this is enabled, you must sign the request using the private key of the identity provider. Selected Enable Assertion Encryption This is a security feature where you can encrypt the SAML2 Assertions returned after authentication. So basically, the response must be encrypted when this is enabled. Selected Enable Assertion Signing Select Enable Assertion Signing to sign the SAML2 Assertions returned after the authentication. SAML2 relying party components expect these assertions to be signed by the Identity Server.
Selected Enable Logout Select Enable Single Logout so that all sessions are terminated once the user signs out from one server. Selected Logout URL You can enter a custom Logout URL if you selected Enable Logout. If you do not enter anything here it will simply return to the SSO URL you specified. This is the URL that the logout request is directed to when the user attempts to log out.
To do this through the configuration file, open the
<IS_HOME>/repository/conf/security/authenticators.xmlfile and add the following parameters under the<SSOAuthenticator>configuration tag.<Parameter name="LogoutSupportedIDP">true</Parameter> <Parameter name="ExternalLogoutPage">EXTERNAL_LOGOUT_PAGE_URL</Parameter>
https://localhost:8443/idp/samlsso/logout Enable Logout Request Signing Selecting this checkbox enables you to sign the logout request. Selected Enable Authentication Response Signing Select Enable Authentication Response Signing to sign the SAML2 responses returned after the authentication.
Selected Signature Algorithm Specifies the ‘SignatureMethod’ algorithm to be used in the ‘Signature’ element in POST binding and “SigAlg” HTTP Parameter in REDIRECT binding. The expandable Signature Algorithms table below lists the usable algorithms and their respective URIs that will be sent in the actual SAMLRequest.
Default value is RSA with SHA1.Digest Algorithm Specifies the ‘DigestMethod’ algorithm to be used in the ‘Signature’ element in POST binding. The Digest Algorithms table below lists the usable algorithms and their respective URIs that will be sent in the actual SAMLRequest.
Default value is SHA1.Attribute Consuming Service Index Specifies the ‘AttributeConsumingServiceIndex’ attribute. By default this would be empty, therefore that attribute would not be sent unless filled. Enable Force Authentication Enable force authentication or decide from the incoming request. This affects ‘ForceAuthn’ attribute. Default value is As Per Request.Include Public Certificate Include the public certificate in the the request. Selected by default. Include Protocol Binding Include ‘ProtocolBinding’ attribute in the request. Selected by default. Include NameID Policy Include ‘NameIDPolicy’ element in the request. Selected by default. Include Authentication Context Include a new ‘RequestedAuthnContext’ element in the request, or reuse from the incoming request. Default value is Yes.Authentication Context Class Choose ‘AuthnContextClassRef’ element to be sent. Authentication Context Class table below lists the usable classes and their respective URIs that will be sent in the actual SAMLRequest.
Default value is “PasswordProtectedTransport”. Authentication Context Comparison Level Choose the Requested Authentication Context ‘Comparison’ attribute to be sent. Default value is “Exact”. SAML2 Web SSO User Id Location Select whether the User ID is found in 'Name Identifier' or if it is found among claims. If the user ID is found among the claims, it can override the User ID Claim URI configuration in the identity provider claim mapping section. User ID found among claims HTTP Binding Select the HTTP binding details that are relevant for your scenario. This refers to how the request is sent to the identity provider. HTTP-Redirect and HTTP-POST are standard means of sending the request. If you select As Per Request it can handle any type of request. HTTP-POST Additional Query Parameters This is necessary if you are connecting to another Identity Server or application. Sometimes extra parameters are required by this IS or application so these can be specified here. These will be sent along with the SAML request. paramName1=value1 Configure ACL URL in a production environment
The default assertion consumer URL that is sent with the SAML request includes the local domain and default port. In a production environment, you may need to change the assertion consumer URL. To do this, follow the steps below:
- Open the
application-authentication.xml file found in the<IS_HOME>/repository/conf/identityfolder. Add the following property and update the assertion consumer URL as required.
<AuthenticatorConfig name="SAMLSSOAuthenticator" enabled="true"> <Parameter name="SAMLSSOAssertionConsumerUrl">https://localhost:9443/commonauth</Parameter> </AuthenticatorConfig>
- Open the
- Identity Federation is part of the process of configuring an identity provider. For more information on how to configure an identity provider, see Configuring an Identity Provider.
- See How To: Configure Shibboleth IdP as a Trusted Identity Provider for a sample of using SAML2 Web SSO configuration.