With the SAML2 relying party capabilities of Carbon, it is possible to set up Single Sign-On between different WSO2 Product instances where WSO2 Identity Server acts as the identity provider while other WSO2 products act as the relying party. This topic provides instructions on how to set up Single Sign-On between different WSO2 products.
Step 1 - Installing the SAML2 relying party (SAML2 SSO Authenticator) feature in a Carbon Server
You only need to do this step if "SAML2 based Single Sign-On authenticator" is not installed in your WSO2 product.
SAML2 relying party components are not shipped with the default Carbon distribution. However, these bundles are packages that can be installed as a feature, which is available in the online-hosted P2 repository. Therefore, it is possible to install this feature with minimal effort through the Carbon Feature Manager.
- Add the WSO2 online P2 repository as a new repository. Usually, the hosted P2 repository is available at this URL: http://product-dist.wso2.com/p2/carbon/releases/wilkes/. To learn how to add a repository to the Identity Server Managing the Feature Repository in the WSO2 Product Administration Guide.
- Search for the word "authenticator". Select "SAML2 based Single Sign-On authenticator" from the result and click "Install." See Installing Features in the WSO2 Product Administration Guide.
Step 2 - Configuring the Carbon Server to use the SAML2-based authentication instead of default username/password-based authentication
After installing the SAML2 relying party components (SAML2 SSO authenticator), it is necessary to configure the SAML2 SSO authentication component to communicate with the Identity Server for user authentication. This can be configured in the
<PRODUCT_HOME>/repository/conf/security/authenticators.xml file. This file will contain configurations for different authenticators. By default, it is shipped with a sample configuration for SAML2 SSO authenticator and requires minor modifications to prior to setup.
Authenticator disabled- This should be set to
Priority- This is the priority level of the authenticator. In the Carbon Runtime, the authenticator with the highest priority will be picked up. This value should be greater than 5 in order to supersede the default username/password-based authenticator.
Parameter LoginPage- This is the default login page URL of Carbon. All requests coming to this page will be intercepted for authentication. It is not necessary to change this value from the value given in the sample configuration.
Parameter ServiceProviderID- This is the unique identifier for the Carbon Server in an SSO setup. This value should be used as the value of the issuer in the Identity Server configuration.
Parameter IdentityProviderSSOServiceURL- This is the Identity Server URL to which the users will be redirected for authentication. It should have this format:
Parameter NameIDPolicyFormat- This specifies the name identifier format that the Carbon server wants to receive in the subject of an assertion from a particular identity provider.
Parameter IdPCertAlias- This is uncommented by default. This is the alias of the identity provider certificate. This is specifically used whenever a Carbon server uses IS as the identity provider. The configuration needs to be done at the relying party server's
Step 3 - Sharing the user store
For single sign-on to work, you need to configure the WSO2 products to share a common user store. For more information on configuring this, see Configuring the Primary User Store.
Step 4 - Configuring the Identity Server as the Single Sign-On provider
Finally, you need to configure the Identity Server to act as the Single Sign-on provider. Each relying party should be registered as a service provider at the Identity Server-end. The following is a sample configuration for registering a Carbon server as a service provider.
- 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 Service Providers.
- Fill in the Service Provider Name and provide a brief Description of the service provider. Only Service Provider Name is a required field.
- Click Register to add the new service provider.
- Expand the Inbound Authentication Configuration section, followed by the SAML2 Web SSO Configuration section and click Configure.
- Fill in the form that appears.
- Specify the Issuer. This should be equal to the
ServiceProviderIDvalue mentioned in the
authenticators.xmlof the relying party Carbon server.
- Specify the Assertion Consumer URL. This is the URL to which the browser should be redirected after the authentication is successful. It should have this format:
- Select Use fully qualified username in SAML Response if that feature is required.
- Select Enable Response Signing to sign the SAML2 Responses returned after the authentication.
- Select Enable Signature Validation in Authentication Requests and Logout Requests if you need this feature configured.
- Select Enable Single Logout so that all sessions are terminated once the user signs out from one server. You can enter a SLO Response URL and SLO Request URL if required. These indicate the endpoint that the response and reqest are sent to.
- Select Enable Attribute Profile to enable this and add a claim by entering the claim link and clicking the Add Claim button.
- Select Enable Audience Restriction to restrict the audience. You may add audience members using the Audience text box and clicking the Add Audience button.
- Specify the Issuer. This should be equal to the
- Expand the Local & Outbound Authentication Configuration section and do the following.
- Select Use tenant domain in local subject identifier to append the tenant domain to the local subject identifier.
- Select Use user store domain in local subject identifier to append the user store domain that the user resides in the local subject identifier.
Click the Update button to update the details of the service provider.