Doc fix.
[gsasl.git] / doc / specification / draft-ietf-sasl-saslprep-05.txt
blob60b7c5bacd750efd2a27db47362cc7b50415bd9b
7 INTERNET-DRAFT                                   Kurt D. Zeilenga
8 Intended Category: Standards Track            OpenLDAP Foundation
9 Expires: August 2004                             15 February 2004
12         SASLprep: Stringprep profile for user names and passwords
13                     <draft-ietf-sasl-saslprep-05.txt>
16 Status of Memo
18   This document is an Internet-Draft and is in full conformance with all
19   provisions of Section 10 of RFC 2026.
21   This document is intended to be, after appropriate review and
22   revision, submitted to the RFC Editor as a Standards Track document.
23   Distribution of this memo is unlimited.  Technical discussion of this
24   document will take place on the IETF SASL mailing list
25   <ietf-sasl@imc.org>.  Please send editorial comments directly to the
26   document editor <Kurt@OpenLDAP.org>.
28   Internet-Drafts are working documents of the Internet Engineering Task
29   Force (IETF), its areas, and its working groups.  Note that other
30   groups may also distribute working documents as Internet-Drafts.
31   Internet-Drafts are draft documents valid for a maximum of six months
32   and may be updated, replaced, or obsoleted by other documents at any
33   time.  It is inappropriate to use Internet-Drafts as reference
34   material or to cite them other than as ``work in progress.''
36   The list of current Internet-Drafts can be accessed at
37   <http://www.ietf.org/ietf/1id-abstracts.txt>. The list of
38   Internet-Draft Shadow Directories can be accessed at
39   <http://www.ietf.org/shadow.html>.
41   Copyright (C) The Internet Society (2004).  All Rights Reserved.
43   Please see the Full Copyright section near the end of this document
44   for more information.
47 Abstract
49   This document describes how to prepare Unicode strings representing
50   user names and passwords for comparison.  The document defines the
51   "SASLprep" profile of the "stringprep" algorithm to be used for both
52   user names and passwords.  This profile is intended to be used by
53   Simple Authentication and Security Layer (SASL) mechanisms (such as
54   PLAIN, CRAM-MD5, and DIGEST-MD5) as well as other protocols exchanging
58 Zeilenga                        SASLprep                        [Page 1]
60 INTERNET-DRAFT       draft-ietf-sasl-saslprep-05.txt    15 February 2004
63   user names and/or passwords.
66 1. Introduction
68   The use of simple user names and passwords in authentication and
69   authorization is pervasive on the Internet.  To increase the
70   likelihood that user name and password input and comparison work in
71   ways that make sense for typical users throughout the world, this
72   document defines rules for preparing internationalized user names and
73   passwords for comparison.  For simplicity and implementation ease, a
74   single algorithm is defined for both user names and passwords.
76   This document defines the "SASLprep" profile of the "stringprep"
77   algorithm [StringPrep].
79   The profile is designed for use in Simple Authentication and Security
80   Layer ([SASL]) mechanisms such as [PLAIN].  It may be applicable
81   elsewhere simple user names and passwords are used.  This profile is
82   not intended to be used to prepare identity strings which are not
83   simple user names (e.g., e-mail addresses, domain names, distinguished
84   names), or where identity or password strings which are not character
85   data.
88 2. The SASLprep profile
90   This section defines the "SASLprep" profile.  This profile is intended
91   to be used to prepare strings representing simple user names and
92   passwords.
94   This profile uses Unicode 3.2, as defined in [StringPrep, A.1].
96   Character names in this document use the notation for code points and
97   names from the Unicode Standard [Unicode].  For example, the letter
98   "a" may be represented as either <U+0061> or <LATIN SMALL LETTER A>.
99   In the lists of mappings and the prohibited characters, the "U+" is
100   left off to make the lists easier to read.  The comments for character
101   ranges are shown in square brackets (such as "[CONTROL CHARACTERS]")
102   and do not come from the standard.
104   Note: a glossary of terms used in Unicode can be found in [Glossary].
105   Information on the Unicode character encoding model can be found in
106   [CharModel].
109 2.1. Mapping
114 Zeilenga                        SASLprep                        [Page 2]
116 INTERNET-DRAFT       draft-ietf-sasl-saslprep-05.txt    15 February 2004
119   This profile specifies:
120     - non-ASCII space characters [StringPrep, C.1.2] be mapped to SPACE
121       (U+0020), and
123     - the "commonly mapped to nothing" characters [StringPrep, B.1] be
124       mapped to nothing.
128 2.2. Normalization
130   This profile specifies using Unicode normalization form KC, as
131   described in Section 4 of [StringPrep].
134 2.3. Prohibited Output
136   This profile specifies the following characters:
138     - Non-ASCII space characters [StringPrep, C.1.2],
139     - ASCII control characters [StringPrep, C.2.1],
140     - Non-ASCII control characters [StringPrep, C.2.2],
141     - Private Use [StringPrep, C.3],
142     - Non-character code points [StringPrep, C.4],
143     - Surrogate code points [StringPrep, C.5],
144     - Inappropriate for plain text [StringPrep, C.6],
145     - Inappropriate for canonical representation [StringPrep, C.7],
146     - Change display properties or are deprecated [StringPrep, C.8], and
147     - Tagging characters [StringPrep, C.9].
149   are prohibited output.
152 2.4. Bidirectional characters
154   This profile specifies checking bidirectional strings as described in
155   [StringPrep, Section 6].
158 2.5. Unassigned Code Points
160   This profile specifies [StringPrep, A.1] table as its list of
161   unassigned code points.
164 3. Security Considerations
166   This profile is intended to used to prepare simple user names and
170 Zeilenga                        SASLprep                        [Page 3]
172 INTERNET-DRAFT       draft-ietf-sasl-saslprep-05.txt    15 February 2004
175   passwords strings for comparison or use in cryptographic functions
176   (e.g., message digests).
178   It is not intended to be used for to prepare identity strings which
179   are not simple user names (e.g., distinguished names and domain
180   names).  Nor is the profile intended to be used for simple user names
181   which require different handling.  Protocols (or applications of those
182   protocols) which have application-specific identity forms and/or
183   comparison algorithms should use mechanisms specifically designed for
184   these forms and algorithms.
186   Application of string preparation may have an impact upon the
187   feasibility of brute force and dictionary attacks.  While the number
188   of possible prepared strings is less than the number of possible
189   Unicode strings, the number of usable names and passwords is hoped to
190   be greater.
192   User names and passwords should be protected from eavesdropping.
194   General "stringprep" and Unicode security considerations apply.  Both
195   are discussed in [StringPrep].
198 4. IANA Considerations
200   This document details the "SASLprep" profile of [StringPrep] protocol.
201   Upon Standards Action the profile should be registered in the
202   stringprep profile registry.
204       Name of this profile: SASLprep
205       RFC in which the profile is defined: This RFC
206       Indicator whether or not this is the newest version of the
207       profile: This is the first version of the SASPprep profile.
210 5. Acknowledgment
212   This document borrows text from "Preparation of Internationalized
213   Strings ('stringprep')" and "Nameprep: A Stringprep Profile for
214   Internationalized Domain Names", both by Paul Hoffman and Marc
215   Blanchet.
217   This document is a product of the IETF SASL WG.
220 6. Normative References
222   [StringPrep]  Hoffman P. and M. Blanchet, "Preparation of
226 Zeilenga                        SASLprep                        [Page 4]
228 INTERNET-DRAFT       draft-ietf-sasl-saslprep-05.txt    15 February 2004
231                 Internationalized Strings ('stringprep')",
232                 draft-hoffman-rfc3454bis-xx.txt, a work in progress.
234   [SASL]        Melnikov, A. (Editor), "Simple Authentication and
235                 Security Layer (SASL)",
236                 draft-ietf-sasl-rfc2222bis-xx.txt, a work in progress.
238   [Unicode]     The Unicode Consortium, "The Unicode Standard, Version
239                 3.2.0" is defined by "The Unicode Standard, Version 3.0"
240                 (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5),
241                 as amended by the "Unicode Standard Annex #27: Unicode
242                 3.1" (http://www.unicode.org/reports/tr27/) and by the
243                 "Unicode Standard Annex #28: Unicode 3.2"
244                 (http://www.unicode.org/reports/tr28/).
247 7. Informative References
249   [Glossary]    The Unicode Consortium, "Unicode Glossary",
250                 <http://www.unicode.org/glossary/>.
252   [CharModel]   Whistler, K. and M. Davis, "Unicode Technical Report
253                 #17, Character Encoding Model", UTR17,
254                 <http://www.unicode.org/unicode/reports/tr17/>, August
255                 2000.
257   [CRAM-MD5]    Nerenberg, L., "The CRAM-MD5 SASL Mechanism",
258                 draft-ietf-sasl-crammd5-xx.txt, a work in progress.
260   [DIGEST-MD5]  Leach, P., C. Newman, and A. Melnikov, "Using Digest
261                 Authentication as a SASL Mechanism",
262                 draft-ietf-sasl-rfc2831bis-xx.txt, a work in progress.
264   [PLAIN]       Zeilenga, K. (Editor), "The Plain SASL Mechanism",
265                 draft-ietf-sasl-plain-xx.txt, a work in progress.
268 8. Editor's Address
270   Kurt D. Zeilenga
271   OpenLDAP Foundation
273   Email: Kurt@OpenLDAP.org
277 Intellectual Property Rights
282 Zeilenga                        SASLprep                        [Page 5]
284 INTERNET-DRAFT       draft-ietf-sasl-saslprep-05.txt    15 February 2004
287   The IETF takes no position regarding the validity or scope of any
288   intellectual property or other rights that might be claimed to pertain
289   to the implementation or use of the technology described in this
290   document or the extent to which any license under such rights might or
291   might not be available; neither does it represent that it has made any
292   effort to identify any such rights.  Information on the IETF's
293   procedures with respect to rights in standards-track and
294   standards-related documentation can be found in BCP-11.  Copies of
295   claims of rights made available for publication and any assurances of
296   licenses to be made available, or the result of an attempt made to
297   obtain a general license or permission for the use of such proprietary
298   rights by implementors or users of this specification can be obtained
299   from the IETF Secretariat.
301   The IETF invites any interested party to bring to its attention any
302   copyrights, patents or patent applications, or other proprietary
303   rights which may cover technology that may be required to practice
304   this standard.  Please address the information to the IETF Executive
305   Director.
308 Full Copyright
310   Copyright (C) The Internet Society (2004). All Rights Reserved.
312   This document and translations of it may be copied and furnished to
313   others, and derivative works that comment on or otherwise explain it
314   or assist in its implementation may be prepared, copied, published and
315   distributed, in whole or in part, without restriction of any kind,
316   provided that the above copyright notice and this paragraph are
317   included on all such copies and derivative works.  However, this
318   document itself may not be modified in any way, such as by removing
319   the copyright notice or references to the Internet Society or other
320   Internet organizations, except as needed for the  purpose of
321   developing Internet standards in which case the procedures for
322   copyrights defined in the Internet Standards process must be followed,
323   or as required to translate it into languages other than English.
338 Zeilenga                        SASLprep                        [Page 6]