The <sts_authentication> element
Specifies that a Security Token Service (STS) must be used for authentication and determines what type of request is sent.
Used in:
- Service provider
- Service requester
Contained by:
Attributes:
| Name | Description |
|---|---|
| action | Specifies what type of request CICS® sends to the STS when a message is received
in the service provider pipeline. Valid values are as follows:
In a service requester pipeline, you cannot specify this attribute because CICS always requests that the STS issues a token. |
| extract | This attribute is valid only when you are using
SAML. Are the elements of the SAML token to be extracted? Valid values
are as follows:
|
| token_signature | This attribute is valid only when you are using
SAML. Must a token signature be supplied? Valid values are as follows:
|
| tran_channel | This attribute is valid only when you are
using SAML. In a service provider pipeline, this attribute specifies
whether SAML assertions contained in a message that is received in
the pipeline are made available to the target application program
in containers in the transaction channel DFHTRANSACTION. Valid values
are as follows:
In
a service requester pipeline, this attribute specifies whether the
SAML token contained in the DFHSAML-OUTTOKEN container of the transaction
channel DFHTRANSACTION is used on the request. Valid values are as
follows:
|
Contains:
- An <auth_token_type> element. This element
is required when you specify a <sts_authentication> element
in a service requester pipeline and is optional in a service provider
pipeline. For more information, see <auth_token_type>.
- In a service requester pipeline, the <auth_token_type> element indicates the type of token that STS issues when CICS sends it the user ID contained in the DFHWS-USERID container. The token that CICS receives from the STS is placed in the header of the outbound message.
- In a service provider pipeline, the <auth_token_type> element
is used to determine the identity token that CICS takes from the message header and sends
to the STS to exchange or validate. CICS uses
the first identity token of the specified type in the message header.
If you do not specify this element, CICS uses
the first identity token that it finds in the message header. CICS does not consider the following
as identity tokens:
- wsu:Timestamp
- xenc:ReferenceList
- xenc:EncryptedKey
- ds:Signature
- In a service provider pipeline only, an optional, empty <suppress/> element. If this element is specified, the handler does not attempt to use any security tokens in the message to determine the user ID that the work runs under. The <suppress/> element includes the identity token that is returned by the STS.
Example
The following example shows a service provider pipeline, where the security handler requests a token from the STS.
<sts_authentication action="issue">
<auth_token_type>
<namespace>http://example.org.tokens</namespace>
<element>UsernameToken</element>
</auth_token_type>
<suppress/>
</sts_authentication>