]> git.sur5r.net Git - openldap/blob - doc/drafts/draft-ietf-ldapbis-dn-xx.txt
Add note about syncrepl Persist retries
[openldap] / doc / drafts / draft-ietf-ldapbis-dn-xx.txt
1
2
3
4
5
6
7 INTERNET-DRAFT                           Editor: Kurt D. Zeilenga
8 Intended Category: Standard Track                OpenLDAP Foundation
9 Expires in six months                            15 February 2004
10 Obsoletes: 2253
11
12
13
14             LDAP: String Representation of Distinguished Names
15                       <draft-ietf-ldapbis-dn-13.txt>
16
17
18
19 Status of Memo
20
21   This document is an Internet-Draft and is in full conformance with all
22   provisions of Section 10 of RFC2026.
23
24   This document is intended to be, after appropriate review and
25   revision, submitted to the RFC Editor as a Standard Track document
26   replacing RFC 2253.  Distribution of this memo is unlimited.
27   Technical discussion of this document will take place on the IETF LDAP
28   Revision (LDAPBIS) Working Group mailing list
29   <ietf-ldapbis@openldap.org>.  Please send editorial comments directly
30   to the document editor <Kurt@OpenLDAP.org>.
31
32   Internet-Drafts are working documents of the Internet Engineering Task
33   Force (IETF), its areas, and its working groups.  Note that other
34   groups may also distribute working documents as Internet-Drafts.
35   Internet-Drafts are draft documents valid for a maximum of six months
36   and may be updated, replaced, or obsoleted by other documents at any
37   time.  It is inappropriate to use Internet-Drafts as reference
38   material or to cite them other than as ``work in progress.''
39
40   The list of current Internet-Drafts can be accessed at
41   <http://www.ietf.org/ietf/1id-abstracts.txt>. The list of
42   Internet-Draft Shadow Directories can be accessed at
43   <http://www.ietf.org/shadow.html>.
44
45   Copyright (C) The Internet Society (2004).  All Rights Reserved.
46
47   Please see the Full Copyright section near the end of this document
48   for more information.
49
50
51
52
53
54
55
56
57
58 Zeilenga                LDAP: Distinguished Names               [Page 1]
59 \f
60 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
61
62
63 Abstract
64
65   The X.500 Directory uses distinguished names (DNs) as primary keys to
66   entries in the directory.  This document defines the string
67   representation used in the Lightweight Directory Access Protocol
68   (LDAP) to transfer distinguished names.  The string representation is
69   designed to give a clean representation of commonly used distinguished
70   names, while being able to represent any distinguished name.
71
72
73 1.  Background and Intended Usage
74
75   In X.500-based directory systems [X.500], including those accessed
76   using the Lightweight Directory Access Protocol (LDAP) [Roadmap],
77   distinguished names (DNs) are used to unambiguously refer to directory
78   entries [X.501][Models].
79
80   The structure of a DN [X.501] is described in terms of ASN.1 [X.680].
81   In the X.500 Directory Access Protocol [X.511] (and other ITU-defined
82   directory protocols), DNs are encoded using the Basic Encoding Rules
83   (BER) [X.690].  In LDAP, DNs are represented in the string form
84   described in this document.
85
86   It is important to have a common format to be able to unambiguously
87   represent a distinguished name.  The primary goal of this
88   specification is ease of encoding and decoding.  A secondary goal is
89   to have names that are human readable.  It is not expected that LDAP
90   implementations with a human user interface would display these
91   strings directly to the user, but would most likely be performing
92   translations (such as expressing attribute type names in the local
93   national language).
94
95   This document defines the string representation of Distinguished Names
96   used in LDAP [Protocol][Syntaxes].  Section 2 details the RECOMMENDED
97   algorithm for converting a DN from its ASN.1 structured representation
98   to a string.  Section 3 details how to convert a DN from a string to a
99   ASN.1 structured representation.
100
101   While other documents may define other algorithms for converting a DN
102   from its ASN.1 structured representation to a string, all algorithms
103   MUST produce strings which adhere to the requirements of Section 3.
104
105   This document does not define a canonical string representation for
106   DNs.  Comparison of DNs for equality is to be performed in accordance
107   with the distinguishedNameMatch matching rule [Syntaxes].
108
109   This document is an integral part of the LDAP Technical Specification
110   [Roadmap].  This document obsoletes RFC 2253.  Changes since RFC 2253
111
112
113
114 Zeilenga                LDAP: Distinguished Names               [Page 2]
115 \f
116 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
117
118
119   are summarized in Appendix B.
120
121   This specification assumes familiarity with X.500 [X.500] and the
122   concept of Distinguished Name [X.501][Models].
123
124
125 1.1. Conventions
126
127   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
128   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
129   document are to be interpreted as described in BCP 14 [RFC2119].
130
131   Character names in this document use the notation for code points and
132   names from the Unicode Standard [Unicode].  For example, the letter
133   "a" may be represented as either <U+0061> or <LATIN SMALL LETTER A>.
134
135   Note: a glossary of terms used in Unicode can be found in [Glossary].
136   Information on the Unicode character encoding model can be found in
137   [CharModel].
138
139
140 2.  Converting DistinguishedName from ASN.1 to a String
141
142   X.501 [X.501] defines the ASN.1 [X.680] structure of distinguished
143   name.  The following is a variant provided for discussion purposes.
144
145       DistinguishedName ::= RDNSequence
146
147       RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
148
149       RelativeDistinguishedName ::= SET SIZE (1..MAX) OF
150           AttributeTypeAndValue
151
152       AttributeTypeAndValue ::= SEQUENCE {
153           type  AttributeType,
154           value AttributeValue }
155
156   This section defines the RECOMMENDED algorithm for converting a
157   distinguished name from an ASN.1 structured representation to an UTF-8
158   [RFC3629] encoded Unicode [Unicode] character string representation.
159   Other documents may describe other algorithms for converting a
160   distinguished name to a string, but only strings which conform to the
161   grammar defined in Section 3 SHALL be produced by LDAP
162   implementations.
163
164
165 2.1. Converting the RDNSequence
166
167
168
169
170 Zeilenga                LDAP: Distinguished Names               [Page 3]
171 \f
172 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
173
174
175   If the RDNSequence is an empty sequence, the result is the empty or
176   zero length string.
177
178   Otherwise, the output consists of the string encodings of each
179   RelativeDistinguishedName in the RDNSequence (according to Section
180   2.2), starting with the last element of the sequence and moving
181   backwards toward the first.
182
183   The encodings of adjoining RelativeDistinguishedNames are separated by
184   a comma (',' U+002C) character.
185
186
187 2.2.  Converting RelativeDistinguishedName
188
189   When converting from an ASN.1 RelativeDistinguishedName to a string,
190   the output consists of the string encodings of each
191   AttributeTypeAndValue (according to Section 2.3), in any order.
192
193   Where there is a multi-valued RDN, the outputs from adjoining
194   AttributeTypeAndValues are separated by a plus sign ('+' U+002B)
195   character.
196
197
198 2.3.  Converting AttributeTypeAndValue
199
200   The AttributeTypeAndValue is encoded as the string representation of
201   the AttributeType, followed by an equals ('=' U+003D) character,
202   followed by the string representation of the AttributeValue.  The
203   encoding of the AttributeValue is given in Section 2.4.
204
205   If the AttributeType is defined to have a short name and that short
206   name is known to be registered [REGISTRY][BCP64bis] as identifying the
207   AttributeType, that short name, a <descr>, is used.  Otherwise the
208   AttributeType is encoded as the dotted-decimal encoding, a
209   <numericoid>, of its OBJECT IDENTIFIER.  The <descr> and <numericoid>
210   is defined in [Models].
211
212   Implementations are not expected to dynamically update their knowledge
213   of registered short names.  However, implementations SHOULD provide a
214   mechanism to allow its knowledge of registered short names to be
215   updated.
216
217
218 2.4.  Converting an AttributeValue from ASN.1 to a String
219
220   If the AttributeType is of the dotted-decimal form, the AttributeValue
221   is represented by an number sign ('#' U+0023) character followed by
222   the hexadecimal encoding of each of the octets of the BER encoding of
223
224
225
226 Zeilenga                LDAP: Distinguished Names               [Page 4]
227 \f
228 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
229
230
231   the X.500 AttributeValue.  This form is also used when the syntax of
232   the AttributeValue does not have a LDAP-specific [Syntaxes, Section
233   3.1] string encoding defined for it or the LDAP-specific string
234   encoding is not restricted to UTF-8 encoded Unicode characters.  This
235   form may also be used in other cases, such as when a reversible string
236   representation is desired (see Section 5.2).
237
238   Otherwise, if the AttributeValue is of a syntax which has a
239   LDAP-specific string encoding, the value is converted first to a UTF-8
240   encoded Unicode string according to its syntax specification (see
241   [Syntaxes, Section 3.3] for examples).  If that UTF-8 encoded Unicode
242   string does not have any of the following characters which need
243   escaping, then that string can be used as the string representation of
244   the value.
245
246       - a space (' ' U+0020) or number sign ('#' U+0023) occurring at
247         the beginning of the string;
248
249       - a space (' ' U+0020) character occurring at the end of the
250         string;
251
252       - one of the characters '"', '+', ',', ';', '<', '>',  or '\'
253         (U+0022, U+002B, U+002C, U+003B, U+003C, U+003E, or U+005C
254         respectively);
255
256       - the null (U+0000) character.
257
258   Other characters may be escaped.
259
260   Each octet of the character to be escaped is replaced by a backslash
261   and two hex digits, which form a single octet in the code of the
262   character.  Alternatively, if and only if the character to be escaped
263   is one of
264
265       ' ', '"', '#', '+', ',', ';', '<', '=', '>', or '\'
266       (U+0020, U+0022, U+0023, U+002B, U+002C, U+003B,
267        U+003C, U+003D, U+003E, U+005C respectively)
268
269   it can be prefixed by a backslash ('\' U+0005C).
270
271   Examples of the escaping mechanism are shown in Section 4.
272
273
274 3. Parsing a String back to a Distinguished Name
275
276   The string representation of Distinguished Names is restricted to
277   UTF-8 [RFC3629] encoded Unicode [Unicode] characters.  The structure
278   of this string representation is specified using the following
279
280
281
282 Zeilenga                LDAP: Distinguished Names               [Page 5]
283 \f
284 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
285
286
287   Augmented BNF [RFC2234] grammar:
288
289       distinguishedName = [ relativeDistinguishedName
290           *( COMMA relativeDistinguishedName ) ]
291       relativeDistinguishedName = attributeTypeAndValue
292           *( PLUS attributeTypeAndValue )
293       attributeTypeAndValue = attributeType EQUALS attributeValue
294       attributeType = descr / numericoid
295       attributeValue = string / hexstring
296
297       ; The following characters are to be escaped when they appear
298       ; in the value to be encoded: ESC, one of <escaped>, leading
299       ; SHARP or SPACE, trailing SPACE, and NULL.
300       string     = [ (leadchar / pair)
301                    [ *( stringchar / pair ) ( trailchar / pair ) ] ]
302
303       leadchar   = LUTF1 / UTFMB
304       LUTF1      = %x01-1F / %x21 / %x24-2A / %x2D-3A /
305                    %x3D / %x3F-5B / %x5D-7F
306
307       trailchar  = TUTF1 / UTFMB
308       TUTF1      = %x01-1F / %x21 / %x23-2A / %x2D-3A /
309                    %x3D / %x3F-5B / %x5D-7F
310
311       stringchar = SUTF1 / UTFMB
312       SUTF1      = %x01-21 / %x23-2A / %x2D-3A /
313                    %x3D / %x3F-5B / %x5D-7F
314
315       pair       = ESC ( ESC / special / hexpair )
316       special    = escaped / SPACE / SHARP / EQUALS
317       escaped    = DQUOTE / PLUS / COMMA / SEMI / LANGLE / RANGLE
318       hexstring  = SHARP 1*hexpair
319       hexpair    = HEX HEX
320
321   where the productions <descr>, <numericoid>, <COMMA>, <DQUOTE>,
322   <EQUALS>, <ESC>, <HEX>, <LANGLE>, <NULL>, <PLUS>, <RANGLE>, <SEMI>,
323   <SPACE>, <SHARP>, <UTFMB> are defined in [Models].
324
325   Each <attributeType>, either a <descr> or a <numericoid>, refers to an
326   attribute type of an attribute value assertion (AVA).  The
327   <attributeType> is followed by a <EQUALS> and an <attributeValue>.
328   The <attributeValue> is either in <string> or <hexstring> form.
329
330   If in <string> form, a LDAP string representation asserted value can
331   be obtained by replacing (left-to-right, non-recursively) each <pair>
332   appearing in the <string> as follows:
333       replace <ESC><ESC> with <ESC>;
334       replace <ESC><special> with <special>;
335
336
337
338 Zeilenga                LDAP: Distinguished Names               [Page 6]
339 \f
340 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
341
342
343       replace <ESC><hexpair> with the octet indicated by the <hexpair>.
344
345   If in <hexstring> form, a BER representation can be obtained from
346   converting each <hexpair> of the <hexstring> to the octet indicated by
347   the <hexpair>.
348
349   One or more attribute values assertions, separated by <PLUS>, for a
350   relative distinguished name.
351
352   Zero or more relative distinguished names, separated by <COMMA>, for a
353   distinguished name.
354
355   Implementations MUST recognize AttributeType name strings
356   (descriptors) listed in the following table, but MAY recognize other
357   name strings.
358
359       String  X.500 AttributeType
360       ------  --------------------------------------------
361       CN      commonName (2.5.4.3)
362       L       localityName (2.5.4.7)
363       ST      stateOrProvinceName (2.5.4.8)
364       O       organizationName (2.5.4.10)
365       OU      organizationalUnitName (2.5.4.11)
366       C       countryName (2.5.4.6)
367       STREET  streetAddress (2.5.4.9)
368       DC      domainComponent (0.9.2342.19200300.100.1.25)
369       UID     userId (0.9.2342.19200300.100.1.1)
370
371   Implementations MAY recognize other DN string representations (such as
372   that described in RFC 1779).  However, as there is no requirement that
373   alternative DN string representations to be recognized (and, if so,
374   how), implementations SHOULD only generate DN strings in accordance
375   with Section 2 of this document.
376
377
378 4.  Examples
379
380   This notation is designed to be convenient for common forms of name.
381   This section gives a few examples of distinguished names written using
382   this notation.  First is a name containing three relative
383   distinguished names (RDNs):
384
385       UID=jsmith,DC=example,DC=net
386
387   Here is an example name containing three RDNs, in which the first RDN
388   is multi-valued:
389
390       OU=Sales+CN=J. Smith,DC=example,DC=net
391
392
393
394 Zeilenga                LDAP: Distinguished Names               [Page 7]
395 \f
396 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
397
398
399   This example shows the method of escaping of a comma in a common name:
400
401       CN=John Smith\, III,DC=example,DC=net
402
403   An example name in which a value contains a carriage return character:
404
405       CN=Before\0dAfter,DC=example,DC=net
406
407   An example name in which an RDN was of an unrecognized type.  The
408   value is the BER encoding of an OCTET STRING containing two octets
409   0x48 and 0x69.
410
411       1.3.6.1.4.1.1466.0=#04024869,DC=example,DC=com
412
413   Finally, an example of an RDN commonName value consisting of 5
414   letters:
415
416       Unicode Character                Code       UTF-8   Escaped
417       -------------------------------  ------     ------  --------
418       LATIN CAPITAL LETTER L           U+004C     0x4C    L
419       LATIN SMALL LETTER U             U+0075     0x75    u
420       LATIN SMALL LETTER C WITH CARON  U+010D     0xC48D  \C4\8D
421       LATIN SMALL LETTER I             U+0069     0x69    i
422       LATIN SMALL LETTER C WITH ACUTE  U+0107     0xC487  \C4\87
423
424   could be written in printable ASCII (useful for debugging purposes):
425
426       CN=Lu\C4\8Di\C4\87
427
428
429 5.  Security Considerations
430
431   The following security considerations are specific to the handling of
432   distinguished names.  LDAP security considerations are discussed in
433   [Protocol] and other documents comprising the LDAP Technical
434   Specification [Roadmap].
435
436
437 5.1. Disclosure
438
439   Distinguished Names typically consist of descriptive information about
440   the entries they name, which can be people, organizations, devices or
441   other real-world objects.  This frequently includes some of the
442   following kinds of information:
443
444     - the common name of the object (i.e. a person's full name)
445     - an email or TCP/IP address
446     - its physical location (country, locality, city, street address)
447
448
449
450 Zeilenga                LDAP: Distinguished Names               [Page 8]
451 \f
452 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
453
454
455     - organizational attributes (such as department name or affiliation)
456
457   Most countries have privacy laws regarding the publication of
458   information about people.
459
460
461 5.2. Use of Distinguished Names in Security Applications
462
463   The transformations of an AttributeValue value from its X.501 form to
464   an LDAP string representation are not always reversible back to the
465   same BER (Basic Encoding Rules) or DER (Distinguished Encoding rules)
466   form.  An example of a situation which requires the DER form of a
467   distinguished name is the verification of an X.509 certificate.
468
469   For example, a distinguished name consisting of one RDN with one AVA,
470   in which the type is commonName and the value is of the TeletexString
471   choice with the letters 'Sam' would be represented in LDAP as the
472   string <CN=Sam>.  Another distinguished name in which the value is
473   still 'Sam' but of the PrintableString choice would have the same
474   representation <CN=Sam>.
475
476   Applications which require the reconstruction of the DER form of the
477   value SHOULD NOT use the string representation of attribute syntaxes
478   when converting a distinguished name to the LDAP format.  Instead,
479   they SHOULD use the hexadecimal form prefixed by the number sign ('#')
480   as described in the first paragraph of Section 2.3.
481
482
483 6.  Acknowledgment
484
485   This document is an update to RFC 2253, by Mark Wahl, Tim Howes, and
486   Steve Kille.  RFC 2253 was a product of the IETF ASID Working Group.
487
488   This document is a product of the IETF LDAPBIS Working Group.
489
490
491 7. Document Editor's Address
492
493   Kurt D. Zeilenga
494   OpenLDAP Foundation
495   <Kurt@OpenLDAP.org>
496
497
498 8. Normative References
499
500   [X.501]       International Telecommunication Union -
501                 Telecommunication Standardization Sector, "The Directory
502                 -- Models," X.501(1993) (also ISO/IEC 9594-2:1994).
503
504
505
506 Zeilenga                LDAP: Distinguished Names               [Page 9]
507 \f
508 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
509
510
511   [X.680]       International Telecommunication Union -
512                 Telecommunication Standardization Sector, "Abstract
513                 Syntax Notation One (ASN.1) - Specification of Basic
514                 Notation", X.680(1997) (also ISO/IEC 8824-1:1998).
515
516   [RFC2119]     Bradner, S., "Key words for use in RFCs to Indicate
517                 Requirement Levels", BCP 14 (also RFC 2119), March 1997.
518
519   [RFC2234]     Crocker, D. and P. Overell, "Augmented BNF for Syntax
520                 Specifications: ABNF", RFC 2234, November 1997.
521
522   [RFC3329]     Yergeau, F., "UTF-8, a transformation format of ISO
523                 10646", RFC 3329 (also STD 64), November 2003.
524
525   [Unicode]     The Unicode Consortium, "The Unicode Standard, Version
526                 3.2.0" is defined by "The Unicode Standard, Version 3.0"
527                 (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5),
528                 as amended by the "Unicode Standard Annex #27: Unicode
529                 3.1" (http://www.unicode.org/reports/tr27/) and by the
530                 "Unicode Standard Annex #28: Unicode 3.2"
531                 (http://www.unicode.org/reports/tr28/).
532
533   [Models]      Zeilenga, K. (editor), "LDAP: Directory Information
534                 Models", draft-ietf-ldapbis-models-xx.txt, a work in
535                 progress.
536
537   [Roadmap]     Zeilenga, K. (editor), "LDAP: Technical Specification
538                 Road Map", draft-ietf-ldapbis-roadmap-xx.txt, a work in
539                 progress.
540
541   [Protocol]    Sermersheim, J. (editor), "LDAP: The Protocol",
542                 draft-ietf-ldapbis-protocol-xx.txt, a work in progress.
543
544   [Syntaxes]    Legg, S. (editor), "LDAP: Syntaxes and Matching Rules",
545                 draft-ietf-ldapbis-syntaxes-xx.txt, a work in progress.
546
547   [Schema]      Dally, K. (editor), "LDAP: User Schema",
548                 draft-ietf-ldapbis-user-schema-xx.txt, a work in
549                 progress.
550
551   [REGISTRY]    IANA, Object Identifier Descriptors Registry,
552                 <http://www.iana.org/...>.
553
554 9. Informative References
555
556   [ASCII]       Coded Character Set--7-bit American Standard Code for
557                 Information Interchange, ANSI X3.4-1986.
558
559
560
561
562 Zeilenga                LDAP: Distinguished Names              [Page 10]
563 \f
564 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
565
566
567   [X.500]       International Telecommunication Union -
568                 Telecommunication Standardization Sector, "The Directory
569                 -- Overview of concepts, models and services,"
570                 X.500(1993) (also ISO/IEC 9594-1:1994).
571
572   [X.690]       International Telecommunication Union -
573                 Telecommunication Standardization Sector, "Specification
574                 of ASN.1 encoding rules: Basic Encoding Rules (BER),
575                 Canonical Encoding Rules (CER), and Distinguished
576                 Encoding Rules (DER)", X.690(1997) (also ISO/IEC
577                 8825-1:1998).
578
579   [RFC2849]     Good, G., "The LDAP Data Interchange Format (LDIF) -
580                 Technical Specification", RFC 2849, June 2000.
581
582   [BCP64bis]    Zeilenga, K., "IANA Considerations for LDAP", draft-
583                 ietf-ldapbis-bcp64-xx.txt, a work in progress.
584
585   [CharModel]   Whistler, K. and M. Davis, "Unicode Technical Report
586                 #17, Character Encoding Model", UTR17,
587                 <http://www.unicode.org/unicode/reports/tr17/>, August
588                 2000.
589
590   [Glossary]    The Unicode Consortium, "Unicode Glossary",
591                 <http://www.unicode.org/glossary/>.
592
593
594
595 Appendix A.   Presentation Issues
596
597   This appendix is provided for informational purposes only, it is not a
598   normative part of this specification.
599
600   The string representation described in this document is not intended
601   to be presented to humans without translation.  However, at times it
602   may be desirable to present non-translated DN strings to users.  This
603   section discusses presentation issues associated with non-translated
604   DN strings.  Presentation of translated DN strings issues are not
605   discussed in this appendix.  Transcoding issues are also not discussed
606   in this appendix.
607
608   This appendix provides guidance for applications presenting DN strings
609   to users.  This section is not comprehensive, it does not discuss all
610   presentation issues which implementors may face.
611
612   Not all user interfaces are capable of displaying the full set of
613   Unicode characters.  Some Unicode characters are not displayable.
614
615
616
617
618 Zeilenga                LDAP: Distinguished Names              [Page 11]
619 \f
620 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
621
622
623   It is recommended that human interfaces use the optional hex pair
624   escaping mechanism (Section 2.3) to produce a string representation
625   suitable for display to the user.  For example, an application can
626   generate a DN string for display which escapes all non-printable
627   characters appearing in the AttributeValue's string representation (as
628   demonstrated in the final example of Section 4).
629
630   When a DN string is displayed in free form text, it is often necessary
631   to distinguish the DN string from surrounding text.  While this is
632   often done with white space (as demonstrated in Section 4), it is
633   noted that DN strings may end with white space.  Careful readers of
634   Section 3 will note that characters '<' (U+003C) and '>' (U+003E) may
635   only appear in the DN string if escaped.  These characters are
636   intended to be used in free form text to distinguish a DN string from
637   surrounding text.  For example, <CN=Sam\ > distinguished the string
638   representation of the DN comprised of one RDN consisting of the AVA:
639   the commonName (CN) value 'Sam ' from the surrounding text.  It should
640   be noted to the user that the wrapping '<' and '>' characters are not
641   part of the DN string.
642
643   DN strings can be quite long.  It is often desirable to line-wrap
644   overly long DN strings in presentations.  Line wrapping should be done
645   by inserting white space after the RDN separator character or, if
646   necessary, after the AVA separator character.  It should be noted to
647   the user that the inserted white space is not part of the DN string
648   and is to be removed before use in LDAP.  For example,
649
650       The following DN string is long:
651           CN=Kurt D. Zeilenga,OU=Engineering,L=Redwood Shores,
652           O=OpenLDAP Foundation,ST=California,C=US
653       so it has been line-wrapped for readability.  The extra white
654       space is to be removed before the DN string is used in LDAP.
655
656   It is not advised to insert white space otherwise as it may not be
657   obvious to the user which white space is part of the DN string and
658   which white space was added for readability.
659
660   Another alternative is to use the LDAP Data Interchange Format (LDIF)
661   [RFC2849].  For example,
662
663           # This entry has a long DN...
664           dn: CN=Kurt D. Zeilenga,OU=Engineering,L=Redwood Shores,
665            O=OpenLDAP Foundation,ST=California,C=US
666           CN: Kurt D. Zeilenga
667           SN: Zeilenga
668           objectClass: person
669
670
671
672
673
674 Zeilenga                LDAP: Distinguished Names              [Page 12]
675 \f
676 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
677
678
679 Appendix B. Changes made since RFC 2253
680
681   This appendix is provided for informational purposes only, it is not a
682   normative part of this specification.
683
684   The following substantive changes were made to RFC 2253:
685     - Removed IESG Note.  The IESG Note has been addressed.
686     - Replaced all references to ISO 10646-1 with [Unicode].
687     - Clarified (in Section 1) that this document does not define a
688       canonical string representation.
689     - Revised specification (in Section 2) to allow short names of any
690       registered attribute type to appear in string representations of
691       DNs instead of being restricted to a "published table".  Remove
692       "as an example" language.  Added statement (in Section 3) allowing
693       recognition of additional names but require recognization of those
694       names in the published table.  The table is now published in
695       Section 3.
696     - Replaced specification of additional requirements for LDAPv2
697       implementations which also support LDAPv3 (RFC 2253, Section 4)
698       with a statement (in Section 3) allowing recognition of
699       alternative string representations.
700     - Updated Section 2.3 to indicate attribute type name strings are
701       case insensitive.
702     - Updated Section 2.4 to allow hex pair escaping of all characters
703       and clarified escaping for when multiple octet UTF-8 echodings are
704       present.
705     - Rewrote Section 3 to use ABNF as defined in RFC 2234.
706     - Rewrote Section 3 ABNF to be consistent with 2.4.
707     - Updated Section 3 to describe how to parse elements of the
708       grammar.
709     - Rewrote examples.
710     - Added reference to documentations containing general LDAP security
711       considerations.
712     - Added discussion of presentation issues (Appendix A).
713     - Added this appendix.
714
715   In addition, numerous editorial changes were made.
716
717
718 Intellectual Property Rights
719
720   The IETF takes no position regarding the validity or scope of any
721   intellectual property or other rights that might be claimed to pertain
722   to the implementation or use of the technology described in this
723   document or the extent to which any license under such rights might or
724   might not be available; neither does it represent that it has made any
725   effort to identify any such rights.  Information on the IETF's
726   procedures with respect to rights in standards-track and
727
728
729
730 Zeilenga                LDAP: Distinguished Names              [Page 13]
731 \f
732 INTERNET-DRAFT        draft-ietf-ldapbis-dn-13.txt       15 Febrary 2004
733
734
735   standards-related documentation can be found in BCP-11.  Copies of
736   claims of rights made available for publication and any assurances of
737   licenses to be made available, or the result of an attempt made to
738   obtain a general license or permission for the use of such proprietary
739   rights by implementors or users of this specification can be obtained
740   from the IETF Secretariat.
741
742   The IETF invites any interested party to bring to its attention any
743   copyrights, patents or patent applications, or other proprietary
744   rights which may cover technology that may be required to practice
745   this standard.  Please address the information to the IETF Executive
746   Director.
747
748
749
750 Full Copyright
751
752   Copyright (C) The Internet Society (2004). All Rights Reserved.
753
754   This document and translations of it may be copied and furnished to
755   others, and derivative works that comment on or otherwise explain it
756   or assist in its implementation may be prepared, copied, published and
757   distributed, in whole or in part, without restriction of any kind,
758   provided that the above copyright notice and this paragraph are
759   included on all such copies and derivative works.  However, this
760   document itself may not be modified in any way, such as by removing
761   the copyright notice or references to the Internet Society or other
762   Internet organizations, except as needed for the  purpose of
763   developing Internet standards in which case the procedures for
764   copyrights defined in the Internet Standards process must be followed,
765   or as required to translate it into languages other than English.
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786 Zeilenga                LDAP: Distinguished Names              [Page 14]
787 \f