GSS_S_PROMPTING_NEEDED is a bit
[cyrus-sasl.git] / doc / draft-ietf-sasl-saslprep-xx.txt
1
2
3
4
5
6
7 INTERNET-DRAFT                                   Kurt D. Zeilenga
8 Intended Category: Standards Track            OpenLDAP Foundation
9 Expires in six months                             27 October 2003
10
11
12         SASLprep: Stringprep profile for user names and passwords
13                     <draft-ietf-sasl-saslprep-04.txt>
14
15
16 Status of Memo
17
18   This document is an Internet-Draft and is in full conformance with all
19   provisions of Section 10 of RFC 2026.
20
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>.
27
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.''
35
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>.
40
41   Copyright (C) The Internet Society (2003).  All Rights Reserved.
42
43   Please see the Full Copyright section near the end of this document
44   for more information.
45
46
47 Abstract
48
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
55
56
57
58 Zeilenga                        SASLprep                        [Page 1]
59 \f
60 INTERNET-DRAFT       draft-ietf-sasl-saslprep-04.txt     27 October 2003
61
62
63   user names and/or passwords.
64
65
66 1. Introduction
67
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.
75
76   This document defines the "SASLprep" profile of the "stringprep"
77   algorithm [StringPrep].
78
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 for arbitrary text.  This profile is also not
83   intended to be used to prepare identity strings which are not simple
84   user names (e.g., e-mail addresses, domain names, distinguished
85   names).
86
87
88 2. The SASLprep profile
89
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.
93
94   This profile uses Unicode 3.2, as defined in [StringPrep, A.1].
95
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.
103
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].
107
108
109 2.1. Mapping
110
111
112
113
114 Zeilenga                        SASLprep                        [Page 2]
115 \f
116 INTERNET-DRAFT       draft-ietf-sasl-saslprep-04.txt     27 October 2003
117
118
119   This profile specifies:
120     - non-ASCII space characters [StringPrep, C.1.2] be mapped to SPACE
121       (U+0020), and
122
123     - the "commonly mapped to nothing" characters [StringPrep, B.1] be
124       mapped to nothing.
125
126
127
128 2.2. Normalization
129
130   This profile specifies using Unicode normalization form KC, as
131   described in Section 4 of [StringPrep].
132
133
134 2.3. Prohibited Output
135
136   This profile specifies the following characters:
137
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].
148
149   are prohibited output.
150
151
152 2.4. Bidirectional characters
153
154   This profile specifies checking bidirectional strings as described in
155   [StringPrep, Section 6].
156
157
158 2.5. Unassigned Code Points
159
160   This profile specifies [StringPrep, A.1] table as its list of
161   unassigned code points.
162
163
164 3. Security Considerations
165
166   This profile is intended to used to prepare simple user names and
167
168
169
170 Zeilenga                        SASLprep                        [Page 3]
171 \f
172 INTERNET-DRAFT       draft-ietf-sasl-saslprep-04.txt     27 October 2003
173
174
175   passwords for comparison.  It is not intended to be used for to
176   prepare identities which are not simple user names (e.g.,
177   distinguished names and domain names).  Nor is the profile intended to
178   be used for simple user names which require different handling.
179   Protocols (or applications of those protocols) which have
180   application-specific identity forms and/or comparison algorithms
181   should use mechanisms specifically designed for these forms and
182   algorithms.
183
184   User names and passwords should be protected from eavesdropping.
185
186   General "stringprep" and Unicode security considerations apply.  Both
187   are discussed in [StringPrep].
188
189
190 4. IANA Considerations
191
192   This document details the "SASLprep" profile of [StringPrep] protocol.
193   Upon Standards Action the profile should be registered in the
194   stringprep profile registry.
195
196       Name of this profile: SASLprep
197       RFC in which the profile is defined: This RFC
198       Indicator whether or not this is the newest version of the
199       profile: This is the first version of the SASPprep profile.
200
201
202 5. Acknowledgment
203
204   This document borrows text from "Preparation of Internationalized
205   Strings ('stringprep')" and "Nameprep: A Stringprep Profile for
206   Internationalized Domain Names", both by Paul Hoffman and Marc
207   Blanchet.
208
209   This document is a product of the IETF SASL WG.
210
211
212 6. Normative References
213
214   [StringPrep]  Hoffman P. and M. Blanchet, "Preparation of
215                 Internationalized Strings ('stringprep')",
216                 draft-hoffman-rfc3454bis-xx.txt, a work in progress.
217
218   [SASL]        Melnikov, A. (Editor), "Simple Authentication and
219                 Security Layer (SASL)",
220                 draft-ietf-sasl-rfc2222bis-xx.txt, a work in progress.
221
222   [Unicode]     The Unicode Consortium, "The Unicode Standard, Version
223
224
225
226 Zeilenga                        SASLprep                        [Page 4]
227 \f
228 INTERNET-DRAFT       draft-ietf-sasl-saslprep-04.txt     27 October 2003
229
230
231                 3.2.0" is defined by "The Unicode Standard, Version 3.0"
232                 (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5),
233                 as amended by the "Unicode Standard Annex #27: Unicode
234                 3.1" (http://www.unicode.org/reports/tr27/) and by the
235                 "Unicode Standard Annex #28: Unicode 3.2"
236                 (http://www.unicode.org/reports/tr28/).
237
238
239 7. Informative References
240
241   [Glossary]    The Unicode Consortium, "Unicode Glossary",
242                 <http://www.unicode.org/glossary/>.
243
244   [CharModel]   Whistler, K. and M. Davis, "Unicode Technical Report
245                 #17, Character Encoding Model", UTR17,
246                 <http://www.unicode.org/unicode/reports/tr17/>, August
247                 2000.
248
249   [CRAM-MD5]    Nerenberg, L., "The CRAM-MD5 SASL Mechanism",
250                 draft-ietf-sasl-crammd5-xx.txt, a work in progress.
251
252   [DIGEST-MD5]  Leach, P., C. Newman, and A. Melnikov, "Using Digest
253                 Authentication as a SASL Mechanism",
254                 draft-ietf-sasl-rfc2831bis-xx.txt, a work in progress.
255
256   [PLAIN]       Zeilenga, K. (Editor), "The Plain SASL Mechanism",
257                 draft-ietf-sasl-plain-xx.txt, a work in progress.
258
259
260 8. Editor's Address
261
262   Kurt Zeilenga
263   OpenLDAP Foundation
264
265   Email: kurt@OpenLDAP.org
266
267
268 Intellectual Property Rights
269
270   The IETF takes no position regarding the validity or scope of any
271   intellectual property or other rights that might be claimed to pertain
272   to the implementation or use of the technology described in this
273   document or the extent to which any license under such rights might or
274   might not be available; neither does it represent that it has made any
275   effort to identify any such rights.  Information on the IETF's
276   procedures with respect to rights in standards-track and
277   standards-related documentation can be found in BCP-11.  Copies of
278   claims of rights made available for publication and any assurances of
279
280
281
282 Zeilenga                        SASLprep                        [Page 5]
283 \f
284 INTERNET-DRAFT       draft-ietf-sasl-saslprep-04.txt     27 October 2003
285
286
287   licenses to be made available, or the result of an attempt made to
288   obtain a general license or permission for the use of such proprietary
289   rights by implementors or users of this specification can be obtained
290   from the IETF Secretariat.
291
292   The IETF invites any interested party to bring to its attention any
293   copyrights, patents or patent applications, or other proprietary
294   rights which may cover technology that may be required to practice
295   this standard.  Please address the information to the IETF Executive
296   Director.
297
298
299 Full Copyright
300
301   Copyright (C) The Internet Society (2003). All Rights Reserved.
302
303   This document and translations of it may be copied and furnished to
304   others, and derivative works that comment on or otherwise explain it
305   or assist in its implmentation may be prepared, copied, published and
306   distributed, in whole or in part, without restriction of any kind,
307   provided that the above copyright notice and this paragraph are
308   included on all such copies and derivative works.  However, this
309   document itself may not be modified in any way, such as by removing
310   the copyright notice or references to the Internet Society or other
311   Internet organizations, except as needed for the  purpose of
312   developing Internet standards in which case the procedures for
313   copyrights defined in the Internet Standards process must be followed,
314   or as required to translate it into languages other than English.
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338 Zeilenga                        SASLprep                        [Page 6]
339 \f