This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Configuring SAML2 SSO

This sample is a demonstration on how to configure SAML2 SSO using a sample service provider.

Configuring the web app

  1. Check out the source from the repository location which contains the samples.

    svn co https://svn.wso2.org/repos/wso2/carbon/platform/branches/turing/products/is/4.5.0/modules/samples/sso/
  2. Go to <HOME>/sso/SSOAgentSample in the checked out folder and build the sample with following command.

    mvn clean install
  3. After successfully building the sample, a .war file named travelocity.com can be found inside the <HOME>/sso/SSOAgentSample/target folder.
  4. Deploy this sample web app on a web container. To do this, use the Apache Tomcat server.

    Since this sample is written based on Servlet 3.0 it needs to be deployed on Tomcat 7.x.

    Use the following steps to deploy the web app in the web container:

    1. Stop the Apache Tomcat server if it is already running.
    2. Copy the travelocity.war file to the <TOMCAT_HOME>/webapps folder.
    3. Start the Apache Tomcat server.

The travelocity.properties file, which is found inside the travelocity.com/WEB-INF/classes folder, can be used to change the properties like issuerID, consumer url and IdP url. This sample uses default values.

  • A unique identifier for this SAML 2.0 Service Provider application: SAML.IssuerID=travelocity.com
  • The URL of the SAML 2.0 Assertion Consumer: SAML.ConsumerUrl=http://localhost:8080/travelocity.com/samlsso-home.jsp
  • The URL of the SAML 2.0 Identity Provider: SAML.IdPUrl=https://localhost:9443/samlsso

Now that the web app is successfully deployed on a web container; the next step is to configure WSO2 Identity Server as the identity provider.

Configuring WSO2 Identity Server as an identity provider

  1. Start Identity Server and access management console using https://localhost:9443/carbon/
  2. Login to management console using default administrator credentials (the username and password are both "admin").
  3. In the management console found on the left of your screen, navigate to Main > Manage > SAML SSO.
  4. Click on Register New Service Provider. 
  5. A form appears. Register the new service provider by providing the following values.
    • Issuer: travelocity.com

      This value should be same as the SAML.IssuerID value specified inside the travelocity.com/WEB-INF/classes/travelocity.properties file.

    • Assertion Consumer URL: http://localhost:8080/travelocity.com/samlsso-home.jsp

      This value should be same as the SAML.ConsumerUrl value mentioned inside the travelocity.com/WEB-INF/classes/travelocity.properties file.

    • NameID format: Enter the default value here (i.e., urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress)
    • Use fully qualified username in the NameID: Set this as true by selecting the checkbox
    • Enable Response Signing: Set this as true by selecting the checkbox
    • Enable Assertion Signing: Set this as true by selecting the checkbox
    • Enable Signature Validation in Authentication Requests and Logout Requests: Set this as true (Certificate alias = wso2carbon)
    • Enable Single Logout: Set this as true by selecting the checkbox
  6. After providing above values click Register.

After successfully registering the service provider, logout from management console. You have now configuring Identity Server as the identity provider. The next step is to run the sample.

Running the sample

  1. Visit http://localhost:8080/travelocity.com. You are directed to the following page:
     
  2. Since you need to use SAML2 for this sample, click the first link, i.e., Click here to login with SAML from Identity Server. You are redirected to the Identity Server for authentication.
  3. Enter the default admin credentials (admin/admin).
  4. Now you are logged in and you can see the home page of the travelocity.com app.
  1. If you need to view the SAML request and response, please add the following debug log to the log4j.properties file found inside <PRODUCT_HOME>/repository/conf.

    log4j.logger.org.wso2.carbon.identity=DEBUG
  2. Since single log out is enabled, if you click the logout button in the travelocity.com home page, you will successfully log out.