Web Services Security
Kerberos Token Profile 1.1

OASIS Public Review Draft – 28 June 2005

OASIS identifier:

{product-productVersion-artifactType-stage-descriptiveName-revision.form (Word) (PDF) (HTML)}

Location:

http://docs.oasis-open.org/wss/2005/xx/wss-v1.1-spec-pr-KerberosTokenProfile-01

Technical Commitee:

Web Service Security (WSS)

Chairs:

Kelvin Lawrence, IBM

            Chris Kaler, Microsoft

Editors:

Anthony Nadalin, IBM

Chris Kaler, Microsoft

            Ronald Monzillo, Sun

Phillip Hallam-Baker, Verisign

Abstract:         

This document describes how to use Kerberos [Kerb] tickets (specifically the AP-REQ packet) with the WSS: SOAP Message Security [WSS] specification.

Status:

This is an interim draft. Please send comments to the editors.

 

Committee members should send comments on this specification to the wss@lists.oasis-open.org list. Others should subscribe to and send comments to the wss-comment@lists.oasis-open.org list. To subscribe, visit http://lists.oasis-open.org/ob/adm.pl.

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Security Services TC web page (http://www.oasis-open.org/who/intellectualproperty.shtml).


Notices

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementors or users of this specification, can be obtained from the OASIS Executive Director.

OASIS invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to implement this specification. Please address the information to the OASIS Executive Director.

Copyright  © The Organization for the Advancement of Structured Information Standards [OASIS] 2002-2005. All Rights Reserved.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself does not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document must be followed, or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an “AS IS” basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
Table of Contents

1      Introduction. 4

2      Notations and Terminology. 5

2.1 Notational Conventions. 5

2.2 Namespaces. 5

2.3 Terminology. 6

3      Usage. 7

3.1 Processing Model 7

3.2 Attaching Security Tokens. 7

3.3 Identifying and Referencing Kerberos Tokens. 8

3.4 Authentication. 9

3.5 Encryption. 10

3.6 Principal Name. 10

3.7 Error Codes. 10

4      Threat Model and Countermeasures. 11

5      References. 12

Appendix A. Acknowledgments. 13

Appendix B. Revision History. 16

 

This specification describes the use of Kerberos [Kerb] tokens with respect to the WSS: SOAP Message Security specification [WSS].

Specifically, this document defines how to encode Kerberos tickets and attach them to SOAP messages.  As well, it specifies how to add signatures and encryption to the SOAP message, in accordance with WSS: SOAP Message Security, which uses and references the Kerberos tokens.

For interoperability concerns, and for some security concerns, the specification is limited to using the AP-REQ packet (service ticket and authenticator) defined by Kerberos as the Kerberos token.  This allows a service to authenticate the ticket and interoperate with existing Kerberos implementations.

It should be noted that how the AP-REQ is obtained is out of scope of this specification as are scenarios involving other ticket types and user-to-user interactions. 

Note that Sections 2.1, 2.2, all of 3, and indicated parts of 6 are normative.  All other sections are non-normative.

This section specifies the notations, namespaces, and terminology used in this specification.

2.1 Notational Conventions

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC2119 [2119].

 

Namespace URIs (of the general form "some-URI") represent some application-dependent or context-dependent URI as defined in RFC2396 [URI].

 

This specification is designed to work with the general SOAP [S11, S12] message structure and message processing model, and should be applicable to any version of SOAP. The current SOAP 1.2 namespace URI is used herein to provide detailed examples, but there is no intention to limit the applicability of this specification to a single version of SOAP.

2.2 Namespaces

The XML namespace [XML-ns] URIs that MUST be used by implementations of this specification are as follows (note that different elements in this specification are from different namespaces):

 

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd

http://docs.oasis-open.org/wss/2005/xx/oasis-2005xx-wss-wssecurity-secext-1.1.xsd

 

Note that this specification does not introduce new schema elements.

The following namespaces are used in this document:

Prefix

Namespace

S11

http://schemas.xmlsoap.org/soap/envelope/

S12

http://www.w3.org/2003/05/soap-envelope

wsse

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd

wsse11

http://docs.oasis-open.org/wss/2005/xx/oasis-2005xx-wss-wssecurity-secext-1.1.xsd

wsu

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd

ds

http://www.w3.org/2000/09/xmldsig#

xenc

http://www.w3.org/2001/04/xmlenc#

 

The URLs provided for the wsse and wsu namespaces can be used to obtain the schema files. URI fragments defined in this specification are relative to the following base URI unless otherwise specified:

http://docs.oasis-open.org/wss/2005/xx/oasis-2005xx-wss-kerberos-token-profile-1.1

2.3  Terminology

Readers are presumed to be familiar with the terms in the Internet Security Glossary [ISG].

 

This specification employs the terminology defined in the WSS: SOAP Message Security Core Specification [WSS].

 

The following (non-normative) table defines additional acronyms and abbreviations for this document.

Term

Definition

SHA

Secure Hash Algorithm

SOAP

Simple Object Access Protocol

URI

Uniform Resource Identifier

XML

Extensible Markup Language

 

3        Usage

This section describes the profile (specific mechanisms and procedures) for the Kerberos binding of WSS: SOAP Message Security.

Identification: http://docs.oasis-open.org/wss/2005/xx/oasis-2005xx-wss-kerberos-token-profile-1.1

3.1 Processing Model

The processing model for WSS: SOAP Message Security with Kerberos tokens is no different from that of WSS: SOAP Message Security with other token formats as described in WSS: SOAP Message Security. 

3.2 Attaching Security Tokens

Kerberos tokens are attached to SOAP messages using WSS: SOAP Message Security by using the <wsse:BinarySecurityToken> described in WSS: SOAP Message Security.  When using this element, the @ValueType attribute MUST be specified.  This specification defines two values for this token as defined in the table below:

URI

Description

http://docs.oasis-open.org/wss/2005/xx/oasis-2005xx-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ

Kerberos v5 AP-REQ as defined in the Kerberos specification. This ValueType is used when the ticket is an AP Request.

http://docs.oasis-open.org/wss/2005/xx/oasis-2005xx-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ

A GSS wrapped Kerberos v5 AP-REQ as defined in the GSSAPI specification. This ValueType is used when the ticket is an AP Request (ST + Authenticator).

It should be noted that the URIs in the table above also serves as the official URIs identifying the Kerberos token defined in this specification.

 

Both token types defined in this section use the type 0x8003 defined in RFC1964 for the checksum field of the authenticator inside the AP_REQ.

 

The octet sequence of the either the GSS wrapped Kerberos ticket or the Kerberos ticket (e.g. AP-REQ) is encoded using the indicated algorithm (e.g. base 64) and the result is placed inside of the <wsse:BinarySecurityToken> element.

The following example illustrates a SOAP message with a Kerberos token.

<S11:Envelope xmlns:S11="...">

    <S11:Header>

        <wsse:Security xmlns:wsse="...">

            <wsse:BinarySecurityToken

            xmlns:wsse="... "

                wsu:Id="myToken"

                ValueType="...#Kerberosv5_AP_REQ"

                EncodingType="...#Base64Binary">

                MIIEZzCCA9CgAwIBAgIQEmtJZc0...

            </wsse:BinarySecurityToken>

            ...

        </wsse:Security>

    </S11:Header>

    <S11:Body>

        ...

    </S11:Body>

</S11:Envelope>

 

3.3 Identifying and Referencing Kerberos Tokens

A Kerberos Token is referenced by means of the <wsse:SecurityTokenReference> element.  This mechanism, defined in WSS: SOAP Message Security, provides different referencing mechanisms.  The following list identifies the supported and unsupported mechanisms:

The wsu:Id MAY be specified on the <wsse:BinarySecurityToken> element allowing the token to be directly referenced.

A <wsse:KeyIdentifier> element MAY be used which specifies the identifier for the Kerberos ticket.  This value is computed as the SHA1 of the pre-encoded octets that were used to form the contents of the <wsse:BinarySecurityToken> element.  The <wsse:KeyIdentifier> element contains the encoded form the of the KeyIdentifier which is defined as  the base64 encoding of the SHA1 result.

Key Name references MUST NOT be used.

When a Kerberos Token is referenced using <wsse:SecurityTokenReference> the @ValueType attribute is not required.  If specified, the URI listed above as Kerberos token type MUST be specified.

The <wsse:SecurityTokenReference> element from which the reference is made contains the <wsse:KeyIdentifier>  element. The <wsse:KeyIdentifier> element MUST have a ValueType attribute with the value #Kerberosv5APREQSHA1 and its contents MUST be the SHA1 of GSS wrapped or unwrapped AP-REQ, encoded as per the <wsse:KeyIdentifier> element’s EncodingType attribute.

 

Reference Identifier

ValueType URI

Description