Update.
[libidn.git] / doc / specifications / draft-ietf-sasl-saslprep-01.txt
blobfd3b8a37e1f2ff7f8a9109394a6dcf89f63df126
7 INTERNET-DRAFT                                   Kurt D. Zeilenga
8 Intended Category: Standards Track            OpenLDAP Foundation
9 Expires in six months                                  4 May 2003
12         SASLprep: Stringprep profile for user names and passwords
13                     <draft-ietf-sasl-saslprep-01.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 RFC2026.
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 2003, The Internet Society.  All Rights Reserved.
43   Please see the Copyright section near the end of this document for
44   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" "stringprep" profile to be used for both user names and
52   passwords.  This profile is intended to be used by Simple
53   Authentication and Security Layer (SASL) mechanisms (such as PLAIN,
54   CRAM-MD5, and DIGEST-MD5) as well as other protocols exchanging user
58 Zeilenga                        SASLprep                        [Page 1]
60 INTERNET-DRAFT       draft-ietf-sasl-saslprep-01.txt          4 May 2003
63   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   likelyhood that user name and password input and comparsion 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   protocol [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 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).
88 1.1. Conventions
90   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
91   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
92   document are to be interpreted as described in BCP 14 [RFC2119].
94   Character names in this document use the notation for code points and
95   names from the Unicode Standard [Unicode].  For example, the letter
96   "a" may be represented as either <U+0061> or <LATIN SMALL LETTER A>.
97   In the lists of mappings and the prohibited characters, the "U+" is
98   left off to make the lists easier to read.  The comments for character
99   ranges are shown in square brackets (such as "[CONTROL CHARACTERS]")
100   and do not come from the standard.
102   Note: a glossary of terms used in Unicode can be found in [Glossary].
103   Information on the Unicode character encoding model can be found in
104   [CharModel].
107 2. The SASLprep profile
109   This section defines the "SASLprep" profile.  This profile is intended
110   to be used to prepare strings representing simple user names and
114 Zeilenga                        SASLprep                        [Page 2]
116 INTERNET-DRAFT       draft-ietf-sasl-saslprep-01.txt          4 May 2003
119   passwords.
121   This profile uses Unicode 3.2, as defined in [StringPrep, A.1].
124 2.1. Mapping
126   This profile specifies:
127     - non-ASCII space characters [StringPrep, C.1.2] be mapped to SPACE
128       (U+0020), and
130     - the "commonly mapped to nothing" characters [StringPrep, B.1] be
131       mapped to nothing.
135 2.2. Normalization
137   This profile specifies using Unicode normalization form KC, as
138   described in Section 4 of [StringPrep].
141 2.3. Prohibited Output
143   This profile specifies the following characters:
145     - Non-ASCII space characters [StringPrep, C.1.2],
146     - ASCII control charcters [StringPrep, C.2.1],
147     - Non-ASCII control characters [StringPrep, C.2.2],
148     - Private Use [StringPrep, C.3],
149     - Non-character code points [StringPrep, C.4],
150     - Surrogate code points [StringPrep, C.5],
151     - Inappropriate for plain text [StringPrep, C.6],
152     - Inappropriate for canonical representation [StringPrep, C.7],
153     - Change display properties or are deprecated [StringPrep, C.8], and
154     - Tagging characters [StringPrep, C.9].
156   are prohibited output.
159 2.4. Bidirectional characters
161   This profile specifies checking bidirectional strings as described in
162   [StringPrep, Section 6].
165 2.5. Unassigned Code Points
170 Zeilenga                        SASLprep                        [Page 3]
172 INTERNET-DRAFT       draft-ietf-sasl-saslprep-01.txt          4 May 2003
175   This profile specifies [StringPrep, A.1] table as its list of
176   unassigned code points.
179 3. IANA Considerations
181   This document details the "SASLprep" profile of [StringPrep] protocol.
182   Upon Standards Action the profile should be registered in the
183   stringprep profile registry.
185       Name of this profile: SASLprep
186       RFC in which the profile is defined: This RFC
187       Indicator whether or not this is the newest version of the
188       profile: This is the first version of the User Name profile.
191 5. Acknowledgement
193       This document borrows text from "Preparation of Internationalized
194       Strings ('stringprep')" and "Nameprep: A Stringprep Profile for
195       Internationalized Domain Names", both by Paul Hoffman and Marc
196       Blanchet.
199 6. Normative References
201   [Keywords]   S. Bradner, "Key words for use in RFCs to Indicate
202                Requirement Levels", BCP 14 (also RFC 2119), March 1997.
204   [StringPrep] P. Hoffman, M. Blanchet, "Preparation of
205                Internationalized Strings ('stringprep')", RFC 3454,
206                December 2002.
208   [SASL]       J. Myers, "Simple Authentication and Security Layer
209                (SASL)", draft-myers-saslrev-xx.txt (a work in progress).
211   [Unicode]    The Unicode Consortium. The Unicode Standard, Version
212                3.2.0 is defined by The Unicode Standard, Version 3.0
213                (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5),
214                as amended by the Unicode Standard Annex #27: Unicode 3.1
215                (http://www.unicode.org/reports/tr27/) and by the Unicode
216                Standard Annex #28: Unicode 3.2
217                (http://www.unicode.org/reports/tr28/).
220 7. Informative References
222   [Glossary]   Unicode Glossary, <http://www.unicode.org/glossary/>.
226 Zeilenga                        SASLprep                        [Page 4]
228 INTERNET-DRAFT       draft-ietf-sasl-saslprep-01.txt          4 May 2003
231   [CharModel]  Unicode Technical Report;17, Character Encoding Model.
232                <http://www.unicode.org/unicode/reports/tr17/>.
234   [CRAM-MD5]   L. Nerenberg, "The CRAM-MD5 SASL Mechanism",
235                draft-nerenberg-sasl-crammd5-xx.txt (a work in progress).
237   [PLAIN]      K. Zeilenga, "The Plain SASL Mechanism",
238                draft-ietf-sasl-plain-xx.txt (a work in progress).
240   [DIGEST-MD5] P. Leach, C. Newman, A. Melnikov, "Using Digest
241                Authentication as a SASL Mechanism",
242                draft-ietf-sasl-rfc2831bis-xx.txt (a work in progress).
245 8. Editor's Address
247   Kurt Zeilenga
248   OpenLDAP Foundation
250   Email: kurt@OpenLDAP.org
253 Full Copyright Statement
255   Copyright 2003, The Internet Society.  All Rights Reserved.
257   This document and translations of it may be copied and furnished to
258   others, and derivative works that comment on or otherwise explain it
259   or assist in its implementation may be prepared, copied, published and
260   distributed, in whole or in part, without restriction of any kind,
261   provided that the above copyright notice and this paragraph are
262   included on all such copies and derivative works.  However, this
263   document itself may not be modified in any way, such as by removing
264   the copyright notice or references to the Internet Society or other
265   Internet organizations, except as needed for the  purpose of
266   developing Internet standards in which case the procedures for
267   copyrights defined in the Internet Standards process must be followed,
268   or as required to translate it into languages other than English.
270   The limited permissions granted above are perpetual and will not be
271   revoked by the Internet Society or its successors or assigns.
273   This document and the information contained herein is provided on an
274   "AS IS" basis and THE AUTHORS, THE INTERNET SOCIETY, AND THE INTERNET
275   ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
276   INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
277   INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
278   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
282 Zeilenga                        SASLprep                        [Page 5]