the new makeinfo sets the FLOAT_NAME by default.
[gnutls.git] / doc / protocol / draft-santesson-tls-ume-05.txt
bloba9101cb240363875ecbbc2d817a20b780bff0397
5 INTERNET-DRAFT                                  S. Santesson (Microsoft)
6 Updates: 2246, 4346 (once approved)             A. Medvinsky (Microsoft)
7 Intended Category: Standards track                   J. Ball (Microsoft)
8 Expires October 2006                                          April 2006
11                        TLS User Mapping Extension
12                     <draft-santesson-tls-ume-05.txt>
15 Status of this Memo
17    By submitting this Internet-Draft, each author represents that any
18    applicable patent or other IPR claims of which he or she is aware
19    have been or will be disclosed, and any of which he or she becomes
20    aware will be disclosed, in accordance with Section 6 of BCP 79.
22    Internet-Drafts are working documents of the Internet Engineering
23    Task Force (IETF), its areas, and its working groups.  Note that
24    other groups may also distribute working documents as Internet-
25    Drafts.
27    Internet-Drafts are draft documents valid for a maximum of six months
28    and may be updated, replaced, or obsoleted by other documents at any
29    time.  It is inappropriate to use Internet-Drafts as reference
30    material or to cite them other than a "work in progress."
32    The list of current Internet-Drafts can be accessed at
33    http://www.ietf.org/1id-abstracts.html
35    The list of Internet-Draft Shadow Directories can be accessed at
36    http://www.ietf.org/shadow.html
39 Abstract
41    This document specifies a TLS extension that enables clients to send
42    generic user mapping data in a supplemental data handshake message
43    defined in RFC TBD. One such mapping is defined, the UpnDomainHint,
44    which may be used by a server to locate a user in a directory
45    database. Other mappings may be defined in other documents in the
46    future.
48    (NOTE TO RFC EDITOR:  Replace "RFC TBD" with the RFC number assigned
49    to draft-santesson-tls-supp-00.txt)
56 Santesson, et. all                                              [Page 1]
58 INTERNET DRAFT         TLS User Mapping extension             April 2006
61 Table of Contents
63    1  Introduction ................................................    2
64    2  User mapping extension ......................................    3
65    3  User mapping handshake exchange .............................    4
66    4  Message flow ................................................    7
67    5  Security Considerations .....................................    8
68    6  References ..................................................    9
69    7 IANA Considerations ... ......................................    9
70    Authors' Addresses .............................................   10
71    Acknowledgements ...............................................   10
72    Disclaimer .....................................................   11
73    Copyright Statement ............................................   11
75 1.  Introduction
77    This specification defines a TLS extension and a payload for the
78    SupplementalData handshake message, defined in RFC TBD [N6], to
79    accommodate mapping of users to their user accounts when using TLS
80    client authentication as the authentication method.
82    The UPN (User Principal Name) is a name form defined by Microsoft
83    which specifies a user's entry in a directory in the form of
84    userName@domainName.  Traditionally Microsoft has relied on such UPN
85    names to be present in the client certificate when logging on to a
86    domain account.
88    This has however several drawbacks since it prevents the use of
89    certificates with an absent UPN and also requires re-issuance of
90    certificates or issuance of multiple certificates to reflect account
91    changes or creation of new accounts.
93    The TLS extension defined in this document provide a significant
94    improvement to this situation as it allows a single certificate to be
95    mapped to one or more accounts of the user and does not require the
96    certificate to contain a UPN.
98    The new TLS extension (user_mapping) is sent in the client hello
99    message. Per convention defined in RFC 4366 [N4], the server places
100    the same extension (user_mapping) in the server hello message, to
101    inform the client that the server understands this extension. If the
102    server does not understand the extension, it will respond with a
103    server hello omitting this extension and the client will proceed as
104    normal, ignoring the extension, and not include the
105    UserMappingDataList data in the TLS handshake.
107    If the new extension is understood, the client will inject
108    UserMappingDataList data in the SupplementalData handshake message
112 Santesson, et. all                                              [Page 2]
114 INTERNET DRAFT         TLS User Mapping extension             April 2006
117    prior to the Client's Certificate message. The server will then parse
118    this message, extracting the client's domain, and store it in the
119    context for use when mapping the certificate to the user's directory
120    account.
122    No other modifications to the protocol are required. The messages are
123    detailed in the following sections.
126 1.1  Terminology
128    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
129    "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
130    document are to be interpreted as described in RFC 2119 [N1].
132    The syntax for the TLS User Mapping extension is defined using the
133    TLS Presentation Language, which is specified in Section 4 of [N2].
135 1.2  Design considerations
137    The reason the mapping data itself is not placed in the extension
138    portion of the client hello is to prevent broadcasting this
139    information to servers that don't understand the extension.
140    Additionally, if mapping information were to be considered
141    confidential, the addition of a new user mapping message type could
142    allow the data to be encrypted using the server's public key.
145 2  User mapping extension
147    A new extension type (user_mapping(TBD)) is added to the Extension
148    used in both the client hello and server hello messages. The
149    extension type is specified as follows.
152       enum {
153            user_mapping(TBD), (65535)
154       } ExtensionType;
156    The "extension_data" field of this extension SHALL contain
157    "UserMappingTypeList" with a list of supported hint types where:
159       struct {
160             UserMappingType user_mapping_types<1..2^8-1>
161       } UserMappingTypeList;
163    Enumeration of hint types (user_mapping_types) defined in this
164    document is provided in section 3.
168 Santesson, et. all                                              [Page 3]
170 INTERNET DRAFT         TLS User Mapping extension             April 2006
173    The list of user_mapping_types included in a client hello SHALL
174    signal the hint types supported by the client. The list of
175    user_mapping_types included in the server hello SHALL signal the hint
176    types preferred by the server.
178    If none of the hint types listed by the client is supported by the
179    server, the server SHALL omit the user_mapping extension in the
180    server hello.
182    When the user_mapping extension is included in the server hello, the
183    list of hint types in "UserMappingTypeList" SHALL be either equal to,
184    or a subset of, the list provided by the client.
186 3  User mapping handshake exchange
188    The underlying structure of the SupplementalData handshake message,
189    used to carry information defined in this section, is defined in RFC
190    TBD [N6].
192    A new SupplementalDataType [N6] is defined to accommodate
193    communication of generic user mapping data. See RFC 2246 (TLS 1.0)
194    [N2] and RFC 4346 (TLS 1.1) [N3] for other handshake types.
196    The information in this data type carries one or more unauthenticated
197    hints, UserMappingDataList, inserted by the client side. Upon receipt
198    and successful completion of the TLS handshake, the server MAY use
199    this hint to locate the user's account from which user information
200    and credentials MAY be retrieved to support authentication based on
201    the client certificate.
203    The hint defined in this specification (upn_domain_hint) specifies
204    two fields, user_principal_name and domain_name. The domain_name
205    field MAY be used when only domain information is needed, e.g. where
206    a user have accounts in multiple domains using the same username
207    name, where that user name is known from another source (e.g. from
208    the client certificate). When the user name is also needed, the
209    upn_domain_hint field MAY be used to indicate both username and
210    domain name. If both fields are present, then the server can make use
211    of whichever one it chooses.
214       struct {
215             SupplementalDataType supp_data_type;
216             select(SupplementalDataType) {
217                case user_mapping_data: UserMappingDataList;
218                }
219       } SupplementalDataEntry;
224 Santesson, et. all                                              [Page 4]
226 INTERNET DRAFT         TLS User Mapping extension             April 2006
229       enum {
230             user_mapping_data(TBD), (65535)
231       } SupplementalDataType;
234    The user_mapping_data(TBD) enumeration results in a new supplemental
235    data type UserMappingDataList with the following structure:
238       enum {
239              upn_domain_hint(0), (255)
240       } UserMappingType;
242       struct {
243              opaque user_principal_name<0..2^16-1>;
244              opaque domain_name<0..2^16-1>;
245       } UpnDomainHint;
247       struct {
248              UserMappingType user_mapping_version
249              select(UserMappingType) {
250                    case upn_domain_hint:
251                         UpnDomainHint;
252              }
253       } UserMappingData;
255       struct{
256          UserMappingData user_mapping_data_list<1..2^16-1>;
257       }UserMappingDataList;
260    The user_principal_name parameter, when specified, SHALL contain a
261    Unicode UPN, encoded as a UTF-8 string in the following form:
263       user@domain
265    For example the UPN 'foo@example.com' represents user 'foo' at domain
266    'example.com'.
268    The user_principal_name field, when specified, SHALL be of the form
269    "user@domain", where "user" is a UTF-8 encoded Unicode string that
270    does not contain the "@" character, and "domain" is a domain name
271    meeting the requirements in the following paragraph.
273    The domain_name field, when specified, SHALL contain a domain name in
274    the usual text form: in other words, a sequence of one or more domain
275    labels separated by ".", each domain label starting and ending with
276    an alphanumeric character and possibly also containing "-"
280 Santesson, et. all                                              [Page 5]
282 INTERNET DRAFT         TLS User Mapping extension             April 2006
285    characters.  This field is an "IDN-unaware domain name slot" as
286    defined in RFC 3490 [N7] and therefore, domain names containing non-
287    ASCII characters have to be processed as described in RFC 3490 before
288    being stored in this field.
290    The UpnDomainHint MUST at least contain a non empty
291    user_principal_name or a non empty domain_name. The UpnDomainHint MAY
292    contain both user_principal_name and domain_name.
294    The UserMappingData structure contains a single mapping of type
295    UserMappingType.  This structure can be leveraged to define new types
296    of user mapping hints in the future.  The UserMappingDataList MAY
297    carry multiple hints; it is defined as a vector of UserMappingData
298    structures.
300    No preference is given to the order in which hints are specified in
301    this vector.  If the client sends more then one hint then the Server
302    SHOULD use the applicable mapping supported by the server.
336 Santesson, et. all                                              [Page 6]
338 INTERNET DRAFT         TLS User Mapping extension             April 2006
341 4  Message flow
343    In order to negotiate to send user mapping data to a server in
344    accordance with this specification, clients MUST include an extension
345    of type "user_mapping" in the (extended) client hello, which SHALL
346    contain a list of supported hint types.
348    Servers that receive an extended client hello containing a
349    "user_mapping" extension, MAY indicate that they are willing to
350    accept user mapping data by including an extension of type
351    "user_mapping" in the (extended) server hello, which SHALL contain a
352    list of preferred hint types.
354    After negotiation of the use of user mapping has been successfully
355    completed (by exchanging hello messages including "user_mapping"
356    extensions), clients MAY send a "SupplementalData" message containing
357    the "UserMappingDataList" before the "Certificate" message. The
358    message flow is illustrated in Fig. 1 below.
360       Client                                               Server
362       ClientHello
363        /* with user_mapping ext */ -------->
365                                                       ServerHello
366                                       /* with user-mapping ext */
367                                                      Certificate*
368                                                ServerKeyExchange*
369                                               CertificateRequest*
370                                    <--------      ServerHelloDone
372       SupplementalData
373        /* with UserMappingDataList */
374       Certificate*
375       ClientKeyExchange
376       CertificateVerify*
377       [ChangeCipherSpec]
378       Finished                     -------->
379                                                [ChangeCipherSpec]
380                                    <--------             Finished
381       Application Data             <------->     Application Data
383              Fig. 1 - Message flow with user mapping data
385    * Indicates optional or situation-dependent messages that are not
386    always sent according to RFC 2246 [N2] and RFC 4346 [N3].
392 Santesson, et. all                                              [Page 7]
394 INTERNET DRAFT         TLS User Mapping extension             April 2006
397 5  Security Considerations
399    The UPN sent in the UserMappingDataList is unauthenticated data that
400    MUST NOT be treated as a trusted identifier. Authentication of the
401    user represented by that UPN MUST rely solely on validation of the
402    client certificate. One way to do this in the Microsoft environment
403    is to use the UPN to locate and extract a certificate of the claimed
404    user from the trusted directory and subsequently match this
405    certificate against the validated client certificate from the TLS
406    handshake.
408    As the client is the initiator of this TLS extension, it needs to
409    determine when it is appropriate to send the User Mapping
410    Information. It may not be prudent to broadcast this information to
411    just any server at any time, as it can reveal network infrastructure
412    the client and server are using.
414    To avoid superfluously sending this information, two techniques
415    SHOULD be used to control its dissemination.
417       - The client SHOULD only send the UserMappingDataList in the
418         supplemental data message if it is agreed upon in the hello
419         message exchange, preventing the information from being sent
420         to a server that doesn't understand the User Mapping Extension.
422       - The client SHOULD further only send this information if the
423         server belongs to a domain to which the client intends to
424         authenticate using the UPN as identifier.
448 Santesson, et. all                                              [Page 8]
450 INTERNET DRAFT         TLS User Mapping extension             April 2006
453 6 References
455    Normative references:
457    [N1]      S. Bradner, "Key words for use in RFCs to Indicate
458              Requirement Levels", BCP 14, RFC 2119, March 1997.
460    [N2]      T. Dierks, C. Allen, "The TLS Protocol Version 1.0",
461              RFC 2246, January 1999.
463    [N3]      T. Dierks, E. Rescorla, "The TLS Protocol Version 1.1",
464              RFC 4346, January 2006.
466    [N4]      S. Blake-Wilson, M. Nystrom, D. Hopwood, J. Mikkelsen,
467              T. Wright, "Transport Layer Security (TLS) Extensions",
468              RFC 4366, February 2006.
470    [N5]      Mockapetris, P., "Domain Names - Concepts and
471              Facilities", STD 13, RFC 1034, November 1987.
473    [N6]      S. Santesson, "TLS Handshake Message for Supplementary
474              Data", RFC TBD (currently: draft-santesson-tls-supp-00,
475              Date 2006.
477    [N7]      P. Faltstrom, P. Hoffman, A. Costello, "Internationalizing
478              Domain Names in Applications (IDNA)", RFC 3490, March 2003
480    [N8]      T. Narten, H. Alvestrand, "Guidelines for Writing an IANA
481              Considerations Section in RFCs", RFC 2434, October 1998
484 7 IANA Considerations
486    IANA needs to take the following actions:
488    1) Create an entry, user_mapping(TBD), in the existing registry for
489    ExtensionType (defined in RFC 4366 [N4]).
491    2) Create an entry, user_mapping_data(TBD), in the new registry for
492    SupplementalDataType (defined in draft-santesson-tls-supp-00).
494    3) Establish a registry for TLS UserMappingType values.  The first
495    entry in the registry is upn_domain_hint(0). TLS UserMappingType
496    values in the inclusive range 0-63 (decimal) are assigned via RFC
497    2434 [N8] Standards Action.  Values from the inclusive range 64-223
498    (decimal) are assigned via RFC 2434 Specification Required.  Values
499    from the inclusive range 224-255 (decimal) are reserved for RFC 2434
500    Private Use.
504 Santesson, et. all                                              [Page 9]
506 INTERNET DRAFT         TLS User Mapping extension             April 2006
509 Authors' Addresses
512    Stefan Santesson
513    Microsoft
514    Finlandsgatan 30
515    164 93 KISTA
516    Sweden
518    EMail: stefans(at)microsoft.com
521    Ari Medvinsky
522    Microsoft
523    One Microsoft Way
524    Redmond, WA 98052-6399
525    USA
527    Email: arimed(at)microsoft.com
530    Joshua Ball
531    Microsoft
532    One Microsoft Way
533    Redmond, WA 98052-6399
534    USA
536    Email: joshball(at)microsoft.com
540 Acknowledgements
542    The authors extend a special thanks to Russ Housley, Eric Resocorla
543    and Paul Leach for their substantial contributions.
560 Santesson, et. all                                             [Page 10]
562 INTERNET DRAFT         TLS User Mapping extension             April 2006
565 Disclaimer
567    This document and the information contained herein are provided on an
568    "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
569    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
570    ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
571    INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
572    INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
573    WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
576 Copyright Statement
578    Copyright (C) The Internet Society (2006).
580    This document is subject to the rights, licenses and restrictions
581    contained in BCP 78, and except as set forth therein, the authors
582    retain all their rights.
585 Expires October 2006
616 Santesson, et. all                                             [Page 11]