[MS-CSSP]:

Credential Security Support Provider (CredSSP) Protocol

Intellectual Property Rights Notice for Open Specifications Documentation

 Technical Documentation. Microsoft publishes Open Specifications documentation (“this
documentation”) for protocols, file formats, data portability, computer languages, and standards
support. Additionally, overview documents cover inter-protocol relationships and interactions.
 Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other
terms that are contained in the terms of use for the Microsoft website that hosts this
documentation, you can make copies of it in order to develop implementations of the technologies
that are described in this documentation and can distribute portions of it in your implementations
that use these technologies or in your documentation as necessary to properly document the
implementation. You can also distribute in your implementation, with or without modification, any
schemas, IDLs, or code samples that are included in the documentation. This permission also
applies to any documents that are referenced in the Open Specifications documentation.
 No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.

 Patents. Microsoft has patents that might cover your implementations of the technologies
described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of
this documentation grants any licenses under those patents or any other Microsoft patents.
However, a given Open Specifications document might be covered by the Microsoft Open
Specifications Promise or the Microsoft Community Promise. If you would prefer a written license,
or if the technologies described in this documentation are not covered by the Open Specifications
Promise or Community Promise, as applicable, patent licenses are available by contacting
iplg@microsoft.com.
 Trademarks. The names of companies and products contained in this documentation might be
covered by trademarks or similar intellectual property rights. This notice does not grant any
licenses under those rights. For a list of Microsoft trademarks, visit
www.microsoft.com/trademarks.
 Fictitious Names. The example companies, organizations, products, domain names, email
addresses, logos, people, places, and events that are depicted in this documentation are fictitious.
No association with any real company, organization, product, domain name, email address, logo,
person, place, or event is intended or should be inferred.
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other
than as specifically described above, whether by implication, estoppel, or otherwise.

Tools. The Open Specifications documentation does not require the use of Microsoft programming
tools or programming environments in order for you to develop an implementation. If you have access
to Microsoft programming tools and environments, you are free to take advantage of them. Certain
Open Specifications documents are intended for use in conjunction with publicly available standards
specifications and network programming art and, as such, assume that the reader either is familiar
with the aforementioned material or has immediate access to it.

1 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
Revision Summary

Revision Revision
Date History Class Comments

12/18/2006 0.1 New Version 0.1 release

3/2/2007 1.0 Major Version 1.0 release

4/3/2007 1.1 Minor Version 1.1 release

5/11/2007 1.2 Minor Version 1.2 release

6/1/2007 1.2.1 Editorial Changed language and formatting in the technical content.

7/3/2007 1.2.2 Editorial Changed language and formatting in the technical content.

7/20/2007 1.2.3 Editorial Changed language and formatting in the technical content.

8/10/2007 1.2.4 Editorial Changed language and formatting in the technical content.

9/28/2007 1.2.5 Editorial Changed language and formatting in the technical content.

10/23/2007 1.3 Minor Clarified the meaning of the technical content.

11/30/2007 1.3.1 Editorial Changed language and formatting in the technical content.

1/25/2008 1.3.2 Editorial Changed language and formatting in the technical content.

3/14/2008 1.3.3 Editorial Changed language and formatting in the technical content.

5/16/2008 1.3.4 Editorial Changed language and formatting in the technical content.

6/20/2008 1.3.5 Editorial Changed language and formatting in the technical content.

7/25/2008 1.3.6 Editorial Changed language and formatting in the technical content.

8/29/2008 1.3.7 Editorial Changed language and formatting in the technical content.

10/24/2008 1.3.8 Editorial Changed language and formatting in the technical content.

12/5/2008 2.0 Major Updated and revised the technical content.

1/16/2009 2.0.1 Editorial Changed language and formatting in the technical content.

2/27/2009 2.0.2 Editorial Changed language and formatting in the technical content.

4/10/2009 2.0.3 Editorial Changed language and formatting in the technical content.

5/22/2009 3.0 Major Updated and revised the technical content.

7/2/2009 3.0.1 Editorial Changed language and formatting in the technical content.

8/14/2009 3.0.2 Editorial Changed language and formatting in the technical content.

9/25/2009 3.1 Minor Clarified the meaning of the technical content.

11/6/2009 4.0 Major Updated and revised the technical content.

12/18/2009 4.0.1 Editorial Changed language and formatting in the technical content.

1/29/2010 5.0 Major Updated and revised the technical content.

3/12/2010 5.0.1 Editorial Changed language and formatting in the technical content.

2 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
 Revision Revision
Date History Class Comments

4/23/2010 6.0 Major Updated and revised the technical content.

6/4/2010 6.0.1 Editorial Changed language and formatting in the technical content.

No changes to the meaning, language, or formatting of the

7/16/2010 6.0.1 None
technical content.

No changes to the meaning, language, or formatting of the

8/27/2010 6.0.1 None
technical content.

No changes to the meaning, language, or formatting of the

10/8/2010 6.0.1 None
technical content.

No changes to the meaning, language, or formatting of the

11/19/2010 6.0.1 None
technical content.

No changes to the meaning, language, or formatting of the

1/7/2011 6.0.1 None
technical content.

No changes to the meaning, language, or formatting of the

2/11/2011 6.0.1 None
technical content.

No changes to the meaning, language, or formatting of the

3/25/2011 6.0.1 None
technical content.

No changes to the meaning, language, or formatting of the

5/6/2011 6.0.1 None
technical content.

6/17/2011 6.1 Minor Clarified the meaning of the technical content.

No changes to the meaning, language, or formatting of the

9/23/2011 6.1 None
technical content.

12/16/2011 7.0 Major Updated and revised the technical content.

No changes to the meaning, language, or formatting of the

3/30/2012 7.0 None
technical content.

No changes to the meaning, language, or formatting of the

7/12/2012 7.0 None
technical content.

No changes to the meaning, language, or formatting of the

10/25/2012 7.0 None
technical content.

1/31/2013 8.0 Major Updated and revised the technical content.

8/8/2013 9.0 Major Updated and revised the technical content.

No changes to the meaning, language, or formatting of the

11/14/2013 9.0 None
technical content.

2/13/2014 10.0 Major Updated and revised the technical content.

5/15/2014 11.0 Major Updated and revised the technical content.

6/30/2015 12.0 Major Significantly changed the technical content.

No changes to the meaning, language, or formatting of the

10/16/2015 12.0 None
technical content.

7/14/2016 13.0 Major Significantly changed the technical content.

3 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
Table of Contents
1 Introduction ............................................................................................................ 5
1.1 Glossary ........................................................................................................... 5
1.2 References ........................................................................................................ 6
1.2.1 Normative References ................................................................................... 6
1.2.2 Informative References ................................................................................. 7
1.3 Overview .......................................................................................................... 7
1.4 Relationship to Other Protocols ............................................................................ 8
1.5 Prerequisites/Preconditions ................................................................................. 8
1.6 Applicability Statement ....................................................................................... 9
1.7 Versioning and Capability Negotiation ................................................................... 9
1.8 Vendor-Extensible Fields ..................................................................................... 9
1.9 Standards Assignments....................................................................................... 9
2 Messages ............................................................................................................... 10
2.1 Transport ........................................................................................................ 10
2.2 Message Syntax ............................................................................................... 10
2.2.1 TSRequest ................................................................................................. 10
2.2.1.1 NegoData............................................................................................. 11
2.2.1.2 TSCredentials ....................................................................................... 11
2.2.1.2.1 TSPasswordCreds ............................................................................ 11
2.2.1.2.2 TSSmartCardCreds .......................................................................... 12
2.2.1.2.2.1 TSCspDataDetail ........................................................................ 12
2.2.1.2.3 TSRemoteGuardCreds ...................................................................... 12
2.2.1.2.3.1 TSRemoteGuardPackageCred ...................................................... 13
3 Protocol Details ..................................................................................................... 14
3.1 Common Details .............................................................................................. 14
3.1.1 Abstract Data Model .................................................................................... 14
3.1.2 Timers ...................................................................................................... 14
3.1.3 Initialization ............................................................................................... 14
3.1.4 Higher-Layer Triggered Events ..................................................................... 14
3.1.5 Processing Events and Sequencing Rules ....................................................... 14
3.1.6 Timer Events .............................................................................................. 15
3.1.7 Other Local Events ...................................................................................... 15
4 Protocol Examples ................................................................................................. 16
5 Security ................................................................................................................. 17
5.1 Security Considerations for Implementers ........................................................... 17
5.2 Index of Security Parameters ............................................................................ 17
6 Appendix A: Product Behavior ............................................................................... 18
7 Change Tracking .................................................................................................... 20
8 Index ..................................................................................................................... 22

4 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
1 Introduction
The Credential Security Support Provider (CredSSP) Protocol enables an application to securely
delegate a user's credentials from a client to a target server. This protocol first establishes an
encrypted channel between the client and the target server by using Transport Layer Security
(TLS) (as specified in [RFC2246]). The CredSSP Protocol uses TLS as an encrypted pipe; it does not
rely on the client/server authentication services that are available in TLS. The CredSSP Protocol then
uses the protocol extensions described in [MS-SPNG] to negotiate a Generic Security Services
(GSS) mechanism that performs mutual authentication and GSS confidentiality services to securely
bind to the TLS channel and encrypt the credentials for the target server. All GSS security tokens are
sent over the encrypted TLS channel.

Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in
this specification are informative.

1.1 Glossary

This document uses the following terms:

application protocol: A network protocol that visibly accomplishes the task that the user or other
agent wants to perform. This is distinguished from all manner of support protocols: from
Ethernet or IP at the bottom to security and routing protocols. While necessary, these are not
always visible to the user. Application protocols include, for instance, HTTP and Server Message
Block (SMB).

certification authority (CA): A third party that issues public key certificates (1). Certificates
serve to bind public keys to a user identity. Each user and certification authority (CA) can decide
whether to trust another user or CA for a specific purpose, and whether this trust should be
transitive. For more information, see [RFC3280].

credential: Previously established, authentication (2) data that is used by a security principal to
establish its own identity. When used in reference to the Netlogon Protocol, it is the data that is
stored in the NETLOGON_CREDENTIAL structure.

CredSSP client: Any application that executes the role of the client as prescribed by the [MS-
CSSP] Protocol described in this document.

CredSSP server: Any application that executes the role of the server as prescribed by the [MS-
CSSP] Protocol described in this document.

domain: A set of users and computers sharing a common namespace and management
infrastructure. At least one computer member of the set must act as a domain controller (DC)
and host a member list that identifies all members of the domain, as well as optionally hosting
the Active Directory service. The domain controller provides authentication (2) of members,
creating a unit of trust for its members. Each domain has an identifier that is shared among its
members. For more information, see [MS-AUTHSOD] section 1.1.1.5 and [MS-ADTS].

Generic Security Services (GSS): An Internet standard, as described in [RFC2743], for providing
security services to applications. It consists of an application programming interface (GSS-API)
set, as well as standards that describe the structure of the security data.

Kerberos: An authentication system that enables two parties to exchange private information
across an otherwise open network by assigning a unique key (called a ticket) to each user that
logs on to the network and then embedding these tickets into messages sent by the users. For
more information, see [MS-KILE].

mutual authentication: A mode in which each party verifies the identity of the other party, as
described in [RFC3748] section 7.2.1.

5 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
 NT LAN Manager (NTLM) Authentication Protocol: A protocol using a challenge-response
mechanism for authentication (2) in which clients are able to verify their identities without
sending a password to the server. It consists of three messages, commonly referred to as Type
1 (negotiation), Type 2 (challenge) and Type 3 (authentication). For more information, see [MS-
NLMP].

public key infrastructure (PKI): The laws, policies, standards, and software that regulate or
manipulate certificates and public and private keys. In practice, it is a system of digital
certificates, certificate authorities (CAs), and other registration authorities that verify and
authenticate the validity of each party involved in an electronic transaction (3). For more
information, see [X509] section 6.

security protocol: A protocol that performs authentication and possibly additional security
services on a network.

service principal name (SPN): The name a client uses to identify a service for mutual
authentication. (For more information, see [RFC1964] section 2.1.1.) An SPN consists of either
two parts or three parts, each separated by a forward slash ('/'). The first part is the service
class, the second part is the instance name, and the third part (if present) is the service name.
For example, "ldap/dc-01.fabrikam.com/fabrikam.com" is a three-part SPN where "ldap" is the
service class name, "dc-01.fabrikam.com" is the instance name, and "fabrikam.com" is the
service name. See [SPNNAMES] for more information about SPN format and composing a
unique SPN.

Simple and Protected GSS-API Negotiation Mechanism (SPNEGO): An authentication

mechanism that allows Generic Security Services (GSS) peers to determine whether their
credentials support a common set of GSS-API security mechanisms, to negotiate different
options within a given security mechanism or different options from several security
mechanisms, to select a service, and to establish a security context among themselves using
that service. SPNEGO is specified in [RFC4178].

Transport Layer Security (TLS): A security protocol that supports confidentiality and integrity of
messages in client and server applications communicating over open networks. TLS supports
server and, optionally, client authentication by using X.509 certificates (as specified in [X509]).
TLS is standardized in the IETF TLS working group. See [RFC4346].

trust: To accept another authority's statements for the purposes of authentication and
authorization, especially in the case of a relationship between two domains. If domain A trusts
domain B, domain A accepts domain B's authentication and authorization statements for
principals represented by security principal objects in domain B; for example, the list of groups
to which a particular user belongs. As a noun, a trust is the relationship between two domains
described in the previous sentence.

MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined
in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.

1.2 References

Links to a document in the Microsoft Open Specifications library point to the correct section in the
most recently published version of the referenced document. However, because individual documents
in the library are not updated at the same time, the section numbers in the documents may not
match. You can confirm the correct section numbering by checking the Errata.

1.2.1 Normative References

We conduct frequent surveys of the normative references to assure their continued availability. If you
have any issue with finding a normative reference, please contact dochelp@microsoft.com. We will
assist you in finding the relevant information.

6 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
[MS-ERREF] Microsoft Corporation, "Windows Error Codes".

[MS-KILE] Microsoft Corporation, "Kerberos Protocol Extensions".

[MS-NLMP] Microsoft Corporation, "NT LAN Manager (NTLM) Authentication Protocol".

[MS-RDPEAR] Microsoft Corporation, "Remote Desktop Protocol Authentication Redirection Virtual

Channel".

[MS-SPNG] Microsoft Corporation, "Simple and Protected GSS-API Negotiation Mechanism (SPNEGO)
Extension".

[RFC2078] Linn, J., "Generic Security Service Application Program Interface, Version 2", RFC 2078,
January 1997, http://www.ietf.org/rfc/rfc2078.txt

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC
2119, March 1997, http://www.rfc-editor.org/rfc/rfc2119.txt

[RFC2246] Dierks, T., and Allen, C., "The TLS Protocol Version 1.0", RFC 2246, January 1999,
http://www.rfc-editor.org/rfc/rfc2246.txt

[RFC3280] Housley, R., Polk, W., Ford, W., and Solo, D., "Internet X.509 Public Key Infrastructure
Certificate and Certificate Revocation List (CRL) Profile", RFC 3280, April 2002,
http://www.ietf.org/rfc/rfc3280.txt

[RFC4120] Neuman, C., Yu, T., Hartman, S., and Raeburn, K., "The Kerberos Network Authentication
Service (V5)", RFC 4120, July 2005, http://www.rfc-editor.org/rfc/rfc4120.txt

[RFC4178] Zhu, L., Leach, P., Jaganathan, K., and Ingersoll, W., "The Simple and Protected Generic
Security Service Application Program Interface (GSS-API) Negotiation Mechanism", RFC 4178, October
2005, http://www.rfc-editor.org/rfc/rfc4178.txt

[RFC793] Postel, J., Ed., "Transmission Control Protocol: DARPA Internet Program Protocol
Specification", RFC 793, September 1981, http://www.rfc-editor.org/rfc/rfc793.txt

[X690] ITU-T, "Information Technology - ASN.1 Encoding Rules: Specification of Basic Encoding Rules
(BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER)", Recommendation
X.690, July 2002, http://www.itu.int/rec/T-REC-X.690/en

1.2.2 Informative References

None.

1.3 Overview

The Credential Security Support Provider (CredSSP) Protocol enables an application to securely
delegate a user's credentials from a client to a target server. For example, the Microsoft Terminal
Server uses the CredSSP Protocol to securely delegate the user's password or smart card PIN from the
client to the server to remotely log on the user and establish a terminal services session.<1>

Policy settings control whether a client delegates the user's credentials in order to assure that the
user's credentials are not delegated to an unauthorized server (a computer under the administrative
control of an attacker). Although trust might exist to facilitate authentication between the client and
server, it does not mean that the target server is trusted with the user's credentials.<2> For example,
trust might be based on the Kerberos Protocol [RFC4120] or NTLM [MS-NLMP].

The CredSSP Protocol is a composite protocol that relies on other standards-based security
protocols. It first uses the Transport Layer Security (TLS) Protocol to establish an encrypted channel

7 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
between the CredSSP client and the CredSSP server. (The client is anonymous at this point; the
client and the server might have no common trusted certification authority (CA) root.)

All subsequent messages are sent over this channel. The CredSSP Protocol then uses the Simple and
Protected Generic Security Service Application Program Interface Negotiation Mechanism (SPNEGO)
to authenticate the user and server in the encrypted TLS session. (SPNEGO is specified in [MS-
SPNG].)

SPNEGO provides a framework for two parties that are engaged in authentication to select from a set
of possible authentication mechanisms. This framework provides selection in a manner that preserves
the opaque nature of the security protocols to the application protocol that uses SPNEGO. In this
case, the CredSSP Protocol is the application protocol that uses SPNEGO.

The CredSSP Protocol uses SPNEGO to mutually authenticate the CredSSP client and CredSSP server.
It then uses the encryption key that is established under SPNEGO to securely bind to the TLS session
(the process by which the server's public key that is used in the TLS handshake is authenticated). The
client encrypts the server's public key by using the encryption key that is established under SPNEGO
and sends it to the server. The server verifies that it is the same public key that was used in the TLS
handshake and sends an acknowledgment (also encrypted under the SPNEGO encryption key) back to
the client. (For more information about this step, see section 3.1.1.) Lastly, the client sends the user's
credentials, which are encrypted under the SPNEGO encryption key, to the server.

All subsequent data that is sent between the client and server application by using the CredSSP
Protocol is encrypted under TLS. The only new on-the-wire formats that are introduced by the
CredSSP Protocol are the encapsulation of the SPNEGO tokens sent over the TLS channel, the binding
between the TLS and SPNEGO protocols, and the format of the user credentials.

1.4 Relationship to Other Protocols

The CredSSP Protocol uses the TLS Protocol, as specified in [RFC2246], to encrypt all traffic between
the CredSSP client and the CredSSP server. The TLS Protocol requires a reliable transport, such as
TCP (as specified in [RFC793]), for all messages that are exchanged between the client and the
server.

The CredSSP Protocol typically uses SPNEGO [MS-SPNG] for mutual authentication between the
CredSSP client and CredSSP server and can use Kerberos [MS-KILE] and NTLM [MS-NLMP].<3>
SPNEGO requires that at least one other authentication protocol be present that is compatible with
Generic Security Services (GSS) [RFC2078] (in addition to SPNEGO itself); otherwise, SPNEGO will not
work. SPNEGO has no dependence on any specific GSS-compatible protocols; however, the Kerberos
Protocol [MS-KILE] is typically used.<4>

The Remote Desktop Protocol (RDP) uses the CredSSP Protocol to delegate credentials from the RDP
client to the RDP server and to encrypt all data that follows by using the TLS channel that is
established as part of the CredSSP Protocol.

1.5 Prerequisites/Preconditions

The CredSSP Protocol assumes the following:

 The CredSSP client MUST have access to the user's credentials (the CredSSP Protocol delegates
these credentials to the CredSSP server).<5>

 A source of cryptographically useful random numbers MUST be available on the client and server
for generating a nonce that is used by the TLS Protocol.

 The CredSSP server MUST have an X.509 certificate (as specified in [RFC3280]) for use in TLS.
The certificate can be self-signed or issued by a third-party certification authority. The CredSSP
Protocol does not assume a common certification authority root between the client and the server.

8 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
 The CredSSP Protocol uses the SPNEGO protocol for mutual client/server authentication; at least
one other GSS-compatible authentication protocol, in addition to the CredSSP Protocol, MUST be
present for it to work.<6>

1.6 Applicability Statement

The CredSSP protocol delegates the user's credentials from a client to a server over a mutually
authenticated encrypted channel. To avoid revealing the user credentials to unauthorized hosts, the
CredSSP client delegates only to trusted servers, as expressed through the security policy that
governs the client's computer. The CredSSP protocol was designed to enable the server to
impersonate the client across a number of different applications that require the user's long-lived
credentials (password).

1.7 Versioning and Capability Negotiation

Versioning and capability negotiation are supported in the CredSSP Protocol as follows:

 Protocol versions: The CredSSP Protocol supports versioning (the version field of the TSRequest
structure, section 2.2.1); however, version 2.0 is currently the only available version.

 Security and authentication methods: The CredSSP Protocol uses the SPNEGO protocol to
negotiate the underlying authentication mechanism. Similarly, the CredSSP Protocol relies on the
TLS Protocol to negotiate the cryptographic algorithms that are used for channel confidentiality
and integrity.

 Localization: The CredSSP Protocol is not localization dependent.

1.8 Vendor-Extensible Fields

The CredSSP Protocol does not have any vendor-extensible fields.

1.9 Standards Assignments

The CredSSP Protocol does not have any standards assignments. Standards assignments for the
Simple and Protected GSS-API Negotiation Mechanism (SPNEGO), Kerberos, NTLM, and TLS Protocols
are specified in [MS-SPNG] section 1.9, [MS-KILE] section 1.9, [MS-NLMP] section 1.9, and [RFC2246]
section G, respectively.

9 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
2 Messages

2.1 Transport

Because the CredSSP Protocol uses TLS, it requires that all messages exchanged between the client
and server are transmitted by using a reliable transport protocol, such as TCP (as specified in
[RFC793]).<7>

2.2 Message Syntax

The CredSSP Protocol introduces the TSRequest message. The client and server use this message to
encapsulate the SPNEGO tokens and TSCredentials message that the client uses to delegate the user's
credentials to the CredSSP server over a TLS connection. These messages are encoded by using
ASN.1 (as specified in [X690]) and Distinguished Encoding Rules (DER).

2.2.1 TSRequest

The TSRequest structure is the top-most structure used by the CredSSP client and CredSSP server. It
contains the SPNEGO tokens or Kerberos/NTLM messages that are passed between the client and
server, and either the public key authentication messages that are used to bind to the TLS session or
the client credentials that are delegated to the server. The TSRequest message is always sent over the
TLS-encrypted channel between the client and server in a CredSSP Protocol exchange (see step 1 in
section 3.1.5).

TSRequest ::= SEQUENCE {

version [0] INTEGER,
negoTokens [1] NegoData OPTIONAL,
authInfo [2] OCTET STRING OPTIONAL,
pubKeyAuth [3] OCTET STRING OPTIONAL,
errorCode [4] INTEGER OPTIONAL
}

version: This field specifies the supported version of the CredSSP Protocol. Valid values for this field
are 2 and 3.<8> If the version received is greater than the implementation understands, treat the
peer as one that is compatible with the version of the CredSSP Protocol that the implementation
understands.

negoTokens: A NegoData structure, as defined in section 2.2.1.1, that contains the SPNEGO tokens
or Kerberos/NTLM messages that are passed between the client and server.

authInfo: A TSCredentials structure, as defined in section 2.2.1.2, that contains the user's credentials
that are delegated to the server. The authInfo field MUST be encrypted under the encryption key
that is negotiated under the SPNEGO package. The authInfo field carries the message signature
and then the encrypted data.

pubKeyAuth: This field is used to assure that the public key that is used by the server during the TLS
handshake belongs to the target server and not to a "man in the middle". This TLS session-binding
is described in section 3.1.5. After the client completes the SPNEGO phase of the CredSSP
Protocol, it uses GSS_WrapEx() for the negotiated protocol to encrypt the server's public key. The
pubKeyAuth field carries the message signature and then the encrypted public key to the server.
In response, the server uses the pubKeyAuth field to transmit to the client a modified version of
the public key (as described in section 3.1.5) that is encrypted under the encryption key that is
negotiated under SPNEGO.

10 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
errorCode: If the negotiated protocol version is 3 and the SPNEGO exchange fails on the server, this
field can be used to send the NTSTATUS failure code ([MS-ERREF] section 2.3) to the client so that
it will know what failed and be able to display a descriptive error to the user.<9>

2.2.1.1 NegoData

The NegoData structure contains the SPNEGO tokens, the Kerberos messages, or the NTLM messages,
as specified in [MS-SPNG] section 2, [MS-KILE] section 2, and [MS-NLMP] section 2, respectively.

NegoData ::= SEQUENCE OF SEQUENCE {

negoToken [0] OCTET STRING
}

NegoToken: One or more SPNEGO tokens, Kerberos messages, or NTLM messages, as specified in
[MS-SPNG], [MS-KILE], and [MS-NLMP], respectively.<10>

2.2.1.2 TSCredentials

The TSCredentials structure contains both the user's credentials that are delegated to the server and
their type.

TSCredentials ::= SEQUENCE {

credType [0] INTEGER,
credentials [1] OCTET STRING
}

credType: Defines the type of credentials that are carried in the credentials field. credType MUST be
one of the following values.

Value Meaning

1 credentials contains a TSPasswordCreds structure (section 2.2.1.2.1) that defines the user's
password credentials.

2 credentials contains a TSSmartCardCreds structure (section 2.2.1.2.2) that defines the user's
smart card credentials.

6 credentials contains a TSRemoteGuardCreds structure (section 2.2.1.2.3) that defines the user's
redirected credentials.

credentials: Contains the user's password, smart card credentials, or Remote Credential Guard
credentials in a TSPasswordCreds structure, a TSSmartCardCreds structure, or a
TSRemoteGuardCreds structure, respectively.

2.2.1.2.1 TSPasswordCreds

The TSPasswordCreds structure contains the user's password credentials that are delegated to the
server.

TSPasswordCreds ::= SEQUENCE {

domainName [0] OCTET STRING,
userName [1] OCTET STRING,
password [2] OCTET STRING
}

domainName: Contains the name of the user's account domain.

11 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
userName: Contains the user's account name.

password: Contains the user's account password.

2.2.1.2.2 TSSmartCardCreds

The TSSmartCardCreds structure contains the user's smart card credentials that are delegated to the
server.

TSSmartCardCreds ::= SEQUENCE {

pin [0] OCTET STRING,
cspData [1] TSCspDataDetail,
userHint [2] OCTET STRING OPTIONAL,
domainHint [3] OCTET STRING OPTIONAL
}

pin: Contains the user's smart card PIN.

cspData: A TSCspDataDetail structure that contains information about the cryptographic service
provider (CSP).

userHint: Contains the user's account hint.

domainHint: Contains the user's domain name to which the user's account belongs. This name could
be entered by the user when the user is first prompted for the PIN.

2.2.1.2.2.1 TSCspDataDetail

The TSCspDataDetail structure contains CSP information used during smart card logon.

TSCspDataDetail ::= SEQUENCE {

keySpec [0] INTEGER,
cardName [1] OCTET STRING OPTIONAL,
readerName [2] OCTET STRING OPTIONAL,
containerName [3] OCTET STRING OPTIONAL,
cspName [4] OCTET STRING OPTIONAL
}

keySpec: Defines the specification of the user's smart card.

cardName: Specifies the name of the smart card.

readerName: Specifies the name of the smart card reader.

containerName: Specifies the name of the certificate container.

cspName: Specifies the name of the CSP.

2.2.1.2.3 TSRemoteGuardCreds

The TSRemoteGuardCreds structure contains a logon credential and supplemental credentials provided
by security packages. The format of the individual credentials depends on the package that provided
them. The logon credential will be passed to the Negotiate package, which will in turn pass it to the
default authentication package.<11>

TSRemoteGuardCreds ::= SEQUENCE{

logonCred [0] TSRemoteGuardPackageCred,
supplementalCreds [1] SEQUENCE OF TSRemoteGuardPackageCred OPTIONAL,

12 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
 }

logonCred: Contains a logon credential for the user.

supplementalCreds: Contains supplemental credentials for other security packages.

2.2.1.2.3.1 TSRemoteGuardPackageCred

The TSRemoteGuardPackageCred structure contains credentials for a specific security package.

TSRemoteGuardPackageCred ::= SEQUENCE{

packageName [0] OCTET STRING,
credBuffer [1] OCTET STRING,
}

packageName: The name of the package for which these credentials are intended.

credBuffer: A byte buffer containing the credentials in a format specified by the package that
provided them. The format for Kerberos is documented in [MS-RDPEAR].

13 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
3 Protocol Details

3.1 Common Details

3.1.1 Abstract Data Model

The CredSSP Protocol requires the client to perform a policy check to verify that the target server is
trusted to receive the user's credentials.

3.1.2 Timers

There are no timers in the CredSSP Protocol.

3.1.3 Initialization

There are no changes to the initialization of TLS, Kerberos, NTLM, and SPNEGO, as specified in
[RFC2246], [MS-KILE], [MS-NLMP], and [MS-SPNG], respectively.

3.1.4 Higher-Layer Triggered Events

The CredSSP Protocol is triggered by a higher-layer application protocol, such as RDP, for delegating
the user's credentials to the target server.

3.1.5 Processing Events and Sequencing Rules

The CredSSP Protocol is carried out in the following sequence and is subject to the protocol rules that
are described in the following steps:

1. The CredSSP client and CredSSP server first complete the TLS handshake, as specified in
[RFC2246]. After the handshake is complete, all subsequent CredSSP Protocol messages are
encrypted by the TLS channel. The CredSSP Protocol does not extend the TLS wire protocol. As
part of the TLS handshake, the CredSSP server does not request the client's X.509 certificate
(thus far, the client is anonymous). Also, the CredSSP Protocol does not require the client to have
a commonly trusted certification authority root with the CredSSP server. Thus, the CredSSP server
MAY use, for example, a self-signed X.509 certificate.<12>

2. Over the encrypted TLS channel, the SPNEGO, Kerberos, or NTLM handshake between the client
and server completes authentication and establishes an encryption key that is used by the
SPNEGO confidentiality services, as specified in [RFC4178]. All SPNEGO tokens or Kerberos/NTLM
messages as well as the underlying encryption algorithms are opaque to the calling application
(the CredSSP client and CredSSP server). The wire protocol for SPNEGO, Kerberos, and NTLM is
specified in [MS-SPNG], [MS-KILE], and [MS-NLMP], respectively.

The SPNEGO tokens or Kerberos/NTLM messages exchanged between the client and the server are
encapsulated in the negoTokens field of the TSRequest structure (section 2.2.1). Both the client
and the server use this structure as many times as necessary to complete the authentication
exchange.<13>

Note During this phase of the protocol, the OPTIONAL authInfo field is omitted from the
TSRequest structure by the client and server; the OPTIONAL pubKeyAuth field is omitted by the
client unless the client is sending the last SPNEGO token or Kerberos/NTLM message. If the client
is sending the last SPNEGO token or Kerberos/NTLM message, the TSRequest structure MUST
have both the negoTokens and the pubKeyAuth fields filled in.

14 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
 Note If the SPNEGO handshake fails on the server side and the client sent a version of 3 or
greater, the server SHOULD send a TSRequest structure back to the client for which the
errorCode field is populated with an unsuccessful NTSTATUS code ([MS-ERREF] section 2.3). The
NTSTATUS code indicates the reason for the failure to the client. If the client receives a TSRequest
message with the errorCode present, it must immediately fail with the provided status code and
cease all further processing.

3. The client encrypts the public key it received from the server (contained in the X.509 certificate) in
the TLS handshake from step 1, by using the confidentiality support of the authentication protocol.
The public key that is encrypted is the ASN.1-encoded SubjectPublicKey sub-field of
SubjectPublicKeyInfo from the X.509 certificate, as specified in [RFC3280] section 4.1. The
encrypted key is encapsulated in the pubKeyAuth field of the TSRequest structure and is sent
over the TLS channel to the server.

Note During this phase of the protocol, the OPTIONAL authInfo field is omitted from the
TSRequest structure; the client MUST send its last SPNEGO token or Kerberos/NTLM message to
the server in the negoTokens field (see step 2) along with the encrypted public key in the
pubKeyAuth field.

4. After the server receives the public key in step 3, it first verifies that it has the same public key
that it used as part of the TLS handshake in step 1. The server then adds 1 to the first byte
representing the public key (the ASN.1 structure corresponding to the SubjectPublicKey field, as
described in step 3) and encrypts the binary result by using the authentication protocol's
encryption services. Due to the addition of 1 to the binary data, and encryption of the data as a
binary structure, the resulting value might not be valid ASN.1-encoded values. The encrypted
binary data is encapsulated in the pubKeyAuth field of the TSRequest structure and is sent over
the encrypted TLS channel to the client. The addition of 1 to the first byte of the public key is
performed so that the client-generated pubKeyAuth message cannot be replayed back to the
client by an attacker.

Note During this phase of the protocol, the OPTIONAL authInfo and negoTokens fields are
omitted from the TSRequest structure.

5. After the client successfully verifies server authenticity by performing a binary comparison of the
data from step 4 to that of the data representing the public key from the server's X.509 certificate
(as specified in [RFC3280], section 4.1), it encrypts the user's credentials (either password or
smart card PIN) by using the authentication protocol's encryption services. The resulting value is
encapsulated in the authInfo field of the TSRequest structure and sent over the encrypted TLS
channel to the server.

The TSCredentials structure within the authInfo field of the TSRequest structure MAY contain a
TSPasswordCreds, TSSmartCardCreds, or TSRemoteGuardCreds structure, but MUST NOT contain
more than one.

Note During this phase of the protocol, the OPTIONAL pubKeyAuth and negoTokens fields are
omitted from the TSRequest structure.

Note If the credentials were of type TSRemoteGuardCreds, the TLS channel continues to be used
for redirected authentication requests, as specified in [MS-RDPEAR].

3.1.6 Timer Events

There are no timer events for the CredSSP Protocol.

3.1.7 Other Local Events

There are no other local events that impact the operation of this protocol.

15 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
4 Protocol Examples

Figure 1: CredSSP negotiation sequence using SPNEGO

Steps 1 through 4: The CredSSP client and CredSSP server complete the TLS handshake. When the
handshake is complete, all subsequent CredSSP Protocol messages are encrypted by the TLS channel,
as specified in [RFC2246]. As part of the TLS handshake, the CredSSP server does not request the
client's X.509 certificate (thus far, the client is anonymous). Furthermore, the CredSSP Protocol does
not require the client to have a commonly trusted certification authority root with the CredSSP server.

Steps 5 and 6: Over the encrypted TLS channel, the SPNEGO handshake between the client and
server completes mutual authentication and establishes an encryption key.

Steps 7 and 8: The public key from the server's X.509 certificate in the TLS handshake is verified that
it belongs to the server (and not to a "man-in-the-middle" attacker).

Step 9: The client sends its credentials to the target server that is protected under SPNEGO and TLS
encryption.

16 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
5 Security

5.1 Security Considerations for Implementers

The purpose of the CredSSP Protocol is to delegate a user's clear text password or pin from the
CredSSP client to a CredSSP server, and it is important to make certain that the server receiving the
credentials does not fall under an attacker's control. Although trust can be facilitated via public key
infrastructure (PKI), the Kerberos protocol, or NTLM, this does not mean that the target server is
trusted with the user's credentials, and additional policy settings should be considered.

Additional policy settings can include defining the servers that are trusted with the user's credentials,
the security strength of the authentication mechanisms allowed to be negotiated under SPNEGO [MS-
SPNG], and the allowed methods by which the CredSSP client can obtain the user's credentials.

5.2 Index of Security Parameters

There are no security parameters in the CredSSP Protocol.

17 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
6 Appendix A: Product Behavior
The information in this specification is applicable to the following Microsoft products or supplemental
software. References to product versions include released service packs.

 Windows XP operating system Service Pack 3 (SP3)

 Windows Vista operating system

 Windows Server 2008 operating system

 Windows 7 operating system

 Windows Server 2008 R2 operating system

 Windows 8 operating system

 Windows Server 2012 operating system

 Windows 8.1 operating system

 Windows Server 2012 R2 operating system

 Windows 10 operating system

 Windows Server 2016 operating system

Exceptions, if any, are noted below. If a service pack or Quick Fix Engineering (QFE) number appears
with the product version, behavior changed in that service pack or QFE. The new behavior also applies
to subsequent service packs of the product unless otherwise specified. If a product edition appears
with the product version, behavior is different in that product edition.

Unless otherwise specified, any statement of optional behavior in this specification that is prescribed
using the terms SHOULD or SHOULD NOT implies product behavior in accordance with the SHOULD or
SHOULD NOT prescription. Unless otherwise specified, the term MAY implies that the product does not
follow the prescription.

<1> Section 1.3: The CredSSP client is present on all Windows products according to the applicability
list at the beginning of this section. The CredSSP server is not present on Windows XP SP3.

<2> Section 1.3: In Windows, the policy settings for the CredSSP client are expressed in terms of
service principal names (SPNs), which define the servers that the client is allowed to send the
user's credentials to.

<3> Section 1.4: Windows CredSSP clients never send Kerberos.

<4> Section 1.4: By default, SPNEGO has the Kerberos Protocol and NTLM available, as specified in
[MS-NLMP]. With the exception of Windows XP SP3, the interface for authentication protocols is open
and extensible. Other protocols can be installed on a specific system by third parties, and other
protocols can be added as defaults in future versions of Windows.

<5> Section 1.5: In Windows, the CredSSP client first checks whether the user's credentials were
passed in by the calling application. If so, these credentials are used by the client. If no credentials
were passed in by the calling application, the CredSSP Protocol uses credentials that are stored locally
in the credentials manager that is associated with the target server. If no credentials are available for
the target server, the CredSSP client uses the user's default credentials, which are entered when the
user first logs on to the operating system.

18 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
<6> Section 1.5: In Windows, the SPNEGO client negotiates Kerberos or NTLM. The Kerberos Protocol
is always preferred over NTLM. NTLM is negotiated only if one or both parties do not support the
Kerberos Protocol, as specified in [MS-NLMP] section 1.5 and in [MS-KILE].

<7> Section 2.1: The Windows component that implements the CredSSP Protocol is transport-
independent—it simply returns opaque CredSSP data back to the calling application. It is up to the
calling application to send this CredSSP Protocol data over a reliable transport to its CredSSP Protocol
peer.

<8> Section 2.2.1: In Windows XP SP3, Windows Vista, Windows Server 2008, Windows 7, Windows
Server 2008 R2, Windows 8, and Windows Server 2012, only version 2 of the CredSSP Protocol is
supported.

<9> Section 2.2.1: Windows XP SP3, Windows Vista, Windows Server 2008, Windows 7, Windows
Server 2008 R2, Windows 8, and Windows Server 2012 do not implement the errorCode field.

<10> Section 2.2.1.1: This contains all Kerberos- or NTLM-specific messages as negotiated by
SPNEGO.

<11> Section 2.2.1.2.3: The TSRemoteGuardCreds structure is not supported on Windows XP SP3,
Windows Vista, Windows Server 2008, Windows 7, Windows Server 2008 R2, Windows 8, Windows
Server 2012, Windows 8.1, Windows Server 2012 R2, Windows 10 v1507 operating system, or
Windows 10 v1511 operating system.

<12> Section 3.1.5: With the exception of Windows XP SP3, the CredSSP server can be configured by
using any X.509 certificate that is trusted by the client based on a commonly trusted certificate
authority (CA) root or by using a self-signed certificate.

<13> Section 3.1.5: The Kerberos or NTLM authentication package is negotiated by SPNEGO.
Therefore, the encryption key that is established under SPNEGO is either a Kerberos subsession key or
an NTLM session key that is shared by both sides upon completion of the SPNEGO exchange.

19 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
7 Change Tracking
This section identifies changes that were made to this document since the last release. Changes are
classified as New, Major, Minor, Editorial, or No change.

The revision class New means that a new document is being released.

The revision class Major means that the technical content in the document was significantly revised.
Major changes affect protocol interoperability or implementation. Examples of major changes are:

 A document revision that incorporates changes to interoperability requirements or functionality.

 The removal of a document from the documentation set.

The revision class Minor means that the meaning of the technical content was clarified. Minor changes
do not affect protocol interoperability or implementation. Examples of minor changes are updates to
clarify ambiguity at the sentence, paragraph, or table level.

The revision class Editorial means that the formatting in the technical content was changed. Editorial
changes apply to grammatical, formatting, and style issues.

The revision class No change means that no new technical changes were introduced. Minor editorial
and formatting changes may have been made, but the technical content of the document is identical
to the last released version.

Major and minor changes can be described further using the following change types:

 New content added.

 Content updated.

 Content removed.

 New product behavior note added.

 Product behavior note updated.

 Product behavior note removed.

 New protocol syntax added.

 Protocol syntax updated.

 Protocol syntax removed.

 New content added due to protocol revision.

 Content updated due to protocol revision.

 Content removed due to protocol revision.

 New protocol syntax added due to protocol revision.

 Protocol syntax updated due to protocol revision.

 Protocol syntax removed due to protocol revision.

 Obsolete document removed.

Editorial changes are always classified with the change type Editorially updated.

Some important terms used in the change type descriptions are defined as follows:

20 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
 Protocol syntax refers to data elements (such as packets, structures, enumerations, and
methods) as well as interfaces.

 Protocol revision refers to changes made to a protocol that affect the bits that are sent over the
wire.

The changes made to this document are listed in the following table. For more information, please
contact dochelp@microsoft.com.

Major
Tracking number (if applicable) and Change
Section change (Y
description type
or N)

Updated to include a reference to [MS-

Content
1.2.1 Normative References RDPEAR] for this version of Windows and Y
update.
Windows Server.

5369 : Added information to the authInfo Content

2.2.1 TSRequest Y
field description. update.

Updated content for this version of Content

2.2.1.2 TSCredentials Y
Windows and Windows Server. update.

Added section with content for this Content

2.2.1.2.3 TSRemoteGuardCreds Y
version of Windows and Windows Server. update.

2.2.1.2.3.1 Added section with content for this Content

Y
TSRemoteGuardPackageCred version of Windows and Windows Server. update.

3.1.5 Processing Events and Updated content for this version of Content
Y
Sequencing Rules Windows and Windows Server. update.

21 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016
8 Index
A
Parameters - security index 17
Abstract data model 14 Preconditions 8
Applicability 9 Prerequisites 8
Product behavior 18
C Protocol
abstract data model 14
Capability negotiation 9 higher-layer triggered events 14
Change tracking 20 initialization 14
local events 15
D message processing 14
sequencing rules 14
Data model - abstract 14 timer events 15
timers 14
E
R
Examples - overview 16
References 6
informative 7
F
normative 6
Relationship to other protocols 8
Fields - vendor-extensible 9
S
G
Security
Glossary 5
implementer considerations 17
parameter index 17
H Sequencing rules 14
Standards assignments 9
Higher-layer triggered events 14 Syntax 10

I T
Implementer - security considerations 17 Timer events 15
Index of security parameters 17 Timers 14
Informative references 7 Tracking changes 20
Initialization 14 Transport 10
Introduction 5 Triggered events - higher-layer 14
TSCredentials 11
L TSCspDataDetail 12
TSPasswordCreds 11
Local events 15 TSRequest 10
TSRequest message 10
M TSSmartCardCreds 12

Message processing 14 V
Messages
syntax 10 Vendor-extensible fields 9
transport 10 Versioning 9
TSRequest 10

NegoData 11
Normative references 6

Overview (synopsis) 7

22 / 22
[MS-CSSP] - v20160714
Credential Security Support Provider (CredSSP) Protocol
Copyright © 2016 Microsoft Corporation
Release: July 14, 2016