Configuring a requester pipeline to use SAML tokens

Configure a requester pipeline to insert SAML tokens in the SOAP header of outbound messages.

Before you begin

If you are adding SAML support to an existing pipeline, identify the pipeline configuration file. If you are creating a new pipeline, create a new pipeline configuration file. CICS® provides two sample configuration files, samlrequester.xml and propagatesamlrequester.xml. The latter contains the tran_channel attribute.

About this task

In this task, you configure a requester pipeline to automatically attach SAML tokens to the outbound SOAP messages. CICS allows only previously validated tokens to be sent out in a SOAP message. The validated token is stored in the DFHSAML-OUTTOKEN container and the token inserted in the SOAP header is taken from this container.

Procedure

  1. Code an <sts_authentication> element in your pipeline configuration file. This element specifies that a Security Token Service (STS) is used for authentication and determines the type of request that is sent. Do not code an <authentication> element.
    1. Optional: Code the tran_channel="yes" attribute to specify that the contents of the DFHTRANSACTION channel's DFHSAML-OUTTOKEN container are used as the SAML token for the request. If you do not specify this attribute, the default value is no, which means that the SAML token is taken from the DFHSAML-OUTTOKEN container in the channel that is passed to the SOAP pipeline.
    2. Within the <sts_authentication> element, code an <auth_token_type> element. Within the <auth_token_type> element, code the following elements:
      <namespace>
      Set the content of this element to either urn:oasis:names:tc:SAML:1.0:assertion or urn:oasis:names:tc:SAML:2.0:assertion, depending on the version of SAML you are using.
      <element>
      Set the content of this element to Assertion.
  2. Code an <sts_endpoint> element.
    1. In the <sts_endpoint> element, code an <endpoint> element.

      Set the value of the endpoint to cics://PROGRAM/DFHSAML.

    2. Optional: In the <sts_endpoint> element, code a <jvmserver> element. This element identifies the server on which to run. If this element is not included, the default sample resource JVM server DFHXSTS is assumed.

Example

<?xml version="1.0" encoding="EBCDIC-CP-US"?>
<requester_pipeline xmlns="http://www.ibm.com/software/htp/cics/pipeline">
  <service>
    <service_handler_list>
      <cics_soap_1.1_handler/>
      <wsse_handler>
        <dfhwsse_configuration version="1">
          <sts_authentication tran_channel="yes">
            <auth_token_type>
              <namespace>urn:oasis:names:tc:SAML:2.0:assertion</namespace>
              <element>Assertion</element>
            </auth_token_type>
          </sts_authentication>
          <sts_endpoint>
            <endpoint>cics://PROGRAM/DFHSAML</endpoint>
            <jvmserver>DFHXSTS</jvmserver>
          </sts_endpoint>
        </dfhwsse_configuration>
      </wsse_handler>
    </service_handler_list>
  </service>
  <service_parameter_list/>
</requester_pipeline>


web_serv_request.html | Timestamp icon Last updated: Sunday, 4 June 2017