idnits 2.17.1 draft-ietf-ldapbis-protocol-15.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) == The 'Obsoletes: ' line in the draft header should list only the _numbers_ of the RFCs which will be obsoleted by this document (if approved); it should not include the word 'RFC' in the list. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 3160 has weird spacing: '... in the c...' == The document seems to lack the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords -- however, there's a paragraph with a matching beginning. Boilerplate error? (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (Jun 2003) is 7620 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Looks like a reference, but probably isn't: '0' on line 2426 -- Looks like a reference, but probably isn't: '3' on line 2363 == Missing Reference: 'LDAPURL' is mentioned on line 1156, but not defined == Missing Reference: 'APPLICATION 0' is mentioned on line 2299, but not defined == Missing Reference: 'SASLprep' is mentioned on line 684, but not defined == Missing Reference: 'APPLICATION 1' is mentioned on line 2314, but not defined -- Looks like a reference, but probably isn't: '7' on line 2347 == Missing Reference: 'APPLICATION 2' is mentioned on line 2318, but not defined == Missing Reference: 'APPLICATION 3' is mentioned on line 2320, but not defined -- Looks like a reference, but probably isn't: '1' on line 2427 -- Looks like a reference, but probably isn't: '2' on line 2362 -- Looks like a reference, but probably isn't: '4' on line 2364 -- Looks like a reference, but probably isn't: '5' on line 2345 -- Looks like a reference, but probably isn't: '6' on line 2346 -- Looks like a reference, but probably isn't: '8' on line 2348 -- Looks like a reference, but probably isn't: '9' on line 2349 == Missing Reference: 'APPLICATION 4' is mentioned on line 2366, but not defined == Missing Reference: 'APPLICATION 19' is mentioned on line 2374, but not defined == Missing Reference: 'APPLICATION 5' is mentioned on line 2376, but not defined == Missing Reference: 'APPLICATION 6' is mentioned on line 2378, but not defined == Missing Reference: 'APPLICATION 7' is mentioned on line 2393, but not defined == Missing Reference: 'APPLICATION 8' is mentioned on line 2395, but not defined == Missing Reference: 'APPLICATION 9' is mentioned on line 2403, but not defined == Missing Reference: 'APPLICATION 10' is mentioned on line 2405, but not defined == Missing Reference: 'APPLICATION 11' is mentioned on line 2407, but not defined == Missing Reference: 'APPLICATION 12' is mentioned on line 2409, but not defined == Missing Reference: 'APPLICATION 13' is mentioned on line 2415, but not defined == Missing Reference: 'APPLICATION 14' is mentioned on line 2417, but not defined == Missing Reference: 'APPLICATION 15' is mentioned on line 2421, but not defined == Missing Reference: 'APPLICATION 16' is mentioned on line 2423, but not defined == Missing Reference: 'APPLICATION 23' is mentioned on line 2425, but not defined == Missing Reference: 'APPLICATION 24' is mentioned on line 2429, but not defined -- Looks like a reference, but probably isn't: '10' on line 2431 -- Looks like a reference, but probably isn't: '11' on line 2432 == Missing Reference: 'RFC2246' is mentioned on line 1944, but not defined ** Obsolete undefined reference: RFC 2246 (Obsoleted by RFC 4346) == Missing Reference: 'RFC2829' is mentioned on line 3202, but not defined ** Obsolete undefined reference: RFC 2829 (Obsoleted by RFC 4510, RFC 4513) == Missing Reference: 'AUTHMETH' is mentioned on line 3191, but not defined == Missing Reference: 'RFC2830' is mentioned on line 3194, but not defined ** Obsolete undefined reference: RFC 2830 (Obsoleted by RFC 4510, RFC 4511, RFC 4513) == Unused Reference: 'SASLPrep' is defined on line 1876, but no explicit reference was found in the text -- No information found for draft-ietf-ldapbis-roadmap-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'Roadmap' -- No information found for draft-ietf-ldapbis-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'LDAPIANA' -- Possible downref: Non-RFC (?) normative reference: ref. 'ISO10646' ** Obsolete normative reference: RFC 2279 (Obsoleted by RFC 3629) -- No information found for draft-ietf-ldapbis-models-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'Models' -- No information found for draft-ietf-ldapbis-dn-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'LDAPDN' -- No information found for draft-ietf-ldapbis-syntaxes-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'Syntaxes' ** Obsolete normative reference: RFC 2396 (Obsoleted by RFC 3986) -- No information found for draft-ietf-ldapbis-authmeth-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'AuthMeth' ** Obsolete normative reference: RFC 2222 (Obsoleted by RFC 4422, RFC 4752) -- No information found for draft-ietf-sasl-saslprep-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'SASLPrep' -- Possible downref: Non-RFC (?) normative reference: ref. 'Unicode' Summary: 8 errors (**), 0 flaws (~~), 31 warnings (==), 30 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet-Draft Editor: J. Sermersheim 3 Intended Category: Standard Track Novell, Inc 4 Document: draft-ietf-ldapbis-protocol-15.txt Jun 2003 5 Obsoletes: RFC 2251 7 LDAP: The Protocol 9 Status of this Memo 11 This document is an Internet-Draft and is in full conformance with 12 all provisions of Section 10 of RFC2026. 14 Internet-Drafts are working documents of the Internet Engineering 15 Task Force (IETF), its areas, and its working groups. Note that other 16 groups may also distribute working documents as Internet-Drafts. 17 Internet-Drafts are draft documents valid for a maximum of six months 18 and may be updated, replaced, or obsoleted by other documents at any 19 time. It is inappropriate to use Internet-Drafts as reference 20 material or to cite them other than as "work in progress." 22 The list of current Internet-Drafts can be accessed at 23 http://www.ietf.org/ietf/1id-abstracts.txt 25 The list of Internet-Draft Shadow Directories can be accessed at 26 http://www.ietf.org/shadow.html. 28 Distribution of this memo is unlimited. Technical discussion of this 29 document will take place on the IETF LDAP Revision Working Group 30 (LDAPbis) mailing list . Please send 31 editorial comments directly to the editor . 33 Abstract 35 This document describes the protocol elements, along with their 36 semantics and encodings, for the Lightweight Directory Access 37 Protocol (LDAP). LDAP provides access to distributed directory 38 services that act in accordance with X.500 data and service models. 39 These protocol elements are based on those described in the X.500 40 Directory Access Protocol (DAP). 42 Table of Contents 44 1. Introduction....................................................2 45 2. Conventions.....................................................3 46 3. Protocol Model..................................................3 47 4. Elements of Protocol............................................4 48 4.1. Common Elements...............................................4 49 4.1.1. Message Envelope............................................4 50 4.1.2. String Types................................................6 51 4.1.3. Distinguished Name and Relative Distinguished Name..........6 52 Lightweight Directory Access Protocol Version 3 54 4.1.4. Attribute Descriptions......................................6 55 4.1.5. Attribute Value.............................................7 56 4.1.6. Attribute Value Assertion...................................7 57 4.1.7. Attribute...................................................8 58 4.1.8. Matching Rule Identifier....................................8 59 4.1.9. Result Message..............................................8 60 4.1.10. Referral..................................................10 61 4.1.11. Controls..................................................11 62 4.2. Bind Operation...............................................12 63 4.3. Unbind Operation.............................................15 64 4.4. Unsolicited Notification.....................................15 65 4.5. Search Operation.............................................16 66 4.6. Modify Operation.............................................23 67 4.7. Add Operation................................................25 68 4.8. Delete Operation.............................................26 69 4.9. Modify DN Operation..........................................26 70 4.10. Compare Operation...........................................27 71 4.11. Abandon Operation...........................................28 72 4.12. Extended Operation..........................................29 73 4.13. Start TLS Operation.........................................30 74 5. Protocol Element Encodings and Transfer........................32 75 5.1. Protocol Encoding............................................32 76 5.2. Transfer Protocols...........................................32 77 6. Implementation Guidelines......................................33 78 6.1. Server Implementations.......................................33 79 6.2. Client Implementations.......................................33 80 7. Security Considerations........................................33 81 8. Acknowledgements...............................................34 82 9. Normative References...........................................34 83 10. Editor's Address..............................................35 84 Appendix A - LDAP Result Codes....................................37 85 A.1 Non-Error Result Codes........................................37 86 A.2 Error Result Codes............................................37 87 Appendix C - Change History.......................................48 88 C.1 Changes made to RFC 2251:.....................................48 89 C.2 Changes made to draft-ietf-ldapbis-protocol-00.txt:...........48 90 C.3 Changes made to draft-ietf-ldapbis-protocol-01.txt:...........49 91 C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt:...........49 92 C.5 Changes made to draft-ietf-ldapbis-protocol-03.txt:...........51 93 C.6 Changes made to draft-ietf-ldapbis-protocol-04.txt:...........53 94 C.7 Changes made to draft-ietf-ldapbis-protocol-05.txt:...........53 95 C.8 Changes made to draft-ietf-ldapbis-protocol-06.txt:...........54 96 C.9 Changes made to draft-ietf-ldapbis-protocol-07.txt:...........57 97 C.10 Changes made to draft-ietf-ldapbis-protocol-08.txt:..........57 98 C.11 Changes made to draft-ietf-ldapbis-protocol-09.txt:..........57 99 C.12 Changes made to draft-ietf-ldapbis-protocol-10.txt:..........57 100 C.13 Changes made to draft-ietf-ldapbis-protocol-11.txt:..........58 101 C.14 Changes made to draft-ietf-ldapbis-protocol-12.txt:..........58 102 C.15 Changes made to draft-ietf-ldapbis-protocol-13.txt...........58 103 C.16 Changes made to draft-ietf-ldapbis-protocol-14.txt...........59 104 Appendix D - Outstanding Work Items...............................61 106 1. Introduction 107 Lightweight Directory Access Protocol Version 3 109 The Directory is "a collection of open systems cooperating to provide 110 directory services" [X.500]. A Directory user, which may be a human 111 or other entity, accesses the Directory through a client (or 112 Directory User Agent (DUA)). The client, on behalf of the directory 113 user, interacts with one or more servers (or Directory System Agents 114 (DSA)). Clients interact with servers using a directory access 115 protocol. 117 This document details the protocol elements of Lightweight Directory 118 Access Protocol, along with their semantics. Following the 119 description of protocol elements, it describes the way in which the 120 protocol is encoded and transferred. 122 This document is an integral part of the LDAP Technical Specification 123 [Roadmap]. 125 This document replaces RFC 2251. Appendix C holds a detailed log of 126 changes to RFC 2251. Prior to Working Group Last Call, this appendix 127 will be distilled to a summary of changes to RFC 2251. 129 2. Conventions 131 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 132 "SHOULD", "SHOULD NOT", "RECOMMENDED", and "MAY" in this document are 133 to be interpreted as described in [RFC2119]. 134 The terms "connection" and "LDAP connection" both refer to the 135 underlying transport protocol connection between two protocol peers. 136 The term "TLS connection" refers to a TLS-protected LDAP connection. 137 The terms "association" and "LDAP association" both refer to the 138 association of the LDAP connection and its current authentication and 139 authorization state. 141 3. Protocol Model 143 The general model adopted by this protocol is one of clients 144 performing protocol operations against servers. In this model, a 145 client transmits a protocol request describing the operation to be 146 performed to a server. The server is then responsible for performing 147 the necessary operation(s) in the directory. Upon completion of the 148 operation(s), the server returns a response containing any results or 149 errors to the requesting client. 151 Note that although servers are required to return responses whenever 152 such responses are defined in the protocol, there is no requirement 153 for synchronous behavior on the part of either clients or servers. 154 Requests and responses for multiple operations may be exchanged 155 between a client and server in any order, provided the client 156 eventually receives a response for every request that requires one. 158 Note that the core protocol operations defined in this document can 159 be mapped to a subset of the X.500(1997) directory abstract service. 161 Lightweight Directory Access Protocol Version 3 163 However there is not a one-to-one mapping between LDAP protocol 164 operations and DAP operations. Server implementations acting as a 165 gateway to X.500 directories may need to make multiple DAP requests. 167 4. Elements of Protocol 169 The LDAP protocol is described using Abstract Syntax Notation 1 170 (ASN.1) [X.680], and is transferred using a subset of ASN.1 Basic 171 Encoding Rules [X.690]. Section 5.1 specifies how the protocol is 172 encoded and transferred. 174 In order to support future Standards Track extensions to this 175 protocol, extensibility is implied where it is allowed (per ASN.1). 176 In addition, ellipses (...) have been supplied in ASN.1 types that 177 are explicitly extensible as discussed in [LDAPIANA]. Because of the 178 implied extensibility, clients and servers MUST ignore trailing 179 SEQUENCE elements whose tags they do not recognize. 181 Changes to the LDAP protocol other than through the extension 182 mechanisms described here require a different version number. A 183 client indicates the version it is using as part of the bind request, 184 described in section 4.2. If a client has not sent a bind, the server 185 MUST assume the client is using version 3 or later. 187 Clients may determine the protocol versions a server supports by 188 reading the supportedLDAPVersion attribute from the root DSE 189 [Models]. Servers which implement version 3 or later MUST provide 190 this attribute. 192 4.1. Common Elements 194 This section describes the LDAPMessage envelope PDU (Protocol Data 195 Unit) format, as well as data type definitions, which are used in the 196 protocol operations. 198 4.1.1. Message Envelope 200 For the purposes of protocol exchanges, all protocol operations are 201 encapsulated in a common envelope, the LDAPMessage, which is defined 202 as follows: 204 LDAPMessage ::= SEQUENCE { 205 messageID MessageID, 206 protocolOp CHOICE { 207 bindRequest BindRequest, 208 bindResponse BindResponse, 209 unbindRequest UnbindRequest, 210 searchRequest SearchRequest, 211 searchResEntry SearchResultEntry, 212 searchResDone SearchResultDone, 213 searchResRef SearchResultReference, 214 Lightweight Directory Access Protocol Version 3 216 modifyRequest ModifyRequest, 217 modifyResponse ModifyResponse, 218 addRequest AddRequest, 219 addResponse AddResponse, 220 delRequest DelRequest, 221 delResponse DelResponse, 222 modDNRequest ModifyDNRequest, 223 modDNResponse ModifyDNResponse, 224 compareRequest CompareRequest, 225 compareResponse CompareResponse, 226 abandonRequest AbandonRequest, 227 extendedReq ExtendedRequest, 228 extendedResp ExtendedResponse, 229 ... }, 230 controls [0] Controls OPTIONAL } 232 MessageID ::= INTEGER (0 .. maxInt) 234 maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- 236 The function of the LDAPMessage is to provide an envelope containing 237 common fields required in all protocol exchanges. At this time the 238 only common fields are the message ID and the controls. 240 If the server receives a PDU from the client in which the LDAPMessage 241 SEQUENCE tag cannot be recognized, the messageID cannot be parsed, 242 the tag of the protocolOp is not recognized as a request, or the 243 encoding structures or lengths of data fields are found to be 244 incorrect, then the server MAY return the Notice of Disconnection 245 described in section 4.4.1, with resultCode protocolError, and MUST 246 immediately close the connection. 248 In other cases where the client or server cannot parse a PDU, it 249 SHOULD abruptly close the connection where further communication 250 (including providing notice) would be pernicious. Otherwise, server 251 implementations MUST return an appropriate response to the request, 252 with the resultCode set to protocolError. 254 The ASN.1 type Controls is defined in section 4.1.11. 256 4.1.1.1. Message ID 258 All LDAPMessage envelopes encapsulating responses contain the 259 messageID value of the corresponding request LDAPMessage. 261 The message ID of a request MUST have a non-zero value different from 262 the values of any other requests outstanding in the LDAP association 263 of which this message is a part. The zero value is reserved for the 264 unsolicited notification message. 266 Typical clients increment a counter for each request. 268 Lightweight Directory Access Protocol Version 3 270 A client MUST NOT send a request with the same message ID as an 271 earlier request on the same LDAP association unless it can be 272 determined that the server is no longer servicing the earlier 273 request. Otherwise the behavior is undefined. For operations that do 274 not return responses (unbind, abandon, and abandoned operations), the 275 client SHOULD assume the operation is in progress until a subsequent 276 bind request completes. 278 4.1.2. String Types 280 The LDAPString is a notational convenience to indicate that, although 281 strings of LDAPString type encode as OCTET STRING types, the 282 [ISO10646] character set (a superset of [Unicode]) is used, encoded 283 following the UTF-8 algorithm [RFC2279]. Note that in the UTF-8 284 algorithm characters which are the same as ASCII (0x0000 through 285 0x007F) are represented as that same ASCII character in a single 286 byte. The other byte values are used to form a variable-length 287 encoding of an arbitrary character. 289 LDAPString ::= OCTET STRING -- UTF-8 encoded, 290 -- ISO 10646 characters 292 The LDAPOID is a notational convenience to indicate that the 293 permitted value of this string is a (UTF-8 encoded) dotted-decimal 294 representation of an OBJECT IDENTIFIER. Although an LDAPOID is 295 encoded as an OCTET STRING, values are limited to the definition of 296 numericoid given in Section 1.3 of [Models]. 298 LDAPOID ::= OCTET STRING -- Constrained to numericoid [Models] 300 For example, 302 1.3.6.1.4.1.1466.1.2.3 304 4.1.3. Distinguished Name and Relative Distinguished Name 306 An LDAPDN and a RelativeLDAPDN are respectively defined to be the 307 representation of a distinguished-name and a relative-distinguished- 308 name after encoding according to the specification in [LDAPDN]. 310 LDAPDN ::= LDAPString 311 -- Constrained to distinguishedName [LDAPDN] 313 RelativeLDAPDN ::= LDAPString 314 -- Constrained to name-component [LDAPDN] 316 4.1.4. Attribute Descriptions 318 The definition and encoding rules for attribute descriptions are 319 defined in Section 2.5 of [Models]. Briefly, an attribute description 320 is an attribute type and zero or more options. 322 Lightweight Directory Access Protocol Version 3 324 AttributeDescription ::= LDAPString 325 -- Constrained to attributedescription 326 -- [Models] 328 An AttributeDescriptionList describes a list of 0 or more attribute 329 descriptions. (A list of zero elements has special significance in 330 the Search request.) 332 AttributeDescriptionList ::= SEQUENCE OF 333 AttributeDescription 335 4.1.5. Attribute Value 337 A field of type AttributeValue is an OCTET STRING containing an 338 encoded attribute value data type. The value is encoded according to 339 its LDAP-specific encoding definition. The LDAP-specific encoding 340 definitions for different syntaxes and attribute types may be found 341 in other documents and in particular [Syntaxes]. 343 AttributeValue ::= OCTET STRING 345 Note that there is no defined limit on the size of this encoding; 346 thus protocol values may include multi-megabyte attributes (e.g. 347 photographs). 349 Attributes may be defined which have arbitrary and non-printable 350 syntax. Implementations MUST NOT display nor attempt to decode as 351 ASN.1, a value if its syntax is not known. The implementation may 352 attempt to discover the subschema of the source entry, and retrieve 353 the values of attributeTypes from it. 355 Clients MUST NOT send attribute values in a request that are not 356 valid according to the syntax defined for the attributes. 358 4.1.6. Attribute Value Assertion 360 The AttributeValueAssertion type definition is similar to the one in 361 the X.500 directory standards. It contains an attribute description 362 and a matching rule assertion value suitable for that type. 364 AttributeValueAssertion ::= SEQUENCE { 365 attributeDesc AttributeDescription, 366 assertionValue AssertionValue } 368 AssertionValue ::= OCTET STRING 370 The syntax of the AssertionValue depends on the context of the LDAP 371 operation being performed. For example, the syntax of the EQUALITY 372 matching rule for an attribute is used when performing a Compare 373 operation. Often this is the same syntax used for values of the 374 attribute type, but in some cases the assertion syntax differs from 375 Lightweight Directory Access Protocol Version 3 377 the value syntax. See objectIdentiferFirstComponentMatch in 378 [Syntaxes] for an example. 380 4.1.7. Attribute 382 An attribute consists of an attribute description and one or more 383 values of that attribute description. (Though attributes MUST have at 384 least one value when stored, due to access control restrictions the 385 set may be empty when transferred from the server to the client. This 386 is described in section 4.5.2, concerning the PartialAttributeList 387 type.) 389 Attribute ::= SEQUENCE { 390 type AttributeDescription, 391 vals SET OF AttributeValue } 393 Each attribute value is distinct in the set (no duplicates). The set 394 of attribute values is unordered. Implementations MUST NOT reply upon 395 any apparent ordering being repeatable. 397 4.1.8. Matching Rule Identifier 399 Matching rules are defined in 4.1.3 of [Models]. A matching rule is 400 identified in the LDAP protocol by the printable representation of 401 either its numericoid, or one of its short name descriptors, e.g. 402 "caseIgnoreIA5Match" or "1.3.6.1.4.1.453.33.33". 404 MatchingRuleId ::= LDAPString 406 Servers which support matching rules for use in the extensibleMatch 407 search filter MUST list the matching rules they implement in 408 subschema entries, using the matchingRules attributes. The server 409 SHOULD also list there, using the matchingRuleUse attribute, the 410 attribute types with which each matching rule can be used. More 411 information is given in section 4.5 of [Syntaxes]. 413 4.1.9. Result Message 415 The LDAPResult is the construct used in this protocol to return 416 success or failure indications from servers to clients. To various 417 requests, servers will return responses of LDAPResult or responses 418 containing the components of LDAPResult to indicate the final status 419 of a protocol operation request. 421 LDAPResult ::= SEQUENCE { 422 resultCode ENUMERATED { 423 success (0), 424 operationsError (1), 425 protocolError (2), 426 timeLimitExceeded (3), 427 sizeLimitExceeded (4), 428 Lightweight Directory Access Protocol Version 3 430 compareFalse (5), 431 compareTrue (6), 432 authMethodNotSupported (7), 433 strongAuthRequired (8), 434 -- 9 reserved -- 435 referral (10), 436 adminLimitExceeded (11), 437 unavailableCriticalExtension (12), 438 confidentialityRequired (13), 439 saslBindInProgress (14), 440 noSuchAttribute (16), 441 undefinedAttributeType (17), 442 inappropriateMatching (18), 443 constraintViolation (19), 444 attributeOrValueExists (20), 445 invalidAttributeSyntax (21), 446 -- 22-31 unused -- 447 noSuchObject (32), 448 aliasProblem (33), 449 invalidDNSyntax (34), 450 -- 35 reserved for undefined isLeaf -- 451 aliasDereferencingProblem (36), 452 -- 37-47 unused -- 453 inappropriateAuthentication (48), 454 invalidCredentials (49), 455 insufficientAccessRights (50), 456 busy (51), 457 unavailable (52), 458 unwillingToPerform (53), 459 loopDetect (54), 460 -- 55-63 unused -- 461 namingViolation (64), 462 objectClassViolation (65), 463 notAllowedOnNonLeaf (66), 464 notAllowedOnRDN (67), 465 entryAlreadyExists (68), 466 objectClassModsProhibited (69), 467 -- 70 reserved for CLDAP -- 468 affectsMultipleDSAs (71), 469 -- 72-79 unused -- 470 other (80), 471 ... }, 472 -- 81-90 reserved for APIs -- 473 matchedDN LDAPDN, 474 diagnosticMessage LDAPString, 475 referral [3] Referral OPTIONAL } 477 The resultCode enumeration is extensible as defined in Section 3.5 of 478 [LDAPIANA]. The meanings of the result codes are given in Appendix A. 479 If a server detects multiple errors for an operation, only one 480 resultCode is returned. The server should return the resultCode that 481 best indicates the nature of the error encountered. 483 Lightweight Directory Access Protocol Version 3 485 The diagnosticMessage field of this construct may, at the server's 486 option, be used to return a string containing a textual, human- 487 readable (terminal control and page formatting characters should be 488 avoided) diagnostic message. As this diagnostic message is not 489 standardized, implementations MUST NOT rely on the values returned. 490 If the server chooses not to return a textual diagnostic, the 491 diagnosticMessage field of the LDAPResult type MUST contain a zero 492 length string. 494 For certain result codes (typically, but not restricted to 495 noSuchObject, aliasProblem, invalidDNSyntax and 496 aliasDereferencingProblem), the matchedDN field is set to the name of 497 the lowest entry (object or alias) in the directory that was matched. 498 If no aliases were dereferenced while attempting to locate the entry, 499 this will be a truncated form of the name provided, or if aliases 500 were dereferenced, of the resulting name, as defined in section 12.5 501 of [X.511]. The matchedDN field contains a zero length string with 502 all other result codes. 504 4.1.10. Referral 506 The referral result code indicates that the contacted server does not 507 hold the target entry of the request. The referral field is present 508 in an LDAPResult if the LDAPResult.resultCode field value is 509 referral, and absent with all other result codes. It contains one or 510 more references to one or more servers or services that may be 511 accessed via LDAP or other protocols. Referrals can be returned in 512 response to any operation request (except unbind and abandon which do 513 not have responses). At least one URL MUST be present in the 514 Referral. 516 During a search operation, after the baseObject is located, and 517 entries are being evaluated, the referral is not returned. Instead, 518 continuation references, described in section 4.5.3, are returned 519 when the search scope spans multiple naming contexts, and several 520 different servers would need to be contacted to complete the 521 operation. 523 Referral ::= SEQUENCE OF LDAPURL -- one or more 525 LDAPURL ::= LDAPString -- limited to characters permitted in 526 -- URLs 528 If the client wishes to progress the operation, it MUST follow the 529 referral by contacting one of the servers. If multiple URLs are 530 present, the client assumes that any URL may be used to progress the 531 operation. 533 URLs for servers implementing the LDAP protocol are written according 534 to [LDAPURL]. If an alias was dereferenced, the part of the URL 535 MUST be present, with the new target object name. If the part is 536 present, the client MUST use this name in its next request to 537 progress the operation, and if it is not present the client will use 538 Lightweight Directory Access Protocol Version 3 540 the same name as in the original request. Some servers (e.g. 541 participating in distributed indexing) may provide a different filter 542 in a referral for a search operation. If the filter part of the URL 543 is present in an LDAPURL, the client MUST use this filter in its next 544 request to progress this search, and if it is not present the client 545 MUST use the same filter as it used for that search. Other aspects of 546 the new request may be the same or different as the request which 547 generated the referral. 549 Note that UTF-8 characters appearing in a DN or search filter may not 550 be legal for URLs (e.g. spaces) and MUST be escaped using the % 551 method in [RFC2396]. 553 Other kinds of URLs may be returned, so long as the operation could 554 be performed using that protocol. 556 4.1.11. Controls 558 A control is a way to specify extension information for an LDAP 559 message. A control only alters the semantics of the message it is 560 attached to. 562 Controls ::= SEQUENCE OF Control 564 Control ::= SEQUENCE { 565 controlType LDAPOID, 566 criticality BOOLEAN DEFAULT FALSE, 567 controlValue OCTET STRING OPTIONAL } 569 The controlType field MUST be a UTF-8 encoded dotted-decimal 570 representation of an OBJECT IDENTIFIER which uniquely identifies the 571 control. This prevents conflicts between control names. 573 The criticality field is either TRUE or FALSE and only applies to 574 request messages that have a corresponding response message. For all 575 other messages (such as abandonRequest, unbindRequest and all 576 response messages), the criticality field is treated as FALSE. 578 If the server recognizes the control type and it is appropriate for 579 the operation, the server will make use of the control when 580 performing the operation. 582 If the server does not recognize the control type or it is not 583 appropriate for the operation, and the criticality field is TRUE, the 584 server MUST NOT perform the operation, and MUST instead return the 585 resultCode unavailableCriticalExtension. 587 If the control is unrecognized or inappropriate but the criticality 588 field is FALSE, the server MUST ignore the control. 590 The controlValue contains any information associated with the 591 control. Its format is defined by the specification of the control. 592 Implementations MUST be prepared to handle arbitrary contents of the 593 Lightweight Directory Access Protocol Version 3 595 controlValue octet string, including zero bytes. It is absent only if 596 there is no value information which is associated with a control of 597 its type. controlValues that are defined in terms of ASN.1 and BER 598 encoded according to Section 5.1, also follow the extensibility rules 599 in Section 4. 601 This document does not specify any controls. Controls may be 602 specified in other documents. The specification of a control consists 603 of: 605 - the OBJECT IDENTIFIER assigned to the control, 607 - whether the control is always noncritical, always critical, or 608 critical at the client's option, 610 - the format of the controlValue contents of the control, 612 - the semantics of the control, 614 - and optionally, semantics regarding the combination of the control 615 with other controls. 617 Servers list the controlType of all request controls they recognize 618 in the supportedControl attribute [Models] in the root DSE. 620 Controls should not be combined unless the semantics of the 621 combination has been specified. The semantics of control 622 combinations, if specified, are generally found in the control 623 specification most recently published. In the absence of combination 624 semantics, the behavior of the operation is undefined. 625 Additionally, the order of a combination of controls in the SEQUENCE 626 is ignored unless the control specification(s) describe(s) 627 combination semantics. 629 4.2. Bind Operation 631 The function of the Bind Operation is to allow authentication 632 information to be exchanged between the client and server. Prior to 633 the first BindRequest, the implied identity is anonymous. Refer to 634 [AuthMeth] for the authentication-related semantics of this 635 operation. 637 The Bind Request is defined as follows: 639 BindRequest ::= [APPLICATION 0] SEQUENCE { 640 version INTEGER (1 .. 127), 641 name LDAPDN, 642 authentication AuthenticationChoice } 644 AuthenticationChoice ::= CHOICE { 645 simple [0] OCTET STRING, 646 -- 1 and 2 reserved 647 sasl [3] SaslCredentials, 648 Lightweight Directory Access Protocol Version 3 650 ... } 652 SaslCredentials ::= SEQUENCE { 653 mechanism LDAPString, 654 credentials OCTET STRING OPTIONAL } 656 Parameters of the Bind Request are: 658 - version: A version number indicating the version of the protocol 659 to be used in this protocol association. This document describes 660 version 3 of the LDAP protocol. Note that there is no version 661 negotiation, and the client just sets this parameter to the 662 version it desires. If the server does not support the specified 663 version, it MUST respond with protocolError in the resultCode 664 field of the BindResponse. 666 - name: The name of the directory object that the client wishes to 667 bind as. This field may take on a null value (a zero length 668 string) for the purposes of anonymous binds ([AuthMeth] section 7) 669 or when using SASL authentication ([AuthMeth] section 4.3). Server 670 behavior is undefined when the name is a null value, simple 671 authentication is used, and a password is specified. The server 672 SHOULD NOT perform any alias dereferencing in determining the 673 object to bind as. 675 - authentication: information used to authenticate the name, if any, 676 provided in the Bind Request. This type is extensible as defined 677 in Section 3.6 of [LDAPIANA]. Servers that do not support a choice 678 supplied by a client will return authMethodNotSupported in the 679 result code of the BindResponse. The simple form of an 680 AuthenticationChoice specifies a simple password to be used for 681 authentication. To improve matching, applications SHOULD prepare 682 textual strings used as passwords. Applications which prepare 683 textural strings used as password are REQUIRED to prepare them by 684 transcoding the string to [Unicode], apply [SASLprep], and encode 685 as UTF-8. 687 Authorization is the use of this authentication information when 688 performing operations. Authorization MAY be affected by factors 689 outside of the LDAP Bind Request, such as lower layer security 690 services. 692 4.2.1. Processing of the Bind Request 694 Upon receipt of a BindRequest, the server MUST ensure there are no 695 outstanding operations in progress on the connection (this simplifies 696 server implementation). To do this, the server may cause them to be 697 abandoned or allow them to finish. The server then proceeds to 698 authenticate the client in either a single-step, or multi-step bind 699 process. Each step requires the server to return a BindResponse to 700 indicate the status of authentication. 702 Lightweight Directory Access Protocol Version 3 704 If the client did not bind before sending a request and receives an 705 operationsError, it may then send a Bind Request. If this also fails 706 or the client chooses not to bind on the existing connection, it may 707 close the connection, reopen it and begin again by first sending a 708 PDU with a Bind Request. This will aid in interoperating with servers 709 implementing other versions of LDAP. 711 Clients MAY send multiple Bind Requests on a connection to change 712 their credentials. Authentication from earlier binds is subsequently 713 ignored. A failed or abandoned Bind Operation has the effect of 714 leaving the LDAP association in an anonymous state. To arrive at a 715 known authentication state after abandoning a bind operation, clients 716 may unbind, rebind, or make use of the BindResponse. 718 For some SASL authentication mechanisms, it may be necessary for the 719 client to invoke the BindRequest multiple times. This is indicated by 720 the server sending a BindResponse with the resultCode set to 721 saslBindInProgress. This indicates that the server requires the 722 client to send a new bind request, with the same sasl mechanism, to 723 continue the authentication process. If at any stage the client 724 wishes to abort the bind process it MAY unbind and then drop the 725 underlying connection. Clients MUST NOT invoke operations between two 726 Bind Requests made as part of a multi-stage bind. 728 A client may abort a SASL bind negotiation by sending a BindRequest 729 with a different value in the mechanism field of SaslCredentials, or 730 an AuthenticationChoice other than sasl. 732 If the client sends a BindRequest with the sasl mechanism field as an 733 empty string, the server MUST return a BindResponse with 734 authMethodNotSupported as the resultCode. This will allow clients to 735 abort a negotiation if it wishes to try again with the same SASL 736 mechanism. 738 4.2.2. Bind Response 740 The Bind Response is defined as follows. 742 BindResponse ::= [APPLICATION 1] SEQUENCE { 743 COMPONENTS OF LDAPResult, 744 serverSaslCreds [7] OCTET STRING OPTIONAL } 746 BindResponse consists simply of an indication from the server of the 747 status of the client's request for authentication. 749 A successful bind operation is indicated by a BindResponse with a 750 resultCode set to success (0). Otherwise, an appropriate resultCode 751 is set in the BindResponse. For bind, the protocolError (2) 752 resultCode may be used to indicate that the version number supplied 753 by the client is unsupported. 755 If the client receives a BindResponse response where the resultCode 756 was protocolError, it MUST close the connection as the server will be 757 Lightweight Directory Access Protocol Version 3 759 unwilling to accept further operations. (This is for compatibility 760 with earlier versions of LDAP, in which the bind was always the first 761 operation, and there was no negotiation.) 763 The serverSaslCreds are used as part of a SASL-defined bind mechanism 764 to allow the client to authenticate the server to which it is 765 communicating, or to perform "challenge-response" authentication. If 766 the client bound with the simple choice, or the SASL mechanism does 767 not require the server to return information to the client, then this 768 field is not to be included in the result. 770 4.3. Unbind Operation 772 The function of the Unbind Operation is to terminate an LDAP 773 association and connection. The Unbind Operation is defined as 774 follows: 776 UnbindRequest ::= [APPLICATION 2] NULL 778 The Unbind Operation has no response defined. Upon transmission of an 779 UnbindRequest, a protocol client MUST assume that the LDAP 780 association is terminated. Upon receipt of an UnbindRequest, a 781 protocol server MUST assume that the requesting client has terminated 782 the association and that all outstanding requests may be discarded, 783 and MUST close the connection. 785 4.4. Unsolicited Notification 787 An unsolicited notification is an LDAPMessage sent from the server to 788 the client which is not in response to any LDAPMessage received by 789 the server. It is used to signal an extraordinary condition in the 790 server or in the connection between the client and the server. The 791 notification is of an advisory nature, and the server will not expect 792 any response to be returned from the client. 794 The unsolicited notification is structured as an LDAPMessage in which 795 the messageID is 0 and protocolOp is of the extendedResp form. The 796 responseName field of the ExtendedResponse is present. The LDAPOID 797 value MUST be unique for this notification, and not be used in any 798 other situation. 800 One unsolicited notification (Notice of Disconnection) is defined in 801 this document. 803 4.4.1. Notice of Disconnection 805 This notification may be used by the server to advise the client that 806 the server is about to close the connection due to an error 807 condition. Note that this notification is NOT a response to an unbind 808 requested by the client: the server MUST follow the procedures of 809 section 4.3. This notification is intended to assist clients in 810 Lightweight Directory Access Protocol Version 3 812 distinguishing between an error condition and a transient network 813 failure. As with a connection close due to network failure, the 814 client MUST NOT assume that any outstanding requests which modified 815 the directory have succeeded or failed. 817 The responseName is 1.3.6.1.4.1.1466.20036, the response field is 818 absent, and the resultCode is used to indicate the reason for the 819 disconnection. 821 The following resultCode values have these meanings when used in this 822 notification: 824 - protocolError: The server has received data from the client in 825 which the LDAPMessage structure could not be parsed. 827 - strongAuthRequired: The server has detected that an establish 828 security association between the client and server has 829 unexpectedly failed or been compromised, or that the server now 830 requires the client to authenticate using a strong(er) mechanism. 832 - unavailable: This server will stop accepting new connections and 833 operations on all existing connections, and be unavailable for an 834 extended period of time. The client may make use of an alternative 835 server. 837 After sending this notice, the server MUST close the connection. 838 After receiving this notice, the client MUST NOT transmit any further 839 on the connection, and may abruptly close the connection. 841 4.5. Search Operation 843 The Search Operation allows a client to request that a search be 844 performed on its behalf by a server. This can be used to read 845 attributes from a single entry, from entries immediately below a 846 particular entry, or a whole subtree of entries. 848 4.5.1. Search Request 850 The Search Request is defined as follows: 852 SearchRequest ::= [APPLICATION 3] SEQUENCE { 853 baseObject LDAPDN, 854 scope ENUMERATED { 855 baseObject (0), 856 singleLevel (1), 857 wholeSubtree (2) }, 858 derefAliases ENUMERATED { 859 neverDerefAliases (0), 860 derefInSearching (1), 861 derefFindingBaseObj (2), 862 derefAlways (3) }, 863 sizeLimit INTEGER (0 .. maxInt), 864 Lightweight Directory Access Protocol Version 3 866 timeLimit INTEGER (0 .. maxInt), 867 typesOnly BOOLEAN, 868 filter Filter, 869 attributes AttributeDescriptionList } 871 Filter ::= CHOICE { 872 and [0] SET SIZE (1..MAX) OF Filter, 873 or [1] SET SIZE (1..MAX) OF Filter, 874 not [2] Filter, 875 equalityMatch [3] AttributeValueAssertion, 876 substrings [4] SubstringFilter, 877 greaterOrEqual [5] AttributeValueAssertion, 878 lessOrEqual [6] AttributeValueAssertion, 879 present [7] AttributeDescription, 880 approxMatch [8] AttributeValueAssertion, 881 extensibleMatch [9] MatchingRuleAssertion } 883 SubstringFilter ::= SEQUENCE { 884 type AttributeDescription, 885 -- at least one must be present, 886 -- initial and final can occur at most once 887 substrings SEQUENCE OF CHOICE { 888 initial [0] AssertionValue, 889 any [1] AssertionValue, 890 final [2] AssertionValue } } 892 MatchingRuleAssertion ::= SEQUENCE { 893 matchingRule [1] MatchingRuleId OPTIONAL, 894 type [2] AttributeDescription OPTIONAL, 895 matchValue [3] AssertionValue, 896 dnAttributes [4] BOOLEAN DEFAULT FALSE } 898 Parameters of the Search Request are: 900 - baseObject: An LDAPDN that is the base object entry relative to 901 which the search is to be performed. 903 - scope: An indicator of the scope of the search to be performed. 904 The semantics of the possible values of this field are identical 905 to the semantics of the scope field in the X.511 Search Operation. 907 - derefAliases: An indicator as to how alias objects (as defined in 908 [X.501]) are to be handled in searching. The semantics of the 909 possible values of this field are: 911 neverDerefAliases: Do not dereference aliases in searching 912 or in locating the base object of the search. 914 derefInSearching: While searching, dereference any alias 915 object subordinate to the base object which is also in the 916 search scope. The filter is applied to the dereferenced 917 object(s). If the search scope is wholeSubtree, the search 918 continues in the subtree of any dereferenced object. 919 Aliases in that subtree are also dereferenced. Servers 920 Lightweight Directory Access Protocol Version 3 922 SHOULD detect looping in this process to prevent denial of 923 service attacks and duplicate entries. 925 derefFindingBaseObj: Dereference aliases in locating the 926 base object of the search, but not when searching 927 subordinates of the base object. 929 derefAlways: Dereference aliases both in searching and in 930 locating the base object of the search. 932 - sizeLimit: A size limit that restricts the maximum number of 933 entries to be returned as a result of the search. A value of 0 in 934 this field indicates that no client-requested size limit 935 restrictions are in effect for the search. Servers may enforce a 936 maximum number of entries to return. 938 - timeLimit: A time limit that restricts the maximum time (in 939 seconds) allowed for a search. A value of 0 in this field 940 indicates that no client-requested time limit restrictions are in 941 effect for the search. 943 - typesOnly: An indicator as to whether search results will contain 944 both attribute descriptions and values, or just attribute 945 descriptions. Setting this field to TRUE causes only attribute 946 descriptions (no values) to be returned. Setting this field to 947 FALSE causes both attribute descriptions and values to be 948 returned. 950 - filter: A filter that defines the conditions that must be 951 fulfilled in order for the search to match a given entry. 953 The 'and', 'or' and 'not' choices can be used to form combinations 954 of filters. At least one filter element MUST be present in an 955 'and' or 'or' choice. The others match against individual 956 attribute values of entries in the scope of the search. 957 (Implementor's note: the 'not' filter is an example of a tagged 958 choice in an implicitly-tagged module. In BER this is treated as 959 if the tag was explicit.) 961 A server MUST evaluate filters according to the three-valued logic 962 of X.511 (1993) section 7.8.1. In summary, a filter is evaluated 963 to either "TRUE", "FALSE" or "Undefined". If the filter evaluates 964 to TRUE for a particular entry, then the attributes of that entry 965 are returned as part of the search result (subject to any 966 applicable access control restrictions). If the filter evaluates 967 to FALSE or Undefined, then the entry is ignored for the search. 969 A filter of the "and" choice is TRUE if all the filters in the SET 970 OF evaluate to TRUE, FALSE if at least one filter is FALSE, and 971 otherwise Undefined. A filter of the "or" choice is FALSE if all 972 of the filters in the SET OF evaluate to FALSE, TRUE if at least 973 one filter is TRUE, and Undefined otherwise. A filter of the "not" 974 choice is TRUE if the filter being negated is FALSE, FALSE if it 975 is TRUE, and Undefined if it is Undefined. 977 Lightweight Directory Access Protocol Version 3 979 The present match evaluates to TRUE where there is an attribute or 980 subtype of the specified attribute description present in an 981 entry, and FALSE otherwise (including a presence test with an 982 unrecognized attribute description.) 984 The matching rule for equalityMatch filter items is defined by the 985 EQUALITY matching rule for the attribute type. 987 The matching rule for AssertionValues in a substrings filter item 988 is defined by the SUBSTR matching rule for the attribute type. 990 The matching rule for greaterOrEqual and lessOrEqual filter items 991 is defined by the ORDERING matching rule for the attribute type. 993 The matching semantics for approxMatch filter items is 994 implementation-defined. If approximate matching is not supported 995 by the server, the filter item should be treated as an 996 equalityMatch. 998 The extensibleMatch is new in this version of LDAP. If the 999 matchingRule field is absent, the type field MUST be present, and 1000 the equality match is performed for that type. If the type field 1001 is absent and matchingRule is present, the matchValue is compared 1002 against all attributes in an entry which support that 1003 matchingRule, and the matchingRule determines the syntax for the 1004 assertion value (the filter item evaluates to TRUE if it matches 1005 with at least one attribute in the entry, FALSE if it does not 1006 match any attribute in the entry, and Undefined if the 1007 matchingRule is not recognized or the assertionValue cannot be 1008 parsed.) If the type field is present and matchingRule is present, 1009 the matchingRule MUST be one permitted for use with that type, 1010 otherwise the filter item is undefined. If the dnAttributes field 1011 is set to TRUE, the match is applied against all the 1012 AttributeValueAssertions in an entry's distinguished name as well, 1013 and also evaluates to TRUE if there is at least one attribute in 1014 the distinguished name for which the filter item evaluates to 1015 TRUE. (Editors note: The dnAttributes field is present so that 1016 there does not need to be multiple versions of generic matching 1017 rules such as for word matching, one to apply to entries and 1018 another to apply to entries and dn attributes as well). 1020 A filter item evaluates to Undefined when the server would not be 1021 able to determine whether the assertion value matches an entry. If 1022 an attribute description in an equalityMatch, substrings, 1023 greaterOrEqual, lessOrEqual, approxMatch or extensibleMatch filter 1024 is not recognized by the server, a matching rule id in the 1025 extensibleMatch is not recognized by the server, the assertion 1026 value cannot be parsed, or the type of filtering requested is not 1027 implemented, then the filter is Undefined. Thus for example if a 1028 server did not recognize the attribute type shoeSize, a filter of 1029 (shoeSize=*) would evaluate to FALSE, and the filters 1030 (shoeSize=12), (shoeSize>=12) and (shoeSize<=12) would evaluate to 1031 Undefined. 1033 Lightweight Directory Access Protocol Version 3 1035 Servers MUST NOT return errors if attribute descriptions or 1036 matching rule ids are not recognized, or assertion values cannot 1037 be parsed. More details of filter processing are given in section 1038 7.8 of [X.511]. 1040 - attributes: A list of the attributes to be returned from each 1041 entry which matches the search filter. There are two special 1042 values which may be used: an empty list with no attributes, and 1043 the attribute description string "*". Both of these signify that 1044 all user attributes are to be returned. (The "*" allows the client 1045 to request all user attributes in addition to any specified 1046 operational attributes). 1048 Attributes MUST be named at most once in the list, and are 1049 returned at most once in an entry. If there are attribute 1050 descriptions in the list which are not recognized, they are 1051 ignored by the server. 1053 If the client does not want any attributes returned, it can 1054 specify a list containing only the attribute with OID "1.1". This 1055 OID was chosen arbitrarily and does not correspond to any 1056 attribute in use. 1058 Client implementors should note that even if all user attributes 1059 are requested, some attributes of the entry may not be included in 1060 search results due to access controls or other restrictions. 1061 Furthermore, servers will not return operational attributes, such 1062 as objectClasses or attributeTypes, unless they are listed by 1063 name, since there may be extremely large number of values for 1064 certain operational attributes. (A list of operational attributes 1065 for use in LDAP is given in [Syntaxes].) 1067 Note that an X.500 "list"-like operation can be emulated by the 1068 client requesting a one-level LDAP search operation with a filter 1069 checking for the presence of the objectClass attribute, and that an 1070 X.500 "read"-like operation can be emulated by a base object LDAP 1071 search operation with the same filter. A server which provides a 1072 gateway to X.500 is not required to use the Read or List operations, 1073 although it may choose to do so, and if it does, it must provide the 1074 same semantics as the X.500 search operation. 1076 4.5.2. Search Result 1078 The results of the search attempted by the server upon receipt of a 1079 Search Request are returned in Search Responses, which are LDAP 1080 messages containing either SearchResultEntry, SearchResultReference, 1081 or SearchResultDone data types. 1083 SearchResultEntry ::= [APPLICATION 4] SEQUENCE { 1084 objectName LDAPDN, 1085 attributes PartialAttributeList } 1086 Lightweight Directory Access Protocol Version 3 1088 PartialAttributeList ::= SEQUENCE OF SEQUENCE { 1089 type AttributeDescription, 1090 vals SET OF AttributeValue } 1091 -- implementors should note that the PartialAttributeList may 1092 -- have zero elements (if none of the attributes of that entry 1093 -- were requested, or could be returned), and that the vals set 1094 -- may also have zero elements (if types only was requested, or 1095 -- all values were excluded from the result.) 1097 SearchResultReference ::= [APPLICATION 19] SEQUENCE OF LDAPURL 1098 -- at least one LDAPURL element must be present 1100 SearchResultDone ::= [APPLICATION 5] LDAPResult 1102 Upon receipt of a Search Request, a server will perform the necessary 1103 search of the DIT. 1105 The server will return to the client a sequence of responses in 1106 separate LDAP messages. There may be zero or more responses 1107 containing SearchResultEntry, one for each entry found during the 1108 search. There may also be zero or more responses containing 1109 SearchResultReference, one for each area not explored by this server 1110 during the search. The SearchResultEntry and SearchResultReference 1111 PDUs may come in any order. Following all the SearchResultReference 1112 responses and all SearchResultEntry responses to be returned by the 1113 server, the server will return a response containing the 1114 SearchResultDone, which contains an indication of success, or 1115 detailing any errors that have occurred. 1117 Each entry returned in a SearchResultEntry will contain all 1118 appropriate attributes as specified in the attributes field of the 1119 Search Request. Return of attributes is subject to access control and 1120 other administrative policy. 1122 Some attributes may be constructed by the server and appear in a 1123 SearchResultEntry attribute list, although they are not stored 1124 attributes of an entry. Clients SHOULD NOT assume that all attributes 1125 can be modified, even if permitted by access control. 1127 If the server's schema defines a textual name for an attribute type, 1128 it SHOULD use a textual name for attributes of that attribute type by 1129 specifying one of the textual names as the value of the attribute 1130 type. Otherwise, the server uses the object identifier for the 1131 attribute type by specifying the object identifier, in ldapOID form, 1132 as the value of attribute type. If the server determines that 1133 returning a textual name will cause interoperability problems, it 1134 SHOULD return the ldapOID form of the attribute type. 1136 4.5.3. Continuation References in the Search Result 1138 If the server was able to locate the entry referred to by the 1139 baseObject but was unable to search all the entries in the scope at 1140 and under the baseObject, the server may return one or more 1141 Lightweight Directory Access Protocol Version 3 1143 SearchResultReference entries, each containing a reference to another 1144 set of servers for continuing the operation. A server MUST NOT return 1145 any SearchResultReference if it has not located the baseObject and 1146 thus has not searched any entries; in this case it would return a 1147 SearchResultDone containing a referral resultCode. 1149 If a server holds a copy or partial copy of the subordinate naming 1150 context, it may use the search filter to determine whether or not to 1151 return a SearchResultReference response. Otherwise 1152 SearchResultReference responses are always returned when in scope. 1154 The SearchResultReference is of the same data type as the Referral. 1155 URLs for servers implementing the LDAP protocol are written according 1156 to [LDAPURL]. The part MUST be present in the URL, with the new 1157 target object name. The client MUST use this name in its next 1158 request. Some servers (e.g. part of a distributed index exchange 1159 system) may provide a different filter in the URLs of the 1160 SearchResultReference. If the filter part of the URL is present in an 1161 LDAP URL, the client MUST use the new filter in its next request to 1162 progress the search, and if the filter part is absent the client will 1163 use again the same filter. If the originating search scope was 1164 singleLevel, the scope part of the URL will be baseObject. Other 1165 aspects of the new search request may be the same or different as the 1166 search which generated the continuation references. 1167 Other kinds of URLs may be returned so long as the operation could be 1168 performed using that protocol. 1170 The name of an unexplored subtree in a SearchResultReference need not 1171 be subordinate to the base object. 1173 In order to complete the search, the client MUST issue a new search 1174 operation for each SearchResultReference that is returned. Note that 1175 the abandon operation described in section 4.11 applies only to a 1176 particular operation sent on an association between a client and 1177 server, and if the client has multiple outstanding search operations, 1178 it MUST abandon each operation individually. 1180 4.5.3.1. Example 1182 For example, suppose the contacted server (hosta) holds the entry 1183 "DC=Example,DC=NET" and the entry "CN=Manager,DC=Example,DC=NET". It 1184 knows that either LDAP-capable servers (hostb) or (hostc) hold 1185 "OU=People,DC=Example,DC=NET" (one is the master and the other server 1186 a shadow), and that LDAP-capable server (hostd) holds the subtree 1187 "OU=Roles,DC=Example,DC=NET". If a subtree search of 1188 "DC=Example,DC=NET" is requested to the contacted server, it may 1189 return the following: 1191 SearchResultEntry for DC=Example,DC=NET 1192 SearchResultEntry for CN=Manager,DC=Example,DC=NET 1193 SearchResultReference { 1194 ldap://hostb/OU=People,DC=Example,DC=NET 1195 ldap://hostc/OU=People,DC=Example,DC=NET 1196 Lightweight Directory Access Protocol Version 3 1198 } 1199 SearchResultReference { 1200 ldap://hostd/OU=Roles,DC=Example,DC=NET 1201 } 1202 SearchResultDone (success) 1204 Client implementors should note that when following a 1205 SearchResultReference, additional SearchResultReference may be 1206 generated. Continuing the example, if the client contacted the server 1207 (hostb) and issued the search for the subtree 1208 "OU=People,DC=Example,DC=NET", the server might respond as follows: 1210 SearchResultEntry for OU=People,DC=Example,DC=NET 1211 SearchResultReference { 1212 ldap://hoste/OU=Managers,OU=People,DC=Example,DC=NET 1213 } 1214 SearchResultReference { 1215 ldap://hostf/OU=Consultants,OU=People,DC=Example,DC=NET 1216 } 1217 SearchResultDone (success) 1219 If the contacted server does not hold the base object for the search, 1220 then it will return a referral to the client. For example, if the 1221 client requests a subtree search of "DC=Example,DC=ORG" to hosta, the 1222 server may return only a SearchResultDone containing a referral. 1224 SearchResultDone (referral) { 1225 ldap://hostg/DC=Example,DC=ORG??sub 1226 } 1228 4.6. Modify Operation 1230 The Modify Operation allows a client to request that a modification 1231 of an entry be performed on its behalf by a server. The Modify 1232 Request is defined as follows: 1234 ModifyRequest ::= [APPLICATION 6] SEQUENCE { 1235 object LDAPDN, 1236 modification SEQUENCE OF SEQUENCE { 1237 operation ENUMERATED { 1238 add (0), 1239 delete (1), 1240 replace (2) }, 1241 modification AttributeTypeAndValues } } 1243 AttributeTypeAndValues ::= SEQUENCE { 1244 type AttributeDescription, 1245 vals SET OF AttributeValue } 1247 Parameters of the Modify Request are: 1249 - object: The object to be modified. The value of this field 1250 contains the DN of the entry to be modified. The server will not 1251 Lightweight Directory Access Protocol Version 3 1253 perform any alias dereferencing in determining the object to be 1254 modified. 1256 - modification: A list of modifications to be performed on the 1257 entry. The entire list of entry modifications MUST be performed in 1258 the order they are listed, as a single atomic operation. While 1259 individual modifications may violate the directory schema, the 1260 resulting entry after the entire list of modifications is 1261 performed MUST conform to the requirements of the directory 1262 schema. The values that may be taken on by the 'operation' field 1263 in each modification construct have the following semantics 1264 respectively: 1266 add: add values listed to the given attribute, creating the 1267 attribute if necessary; 1269 delete: delete values listed from the given attribute, 1270 removing the entire attribute if no values are listed, or 1271 if all current values of the attribute are listed for 1272 deletion; 1274 replace: replace all existing values of the given attribute 1275 with the new values listed, creating the attribute if it 1276 did not already exist. A replace with no value will delete 1277 the entire attribute if it exists, and is ignored if the 1278 attribute does not exist. 1280 The result of the modification attempted by the server upon receipt 1281 of a Modify Request is returned in a Modify Response, defined as 1282 follows: 1284 ModifyResponse ::= [APPLICATION 7] LDAPResult 1286 Upon receipt of a Modify Request, a server will perform the necessary 1287 modifications to the DIT. 1289 The server will return to the client a single Modify Response 1290 indicating either the successful completion of the DIT modification, 1291 or the reason that the modification failed. Note that due to the 1292 requirement for atomicity in applying the list of modifications in 1293 the Modify Request, the client may expect that no modifications of 1294 the DIT have been performed if the Modify Response received indicates 1295 any sort of error, and that all requested modifications have been 1296 performed if the Modify Response indicates successful completion of 1297 the Modify Operation. If the association changes or the connection 1298 fails, whether the modification occurred or not is indeterminate. 1300 The Modify Operation cannot be used to remove from an entry any of 1301 its distinguished values, those values which form the entry's 1302 relative distinguished name. An attempt to do so will result in the 1303 server returning the error notAllowedOnRDN. The Modify DN Operation 1304 described in section 4.9 is used to rename an entry. 1306 Lightweight Directory Access Protocol Version 3 1308 Note that due to the simplifications made in LDAP, there is not a 1309 direct mapping of the modifications in an LDAP ModifyRequest onto the 1310 EntryModifications of a DAP ModifyEntry operation, and different 1311 implementations of LDAP-DAP gateways may use different means of 1312 representing the change. If successful, the final effect of the 1313 operations on the entry MUST be identical. 1315 4.7. Add Operation 1317 The Add Operation allows a client to request the addition of an entry 1318 into the directory. The Add Request is defined as follows: 1320 AddRequest ::= [APPLICATION 8] SEQUENCE { 1321 entry LDAPDN, 1322 attributes AttributeList } 1324 AttributeList ::= SEQUENCE OF SEQUENCE { 1325 type AttributeDescription, 1326 vals SET OF AttributeValue } 1328 Parameters of the Add Request are: 1330 - entry: the Distinguished Name of the entry to be added. Note that 1331 the server will not dereference any aliases in locating the entry 1332 to be added. 1334 - attributes: the list of attributes that make up the content of the 1335 entry being added. Clients MUST include distinguished values 1336 (those forming the entry's own RDN) in this list, the objectClass 1337 attribute, and values of any mandatory attributes of the listed 1338 object classes. Clients MUST NOT supply NO-USER-MODIFICATION 1339 attributes such as the createTimestamp or creatorsName attributes, 1340 since the server maintains these automatically. 1342 The entry named in the entry field of the AddRequest MUST NOT exist 1343 for the AddRequest to succeed. The immediate superior (parent) of the 1344 object and alias entries to be added MUST exist. For example, if the 1345 client attempted to add "CN=JS,DC=Example,DC=NET", the 1346 "DC=Example,DC=NET" entry did not exist, and the "DC=NET" entry did 1347 exist, then the server would return the error noSuchObject with the 1348 matchedDN field containing "DC=NET". If the parent entry exists but 1349 is not in a naming context held by the server, the server SHOULD 1350 return a referral to the server holding the parent entry. 1352 Server implementations SHOULD NOT restrict where entries can be 1353 located in the directory unless DIT structure rules are in place. 1354 Some servers MAY allow the administrator to restrict the classes of 1355 entries which can be added to the directory. 1357 Upon receipt of an Add Request, a server will attempt to add the 1358 requested entry. The result of the add attempt will be returned to 1359 the client in the Add Response, defined as follows: 1361 Lightweight Directory Access Protocol Version 3 1363 AddResponse ::= [APPLICATION 9] LDAPResult 1365 A response of success indicates that the new entry is present in the 1366 directory. 1368 4.8. Delete Operation 1370 The Delete Operation allows a client to request the removal of an 1371 entry from the directory. The Delete Request is defined as follows: 1373 DelRequest ::= [APPLICATION 10] LDAPDN 1375 The Delete Request consists of the Distinguished Name of the entry to 1376 be deleted. Note that the server will not dereference aliases while 1377 resolving the name of the target entry to be removed, and that only 1378 leaf entries (those with no subordinate entries) can be deleted with 1379 this operation. 1381 The result of the delete attempted by the server upon receipt of a 1382 Delete Request is returned in the Delete Response, defined as 1383 follows: 1385 DelResponse ::= [APPLICATION 11] LDAPResult 1387 Upon receipt of a Delete Request, a server will attempt to perform 1388 the entry removal requested. The result of the delete attempt will be 1389 returned to the client in the Delete Response. 1391 4.9. Modify DN Operation 1393 The Modify DN Operation allows a client to change the leftmost (least 1394 significant) component of the name of an entry in the directory, 1395 and/or to move a subtree of entries to a new location in the 1396 directory. The Modify DN Request is defined as follows: 1398 ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { 1399 entry LDAPDN, 1400 newrdn RelativeLDAPDN, 1401 deleteoldrdn BOOLEAN, 1402 newSuperior [0] LDAPDN OPTIONAL } 1404 Parameters of the Modify DN Request are: 1406 - entry: the Distinguished Name of the entry to be changed. This 1407 entry may or may not have subordinate entries. Note that the 1408 server will not dereference any aliases in locating the entry to 1409 be changed. 1411 - newrdn: the RDN that will form the leftmost component of the new 1412 name of the entry. 1414 Lightweight Directory Access Protocol Version 3 1416 - deleteoldrdn: a boolean parameter that controls whether the old 1417 RDN attribute values are to be retained as attributes of the 1418 entry, or deleted from the entry. 1420 - newSuperior: if present, this is the Distinguished Name of an 1421 existing object entry which becomes the immediate superior 1422 (parent)of the existing entry. 1424 The result of the name change attempted by the server upon receipt of 1425 a Modify DN Request is returned in the Modify DN Response, defined as 1426 follows: 1428 ModifyDNResponse ::= [APPLICATION 13] LDAPResult 1430 Upon receipt of a ModifyDNRequest, a server will attempt to perform 1431 the name change. The result of the name change attempt will be 1432 returned to the client in the Modify DN Response. 1434 For example, if the entry named in the "entry" parameter was "cn=John 1435 Smith,c=US", the newrdn parameter was "cn=John Cougar Smith", and the 1436 newSuperior parameter was absent, then this operation would attempt 1437 to rename the entry to be "cn=John Cougar Smith,c=US". If there was 1438 already an entry with that name, the operation would fail with error 1439 code entryAlreadyExists. 1441 The object named in newSuperior MUST exist. For example, if the 1442 client attempted to add "CN=JS,DC=Example,DC=NET", the 1443 "DC=Example,DC=NET" entry did not exist, and the "DC=NET" entry did 1444 exist, then the server would return the error noSuchObject with the 1445 matchedDN field containing "DC=NET". 1447 If the deleteoldrdn parameter is TRUE, the values forming the old RDN 1448 are deleted from the entry. If the deleteoldrdn parameter is FALSE, 1449 the values forming the old RDN will be retained as non-distinguished 1450 attribute values of the entry. The server may not perform the 1451 operation and return an error code if the setting of the deleteoldrdn 1452 parameter would cause a schema inconsistency in the entry. 1454 Note that X.500 restricts the ModifyDN operation to only affect 1455 entries that are contained within a single server. If the LDAP server 1456 is mapped onto DAP, then this restriction will apply, and the 1457 resultCode affectsMultipleDSAs will be returned if this error 1458 occurred. In general clients MUST NOT expect to be able to perform 1459 arbitrary movements of entries and subtrees between servers. 1461 4.10. Compare Operation 1463 The Compare Operation allows a client to compare an assertion 1464 provided with an entry in the directory. The Compare Request is 1465 defined as follows: 1467 CompareRequest ::= [APPLICATION 14] SEQUENCE { 1468 entry LDAPDN, 1469 Lightweight Directory Access Protocol Version 3 1471 ava AttributeValueAssertion } 1473 Parameters of the Compare Request are: 1475 - entry: the name of the entry to be compared with. Note that the 1476 server SHOULD NOT dereference any aliases in locating the entry to 1477 be compared with. 1479 - ava: the assertion with which an attribute in the entry is to be 1480 compared. 1482 The result of the compare attempted by the server upon receipt of a 1483 Compare Request is returned in the Compare Response, defined as 1484 follows: 1486 CompareResponse ::= [APPLICATION 15] LDAPResult 1488 Upon receipt of a Compare Request, a server will attempt to perform 1489 the requested comparison using the EQUALITY matching rule for the 1490 attribute type. The result of the comparison will be returned to the 1491 client in the Compare Response. Note that errors and the result of 1492 comparison are all returned in the same construct. 1494 Note that some directory systems may establish access controls which 1495 permit the values of certain attributes (such as userPassword) to be 1496 compared but not interrogated by other means. 1498 4.11. Abandon Operation 1500 The function of the Abandon Operation is to allow a client to request 1501 that the server abandon an outstanding operation. The Abandon Request 1502 is defined as follows: 1504 AbandonRequest ::= [APPLICATION 16] MessageID 1506 The MessageID MUST be that of an operation which was requested 1507 earlier in this LDAP association. The abandon request itself has its 1508 own message id. This is distinct from the id of the earlier operation 1509 being abandoned. 1511 There is no response defined in the Abandon operation. Upon reciept 1512 of an AbandonRequest, the server MAY abandon the operation identified 1513 by the MessageID. Operation responses are not sent for successfully 1514 abandoned operations, thus a client SHOULD NOT use the Abandon 1515 operation when it needs an indication of whether the operation was 1516 abandoned. For example, if a client performs an update operation 1517 (Add, Modify, or ModifyDN), and it needs to know whether the 1518 directory has changed due to the operation, it should not use the 1519 Abandon operation to cancel the update operation. 1521 Abandon and Unbind operations cannot be abandoned. The ability to 1522 abandon other (particularly update) operations is at the discretion 1523 of the server. 1525 Lightweight Directory Access Protocol Version 3 1527 In the event that a server receives an Abandon Request on a Search 1528 Operation in the midst of transmitting responses to the search, that 1529 server MUST cease transmitting entry responses to the abandoned 1530 request immediately, and MUST NOT send the SearchResponseDone. Of 1531 course, the server MUST ensure that only properly encoded LDAPMessage 1532 PDUs are transmitted. 1534 Clients MUST NOT send abandon requests for the same operation 1535 multiple times, and MUST also be prepared to receive results from 1536 operations it has abandoned (since these may have been in transit 1537 when the abandon was requested, or are not able to be abandoned). 1539 Servers MUST discard abandon requests for message IDs they do not 1540 recognize, for operations which cannot be abandoned, and for 1541 operations which have already been abandoned. 1543 4.12. Extended Operation 1545 An extension mechanism has been added in this version of LDAP, in 1546 order to allow additional operations to be defined for services not 1547 available elsewhere in this protocol, for instance digitally signed 1548 operations and results. 1550 The extended operation allows clients to make requests and receive 1551 responses with predefined syntaxes and semantics. These may be 1552 defined in RFCs or be private to particular implementations. Each 1553 request MUST have a unique OBJECT IDENTIFIER assigned to it. 1555 ExtendedRequest ::= [APPLICATION 23] SEQUENCE { 1556 requestName [0] LDAPOID, 1557 requestValue [1] OCTET STRING OPTIONAL } 1559 The requestName is a dotted-decimal representation of the OBJECT 1560 IDENTIFIER corresponding to the request. The requestValue is 1561 information in a form defined by that request, encapsulated inside an 1562 OCTET STRING. 1564 The server will respond to this with an LDAPMessage containing the 1565 ExtendedResponse. 1567 ExtendedResponse ::= [APPLICATION 24] SEQUENCE { 1568 COMPONENTS OF LDAPResult, 1569 responseName [10] LDAPOID OPTIONAL, 1570 responseValue [11] OCTET STRING OPTIONAL } 1572 If the server does not recognize the request name, it MUST return 1573 only the response fields from LDAPResult, containing the 1574 protocolError result code. 1576 The requestValue and responseValue fields contain any information 1577 associated with the operation. The format of these fields is defined 1578 by the specification of the extended operation. Implementations MUST 1579 Lightweight Directory Access Protocol Version 3 1581 be prepared to handle arbitrary contents of these fields, including 1582 zero bytes. Values that are defined in terms of ASN.1 and BER encoded 1583 according to Section 5.1, also follow the extensibility rules in 1584 Section 4. 1586 Extended operations may be specified in other documents. The 1587 specification of an extended operation consists of: 1589 - the OBJECT IDENTIFIER assigned to the ExtendedRequest.requestName 1590 (and possibly ExtendedResponse.responseName), 1592 - the format of the contents of the requestValue and responseValue 1593 (if any), 1595 - the semantics of the operation, 1597 Servers list the requestName of all ExtendedRequests they recognize 1598 in the supportedExtension attribute [Models] in the root DSE. 1600 requestValues and responseValues that are defined in terms of ASN.1 1601 and BER encoded according to Section 5.1, also follow the 1602 extensibility rules in Section 4. 1604 4.13. Start TLS Operation 1606 The Start Transport Layer Security (StartTLS) operation provides the 1607 ability to establish Transport Layer Security [RFC2246] on an LDAP 1608 connection. 1610 4.13.1. Start TLS Request 1612 A client requests TLS establishment by transmitting a Start TLS 1613 request PDU to the server. The Start TLS request is defined in terms 1614 of an ExtendedRequest. The requestName is "1.3.6.1.4.1.1466.20037", 1615 and the requestValue field is absent. 1617 The client MUST NOT send any PDUs on this connection following this 1618 request until it receives a Start TLS extended response. 1620 4.13.2. Start TLS Response 1622 When a Start TLS request is made, servers supporting the operation 1623 MUST return a Start TLS response PDU to the requestor. The Start TLS 1624 response responseName is also "1.3.6.1.4.1.1466.20037", and the 1625 response field is absent. 1627 The server MUST set the resultCode field to either success or one of 1628 the other values outlined in section 4.13.2.2. 1630 4.13.2.1. "Success" Response 1631 Lightweight Directory Access Protocol Version 3 1633 If the Start TLS Response contains a resultCode of success, this 1634 indicates that the server is willing and able to negotiate TLS. Refer 1635 to section 5.3 of [AuthMeth] for details. 1637 4.13.2.2. Response other than "success" 1639 If the ExtendedResponse contains a resultCode other than success, 1640 this indicates that the server is unwilling or unable to negotiate 1641 TLS. The following resultCodes have these meanings for this 1642 operation: 1644 operationsError (operations sequencing incorrect; e.g. TLS already 1645 established) 1647 protocolError (TLS not supported or incorrect PDU structure) 1649 unavailable (e.g. some major problem with TLS, or server is 1650 shutting down) 1652 The server MUST return operationsError if the client violates any of 1653 the Start TLS extended operation sequencing requirements described in 1654 section 5.3 of [AuthMeth]. 1656 If the server does not support TLS (whether by design or by current 1657 configuration), it MUST set the resultCode to protocolError. The 1658 client's current association is unaffected if the server does not 1659 support TLS. The client MAY proceed with any LDAP operation, or it 1660 MAY close the connection. 1662 The server MUST return unavailable if it supports TLS but cannot 1663 establish a TLS connection for some reason, e.g. the certificate 1664 server not responding, it cannot contact its TLS implementation, or 1665 if the server is in process of shutting down. The client MAY retry 1666 the StartTLS operation, or it MAY proceed with any other LDAP 1667 operation, or it MAY close the LDAP connection. 1669 4.13.3. Closing a TLS Connection 1671 Two forms of TLS connection closure--graceful and abrupt--are 1672 supported. 1674 4.13.3.1. Graceful Closure 1676 Either the client or server MAY terminate the TLS connection and 1677 leave the LDAP connection intact by sending a TLS closure alert. 1679 Before sending a TLS closure alert, the client MUST either wait for 1680 any outstanding LDAP operations to complete, or explicitly abandon 1681 them. 1683 After the initiator of a close has sent a TLS closure alert, it MUST 1684 discard any TLS messages until it has received a TLS closure alert 1685 from the other party. It will cease to send TLS Record Protocol 1686 Lightweight Directory Access Protocol Version 3 1688 PDUs, and following the receipt of the alert, MAY send and receive 1689 LDAP PDUs. 1691 The other party, if it receives a TLS closure alert, MUST immediately 1692 transmit a TLS closure alert. It will subsequently cease to send TLS 1693 Record Protocol PDUs, and MAY send and receive LDAP PDUs. 1695 After the TLS connection has been closed, the server MUST NOT send 1696 responses to any request message received before the TLS closure. 1698 4.13.3.2. Abrupt Closure 1700 Either the client or server MAY abruptly close the TLS connection by 1701 dropping the underlying transfer protocol connection. In this 1702 circumstance, a server MAY send the client a Notice of Disconnection 1703 before dropping the underlying LDAP connection. 1705 5. Protocol Element Encodings and Transfer 1707 One underlying service is defined here. Clients and servers SHOULD 1708 implement the mapping of LDAP over TCP described in 5.2.1. 1710 5.1. Protocol Encoding 1712 The protocol elements of LDAP are encoded for exchange using the 1713 Basic Encoding Rules (BER) [X.690] of ASN.1 [X.680]. However, due to 1714 the high overhead involved in using certain elements of the BER, the 1715 following additional restrictions are placed on BER-encodings of LDAP 1716 protocol elements: 1718 (1) Only the definite form of length encoding will be used. 1720 (2) OCTET STRING values will be encoded in the primitive form only. 1722 (3) If the value of a BOOLEAN type is true, the encoding MUST have 1723 its contents octets set to hex "FF". 1725 (4) If a value of a type is its default value, it MUST be absent. 1726 Only some BOOLEAN and INTEGER types have default values in this 1727 protocol definition. 1729 These restrictions do not apply to ASN.1 types encapsulated inside of 1730 OCTET STRING values, such as attribute values, unless otherwise 1731 noted. 1733 5.2. Transfer Protocols 1735 This protocol is designed to run over connection-oriented, reliable 1736 transports, with all 8 bits in an octet being significant in the data 1737 stream. 1739 Lightweight Directory Access Protocol Version 3 1741 5.2.1. Transmission Control Protocol (TCP) 1743 The encoded LDAPMessage PDUs are mapped directly onto the TCP 1744 bytestream using the BER-based encoding described in section 5.1. It 1745 is recommended that server implementations running over the TCP 1746 provide a protocol listener on the assigned port, 389. Servers may 1747 instead provide a listener on a different port number. Clients MUST 1748 support contacting servers on any valid TCP port. 1750 6. Implementation Guidelines 1752 6.1. Server Implementations 1754 The server MUST be capable of recognizing all the mandatory attribute 1755 type names and implement the syntaxes specified in [Syntaxes]. 1756 Servers MAY also recognize additional attribute type names. 1758 6.2. Client Implementations 1760 Clients that follow referrals or search continuation references MUST 1761 ensure that they do not loop between servers. They MUST NOT 1762 repeatedly contact the same server for the same request with the same 1763 target entry name, scope and filter. Some clients use a counter that 1764 is incremented each time referral handling occurs for an operation, 1765 and these kinds of clients MUST be able to handle at least ten nested 1766 referrals between the root and a leaf entry. 1768 In the absence of prior agreements with servers, clients SHOULD NOT 1769 assume that servers support any particular schemas beyond those 1770 referenced in section 6.1. Different schemas can have different 1771 attribute types with the same names. The client can retrieve the 1772 subschema entries referenced by the subschemaSubentry attribute in 1773 the entries held by the server. 1775 7. Security Considerations 1777 This version of the protocol provides facilities for simple 1778 authentication using a cleartext password, as well as any SASL 1779 mechanism [RFC2222]. SASL allows for integrity and privacy services 1780 to be negotiated. 1782 It is also permitted that the server can return its credentials to 1783 the client, if it chooses to do so. 1785 Use of cleartext password is strongly discouraged where the 1786 underlying transport service cannot guarantee confidentiality and may 1787 result in disclosure of the password to unauthorized parties. 1789 Lightweight Directory Access Protocol Version 3 1791 When used with SASL, it should be noted that the name field of the 1792 BindRequest is not protected against modification. Thus if the 1793 distinguished name of the client (an LDAPDN) is agreed through the 1794 negotiation of the credentials, it takes precedence over any value in 1795 the unprotected name field. 1797 Implementations which cache attributes and entries obtained via LDAP 1798 MUST ensure that access controls are maintained if that information 1799 is to be provided to multiple clients, since servers may have access 1800 control policies which prevent the return of entries or attributes in 1801 search results except to particular authenticated clients. For 1802 example, caches could serve result information only to the client 1803 whose request caused it to be in the cache. 1805 Protocol servers may return referrals which redirect protocol clients 1806 to peer servers. It is possible for a rogue application to inject 1807 such referrals into the data stream in an attempt to redirect a 1808 client to a rogue server. Protocol clients are advised to be aware of 1809 this, and possibly reject referrals when confidentiality measures are 1810 in place. Protocol clients are advised to ignore referrals from the 1811 Start TLS operation. 1813 8. Acknowledgements 1815 This document is an update to RFC 2251, by Mark Wahl, Tim Howes, and 1816 Steve Kille. Their work along with the input of individuals of the 1817 IETF LDAPEXT, LDUP, LDAPBIS, and other Working Groups is gratefully 1818 acknowledged. 1820 9. Normative References 1822 [X.500] ITU-T Rec. X.500, "The Directory: Overview of Concepts, 1823 Models and Service", 1993. 1825 [Roadmap] K. Zeilenga (editor), "LDAP: Technical Specification Road 1826 Map", draft-ietf-ldapbis-roadmap-xx.txt (a work in 1827 progress). 1829 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1830 Requirement Levels", RFC 2119, March 1997. 1832 [X.680] ITU-T Recommendation X.680 (1997) | ISO/IEC 8824-1:1998 1833 Information Technology - Abstract Syntax Notation One 1834 (ASN.1): Specification of basic notation 1836 [X.690] ITU-T Rec. X.690, "Specification of ASN.1 encoding rules: 1837 Basic, Canonical, and Distinguished Encoding Rules", 1994. 1839 [LDAPIANA] K. Zeilenga, "IANA Considerations for LDAP", draft-ietf- 1840 ldapbis-xx.txt (a work in progress). 1842 Lightweight Directory Access Protocol Version 3 1844 [ISO10646] Universal Multiple-Octet Coded Character Set (UCS) - 1845 Architecture and Basic Multilingual Plane, ISO/IEC 10646-1 1846 : 1993. 1848 [RFC2279] Yergeau, F., "UTF-8, a transformation format of Unicode 1849 and ISO 10646", RFC 2279, January 1998. 1851 [Models] K. Zeilenga, "LDAP: The Models", draft-ietf-ldapbis- 1852 models-xx.txt (a work in progress). 1854 [LDAPDN] K. Zeilenga (editor), "LDAP: String Representation of 1855 Distinguished Names", draft-ietf-ldapbis-dn-xx.txt, (a 1856 work in progress). 1858 [Syntaxes] K. Dally (editor), "LDAP: Syntaxes", draft-ietf-ldapbis- 1859 syntaxes-xx.txt, (a work in progress). 1861 [X.501] ITU-T Rec. X.501, "The Directory: Models", 1993. 1863 [X.511] ITU-T Rec. X.511, "The Directory: Abstract Service 1864 Definition", 1993. 1866 [RFC2396] Berners-Lee, T., Fielding, R., and L. Masinter Uniform 1867 Resource Identifiers (URI): Generic Syntax", RFC 2396, 1868 August 1998. 1870 [AuthMeth] R. Harrison (editor), "LDAP: Authentication Methods", 1871 draft-ietf-ldapbis-authmeth-xx.txt, (a work in progress). 1873 [RFC2222] Meyers, J., "Simple Authentication and Security Layer", 1874 RFC 2222, October 1997. 1876 [SASLPrep] Zeilenga, K., "Stringprep profile for user names and 1877 passwords", draft-ietf-sasl-saslprep-xx.txt, (a work in 1878 progress). 1880 [Unicode] The Unicode Consortium, "The Unicode Standard, Version 1881 3.2.0" is defined by "The Unicode Standard, Version 3.0" 1882 (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5), 1883 as amended by the "Unicode Standard Annex #27: Unicode 1884 3.1" (http://www.unicode.org/reports/tr27/) and by the 1885 "Unicode Standard Annex #28: Unicode 3.2" 1886 (http://www.unicode.org/reports/tr28/). 1888 10. Editor's Address 1890 Jim Sermersheim 1891 Novell, Inc. 1892 1800 South Novell Place 1893 Provo, Utah 84606, USA 1894 jimse@novell.com 1895 Lightweight Directory Access Protocol Version 3 1897 +1 801 861-3088 1898 Lightweight Directory Access Protocol Version 3 1900 Appendix A - LDAP Result Codes 1902 This normative appendix details additional considerations regarding 1903 LDAP result codes and provides a brief, general description of each 1904 LDAP result code enumerated in Section 4.1.10. 1906 Additional result codes MAY be defined for use with extensions. 1907 Client implementations SHALL treat any result code which they do not 1908 recognize as an unknown error condition. 1910 A.1 Non-Error Result Codes 1911 These result codes (called "non-error" result codes) do not indicate 1912 an error condition: 1913 success(0), 1914 compareTrue(6), 1915 compareFalse(7), 1916 referral(10), and 1917 saslBindInProgress(14). 1919 The success(0), compareTrue(6), and compare(7) result codes indicate 1920 successful completion (and, hence, are called to as "successful" 1921 result codes). 1923 The referral(10) and saslBindInProgress(14) indicate the client is 1924 required to take additional action to complete the operation 1926 A.2 Error Result Codes 1927 Existing LDAP result codes are described as follows: 1929 success (0) 1931 Indicates successful completion of an operation. 1933 This result code is normally not returned by the compare 1934 operation, see compareFalse (5) and compareTrue (6). It is 1935 possible that a future extension mechanism would allow this 1936 to be returned by a compare operation. 1938 operationsError (1) 1940 Indicates that the operation is not properly sequenced with 1941 relation to other operations (of same or different type). 1943 For example, this code is returned if the client attempts to 1944 Start TLS [RFC2246] while there are other operations 1945 outstanding or if TLS was already established. 1947 protocolError (2) 1948 Lightweight Directory Access Protocol Version 3 1950 Indicates the server received data which has incorrect 1951 structure. 1953 For bind operation only, the code may be resulted to indicate 1954 the server does not support the requested protocol version. 1956 timeLimitExceeded (3) 1958 Indicates that the time limit specified by the client was 1959 exceeded before the operation could be completed. 1961 sizeLimitExceeded (4) 1963 Indicates that the size limit specified by the client was 1964 exceeded before the operation could be completed. 1966 compareFalse (5) 1968 Indicates that the operation successfully completes and the 1969 assertion has evaluated to FALSE. 1971 This result code is normally only returned by the compare 1972 operation. 1974 compareTrue (6) 1976 Indicates that the operation successfully completes and the 1977 assertion has evaluated to TRUE. 1979 This result code is normally only returned by the compare 1980 operation. 1982 authMethodNotSupported (7) 1984 Indicates that the authentication method or mechanism is not 1985 supported. 1987 strongAuthRequired (8) 1989 Except when returned in a Notice of Disconnect (see section 1990 4.4.1), this indicates that the server requires the client to 1991 authentication using a strong(er) mechanism. 1993 referral (10) 1995 Indicates that a referral needs to be chased to complete the 1996 operation (see section 4.1.11). 1998 Lightweight Directory Access Protocol Version 3 2000 adminLimitExceeded (11) 2002 Indicates that an administrative limit has been exceeded. 2004 unavailableCriticalExtension (12) 2006 Indicates that server cannot perform a critical extension 2007 (see section 4.1.12). 2009 confidentialityRequired (13) 2011 Indicates that data confidentiality protections are required. 2013 saslBindInProgress (14) 2015 Indicates the server requires the client to send a new bind 2016 request, with the same SASL mechanism, to continue the 2017 authentication process (see section 4.2). 2019 noSuchAttribute (16) 2021 Indicates that the named entry does not contain the specified 2022 attribute or attribute value. 2024 undefinedAttributeType (17) 2026 Indicates that a request field contains an undefined 2027 attribute type. 2029 inappropriateMatching (18) 2031 Indicates that a request cannot be completed due to an 2032 inappropriate matching. 2034 constraintViolation (19) 2036 Indicates that the client supplied an attribute value which 2037 does not conform to constraints placed upon it by the data 2038 model. 2040 For example, this code is returned when the multiple values 2041 are supplied to an attribute which has a SINGLE-VALUE 2042 constraint. 2044 Lightweight Directory Access Protocol Version 3 2046 attributeOrValueExists (20) 2048 Indicates that the client supplied an attribute or value to 2049 be added to an entry already exists. 2051 invalidAttributeSyntax (21) 2053 Indicates that a purported attribute value does not conform 2054 to the syntax of the attribute. 2056 noSuchObject (32) 2058 Indicates that the object does not exist in the DIT. 2060 aliasProblem (33) 2062 Indicates that an alias problem has occurred. Typically an 2063 alias has been dereferenced which names no object. 2065 invalidDNSyntax (34) 2067 Indicates that a LDAPDN or RelativeLDAPDN field (e.g. search 2068 base, target entry, ModifyDN newrdn, etc.) of a request does 2069 not conform to the required syntax or contains attribute 2070 values which do not conform to the syntax of the attribute's 2071 type. 2073 aliasDereferencingProblem (36) 2075 Indicates that a problem occurred while dereferencing an 2076 alias. Typically an alias was encountered in a situation 2077 where it was not allowed or where access was denied. 2079 inappropriateAuthentication (48) 2081 Indicates the server requires the client which had attempted 2082 to bind anonymously or without supplying credentials to 2083 provide some form of credentials, 2085 invalidCredentials (49) 2087 Indicates the supplied password or SASL credentials are 2088 invalid. 2090 insufficientAccessRights (50) 2091 Lightweight Directory Access Protocol Version 3 2093 Indicates that the client does not have sufficient access 2094 rights to perform the operation. 2096 busy (51) 2098 Indicates that the server is busy. 2100 unavailable (52) 2102 Indicates that the server is shutting down or a subsystem 2103 necessary to complete the operation is offline. 2105 unwillingToPerform (53) 2107 Indicates that the server is unwilling to perform the 2108 operation. 2110 loopDetect (54) 2112 Indicates that the server has detected an internal loop. 2114 namingViolation (64) 2116 Indicates that the entry name violates naming restrictions. 2118 objectClassViolation (65) 2120 Indicates that the entry violates object class restrictions. 2122 notAllowedOnNonLeaf (66) 2124 Indicates that operation is inappropriately acting upon a 2125 non-leaf entry. 2127 notAllowedOnRDN (67) 2129 Indicates that the operation is inappropriately attempting to 2130 remove a value which forms the entry's relative distinguished 2131 name. 2133 entryAlreadyExists (68) 2135 Indicates that the request cannot be added fulfilled as the 2136 entry already exists. 2138 Lightweight Directory Access Protocol Version 3 2140 objectClassModsProhibited (69) 2142 Indicates that the attempt to modify the object class(es) of 2143 an entry objectClass attribute is prohibited. 2145 For example, this code is returned when a when a client 2146 attempts to modify the structural object class of an entry. 2148 affectsMultipleDSAs (71) 2150 Indicates that the operation cannot be completed as it 2151 affects multiple servers (DSAs). 2153 other (80) 2155 Indicates the server has encountered an internal error. 2157 Lightweight Directory Access Protocol Version 3 2159 Appendix B - Complete ASN.1 Definition 2161 This appendix is normative. 2163 Lightweight-Directory-Access-Protocol-V3 DEFINITIONS 2164 IMPLICIT TAGS 2165 EXTENSIBILITY IMPLIED ::= 2167 BEGIN 2169 LDAPMessage ::= SEQUENCE { 2170 messageID MessageID, 2171 protocolOp CHOICE { 2172 bindRequest BindRequest, 2173 bindResponse BindResponse, 2174 unbindRequest UnbindRequest, 2175 searchRequest SearchRequest, 2176 searchResEntry SearchResultEntry, 2177 searchResDone SearchResultDone, 2178 searchResRef SearchResultReference, 2179 modifyRequest ModifyRequest, 2180 modifyResponse ModifyResponse, 2181 addRequest AddRequest, 2182 addResponse AddResponse, 2183 delRequest DelRequest, 2184 delResponse DelResponse, 2185 modDNRequest ModifyDNRequest, 2186 modDNResponse ModifyDNResponse, 2187 compareRequest CompareRequest, 2188 compareResponse CompareResponse, 2189 abandonRequest AbandonRequest, 2190 extendedReq ExtendedRequest, 2191 extendedResp ExtendedResponse, 2192 ... }, 2193 controls [0] Controls OPTIONAL } 2195 MessageID ::= INTEGER (0 .. maxInt) 2197 maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- 2199 LDAPString ::= OCTET STRING -- UTF-8 encoded, 2200 -- [ISO10646] characters 2202 LDAPOID ::= OCTET STRING -- Constrained to numericoid [Models] 2204 LDAPDN ::= LDAPString 2206 RelativeLDAPDN ::= LDAPString 2208 AttributeDescription ::= LDAPString 2209 -- Constrained to attributedescription 2210 -- [Models] 2212 AttributeDescriptionList ::= SEQUENCE OF 2213 Lightweight Directory Access Protocol Version 3 2215 AttributeDescription 2217 AttributeValue ::= OCTET STRING 2219 AttributeValueAssertion ::= SEQUENCE { 2220 attributeDesc AttributeDescription, 2221 assertionValue AssertionValue } 2223 AssertionValue ::= OCTET STRING 2225 Attribute ::= SEQUENCE { 2226 type AttributeDescription, 2227 vals SET OF AttributeValue } 2229 MatchingRuleId ::= LDAPString 2231 LDAPResult ::= SEQUENCE { 2232 resultCode ENUMERATED { 2233 success (0), 2234 operationsError (1), 2235 protocolError (2), 2236 timeLimitExceeded (3), 2237 sizeLimitExceeded (4), 2238 compareFalse (5), 2239 compareTrue (6), 2240 authMethodNotSupported (7), 2241 strongAuthRequired (8), 2242 -- 9 reserved -- 2243 referral (10), 2244 adminLimitExceeded (11), 2245 unavailableCriticalExtension (12), 2246 confidentialityRequired (13), 2247 saslBindInProgress (14), 2248 noSuchAttribute (16), 2249 undefinedAttributeType (17), 2250 inappropriateMatching (18), 2251 constraintViolation (19), 2252 attributeOrValueExists (20), 2253 invalidAttributeSyntax (21), 2254 -- 22-31 unused -- 2255 noSuchObject (32), 2256 aliasProblem (33), 2257 invalidDNSyntax (34), 2258 -- 35 reserved for undefined isLeaf -- 2259 aliasDereferencingProblem (36), 2260 -- 37-47 unused -- 2261 inappropriateAuthentication (48), 2262 invalidCredentials (49), 2263 insufficientAccessRights (50), 2264 busy (51), 2265 unavailable (52), 2266 unwillingToPerform (53), 2267 loopDetect (54), 2268 -- 55-63 unused -- 2269 Lightweight Directory Access Protocol Version 3 2271 namingViolation (64), 2272 objectClassViolation (65), 2273 notAllowedOnNonLeaf (66), 2274 notAllowedOnRDN (67), 2275 entryAlreadyExists (68), 2276 objectClassModsProhibited (69), 2277 -- 70 reserved for CLDAP -- 2278 affectsMultipleDSAs (71), 2279 -- 72-79 unused -- 2280 other (80), 2281 ... }, 2282 -- 81-90 reserved for APIs -- 2283 matchedDN LDAPDN, 2284 diagnosticMessage LDAPString, 2285 referral [3] Referral OPTIONAL } 2287 Referral ::= SEQUENCE OF LDAPURL 2289 LDAPURL ::= LDAPString -- limited to characters permitted in 2290 -- URLs 2292 Controls ::= SEQUENCE OF Control 2294 Control ::= SEQUENCE { 2295 controlType LDAPOID, 2296 criticality BOOLEAN DEFAULT FALSE, 2297 controlValue OCTET STRING OPTIONAL } 2299 BindRequest ::= [APPLICATION 0] SEQUENCE { 2300 version INTEGER (1 .. 127), 2301 name LDAPDN, 2302 authentication AuthenticationChoice } 2304 AuthenticationChoice ::= CHOICE { 2305 simple [0] OCTET STRING, 2306 -- 1 and 2 reserved 2307 sasl [3] SaslCredentials, 2308 ... } 2310 SaslCredentials ::= SEQUENCE { 2311 mechanism LDAPString, 2312 credentials OCTET STRING OPTIONAL } 2314 BindResponse ::= [APPLICATION 1] SEQUENCE { 2315 COMPONENTS OF LDAPResult, 2316 serverSaslCreds [7] OCTET STRING OPTIONAL } 2318 UnbindRequest ::= [APPLICATION 2] NULL 2320 SearchRequest ::= [APPLICATION 3] SEQUENCE { 2321 baseObject LDAPDN, 2322 scope ENUMERATED { 2323 baseObject (0), 2324 singleLevel (1), 2325 Lightweight Directory Access Protocol Version 3 2327 wholeSubtree (2) }, 2328 derefAliases ENUMERATED { 2329 neverDerefAliases (0), 2330 derefInSearching (1), 2331 derefFindingBaseObj (2), 2332 derefAlways (3) }, 2333 sizeLimit INTEGER (0 .. maxInt), 2334 timeLimit INTEGER (0 .. maxInt), 2335 typesOnly BOOLEAN, 2336 filter Filter, 2337 attributes AttributeDescriptionList } 2339 Filter ::= CHOICE { 2340 and [0] SET SIZE (1..MAX) OF Filter, 2341 or [1] SET SIZE (1..MAX) OF Filter, 2342 not [2] Filter, 2343 equalityMatch [3] AttributeValueAssertion, 2344 substrings [4] SubstringFilter, 2345 greaterOrEqual [5] AttributeValueAssertion, 2346 lessOrEqual [6] AttributeValueAssertion, 2347 present [7] AttributeDescription, 2348 approxMatch [8] AttributeValueAssertion, 2349 extensibleMatch [9] MatchingRuleAssertion } 2351 SubstringFilter ::= SEQUENCE { 2352 type AttributeDescription, 2353 -- at least one must be present, 2354 -- initial and final can occur at most once 2355 substrings SEQUENCE OF CHOICE { 2356 initial [0] AssertionValue, 2357 any [1] AssertionValue, 2358 final [2] AssertionValue } } 2360 MatchingRuleAssertion ::= SEQUENCE { 2361 matchingRule [1] MatchingRuleId OPTIONAL, 2362 type [2] AttributeDescription OPTIONAL, 2363 matchValue [3] AssertionValue, 2364 dnAttributes [4] BOOLEAN DEFAULT FALSE } 2366 SearchResultEntry ::= [APPLICATION 4] SEQUENCE { 2367 objectName LDAPDN, 2368 attributes PartialAttributeList } 2370 PartialAttributeList ::= SEQUENCE OF SEQUENCE { 2371 type AttributeDescription, 2372 vals SET OF AttributeValue } 2374 SearchResultReference ::= [APPLICATION 19] SEQUENCE OF LDAPURL 2376 SearchResultDone ::= [APPLICATION 5] LDAPResult 2378 ModifyRequest ::= [APPLICATION 6] SEQUENCE { 2379 object LDAPDN, 2380 modification SEQUENCE OF SEQUENCE { 2381 Lightweight Directory Access Protocol Version 3 2383 operation ENUMERATED { 2384 add (0), 2385 delete (1), 2386 replace (2) }, 2387 modification AttributeTypeAndValues } } 2389 AttributeTypeAndValues ::= SEQUENCE { 2390 type AttributeDescription, 2391 vals SET OF AttributeValue } 2393 ModifyResponse ::= [APPLICATION 7] LDAPResult 2395 AddRequest ::= [APPLICATION 8] SEQUENCE { 2396 entry LDAPDN, 2397 attributes AttributeList } 2399 AttributeList ::= SEQUENCE OF SEQUENCE { 2400 type AttributeDescription, 2401 vals SET OF AttributeValue } 2403 AddResponse ::= [APPLICATION 9] LDAPResult 2405 DelRequest ::= [APPLICATION 10] LDAPDN 2407 DelResponse ::= [APPLICATION 11] LDAPResult 2409 ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { 2410 entry LDAPDN, 2411 newrdn RelativeLDAPDN, 2412 deleteoldrdn BOOLEAN, 2413 newSuperior [0] LDAPDN OPTIONAL } 2415 ModifyDNResponse ::= [APPLICATION 13] LDAPResult 2417 CompareRequest ::= [APPLICATION 14] SEQUENCE { 2418 entry LDAPDN, 2419 ava AttributeValueAssertion } 2421 CompareResponse ::= [APPLICATION 15] LDAPResult 2423 AbandonRequest ::= [APPLICATION 16] MessageID 2425 ExtendedRequest ::= [APPLICATION 23] SEQUENCE { 2426 requestName [0] LDAPOID, 2427 requestValue [1] OCTET STRING OPTIONAL } 2429 ExtendedResponse ::= [APPLICATION 24] SEQUENCE { 2430 COMPONENTS OF LDAPResult, 2431 responseName [10] LDAPOID OPTIONAL, 2432 responseValue [11] OCTET STRING OPTIONAL } 2434 END 2435 Lightweight Directory Access Protocol Version 3 2437 Appendix C - Change History 2438 2441 C.1 Changes made to RFC 2251: 2443 C.1.1 Editorial 2445 - Bibliography References: Changed all bibliography references to 2446 use a long name form for readability. 2447 - Changed occurrences of "unsupportedCriticalExtension" 2448 "unavailableCriticalExtension" 2449 - Fixed a small number of misspellings (mostly dropped letters). 2451 C.1.2 Section 1 2453 - Removed IESG note. 2455 C.1.3 Section 9 2457 - Added references to RFCs 1823, 2234, 2829 and 2830. 2459 C.2 Changes made to draft-ietf-ldapbis-protocol-00.txt: 2461 C.2.1 Section 4.1.6 2463 - In the first paragraph, clarified what the contents of an 2464 AttributeValue are. There was confusion regarding whether or not 2465 an AttributeValue that is BER encoded (due to the "binary" option) 2466 is to be wrapped in an extra OCTET STRING. 2467 - To the first paragraph, added wording that doesn't restrict other 2468 transfer encoding specifiers from being used. The previous wording 2469 only allowed for the string encoding and the ;binary encoding. 2470 - To the first paragraph, added a statement restricting multiple 2471 options that specify transfer encoding from being present. This 2472 was never specified in the previous version and was seen as a 2473 potential interoperability problem. 2474 - Added a third paragraph stating that the ;binary option is 2475 currently the only option defined that specifies the transfer 2476 encoding. This is for completeness. 2478 C.2.2 Section 4.1.7 2480 - Generalized the second paragraph to read "If an option specifying 2481 the transfer encoding is present in attributeDesc, the 2482 AssertionValue is encoded as specified by the option...". 2483 Previously, only the ;binary option was mentioned. 2485 C.2.3 Sections 4.2, 4.9, 4.10 2487 - Added alias dereferencing specifications. In the case of modDN, 2488 followed precedent set on other update operations (... alias is 2489 not dereferenced...) In the case of bind and compare stated that 2490 Lightweight Directory Access Protocol Version 3 2492 servers SHOULD NOT dereference aliases. Specifications were added 2493 because they were missing from the previous version and caused 2494 interoperability problems. Concessions were made for bind and 2495 compare (neither should have ever allowed alias dereferencing) by 2496 using SHOULD NOT language, due to the behavior of some existing 2497 implementations. 2499 C.2.4 Sections 4.5 and Appendix A 2501 - Changed SubstringFilter.substrings.initial, any, and all from 2502 LDAPString to AssertionValue. This was causing an incompatibility 2503 with X.500 and confusion among other TS RFCs. 2505 C.3 Changes made to draft-ietf-ldapbis-protocol-01.txt: 2507 C.3.1 Section 3.4 2509 - Reworded text surrounding subschemaSubentry to reflect that it is 2510 a single-valued attribute that holds the schema for the root DSE. 2511 Also noted that if the server masters entries that use differing 2512 schema, each entry's subschemaSubentry attribute must be 2513 interrogated. This may change as further fine-tuning is done to 2514 the data model. 2516 C.3.2 Section 4.1.12 2518 - Specified that the criticality field is only used for requests and 2519 not for unbind or abandon. Noted that it is ignored for all other 2520 operations. 2522 C.3.3 Section 4.2 2524 - Noted that Server behavior is undefined when the name is a null 2525 value, simple authentication is used, and a password is specified. 2527 C.3.4 Section 4.2.(various) 2529 - Changed "unauthenticated" to "anonymous" and "DN" and "LDAPDN" to 2530 "name" 2532 C.3.5 Section 4.2.2 2534 - Changed "there is no authentication or encryption being performed 2535 by a lower layer" to "the underlying transport service cannot 2536 guarantee confidentiality" 2538 C.3.6 Section 4.5.2 2540 - Removed all mention of ExtendedResponse due to lack of 2541 implementation. 2543 C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt: 2545 Lightweight Directory Access Protocol Version 3 2547 C.4.1 Section 4 2549 - Removed "typically" from "and is typically transferred" in the 2550 first paragraph. We know of no (and can conceive of no) case where 2551 this isn't true. 2552 - Added "Section 5.1 specifies how the LDAP protocol is encoded." To 2553 the first paragraph. Added this cross reference for readability. 2554 - Changed "version 3 " to "version 3 or later" in the second 2555 paragraph. This was added to clarify the original intent. 2556 - Changed "protocol version" to "protocol versions" in the third 2557 paragraph. This attribute is multi-valued with the intent of 2558 holding all supported versions, not just one. 2560 C.4.2 Section 4.1.8 2562 - Changed "when transferred in protocol" to "when transferred from 2563 the server to the client" in the first paragraph. This is to 2564 clarify that this behavior only happens when attributes are being 2565 sent from the server. 2567 C.4.3 Section 4.1.10 2569 - Changed "servers will return responses containing fields of type 2570 LDAPResult" to "servers will return responses of LDAPResult or 2571 responses containing the components of LDAPResponse". This 2572 statement was incorrect and at odds with the ASN.1. The fix here 2573 reflects the original intent. 2574 - Dropped '--new' from result codes ASN.1. This simplification in 2575 comments just reduces unneeded verbiage. 2577 C.4.4 Section 4.1.11 2579 - Changed "It contains a reference to another server (or set of 2580 servers)" to "It contains one or more references to one or more 2581 servers or services" in the first paragraph. This reflects the 2582 original intent and clarifies that the URL may point to non-LDAP 2583 services. 2585 C.4.5 Section 4.1.12 2587 - Changed "The server MUST be prepared" to "Implementations MUST be 2588 prepared" in the eighth paragraph to reflect that both client and 2589 server implementations must be able to handle this (as both parse 2590 controls). 2592 C.4.6 Section 4.4 2594 - Changed "One unsolicited notification is defined" to "One 2595 unsolicited notification (Notice of Disconnection) is defined" in 2596 the third paragraph. For clarity and readability. 2598 C.4.7 Section 4.5.1 2599 Lightweight Directory Access Protocol Version 3 2601 - Changed "checking for the existence of the objectClass attribute" 2602 to "checking for the presence of the objectClass attribute" in the 2603 last paragraph. This was done as a measure of consistency (we use 2604 the terms present and presence rather than exists and existence in 2605 search filters). 2607 C.4.8 Section 4.5.3 2609 - Changed "outstanding search operations to different servers," to 2610 "outstanding search operations" in the fifth paragraph as they may 2611 be to the same server. This is a point of clarification. 2613 C.4.9 Section 4.6 2615 - Changed "clients MUST NOT attempt to delete" to "clients MUST NOT 2616 attempt to add or delete" in the second to last paragraph. 2617 - Change "using the "delete" form" to "using the "add" or "delete" 2618 form" in the second to last paragraph. 2620 C.4.10 Section 4.7 2622 - Changed "Clients MUST NOT supply the createTimestamp or 2623 creatorsName attributes, since these will be generated 2624 automatically by the server." to "Clients MUST NOT supply NO-USER- 2625 MODIFICATION attributes such as createTimestamp or creatorsName 2626 attributes, since these are provided by the server." in the 2627 definition of the attributes field. This tightens the language to 2628 reflect the original intent and to not leave a hole in which one 2629 could interpret the two attributes mentioned as the only non- 2630 writable attributes. 2632 C.4.11 Section 4.11 2634 - Changed "has been" to "will be" in the fourth paragraph. This 2635 clarifies that the server will (not has) abandon the operation. 2637 C.5 Changes made to draft-ietf-ldapbis-protocol-03.txt: 2639 C.5.1 Section 3.2.1 2641 - Changed "An attribute is a type with one or more associated 2642 values. The attribute type is identified by a short descriptive 2643 name and an OID (object identifier). The attribute type governs 2644 whether there can be more than one value of an attribute of that 2645 type in an entry, the syntax to which the values must conform, the 2646 kinds of matching which can be performed on values of that 2647 attribute, and other functions." to " An attribute is a 2648 description (a type and zero or more options) with one or more 2649 associated values. The attribute type governs whether the 2650 attribute can have multiple values, the syntax and matching rules 2651 used to construct and compare values of that attribute, and other 2652 functions. Options indicate modes of transfer and other 2653 Lightweight Directory Access Protocol Version 3 2655 functions.". This points out that an attribute consists of both 2656 the type and options. 2658 C.5.2 Section 4 2660 - Changed "Section 5.1 specifies the encoding rules for the LDAP 2661 protocol" to "Section 5.1 specifies how the protocol is encoded 2662 and transferred." 2664 C.5.3 Section 4.1.2 2666 - Added ABNF for the textual representation of LDAPOID. Previously, 2667 there was no formal BNF for this construct. 2669 C.5.4 Section 4.1.4 2671 - Changed "This identifier may be written as decimal digits with 2672 components separated by periods, e.g. "2.5.4.10"" to "may be 2673 written as defined by ldapOID in section 4.1.2" in the second 2674 paragraph. This was done because we now have a formal BNF 2675 definition of an oid. 2677 C.5.5 Section 4.1.5 2679 - Changed the BNF for AttributeDescription to ABNF. This was done 2680 for readability and consistency (no functional changes involved). 2681 - Changed "Options present in an AttributeDescription are never 2682 mutually exclusive." to "Options MAY be mutually exclusive. An 2683 AttributeDescription with mutually exclusive options is treated as 2684 an undefined attribute type." for clarity. It is generally 2685 understood that this is the original intent, but the wording could 2686 be easily misinterpreted. 2687 - Changed "Any option could be associated with any AttributeType, 2688 although not all combinations may be supported by a server." to 2689 "Though any option or set of options could be associated with any 2690 AttributeType, the server support for certain combinations may be 2691 restricted by attribute type, syntaxes, or other factors.". This 2692 is to clarify the meaning of 'combination' (it applies both to 2693 combination of attribute type and options, and combination of 2694 options). It also gives examples of *why* they might be 2695 unsupported. 2697 C.5.6 Section 4.1.11 2699 - Changed the wording regarding 'equally capable' referrals to "If 2700 multiple URLs are present, the client assumes that any URL may be 2701 used to progress the operation.". The previous language implied 2702 that the server MUST enforce rules that it was practically 2703 incapable of. The new language highlights the original intent-- 2704 that is, that any of the referrals may be used to progress the 2705 operation, there is no inherent 'weighting' mechanism. 2707 C.5.7 Section 4.5.1 and Appendix A 2708 Lightweight Directory Access Protocol Version 3 2710 - Added the comment "-- initial and final can occur at most once", 2711 to clarify this restriction. 2713 C.5.8 Section 5.1 2715 - Changed heading from "Mapping Onto BER-based Transport Services" 2716 to "Protocol Encoding". 2718 C.5.9 Section 5.2.1 2720 - Changed "The LDAPMessage PDUs" to "The encoded LDAPMessage PDUs" 2721 to point out that the PDUs are encoded before being streamed to 2722 TCP. 2724 C.6 Changes made to draft-ietf-ldapbis-protocol-04.txt: 2726 C.6.1 Section 4.5.1 and Appendix A 2728 - Changed the ASN.1 for the and and or choices of Filter to have a 2729 lower range of 1. This was an omission in the original ASN.1 2731 C.6.2 Various 2733 - Fixed various typo's 2735 C.7 Changes made to draft-ietf-ldapbis-protocol-05.txt: 2737 C.7.1 Section 3.2.1 2739 - Added "(as defined in Section 12.4.1 of [X.501])" to the fifth 2740 paragraph when talking about "operational attributes". This is 2741 because the term "operational attributes" is never defined. 2742 Alternately, we could drag a definition into the spec, for now, 2743 I'm just pointing to the reference in X.501. 2745 C.7.2 Section 4.1.5 2747 - Changed "And is also case insensitive" to "The entire 2748 AttributeDescription is case insensitive". This is to clarify 2749 whether we're talking about the entire attribute description, or 2750 just the options. 2752 - Expounded on the definition of attribute description options. This 2753 doc now specifies a difference between transfer and tagging 2754 options and describes the semantics of each, and how and when 2755 subtyping rules apply. Now allow options to be transmitted in any 2756 order but disallow any ordering semantics to be implied. These 2757 changes are the result of ongoing input from an engineering team 2758 designed to deal with ambiguity issues surrounding attribute 2759 options. 2761 C.7.3 Sections 4.1.5.1 and 4.1.6 2762 Lightweight Directory Access Protocol Version 3 2764 - Refer to non "binary" transfer encodings as "native encoding" 2765 rather than "string" encoding to clarify and avoid confusion. 2767 C.8 Changes made to draft-ietf-ldapbis-protocol-06.txt: 2769 C.8.1 Title 2771 - Changed to "LDAP: The Protocol" to be consisted with other working 2772 group documents 2774 C.8.2 Abstract 2776 - Moved above TOC to conform to new guidelines 2778 - Reworded to make consistent with other WG documents. 2780 - Moved 2119 conventions to "Conventions" section 2782 C.8.3 Introduction 2784 - Created to conform to new guidelines 2786 C.8.4 Models 2788 - Removed section. There is only one model in this document 2789 (Protocol Model) 2791 C.8.5 Protocol Model 2793 - Removed antiquated paragraph: "In keeping with the goal of easing 2794 the costs associated with use of the directory, it is an objective 2795 of this protocol to minimize the complexity of clients so as to 2796 facilitate widespread deployment of applications capable of using 2797 the directory." 2799 - Removed antiquated paragraph concerning LDAP v1 and v2 and 2800 referrals. 2802 C.8.6 Data Model 2804 - Removed Section 3.2 and subsections. These have been moved to 2805 [Models] 2807 C.8.7 Relationship to X.500 2809 - Removed section. It has been moved to [Roadmap] 2811 C.8.8 Server Specific Data Requirements 2813 - Removed section. It has been moved to [Models] 2815 C.8.9 Elements of Protocol 2816 Lightweight Directory Access Protocol Version 3 2818 - Added "Section 5.1 specifies how the protocol is encoded and 2819 transferred." to the end of the first paragraph for reference. 2821 - Reworded notes about extensibility, and now talk about implied 2822 extensibility and the use of ellipses in the ASN.1 2824 - Removed references to LDAPv2 in third and fourth paragraphs. 2826 C.8.10 Message ID 2828 - Reworded second paragraph to "The message ID of a request MUST 2829 have a non-zero value different from the values of any other 2830 requests outstanding in the LDAP session of which this message is 2831 a part. The zero value is reserved for the unsolicited 2832 notification message." (Added notes about non-zero and the zero 2833 value). 2835 C.8.11 String Types 2837 - Removed ABNF for LDAPOID and added "Although an LDAPOID is encoded 2838 as an OCTET STRING, values are limited to the definition of 2839 numericoid given in Section 1.3 of [Models]." 2841 C.8.12 Distinguished Name and Relative Distinguished Name 2843 - Removed ABNF and referred to [Models] and [LDAPDN] where this is 2844 defined. 2846 C.8.13 Attribute Type 2848 - Removed sections. It's now in the [Models] doc. 2850 C.8.14 Attribute Description 2852 - Removed ABNF and aligned section with [Models] 2854 - Moved AttributeDescriptionList here. 2856 C.8.15 Transfer Options 2858 - Added section and consumed much of old options language (while 2859 aligning with [Models] 2861 C.8.16 Binary Transfer Option 2863 - Clarified intent regarding exactly what is to be BER encoded. 2865 - Clarified that clients must not expect ;binary when not asking for 2866 it (;binary, as opposed to ber encoded data). 2868 C.8.17 Attribute 2870 - Use the term "attribute description" in lieu of "type" 2871 Lightweight Directory Access Protocol Version 3 2873 - Clarified the fact that clients cannot rely on any apparent 2874 ordering of attribute values. 2876 C.8.18 LDAPResult 2878 - To resultCode, added ellipses "..." to the enumeration to indicate 2879 extensibility. and added a note, pointing to [LDAPIANA] 2881 - Removed error groupings ad refer to Appendix A. 2883 C.8.19 Bind Operation 2885 - Added "Prior to the BindRequest, the implied identity is 2886 anonymous. Refer to [AuthMeth] for the authentication-related 2887 semantics of this operation." to the first paragraph. 2889 - Added ellipses "..." to AuthenticationChoice and added a note 2890 "This type is extensible as defined in Section 3.6 of [LDAPIANA]. 2891 Servers that do not support a choice supplied by a client will 2892 return authMethodNotSupported in the result code of the 2893 BindResponse." 2895 - Simplified text regarding how the server handles unknown versions. 2896 Removed references to LDAPv2 2898 C.8.20 Sequencing of the Bind Request 2900 - Aligned with [AuthMeth] In particular, paragraphs 4 and 6 were 2901 removed, while a portion of 4 was retained (see C.8.9) 2903 C.8.21 Authentication and other Security Service 2905 - Section was removed. Now in [AuthMeth] 2907 C.8.22 Continuation References in the Search Result 2909 - Added "If the originating search scope was singleLevel, the scope 2910 part of the URL will be baseObject." 2912 C.8.23 Security Considerations 2914 - Removed reference to LDAPv2 2916 C.8.24 Result Codes 2918 - Added as normative appendix A 2920 C.8.25 ASN.1 2922 - Added EXTENSIBILITY IMPLIED 2924 - Added a number of comments holding referenced to [Models] and 2925 [ISO10646]. 2927 Lightweight Directory Access Protocol Version 3 2929 - Removed AttributeType. It is not used. 2931 C.9 Changes made to draft-ietf-ldapbis-protocol-07.txt: 2933 - Removed all mention of transfer encodings and the binary attribute 2934 option. Please refer to draft-legg-ldap-binary-00.txt and draft- 2935 legg-ldap-transfer-00.txt 2937 - Further alignment with [Models]. 2939 - Added extensibility ellipsis to protocol op choice 2941 - In 4.1.1, clarified when connections may be dropped due to 2942 malformed PDUs 2944 - Specified which matching rules and syntaxes are used for various 2945 filter items 2947 C.10 Changes made to draft-ietf-ldapbis-protocol-08.txt: 2949 C.10.1 Section 4.1.1.1: 2951 - Clarified when it is and isn't appropriate to return an already 2952 used message id. 2954 C.10.2 Section 4.1.11: 2956 - Clarified that a control only applies to the message it's attached 2957 to. 2959 - Explained that the criticality field is only applicable to certain 2960 request messages. 2962 - Added language regarding the combination of controls. 2964 C.10.3 Section 4.11: 2966 - Explained that Abandon and Unbind cannot be abandoned, and 2967 illustrated how to determine whether an operation has been 2968 abandoned. 2970 C.11 Changes made to draft-ietf-ldapbis-protocol-09.txt: 2972 - Fixed formatting 2974 C.12 Changes made to draft-ietf-ldapbis-protocol-10.txt: 2976 C.12.1 Section 4.1.4: 2978 - Removed second paragraph as this language exists in MODELS 2979 Lightweight Directory Access Protocol Version 3 2981 C.12.2 Section 4.2.1: 2983 - Replaced fourth paragraph. It was accidentally removed in an 2984 earlier edit. 2986 C.12.2 Section 4.13: 2988 - Added section describing the StartTLS operation (moved from 2989 authmeth) 2991 C.13 Changes made to draft-ietf-ldapbis-protocol-11.txt: 2993 C.13.1 Section 4.1.9 2995 - Changed "errorMessage" to "diagnosticMessage". Simply to indicate 2996 that the field may be non-empty even if a non-error resultCode is 2997 present. 2999 C.13.2 Section 4.2: 3001 - Reconciled language in "name" definition with [AuthMeth] 3003 C.13.3 Section 4.2.1 3005 - Renamed to "Processing of the Bind Request", and moved some text 3006 from 4.2 into this section. 3008 - Rearranged paragraphs to flow better. 3010 - Specified that (as well as failed) an abandoned bind operation 3011 will leave the connection in an anonymous state. 3013 C.13.4 Section 4.5.3 3015 - Generalized the second paragraph which cited indexing and 3016 searchreferralreferences. 3018 C.14 Changes made to draft-ietf-ldapbis-protocol-12.txt: 3020 - Reworked bind errors. 3021 - General clarifications and edits 3023 C.15 Changes made to draft-ietf-ldapbis-protocol-13.txt 3025 C.15.1 Section 2 & various 3026 - Added definitions for LDAP connection, TLS connection, and LDAP 3027 association, and updated appropriate fields to use proper terms. 3029 C.15.2 Section 4.2 3030 - Added text to authentication, specifying the way in which textual 3031 strings used as passwords are to be prepared. 3033 Lightweight Directory Access Protocol Version 3 3035 C.15.3 Section 4.5.1 3036 - Clarified derefInSearching. Specifically how it works in terms of 3037 subtree and one level searches 3039 C.15.4 Section 4.5.2 3041 - Changed MUST to SHOULD for returning textual attribute name, The 3042 MUST is unreasonable. There are likely cases (such as when the 3043 server knows multiple attributes in separate entries of a search 3044 result set share the same short name) where returning a numericoid 3045 is better than returning a short name. That is, the MUST may 3046 actually disallow servers from preventing misinterpretation of 3047 short names. This is not only an interop issue, but likely a 3048 security consideration. 3050 C.15.4 Section 4.9 3051 - Made modify consistent with add in regards to teh need of parent 3052 entries already existing. 3054 C.15.6 Section 4.13.2.2 3055 - Removed wording indicating that referrals can be returned from 3056 StartTLS 3058 C.16 Changes made to draft-ietf-ldapbis-protocol-14.txt 3060 C.16.1 Section 4.1.9 3062 - Added: If a server detects multiple errors for an operation, only 3063 one resultCode is returned. The server should return the 3064 resultCode that best indicates the nature of the error 3065 encountered. 3067 C.16.2 Section 4.1.11 3068 - Added: controlValues that are defined in terms of ASN.1 and BER 3069 encoded according to Section 5.1, also follow the extensibility 3070 rules in Section 4. 3072 - Removed: "If a SASL transfer encryption or integrity mechanism has 3073 been negotiated, that mechanism does not support the changing of 3074 credentials from one identity to another, then the client MUST 3075 instead establish a new connection." 3077 Each SASL negotiation is, generally, independent of other SASL 3078 negotiations. If there were dependencies between multiple 3079 negotiations of a particular mechanism, the mechanism technical 3080 specification should detail how applications are to deal with 3081 them. LDAP should not require any special handling. And if an LDAP 3082 client had used such a mechanism, it would have the option of 3083 using another mechanism. 3085 C.16.3 Section 4.5.2 and Section 7 3086 - Removed: "If the LDAP association is operating over a connection- 3087 oriented transport such as TCP" 3088 Lightweight Directory Access Protocol Version 3 3090 This is always true. 3092 C.16.4 Section 4.11 3093 - Added: thus a client SHOULD NOT use the Abandon operation when it 3094 needs an indication of whether the operation was abandoned. For 3095 example, if a client performs an update operation (Add, Modify, or 3096 ModifyDN), and it needs to know whether the directory has changed 3097 due to the operation, it should not use the Abandon operation to 3098 cancel the update operation. Clients can determine that an 3099 operation has been abandoned by performing a subsequent bind 3100 operation. 3102 C.16.5 Section 4.12 3104 - Added: 3105 "The requestValue and responseValue fields contain any information 3106 associated with the operation. The format of these fields is 3107 defined by the specification of the extended operation. 3108 Implementations MUST be prepared to handle arbitrary contents of 3109 these fields, including zero bytes. Values that are defined in 3110 terms of ASN.1 and BER encoded according to Section 5.1, also 3111 follow the extensibility rules in Section 4. 3113 Extended operations may be specified in other documents. The 3114 specification of an extended operation consists of: 3116 - the OBJECT IDENTIFIER assigned to the 3117 ExtendedRequest.requestName (and possibly 3118 ExtendedResponse.responseName), 3120 - the format of the contents of the requestValue and responseValue 3121 (if any), 3123 - the semantics of the operation, 3125 Servers list the requestName of all ExtendedRequests they 3126 recognize in the supportedExtension attribute [Models] in the root 3127 DSE. 3129 requestValues and responseValues that are defined in terms of 3130 ASN.1 and BER encoded according to Section 5.1, also follow the 3131 extensibility rules in Section 4." 3133 This was to align with controls and control values. 3135 C.16.6 Section 4.13.3.1 3137 - Added: After the TLS connection has been closed, the server MUST 3138 NOT send responses to any request message received before the TLS 3139 closure. 3141 C.16.7 Section A2 3142 - Removed precedence rules 3143 Lightweight Directory Access Protocol Version 3 3145 Appendix D - Outstanding Work Items 3147 D.0 General 3148 - Integrate notational consistency agreements WG will discuss 3149 notation consistency. Once agreement happens, reconcile draft. 3151 - Reconcile problems with [Models]. Section 3.2 was wholly removed. 3152 There were some protocol semantics in that section that need to be 3153 brought back. Specifically, there was the notion of the server 3154 implicitly adding objectclass superclasses when a value is added. 3156 D.1 Make result code usage consistent. 3158 - While there is a result code appendix, ensure it speaks of result 3159 codes in a general sense, and only highlight specific result codes 3160 in the context of an operation when that operation ties more 3161 specific meanings to that result code. 3163 D.2 Verify references. 3165 - Many referenced documents have changed. Ensure references and 3166 section numbers are correct. 3168 D.3 Review 2119 usage 3170 D.4 Reconcile with I-D Nits 3172 D.5 Section 4.6 3174 - Resolve the meaning of "and is ignored if the attribute does not 3175 exist". See "modify: "non-existent attribute"" on the list. Not 3176 sure if there's really an issue here. Will look at archive 3178 D.6 Section 4.10 3180 - Specify what happens when the attr is missing vs. attr isn't in 3181 schema. Also what happens if there's no equality matching rule. 3182 noSuchAttribute, undefinedAttributeType, inappropriateMatching 3184 D.7 Section 6.1 3186 - Add "that are used by those attributes" to the first paragraph. 3187 - Add "Servers which support update operations MUST, and other 3188 servers SHOULD, support strong authentication mechanisms described 3189 in [RFC2829]." as a second paragraph. Likely should just say 3190 Requirements of authentication methods, SASL mechanisms, and TLS 3191 are described in [AUTHMETH]." (also apply to next two below) 3192 - Add "Servers which provide access to sensitive information MUST, 3193 and other servers SHOULD support privacy protections such as those 3194 described in [RFC2829] and [RFC2830]." as a third paragraph. 3196 Lightweight Directory Access Protocol Version 3 3198 D.8 Section 7 3200 - Add "Servers which support update operations MUST, and other 3201 servers SHOULD, support strong authentication mechanisms described 3202 in [RFC2829]." as a fourth paragraph. 3203 - Add "In order to automatically follow referrals, clients may need 3204 to hold authentication secrets. This poses significant privacy and 3205 security concerns and SHOULD be avoided." as a sixth paragraph. 3206 There are concerns with "automatic" chasing regardless of which, 3207 if any, authentication method/mechanism is used. 3209 - Add notes regarding DoS attack found by CERT advisories. 3211 D.9 Various issues on ldapbis mailing list (some may already be 3212 resolved) 3214 - "Attribute Name Length Bounds" thread. 3216 - "Extensibility of SearchRequest.attributes" thread 3217 Lightweight Directory Access Protocol Version 3 3219 Full Copyright Statement 3221 Copyright (C) The Internet Society (2002). All Rights Reserved. 3223 This document and translations of it may be copied and furnished to 3224 others, and derivative works that comment on or otherwise explain it 3225 or assist in its implementation may be prepared, copied, published 3226 and distributed, in whole or in part, without restriction of any 3227 kind, provided that the above copyright notice and this paragraph are 3228 included on all such copies and derivative works. However, this 3229 document itself may not be modified in any way, such as by removing 3230 the copyright notice or references to the Internet Society or other 3231 Internet organizations, except as needed for the purpose of 3232 developing Internet standards in which case the procedures for 3233 copyrights defined in the Internet Standards process must be 3234 followed, or as required to translate it into languages other than 3235 English. 3237 The limited permissions granted above are perpetual and will not be 3238 revoked by the Internet Society or its successors or assigns. 3240 This document and the information contained herein is provided on an 3241 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 3242 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 3243 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 3244 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 3245 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.