This documentation is for WSO2 Identity Server 5.8.0 . View documentation for the latest release.

All docs This doc
||
Skip to end of metadata
Go to start of metadata

WSO2 Identity Server (WSO2 IS) supports acquiring SAML protocol messages via HTTP Artifact Binding according to section 3.5 of the SAML 2.0 core specification. Once a user is authenticated successfully, the WSO2 Identity Server issues a SAML artifact in the place of the actual SAML response. The service provider application can acquire this artifact and use it as a reference to obtain the actual SAML response from WSO2 Identity Server. The following sections guide you through configuring SAML artifact binding and trying it out with a sample application. 

 Click here for more information about artifact binding

You can use HTTP artifact binding for instances where the SAML requester and responder need to communicate with each other using an HTTP user agent as an intermediary, but it's limitations preclude or discourage the transmission of an entire message (or message exchange) through it. This may be due to some technical reasons or the reluctance to expose the message content to the intermediary (where encryption is not practical).

In the HTTP artifact binding, the SAML request, the SAML response, or both are transmitted by reference using a small stand-in called an artifact. A separate, synchronous binding, such as the SAML SOAP binding, is used to exchange the artifact for the actual protocol message using the artifact resolution protocol. When using the HTTP artifact binding for the SAML <Response> message, SAML permits the artifact to be delivered via the browser using either an HTTP POST or HTTP Redirect response. 

About SAML Artifact

SAML artifact is a short, opaque string which will have the ability of an artifact receiver to identify the issuer of the artifact, resistance to tampering and forgery, uniqueness, and compactness. 

The format of a SAML artifact is shown below:

The diagram below shows the process of SAML Artifact Binding.

Configuring SAML artifact binding

  1. Log in to the management console.
  2. Navigate to Service Providers > Add in the Main menu of the management console and add a new service provider called " saml2-web-app-dispatch.com ". For more information about configuring a service provider, see Adding and Configuring a Service Provider
  3. Expand the Inbound Authentication configuration > SAML2 Web SSO configuration section, and click Configure
  4. Fill in the following fields. 
    • Issuer:  saml2-web-app-dispatch.com
    • Assertion Consumer URL:  http://localhost.com:8080/saml2-web-app-dispatch.com/consumer
  5. Select Enable SAML2 Artifact Binding to enable SAML2 artifact binding. Once this is enabled, WSO2 Identity Server responds to each SAML SSO authentication request with an artifact. 

  6. You can also enable signature validation by selecting Enable Signature Validation in Artifact Resolve Request. Once this is enabled, WSO2 IS expects to receive signed artifact resolve requests and validates that signature against the service provider certificate. For more information, see the Resolving SAML2 artifacts with WSO2 IS section. 

  7. Leave the rest of the default configurations as it is and click Register

Setting up the samples 

To try out the functionality using a sample application, you need to set up the PickUp Dispatch sample application. You can skip this section if you wish to try out the functionality with your own sample application or with an existing service provider. 

Before you begin,

  • Download and install Apache Tomcat version 8.*.* or higher.

  • This tutorial demonstrates SAML2 artifact binding using  localhost.com  as the local domain.
    Open the 
    etc/hosts  file in your machine, a dd the following entry, and restart your computer to  map the  localhost.com  domain to your ip address.


    127.0.0.1       localhost.com

    To avoid any IP address conflicts, ensure that this is the only entry for this IP address in the /etc/hosts file.

  • Enable a SAML tracer on your browser to view the SAML response artifact.

  1. Download the following saml2-web-app-dispatch.com.war  file and paste it inside the <TOMCAT_HOME>/webapps directory. 

  2. Restart the Tomcat server.

  3. Once you deploy the sample application and start the tomcat server, a folder named saml2-web-app-dispatch.com is created inside the <TOMCAT_HOME>/webapps directory. Navigate to the <TOMCAT_HOME>/webapps/saml2-web-app-dispatch.com/WEB-INF/classes folder and open the sso.properties file. 

  4. The following properties inside the sso.properties file are related to SAML2 artifact binding. You can configure them accordingly if required. 

    Tip: If you configure the properties, restart the Tomcat server for the changes to take effect.  

    PropertyDescriptionDefault Value
    SAML2.ArtifactResolveUrl This is the Artifact Resolution Endpoint of the identity provider (IdP) which the service provider uses to resolve artifacts. https://localhost:9443/samlartresolve
    SAML2.EnableArtifactResolveSigning When this property is set to true, the sample application signs the artifact resolve requests that are send to the IdP. true
  5. Access the PickUp application URL:  http://localhost.com:8080/saml2-web-app-dispatch.com
  6. Enter admin/admin credentials and click Login. Provide the required consent. 
  7. You can use a SAML tracer add-on with your browser to view the SAML2 response artifact for the SSO authentication request. The code block below shows an example response.

    HTTP/1.1 302 Object Moved
    Date: 21 Jan 2004 07:00:49 GMT
    Location: https://ServiceProvider.com/ACS/URL?
    SAMLart=AAQAADWNEw5VT47wcO4zX%2FiEzMmFQvGknDfws2ZtqSGdkNSbsW1cmVR0bzU%3D&RelayState=0043bfc1bc45110dae17004005b13a2b
    Content-Type: text/html; charset=iso-8859-1

You have successfully set up SAML artifact binding. See the sections below for more information on resolving SAML2 artifacts and configuring an artifact expiration time.

Configuring artifact expiration time

According to the SAML 2.0 Binding Specification, issued SAML Artifacts should have an expiration time. WSO2 Identity Server does not resolve the artifacts that have passed this time limit. You can configure this restriction by editing the <IS_HOME>/repository/conf/identity/identity.xml file. Open the file in a text editor and search for the <SAML2ArtifactValidityPeriodInMinutes> property.

…
<SAML2ArtifactValidityPeriodInMinutes>4</SAML2ArtifactValidityPeriodInMinutes>
…

Note: The default time limit is 4 minutes. In a practical scenario, this time limit should be smaller than the SAML response validity period.

Resolving SAML2 artifacts with WSO2 IS

According to the SAML Specification, issued SAML artifacts should be resolved, or exchanged to an actual SAML response, via a back channel call to the issuer. WSO2 Identity Server supports SOAP Binding to resolve SAML artifacts according to Section 3.6 of the SAML 2.0 Binding Specification.


WSO2 IS Artifact Resolution Endpoint: https://wso2.is.com:9443/samlartresolve

The service provider application should send an <ArtifactResolve> message wrapped in a SOAP envelope to the WSO2 Identity Server artifact resolution endpoint. The following example shows a SAML artifact resolve request. 

POST /samlartresolve HTTP/1.1
Host: wso2is.com
Content-Type: text/xml
Content-Length: nnn
SOAPAction: http://www.oasis-open.org/committees/security
<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Body>
		<samlp:ArtifactResolve
			xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
			xmlns="urn:oasis:names:tc:SAML:2.0:assertion"
			ID="_6c3a4f8b9c2d" Version="2.0"
			IssueInstant="2004-01-21T19:00:49Z">
			<Issuer>https://ServiceProvider.com/SAML</Issuer>
			<Artifact>
			    AAQAADWNEw5VT47wcO4zX/iEzMmFQvGknDfws2ZtqSGdkNSbsW1cmVR0bzU=
			</Artifact>
		</samlp:ArtifactResolve>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

If signature validation for artifact resolve is enabled, the service provider has to sign this request with it’s private key. WSO2 IS validates the request and if it is valid, an <ArtifactResponse> message is sent with the actual SAML response set as the message element. The code block below shows an example of an <ArtifactResponse> message.

HTTP/1.1 200 OK
Date: 21 Jan 2004 07:00:49 GMT
Content-Type: text/xml
Content-Length: nnnn

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Body>
		<samlp:ArtifactResponse
			xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
			xmlns="urn:oasis:names:tc:SAML:2.0:assertion"
			ID="_FQvGknDfws2Z" Version="2.0"
			InResponseTo="_6c3a4f8b9c2d"
			IssueInstant="2004-01-21T19:00:49Z">
			<Issuer>https://wso2is.com</Issuer>
			<samlp:Status>
				<samlp:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success"/>
			</samlp:Status>
			<samlp:Response ID="d2b7c388cec36fa7c39c28fd298644a8"
				IssueInstant="2004-01-21T19:00:49Z"
				Version="2.0">
				...
			</samlp:Response>
		</samlp:ArtifactResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
POST /samlartresolve HTTP/1.1
Host: wso2is.com
Content-Type: text/xml
Content-Length: nnn
SOAPAction: http://www.oasis-open.org/committees/security
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <samlp:ArtifactResolve
            xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
            xmlns="urn:oasis:names:tc:SAML:2.0:assertion"
            ID="_6c3a4f8b9c2d" Version="2.0"
            IssueInstant="2004-01-21T19:00:49Z">
            <Issuer>https://ServiceProvider.com/SAML</Issuer>
            <samlp:Artifact>
                AAQAADWNEw5VT47wcO4zX/iEzMmFQvGknDfws2ZtqSGdkNSbsW1cmVR0bzU=
            </samlp:Artifact>
        </samlp:ArtifactResolve>
    </SOAP-ENV:Body>
  • No labels