idnits 2.17.1 draft-ietf-ldapbis-protocol-16.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 == 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 2432 -- Looks like a reference, but probably isn't: '3' on line 2369 == Missing Reference: 'LDAPURL' is mentioned on line 3182, but not defined == Missing Reference: 'APPLICATION 0' is mentioned on line 2305, but not defined == Missing Reference: 'SASLprep' is mentioned on line 676, but not defined == Missing Reference: 'APPLICATION 1' is mentioned on line 2320, but not defined -- Looks like a reference, but probably isn't: '7' on line 2353 == Missing Reference: 'APPLICATION 2' is mentioned on line 2324, but not defined == Missing Reference: 'APPLICATION 3' is mentioned on line 2326, but not defined -- Looks like a reference, but probably isn't: '1' on line 2433 -- Looks like a reference, but probably isn't: '2' on line 2368 -- Looks like a reference, but probably isn't: '4' on line 2370 -- Looks like a reference, but probably isn't: '5' on line 2351 -- Looks like a reference, but probably isn't: '6' on line 2352 -- Looks like a reference, but probably isn't: '8' on line 2354 -- Looks like a reference, but probably isn't: '9' on line 2355 == Missing Reference: 'APPLICATION 4' is mentioned on line 2372, but not defined == Missing Reference: 'APPLICATION 19' is mentioned on line 2380, but not defined == Missing Reference: 'APPLICATION 5' is mentioned on line 2382, but not defined == Missing Reference: 'APPLICATION 6' is mentioned on line 2384, but not defined == Missing Reference: 'APPLICATION 7' is mentioned on line 2399, but not defined == Missing Reference: 'APPLICATION 8' is mentioned on line 2401, but not defined == Missing Reference: 'APPLICATION 9' is mentioned on line 2409, but not defined == Missing Reference: 'APPLICATION 10' is mentioned on line 2411, but not defined == Missing Reference: 'APPLICATION 11' is mentioned on line 2413, but not defined == Missing Reference: 'APPLICATION 12' is mentioned on line 2415, but not defined == Missing Reference: 'APPLICATION 13' is mentioned on line 2421, but not defined == Missing Reference: 'APPLICATION 14' is mentioned on line 2423, but not defined == Missing Reference: 'APPLICATION 15' is mentioned on line 2427, but not defined == Missing Reference: 'APPLICATION 16' is mentioned on line 2429, but not defined == Missing Reference: 'APPLICATION 23' is mentioned on line 2431, but not defined == Missing Reference: 'APPLICATION 24' is mentioned on line 2435, but not defined -- Looks like a reference, but probably isn't: '10' on line 2437 -- Looks like a reference, but probably isn't: '11' on line 2438 == Missing Reference: 'RFC2246' is mentioned on line 1950, but not defined ** Obsolete undefined reference: RFC 2246 (Obsoleted by RFC 4346) == Missing Reference: 'AUTHMETH' is mentioned on line 3172, but not defined == Unused Reference: 'SASLPrep' is defined on line 1874, but no explicit reference was found in the text == Unused Reference: 'IP' is defined on line 1889, 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' -- Possible downref: Non-RFC (?) normative reference: ref. 'TCP' -- Possible downref: Non-RFC (?) normative reference: ref. 'IP' Summary: 6 errors (**), 0 flaws (~~), 29 warnings (==), 32 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-16.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....................................................3 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.............................................25 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. Informative References........................................36 84 11. Editor's Address..............................................36 85 Appendix A - LDAP Result Codes....................................37 86 A.1 Non-Error Result Codes........................................37 87 A.2 Result Codes..................................................37 88 Appendix C - Change History.......................................48 89 C.1 Changes made to RFC 2251:.....................................48 90 C.2 Changes made to draft-ietf-ldapbis-protocol-00.txt:...........48 91 C.3 Changes made to draft-ietf-ldapbis-protocol-01.txt:...........49 92 C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt:...........49 93 C.5 Changes made to draft-ietf-ldapbis-protocol-03.txt:...........51 94 C.6 Changes made to draft-ietf-ldapbis-protocol-04.txt:...........53 95 C.7 Changes made to draft-ietf-ldapbis-protocol-05.txt:...........53 96 C.8 Changes made to draft-ietf-ldapbis-protocol-06.txt:...........54 97 C.9 Changes made to draft-ietf-ldapbis-protocol-07.txt:...........57 98 C.10 Changes made to draft-ietf-ldapbis-protocol-08.txt:..........57 99 C.11 Changes made to draft-ietf-ldapbis-protocol-09.txt:..........57 100 C.12 Changes made to draft-ietf-ldapbis-protocol-10.txt:..........57 101 C.13 Changes made to draft-ietf-ldapbis-protocol-11.txt:..........58 102 C.14 Changes made to draft-ietf-ldapbis-protocol-12.txt:..........58 103 C.15 Changes made to draft-ietf-ldapbis-protocol-13.txt...........58 104 C.16 Changes made to draft-ietf-ldapbis-protocol-14.txt...........59 105 C.17 Changes made to draft-ietf-ldapbis-protocol-15.txt...........61 106 Appendix D - Outstanding Work Items...............................61 107 Lightweight Directory Access Protocol Version 3 109 1. Introduction 111 The Directory is "a collection of open systems cooperating to provide 112 directory services" [X.500]. A Directory user, which may be a human 113 or other entity, accesses the Directory through a client (or 114 Directory User Agent (DUA)). The client, on behalf of the directory 115 user, interacts with one or more servers (or Directory System Agents 116 (DSA)). Clients interact with servers using a directory access 117 protocol. 119 This document details the protocol elements of Lightweight Directory 120 Access Protocol, along with their semantics. Following the 121 description of protocol elements, it describes the way in which the 122 protocol is encoded and transferred. 124 This document is an integral part of the LDAP Technical Specification 125 [Roadmap]. 127 This document replaces RFC 2251. Appendix C holds a detailed log of 128 changes to RFC 2251. Prior to Working Group Last Call, this appendix 129 will be distilled to a summary of changes to RFC 2251. 131 2. Conventions 133 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 134 "SHOULD", "SHOULD NOT", "RECOMMENDED", and "MAY" in this document are 135 to be interpreted as described in [RFC2119]. 136 The terms "connection" and "LDAP connection" both refer to the 137 underlying transport protocol connection between two protocol peers. 138 The term "TLS connection" refers to a TLS-protected LDAP connection. 139 The terms "association" and "LDAP association" both refer to the 140 association of the LDAP connection and its current authentication and 141 authorization state. 143 3. Protocol Model 145 The general model adopted by this protocol is one of clients 146 performing protocol operations against servers. In this model, a 147 client transmits a protocol request describing the operation to be 148 performed to a server. The server is then responsible for performing 149 the necessary operation(s) in the directory. Upon completion of the 150 operation(s), the server returns a response containing an appropriate 151 result code to the requesting client. 153 Although servers are required to return responses whenever such 154 responses are defined in the protocol, there is no requirement for 155 synchronous behavior on the part of either clients or servers. 156 Requests and responses for multiple operations may be exchanged 157 between a client and server in any order, provided the client 158 eventually receives a response for every request that requires one. 160 Lightweight Directory Access Protocol Version 3 162 The core protocol operations defined in this document can be mapped 163 to a subset of the X.500(1997) directory abstract service. However 164 there is not a one-to-one mapping between LDAP protocol operations 165 and DAP operations. Server implementations acting as a gateway to 166 X.500 directories may need to make multiple DAP requests. 168 4. Elements of Protocol 170 The LDAP protocol is described using Abstract Syntax Notation 1 171 (ASN.1) [X.680], and is transferred using a subset of ASN.1 Basic 172 Encoding Rules [X.690]. Section 5.1 specifies how the protocol is 173 encoded and transferred. 175 In order to support future Standards Track extensions to this 176 protocol, extensibility is implied where it is allowed (per ASN.1). 177 In addition, ellipses (...) have been supplied in ASN.1 types that 178 are explicitly extensible as discussed in [LDAPIANA]. Because of the 179 implied extensibility, clients and servers MUST ignore trailing 180 SEQUENCE elements whose tags they do not recognize. 182 Changes to the LDAP protocol other than through the extension 183 mechanisms described here require a different version number. A 184 client indicates the version it is using as part of the bind request, 185 described in section 4.2. If a client has not sent a bind, the server 186 MUST assume the client is using version 3 or later. 188 Clients may determine the protocol versions a server supports by 189 reading the supportedLDAPVersion attribute from the root DSE 190 [Models]. Servers which implement version 3 or later MUST provide 191 this attribute. 193 4.1. Common Elements 195 This section describes the LDAPMessage envelope PDU (Protocol Data 196 Unit) format, as well as data type definitions, which are used in the 197 protocol operations. 199 4.1.1. Message Envelope 201 For the purposes of protocol exchanges, all protocol operations are 202 encapsulated in a common envelope, the LDAPMessage, which is defined 203 as follows: 205 LDAPMessage ::= SEQUENCE { 206 messageID MessageID, 207 protocolOp CHOICE { 208 bindRequest BindRequest, 209 bindResponse BindResponse, 210 unbindRequest UnbindRequest, 211 searchRequest SearchRequest, 212 searchResEntry SearchResultEntry, 213 Lightweight Directory Access Protocol Version 3 215 searchResDone SearchResultDone, 216 searchResRef SearchResultReference, 217 modifyRequest ModifyRequest, 218 modifyResponse ModifyResponse, 219 addRequest AddRequest, 220 addResponse AddResponse, 221 delRequest DelRequest, 222 delResponse DelResponse, 223 modDNRequest ModifyDNRequest, 224 modDNResponse ModifyDNResponse, 225 compareRequest CompareRequest, 226 compareResponse CompareResponse, 227 abandonRequest AbandonRequest, 228 extendedReq ExtendedRequest, 229 extendedResp ExtendedResponse, 230 ... }, 231 controls [0] Controls OPTIONAL } 233 MessageID ::= INTEGER (0 .. maxInt) 235 maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- 237 The function of the LDAPMessage is to provide an envelope containing 238 common fields required in all protocol exchanges. At this time the 239 only common fields are the message ID and the controls. 241 If the server receives a PDU from the client in which the LDAPMessage 242 SEQUENCE tag cannot be recognized, the messageID cannot be parsed, 243 the tag of the protocolOp is not recognized as a request, or the 244 encoding structures or lengths of data fields are found to be 245 incorrect, then the server MAY return the Notice of Disconnection 246 described in section 4.4.1, with the resultCode set to protocolError, 247 and MUST immediately close the connection. 249 In other cases where the client or server cannot parse a PDU, it 250 SHOULD abruptly close the connection where further communication 251 (including providing notice) would be pernicious. Otherwise, server 252 implementations MUST return an appropriate response to the request, 253 with the resultCode set to protocolError. 255 The ASN.1 type Controls is defined in section 4.1.11. 257 4.1.1.1. Message ID 259 All LDAPMessage envelopes encapsulating responses contain the 260 messageID value of the corresponding request LDAPMessage. 262 The message ID of a request MUST have a non-zero value different from 263 the values of any other requests outstanding in the LDAP association 264 of which this message is a part. The zero value is reserved for the 265 unsolicited notification message. 267 Typical clients increment a counter for each request. 269 Lightweight Directory Access Protocol Version 3 271 A client MUST NOT send a request with the same message ID as an 272 earlier request on the same LDAP association unless it can be 273 determined that the server is no longer servicing the earlier 274 request. Otherwise the behavior is undefined. For operations that do 275 not return responses (unbind, abandon, and abandoned operations), the 276 client SHOULD assume the operation is in progress until a subsequent 277 bind request completes. 279 4.1.2. String Types 281 The LDAPString is a notational convenience to indicate that, although 282 strings of LDAPString type encode as OCTET STRING types, the 283 [ISO10646] character set (a superset of [Unicode]) is used, encoded 284 following the UTF-8 algorithm [RFC2279]. Note that in the UTF-8 285 algorithm characters which are the same as ASCII (0x0000 through 286 0x007F) are represented as that same ASCII character in a single 287 byte. The other byte values are used to form a variable-length 288 encoding of an arbitrary character. 290 LDAPString ::= OCTET STRING -- UTF-8 encoded, 291 -- ISO 10646 characters 293 The LDAPOID is a notational convenience to indicate that the 294 permitted value of this string is a (UTF-8 encoded) dotted-decimal 295 representation of an OBJECT IDENTIFIER. Although an LDAPOID is 296 encoded as an OCTET STRING, values are limited to the definition of 297 numericoid given in Section 1.3 of [Models]. 299 LDAPOID ::= OCTET STRING -- Constrained to numericoid [Models] 301 For example, 303 1.3.6.1.4.1.1466.1.2.3 305 4.1.3. Distinguished Name and Relative Distinguished Name 307 An LDAPDN and a RelativeLDAPDN are respectively defined to be the 308 representation of a distinguished-name and a relative-distinguished- 309 name after encoding according to the specification in [LDAPDN]. 311 LDAPDN ::= LDAPString 312 -- Constrained to distinguishedName [LDAPDN] 314 RelativeLDAPDN ::= LDAPString 315 -- Constrained to name-component [LDAPDN] 317 4.1.4. Attribute Descriptions 318 Lightweight Directory Access Protocol Version 3 320 The definition and encoding rules for attribute descriptions are 321 defined in Section 2.5 of [Models]. Briefly, an attribute description 322 is an attribute type and zero or more options. 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 Lightweight Directory Access Protocol Version 3 374 matching rule for an attribute is used when performing a Compare 375 operation. Often this is the same syntax used for values of the 376 attribute type, but in some cases the assertion syntax differs from 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 4.1.9. Result Message 408 The LDAPResult is the construct used in this protocol to return 409 success or failure indications from servers to clients. To various 410 requests, servers will return responses of LDAPResult or responses 411 containing the components of LDAPResult to indicate the final status 412 of a protocol operation request. 414 LDAPResult ::= SEQUENCE { 415 resultCode ENUMERATED { 416 success (0), 417 operationsError (1), 418 protocolError (2), 419 timeLimitExceeded (3), 420 sizeLimitExceeded (4), 421 compareFalse (5), 422 compareTrue (6), 423 authMethodNotSupported (7), 424 strongAuthRequired (8), 425 Lightweight Directory Access Protocol Version 3 427 -- 9 reserved -- 428 referral (10), 429 adminLimitExceeded (11), 430 unavailableCriticalExtension (12), 431 confidentialityRequired (13), 432 saslBindInProgress (14), 433 noSuchAttribute (16), 434 undefinedAttributeType (17), 435 inappropriateMatching (18), 436 constraintViolation (19), 437 attributeOrValueExists (20), 438 invalidAttributeSyntax (21), 439 -- 22-31 unused -- 440 noSuchObject (32), 441 aliasProblem (33), 442 invalidDNSyntax (34), 443 -- 35 reserved for undefined isLeaf -- 444 aliasDereferencingProblem (36), 445 -- 37-47 unused -- 446 inappropriateAuthentication (48), 447 invalidCredentials (49), 448 insufficientAccessRights (50), 449 busy (51), 450 unavailable (52), 451 unwillingToPerform (53), 452 loopDetect (54), 453 -- 55-63 unused -- 454 namingViolation (64), 455 objectClassViolation (65), 456 notAllowedOnNonLeaf (66), 457 notAllowedOnRDN (67), 458 entryAlreadyExists (68), 459 objectClassModsProhibited (69), 460 -- 70 reserved for CLDAP -- 461 affectsMultipleDSAs (71), 462 -- 72-79 unused -- 463 other (80), 464 ... }, 465 -- 81-90 reserved for APIs -- 466 matchedDN LDAPDN, 467 diagnosticMessage LDAPString, 468 referral [3] Referral OPTIONAL } 470 The resultCode enumeration is extensible as defined in Section 3.5 of 471 [LDAPIANA]. The meanings of the result codes are given in Appendix A. 472 If a server detects multiple errors for an operation, only one result 473 code is returned. The server should return the result code that best 474 indicates the nature of the error encountered. 476 The diagnosticMessage field of this construct may, at the server's 477 option, be used to return a string containing a textual, human- 478 readable (terminal control and page formatting characters should be 479 avoided) diagnostic message. As this diagnostic message is not 480 standardized, implementations MUST NOT rely on the values returned. 482 Lightweight Directory Access Protocol Version 3 484 If the server chooses not to return a textual diagnostic, the 485 diagnosticMessage field of the LDAPResult type MUST contain a zero 486 length string. 488 For certain result codes (typically, but not restricted to 489 noSuchObject, aliasProblem, invalidDNSyntax and 490 aliasDereferencingProblem), the matchedDN field is set to the name of 491 the lowest entry (object or alias) in the directory that was matched. 492 If no aliases were dereferenced while attempting to locate the entry, 493 this will be a truncated form of the name provided, or if aliases 494 were dereferenced, of the resulting name, as defined in section 12.5 495 of [X.511]. Unless otherwise defined, the matchedDN field contains a 496 zero length string with all other result codes. 498 4.1.10. Referral 500 The referral result code indicates that the contacted server does not 501 hold the target entry of the request. The referral field is present 502 in an LDAPResult if the resultCode field value is referral, and 503 absent with all other result codes. It contains one or more 504 references to one or more servers or services that may be accessed 505 via LDAP or other protocols. Referrals can be returned in response to 506 any operation request (except unbind and abandon which do not have 507 responses). At least one URL MUST be present in the Referral. 509 During a search operation, after the baseObject is located, and 510 entries are being evaluated, the referral is not returned. Instead, 511 continuation references, described in section 4.5.3, are returned 512 when the search scope spans multiple naming contexts, and several 513 different servers would need to be contacted to complete the 514 operation. 516 Referral ::= SEQUENCE OF URL -- one or more 518 URL ::= LDAPString -- limited to characters permitted in 519 -- URLs 521 If the client wishes to progress the operation, it MUST follow the 522 referral by contacting one of the servers. If multiple URLs are 523 present, the client assumes that any URL may be used to progress the 524 operation. 526 URLs for servers implementing LDAP and accessible via [TCP]/[IP] (v4 527 or v6) are written according to [LDAPURL]. If an alias was 528 dereferenced, the part of the URL MUST be present, with the new 529 target object name. If the part is present, the client MUST use 530 this name in its next request to progress the operation, and if it is 531 not present the client will use the same name as in the original 532 request. Some servers (e.g. participating in distributed indexing) 533 may provide a different filter in a referral for a search operation. 534 If the filter part of the LDAP URL is present, the client MUST use 535 this filter in its next request to progress this search, and if it is 536 not present the client MUST use the same filter as it used for that 537 Lightweight Directory Access Protocol Version 3 539 search. Other aspects of the new request may be the same or different 540 as the request which generated the referral. 542 Note that UTF-8 characters appearing in a DN or search filter may not 543 be legal for URLs (e.g. spaces) and MUST be escaped using the % 544 method in [RFC2396]. 546 Other kinds of URLs may be returned, so long as the operation could 547 be performed using that protocol. 549 4.1.11. Controls 551 A control is a way to specify extension information for an LDAP 552 message. A control only alters the semantics of the message it is 553 attached to. 555 Controls ::= SEQUENCE OF Control 557 Control ::= SEQUENCE { 558 controlType LDAPOID, 559 criticality BOOLEAN DEFAULT FALSE, 560 controlValue OCTET STRING OPTIONAL } 562 The controlType field MUST be a UTF-8 encoded dotted-decimal 563 representation of an OBJECT IDENTIFIER which uniquely identifies the 564 control. This prevents conflicts between control names. 566 The criticality field is either TRUE or FALSE and only applies to 567 request messages that have a corresponding response message. For all 568 other messages (such as abandonRequest, unbindRequest and all 569 response messages), the criticality field is treated as FALSE. 571 If the server recognizes the control type and it is appropriate for 572 the operation, the server will make use of the control when 573 performing the operation. 575 If the server does not recognize the control type or it is not 576 appropriate for the operation, and the criticality field is TRUE, the 577 server MUST NOT perform the operation, and MUST instead set the 578 resultCode to unavailableCriticalExtension. 580 If the control is unrecognized or inappropriate but the criticality 581 field is FALSE, the server MUST ignore the control. 583 The controlValue contains any information associated with the 584 control. Its format is defined by the specification of the control. 585 Implementations MUST be prepared to handle arbitrary contents of the 586 controlValue octet string, including zero bytes. It is absent only if 587 there is no value information which is associated with a control of 588 its type. controlValues that are defined in terms of ASN.1 and BER 589 encoded according to Section 5.1, also follow the extensibility rules 590 in Section 4. 592 Lightweight Directory Access Protocol Version 3 594 This document does not specify any controls. Controls may be 595 specified in other documents. The specification of a control consists 596 of: 598 - the OBJECT IDENTIFIER assigned to the control, 600 - whether the control is always noncritical, always critical, or 601 critical at the client's option, 603 - the format of the controlValue contents of the control, 605 - the semantics of the control, 607 - and optionally, semantics regarding the combination of the control 608 with other controls. 610 Servers list the controlType of all request controls they recognize 611 in the supportedControl attribute [Models] in the root DSE. 613 Controls should not be combined unless the semantics of the 614 combination has been specified. The semantics of control 615 combinations, if specified, are generally found in the control 616 specification most recently published. In the absence of combination 617 semantics, the behavior of the operation is undefined. 618 Additionally, the order of a combination of controls in the SEQUENCE 619 is ignored unless the control specification(s) describe(s) 620 combination semantics. 622 4.2. Bind Operation 624 The function of the Bind Operation is to allow authentication 625 information to be exchanged between the client and server. Prior to 626 the first BindRequest, the implied identity is anonymous. Refer to 627 [AuthMeth] for the authentication-related semantics of this 628 operation. 630 The Bind Request is defined as follows: 632 BindRequest ::= [APPLICATION 0] SEQUENCE { 633 version INTEGER (1 .. 127), 634 name LDAPDN, 635 authentication AuthenticationChoice } 637 AuthenticationChoice ::= CHOICE { 638 simple [0] OCTET STRING, 639 -- 1 and 2 reserved 640 sasl [3] SaslCredentials, 641 ... } 643 SaslCredentials ::= SEQUENCE { 644 mechanism LDAPString, 645 credentials OCTET STRING OPTIONAL } 646 Lightweight Directory Access Protocol Version 3 648 Parameters of the Bind Request are: 650 - version: A version number indicating the version of the protocol 651 to be used in this protocol association. This document describes 652 version 3 of the LDAP protocol. Note that there is no version 653 negotiation, and the client just sets this parameter to the 654 version it desires. If the server does not support the specified 655 version, it MUST respond with protocolError in the resultCode 656 field of the BindResponse. 658 - name: The name of the directory object that the client wishes to 659 bind as. This field may take on a null value (a zero length 660 string) for the purposes of anonymous binds ([AuthMeth] section 7) 661 or when using SASL authentication ([AuthMeth] section 4.3). Server 662 behavior is undefined when the name is a null value, simple 663 authentication is used, and a password is specified. The server 664 SHOULD NOT perform any alias dereferencing in determining the 665 object to bind as. 667 - authentication: information used to authenticate the name, if any, 668 provided in the Bind Request. This type is extensible as defined 669 in Section 3.6 of [LDAPIANA]. Servers that do not support a choice 670 supplied by a client will return authMethodNotSupported in the 671 resultCode field of the BindResponse. The simple form of an 672 AuthenticationChoice specifies a simple password to be used for 673 authentication. To improve matching, applications SHOULD prepare 674 textual strings used as passwords. Applications which prepare 675 textural strings used as password are REQUIRED to prepare them by 676 transcoding the string to [Unicode], apply [SASLprep], and encode 677 as UTF-8. 679 Authorization is the use of this authentication information when 680 performing operations. Authorization MAY be affected by factors 681 outside of the LDAP Bind Request, such as lower layer security 682 services. 684 4.2.1. Processing of the Bind Request 686 Upon receipt of a BindRequest, the server MUST ensure there are no 687 outstanding operations in progress on the connection (this simplifies 688 server implementation). To do this, the server may cause them to be 689 abandoned or allow them to finish. The server then proceeds to 690 authenticate the client in either a single-step, or multi-step bind 691 process. Each step requires the server to return a BindResponse to 692 indicate the status of authentication. 694 If the client did not bind before sending a request and receives an 695 operationsError, it may then send a Bind Request. If this also fails 696 or the client chooses not to bind on the existing connection, it may 697 close the connection, reopen it and begin again by first sending a 698 PDU with a Bind Request. This will aid in interoperating with servers 699 implementing other versions of LDAP. 701 Lightweight Directory Access Protocol Version 3 703 Clients MAY send multiple Bind Requests on a connection to change 704 their credentials. Authentication from earlier binds is subsequently 705 ignored. A failed or abandoned Bind Operation has the effect of 706 leaving the LDAP association in an anonymous state. To arrive at a 707 known authentication state after abandoning a bind operation, clients 708 may unbind, rebind, or make use of the BindResponse. 710 For some SASL authentication mechanisms, it may be necessary for the 711 client to invoke the BindRequest multiple times. This is indicated by 712 the server sending a BindResponse with the resultCode set to 713 saslBindInProgress. This indicates that the server requires the 714 client to send a new bind request, with the same sasl mechanism, to 715 continue the authentication process. If at any stage the client 716 wishes to abort the bind process it MAY unbind and then drop the 717 underlying connection. Clients MUST NOT invoke operations between two 718 Bind Requests made as part of a multi-stage bind. 720 A client may abort a SASL bind negotiation by sending a BindRequest 721 with a different value in the mechanism field of SaslCredentials, or 722 an AuthenticationChoice other than sasl. 724 If the client sends a BindRequest with the sasl mechanism field as an 725 empty string, the server MUST return a BindResponse with 726 authMethodNotSupported as the resultCode. This will allow clients to 727 abort a negotiation if it wishes to try again with the same SASL 728 mechanism. 730 4.2.2. Bind Response 732 The Bind Response is defined as follows. 734 BindResponse ::= [APPLICATION 1] SEQUENCE { 735 COMPONENTS OF LDAPResult, 736 serverSaslCreds [7] OCTET STRING OPTIONAL } 738 BindResponse consists simply of an indication from the server of the 739 status of the client's request for authentication. 741 A successful bind operation is indicated by a BindResponse with a 742 resultCode set to success. Otherwise, an appropriate result code is 743 set in the BindResponse. For bind, the protocolError result code may 744 be used to indicate that the version number supplied by the client is 745 unsupported. 747 If the client receives a BindResponse response where the resultCode 748 field is protocolError, it MUST close the connection as the server 749 will be unwilling to accept further operations. (This is for 750 compatibility with earlier versions of LDAP, in which the bind was 751 always the first operation, and there was no negotiation.) 753 The serverSaslCreds are used as part of a SASL-defined bind mechanism 754 to allow the client to authenticate the server to which it is 755 communicating, or to perform "challenge-response" authentication. If 756 Lightweight Directory Access Protocol Version 3 758 the client bound with the simple choice, or the SASL mechanism does 759 not require the server to return information to the client, then this 760 field is not to be included in the BindResponse. 762 4.3. Unbind Operation 764 The function of the Unbind Operation is to terminate an LDAP 765 association and connection. The Unbind Operation is defined as 766 follows: 768 UnbindRequest ::= [APPLICATION 2] NULL 770 The Unbind Operation has no response defined. Upon transmission of an 771 UnbindRequest, a protocol client MUST assume that the LDAP 772 association is terminated. Upon receipt of an UnbindRequest, a 773 protocol server MUST assume that the requesting client has terminated 774 the association and that all outstanding requests may be discarded, 775 and MUST close the connection. 777 4.4. Unsolicited Notification 779 An unsolicited notification is an LDAPMessage sent from the server to 780 the client which is not in response to any LDAPMessage received by 781 the server. It is used to signal an extraordinary condition in the 782 server or in the connection between the client and the server. The 783 notification is of an advisory nature, and the server will not expect 784 any response to be returned from the client. 786 The unsolicited notification is structured as an LDAPMessage in which 787 the messageID is 0 and protocolOp is of the extendedResp form. The 788 responseName field of the ExtendedResponse is present. The LDAPOID 789 value MUST be unique for this notification, and not be used in any 790 other situation. 792 One unsolicited notification (Notice of Disconnection) is defined in 793 this document. 795 4.4.1. Notice of Disconnection 797 This notification may be used by the server to advise the client that 798 the server is about to close the connection due to an error 799 condition. Note that this notification is NOT a response to an unbind 800 requested by the client: the server MUST follow the procedures of 801 section 4.3. This notification is intended to assist clients in 802 distinguishing between an error condition and a transient network 803 failure. As with a connection close due to network failure, the 804 client MUST NOT assume that any outstanding requests which modified 805 the directory have succeeded or failed. 807 Lightweight Directory Access Protocol Version 3 809 The responseName is 1.3.6.1.4.1.1466.20036, the response field is 810 absent, and the resultCode is used to indicate the reason for the 811 disconnection. 813 The following result codes have these meanings when used in this 814 notification: 816 - protocolError: The server has received data from the client in 817 which the LDAPMessage structure could not be parsed. 819 - strongAuthRequired: The server has detected that an establish 820 security association between the client and server has 821 unexpectedly failed or been compromised, or that the server now 822 requires the client to authenticate using a strong(er) mechanism. 824 - unavailable: This server will stop accepting new connections and 825 operations on all existing connections, and be unavailable for an 826 extended period of time. The client may make use of an alternative 827 server. 829 After sending this notice, the server MUST close the connection. 830 After receiving this notice, the client MUST NOT transmit any further 831 on the connection, and may abruptly close the connection. 833 4.5. Search Operation 835 The Search Operation allows a client to request that a search be 836 performed on its behalf by a server. This can be used to read 837 attributes from a single entry, from entries immediately below a 838 particular entry, or a whole subtree of entries. 840 4.5.1. Search Request 842 The Search Request is defined as follows: 844 SearchRequest ::= [APPLICATION 3] SEQUENCE { 845 baseObject LDAPDN, 846 scope ENUMERATED { 847 baseObject (0), 848 singleLevel (1), 849 wholeSubtree (2) }, 850 derefAliases ENUMERATED { 851 neverDerefAliases (0), 852 derefInSearching (1), 853 derefFindingBaseObj (2), 854 derefAlways (3) }, 855 sizeLimit INTEGER (0 .. maxInt), 856 timeLimit INTEGER (0 .. maxInt), 857 typesOnly BOOLEAN, 858 filter Filter, 859 attributes AttributeDescriptionList } 860 Lightweight Directory Access Protocol Version 3 862 Filter ::= CHOICE { 863 and [0] SET SIZE (1..MAX) OF Filter, 864 or [1] SET SIZE (1..MAX) OF Filter, 865 not [2] Filter, 866 equalityMatch [3] AttributeValueAssertion, 867 substrings [4] SubstringFilter, 868 greaterOrEqual [5] AttributeValueAssertion, 869 lessOrEqual [6] AttributeValueAssertion, 870 present [7] AttributeDescription, 871 approxMatch [8] AttributeValueAssertion, 872 extensibleMatch [9] MatchingRuleAssertion } 874 SubstringFilter ::= SEQUENCE { 875 type AttributeDescription, 876 -- at least one must be present, 877 -- initial and final can occur at most once 878 substrings SEQUENCE OF CHOICE { 879 initial [0] AssertionValue, 880 any [1] AssertionValue, 881 final [2] AssertionValue } } 883 MatchingRuleAssertion ::= SEQUENCE { 884 matchingRule [1] MatchingRuleId OPTIONAL, 885 type [2] AttributeDescription OPTIONAL, 886 matchValue [3] AssertionValue, 887 dnAttributes [4] BOOLEAN DEFAULT FALSE } 889 Parameters of the Search Request are: 891 - baseObject: An LDAPDN that is the base object entry relative to 892 which the search is to be performed. 894 - scope: An indicator of the scope of the search to be performed. 895 The semantics of the possible values of this field are identical 896 to the semantics of the scope field in the X.511 Search Operation. 898 - derefAliases: An indicator as to how alias objects (as defined in 899 [X.501]) are to be handled in searching. The semantics of the 900 possible values of this field are: 902 neverDerefAliases: Do not dereference aliases in searching 903 or in locating the base object of the search. 905 derefInSearching: While searching, dereference any alias 906 object subordinate to the base object which is also in the 907 search scope. The filter is applied to the dereferenced 908 object(s). If the search scope is wholeSubtree, the search 909 continues in the subtree of any dereferenced object. 910 Aliases in that subtree are also dereferenced. Servers 911 SHOULD detect looping in this process to prevent denial of 912 service attacks and duplicate entries. 914 Lightweight Directory Access Protocol Version 3 916 derefFindingBaseObj: Dereference aliases in locating the 917 base object of the search, but not when searching 918 subordinates of the base object. 920 derefAlways: Dereference aliases both in searching and in 921 locating the base object of the search. 923 - sizeLimit: A size limit that restricts the maximum number of 924 entries to be returned as a result of the search. A value of 0 in 925 this field indicates that no client-requested size limit 926 restrictions are in effect for the search. Servers may enforce a 927 maximum number of entries to return. 929 - timeLimit: A time limit that restricts the maximum time (in 930 seconds) allowed for a search. A value of 0 in this field 931 indicates that no client-requested time limit restrictions are in 932 effect for the search. 934 - typesOnly: An indicator as to whether search results will contain 935 both attribute descriptions and values, or just attribute 936 descriptions. Setting this field to TRUE causes only attribute 937 descriptions (no values) to be returned. Setting this field to 938 FALSE causes both attribute descriptions and values to be 939 returned. 941 - filter: A filter that defines the conditions that must be 942 fulfilled in order for the search to match a given entry. 944 The 'and', 'or' and 'not' choices can be used to form combinations 945 of filters. At least one filter element MUST be present in an 946 'and' or 'or' choice. The others match against individual 947 attribute values of entries in the scope of the search. 948 (Implementor's note: the 'not' filter is an example of a tagged 949 choice in an implicitly-tagged module. In BER this is treated as 950 if the tag was explicit.) 952 A server MUST evaluate filters according to the three-valued logic 953 of X.511 (1993) section 7.8.1. In summary, a filter is evaluated 954 to either "TRUE", "FALSE" or "Undefined". If the filter evaluates 955 to TRUE for a particular entry, then the attributes of that entry 956 are returned as part of the search result (subject to any 957 applicable access control restrictions). If the filter evaluates 958 to FALSE or Undefined, then the entry is ignored for the search. 960 A filter of the "and" choice is TRUE if all the filters in the SET 961 OF evaluate to TRUE, FALSE if at least one filter is FALSE, and 962 otherwise Undefined. A filter of the "or" choice is FALSE if all 963 of the filters in the SET OF evaluate to FALSE, TRUE if at least 964 one filter is TRUE, and Undefined otherwise. A filter of the "not" 965 choice is TRUE if the filter being negated is FALSE, FALSE if it 966 is TRUE, and Undefined if it is Undefined. 968 The present match evaluates to TRUE where there is an attribute or 969 subtype of the specified attribute description present in an 970 Lightweight Directory Access Protocol Version 3 972 entry, and FALSE otherwise (including a presence test with an 973 unrecognized attribute description.) 975 The matching rule for equalityMatch filter items is defined by the 976 EQUALITY matching rule for the attribute type. 978 The matching rule for AssertionValues in a substrings filter item 979 is defined by the SUBSTR matching rule for the attribute type. 981 The matching rule for greaterOrEqual and lessOrEqual filter items 982 is defined by the ORDERING matching rule for the attribute type. 984 The matching semantics for approxMatch filter items is 985 implementation-defined. If approximate matching is not supported 986 by the server, the filter item should be treated as an 987 equalityMatch. 989 The extensibleMatch is new in this version of LDAP. If the 990 matchingRule field is absent, the type field MUST be present, and 991 the equality match is performed for that type. If the type field 992 is absent and matchingRule is present, the matchValue is compared 993 against all attributes in an entry which support that 994 matchingRule, and the matchingRule determines the syntax for the 995 assertion value (the filter item evaluates to TRUE if it matches 996 with at least one attribute in the entry, FALSE if it does not 997 match any attribute in the entry, and Undefined if the 998 matchingRule is not recognized or the assertionValue cannot be 999 parsed.) If the type field is present and matchingRule is present, 1000 the matchingRule MUST be one permitted for use with that type, 1001 otherwise the filter item is undefined. If the dnAttributes field 1002 is set to TRUE, the match is applied against all the 1003 AttributeValueAssertions in an entry's distinguished name as well, 1004 and also evaluates to TRUE if there is at least one attribute in 1005 the distinguished name for which the filter item evaluates to 1006 TRUE. (Editors note: The dnAttributes field is present so that 1007 there does not need to be multiple versions of generic matching 1008 rules such as for word matching, one to apply to entries and 1009 another to apply to entries and dn attributes as well). 1011 A filter item evaluates to Undefined when the server would not be 1012 able to determine whether the assertion value matches an entry. If 1013 an attribute description in an equalityMatch, substrings, 1014 greaterOrEqual, lessOrEqual, approxMatch or extensibleMatch filter 1015 is not recognized by the server, a matching rule id in the 1016 extensibleMatch is not recognized by the server, the assertion 1017 value cannot be parsed, or the type of filtering requested is not 1018 implemented, then the filter is Undefined. Thus for example if a 1019 server did not recognize the attribute type shoeSize, a filter of 1020 (shoeSize=*) would evaluate to FALSE, and the filters 1021 (shoeSize=12), (shoeSize>=12) and (shoeSize<=12) would evaluate to 1022 Undefined. 1024 Servers MUST NOT return errors if attribute descriptions or 1025 matching rule ids are not recognized, or assertion values cannot 1026 Lightweight Directory Access Protocol Version 3 1028 be parsed. More details of filter processing are given in section 1029 7.8 of [X.511]. 1031 - attributes: A list of the attributes to be returned from each 1032 entry which matches the search filter. There are two special 1033 values which may be used: an empty list with no attributes, and 1034 the attribute description string "*". Both of these signify that 1035 all user attributes are to be returned. (The "*" allows the client 1036 to request all user attributes in addition to any specified 1037 operational attributes). 1039 Attributes MUST be named at most once in the list, and are 1040 returned at most once in an entry. If there are attribute 1041 descriptions in the list which are not recognized, they are 1042 ignored by the server. 1044 If the client does not want any attributes returned, it can 1045 specify a list containing only the attribute with OID "1.1". This 1046 OID was chosen arbitrarily and does not correspond to any 1047 attribute in use. 1049 Client implementors should note that even if all user attributes 1050 are requested, some attributes of the entry may not be included in 1051 search results due to access controls or other restrictions. 1052 Furthermore, servers will not return operational attributes, such 1053 as objectClasses or attributeTypes, unless they are listed by 1054 name, since there may be extremely large number of values for 1055 certain operational attributes. (A list of operational attributes 1056 for use in LDAP is given in [Syntaxes].) 1058 Note that an X.500 "list"-like operation can be emulated by the 1059 client requesting a one-level LDAP search operation with a filter 1060 checking for the presence of the objectClass attribute, and that an 1061 X.500 "read"-like operation can be emulated by a base object LDAP 1062 search operation with the same filter. A server which provides a 1063 gateway to X.500 is not required to use the Read or List operations, 1064 although it may choose to do so, and if it does, it must provide the 1065 same semantics as the X.500 search operation. 1067 4.5.2. Search Result 1069 The results of the search attempted by the server upon receipt of a 1070 Search Request are returned in Search Responses, which are LDAP 1071 messages containing SearchResultEntry, SearchResultReference, or 1072 SearchResultDone data types. 1074 SearchResultEntry ::= [APPLICATION 4] SEQUENCE { 1075 objectName LDAPDN, 1076 attributes PartialAttributeList } 1078 PartialAttributeList ::= SEQUENCE OF SEQUENCE { 1079 type AttributeDescription, 1080 vals SET OF AttributeValue } 1081 Lightweight Directory Access Protocol Version 3 1083 -- implementors should note that the PartialAttributeList may 1084 -- have zero elements (if none of the attributes of that entry 1085 -- were requested, or could be returned), and that the vals set 1086 -- may also have zero elements (if types only was requested, or 1087 -- all values were excluded from the result.) 1089 SearchResultReference ::= [APPLICATION 19] SEQUENCE OF URL 1090 -- at least one URL element must be present 1092 SearchResultDone ::= [APPLICATION 5] LDAPResult 1094 Upon receipt of a Search Request, a server will perform the necessary 1095 search of the DIT. 1097 The server will return to the client a sequence of responses in 1098 separate LDAP messages. There may be zero or more responses 1099 containing SearchResultEntry, one for each entry found during the 1100 search. There may also be zero or more responses containing 1101 SearchResultReference, one for each area not explored by this server 1102 during the search. The SearchResultEntry and SearchResultReference 1103 PDUs may come in any order. Following all the SearchResultReference 1104 responses and all SearchResultEntry responses to be returned by the 1105 server, the server will return a response containing the 1106 SearchResultDone, which contains an indication of success, or 1107 detailing any errors that have occurred. 1109 Each entry returned in a SearchResultEntry will contain all 1110 appropriate attributes as specified in the attributes field of the 1111 Search Request. Return of attributes is subject to access control and 1112 other administrative policy. 1114 Some attributes may be constructed by the server and appear in a 1115 SearchResultEntry attribute list, although they are not stored 1116 attributes of an entry. Clients SHOULD NOT assume that all attributes 1117 can be modified, even if permitted by access control. 1119 If the server's schema defines a textual name for an attribute type, 1120 it SHOULD use a textual name for attributes of that attribute type by 1121 specifying one of the textual names as the value of the attribute 1122 type. Otherwise, the server uses the object identifier for the 1123 attribute type by specifying the object identifier, in ldapOID form, 1124 as the value of attribute type. If the server determines that 1125 returning a textual name will cause interoperability problems, it 1126 SHOULD return the ldapOID form of the attribute type. 1128 4.5.3. Continuation References in the Search Result 1130 If the server was able to locate the entry referred to by the 1131 baseObject but was unable to search all the entries in the scope at 1132 and under the baseObject, the server may return one or more 1133 SearchResultReference entries, each containing a reference to another 1134 set of servers for continuing the operation. A server MUST NOT return 1135 any SearchResultReference if it has not located the baseObject and 1136 Lightweight Directory Access Protocol Version 3 1138 thus has not searched any entries; in this case it would return a 1139 SearchResultDone containing a referral result code. 1141 If a server holds a copy or partial copy of the subordinate naming 1142 context, it may use the search filter to determine whether or not to 1143 return a SearchResultReference response. Otherwise 1144 SearchResultReference responses are always returned when in scope. 1146 The SearchResultReference is of the same data type as the Referral. 1147 URLs for servers implementing LDAP and accessible via [TCP]/[IP] (v4 1148 or v6) are written according to [LDAPURL]. The part MUST be 1149 present in the URL, with the new target object name. The client MUST 1150 use this name in its next request. Some servers (e.g. part of a 1151 distributed index exchange system) may provide a different filter in 1152 the URLs of the SearchResultReference. If the filter part of the URL 1153 is present in an LDAP URL, the client MUST use the new filter in its 1154 next request to progress the search, and if the filter part is absent 1155 the client will use again the same filter. If the originating search 1156 scope was singleLevel, the scope part of the URL will be baseObject. 1157 Other aspects of the new search request may be the same or different 1158 as the search which generated the continuation references. 1160 Other kinds of URLs may be returned so long as the operation could be 1161 performed using that protocol. 1163 The name of an unexplored subtree in a SearchResultReference need not 1164 be subordinate to the base object. 1166 In order to complete the search, the client MUST issue a new search 1167 operation for each SearchResultReference that is returned. Note that 1168 the abandon operation described in section 4.11 applies only to a 1169 particular operation sent on an association between a client and 1170 server, and if the client has multiple outstanding search operations, 1171 it MUST abandon each operation individually. 1173 4.5.3.1. Example 1175 For example, suppose the contacted server (hosta) holds the entry 1176 "DC=Example,DC=NET" and the entry "CN=Manager,DC=Example,DC=NET". It 1177 knows that either LDAP-capable servers (hostb) or (hostc) hold 1178 "OU=People,DC=Example,DC=NET" (one is the master and the other server 1179 a shadow), and that LDAP-capable server (hostd) holds the subtree 1180 "OU=Roles,DC=Example,DC=NET". If a subtree search of 1181 "DC=Example,DC=NET" is requested to the contacted server, it may 1182 return the following: 1184 SearchResultEntry for DC=Example,DC=NET 1185 SearchResultEntry for CN=Manager,DC=Example,DC=NET 1186 SearchResultReference { 1187 ldap://hostb/OU=People,DC=Example,DC=NET 1188 ldap://hostc/OU=People,DC=Example,DC=NET } 1189 SearchResultReference { 1190 ldap://hostd/OU=Roles,DC=Example,DC=NET } 1191 Lightweight Directory Access Protocol Version 3 1193 SearchResultDone (success) 1195 Client implementors should note that when following a 1196 SearchResultReference, additional SearchResultReference may be 1197 generated. Continuing the example, if the client contacted the server 1198 (hostb) and issued the search for the subtree 1199 "OU=People,DC=Example,DC=NET", the server might respond as follows: 1201 SearchResultEntry for OU=People,DC=Example,DC=NET 1202 SearchResultReference { 1203 ldap://hoste/OU=Managers,OU=People,DC=Example,DC=NET } 1204 SearchResultReference { 1205 ldap://hostf/OU=Consultants,OU=People,DC=Example,DC=NET } 1206 SearchResultDone (success) 1208 If the contacted server does not hold the base object for the search, 1209 then it will return a referral to the client. For example, if the 1210 client requests a subtree search of "DC=Example,DC=ORG" to hosta, the 1211 server may return only a SearchResultDone containing a referral. 1213 SearchResultDone (referral) { 1214 ldap://hostg/DC=Example,DC=ORG??sub } 1216 4.6. Modify Operation 1218 The Modify Operation allows a client to request that a modification 1219 of an entry be performed on its behalf by a server. The Modify 1220 Request is defined as follows: 1222 ModifyRequest ::= [APPLICATION 6] SEQUENCE { 1223 object LDAPDN, 1224 modification SEQUENCE OF SEQUENCE { 1225 operation ENUMERATED { 1226 add (0), 1227 delete (1), 1228 replace (2) }, 1229 modification AttributeTypeAndValues } } 1231 AttributeTypeAndValues ::= SEQUENCE { 1232 type AttributeDescription, 1233 vals SET OF AttributeValue } 1235 Parameters of the Modify Request are: 1237 - object: The object to be modified. The value of this field 1238 contains the DN of the entry to be modified. The server will not 1239 perform any alias dereferencing in determining the object to be 1240 modified. 1242 - modification: A list of modifications to be performed on the 1243 entry. The entire list of entry modifications MUST be performed in 1244 the order they are listed, as a single atomic operation. While 1245 individual modifications may violate the directory schema, the 1246 Lightweight Directory Access Protocol Version 3 1248 resulting entry after the entire list of modifications is 1249 performed MUST conform to the requirements of the directory 1250 schema. The values that may be taken on by the 'operation' field 1251 in each modification construct have the following semantics 1252 respectively: 1254 add: add values listed to the given attribute, creating the 1255 attribute if necessary; 1257 delete: delete values listed from the given attribute, 1258 removing the entire attribute if no values are listed, or 1259 if all current values of the attribute are listed for 1260 deletion; 1262 replace: replace all existing values of the given attribute 1263 with the new values listed, creating the attribute if it 1264 did not already exist. A replace with no value will delete 1265 the entire attribute if it exists, and is ignored if the 1266 attribute does not exist. 1268 The result of the modification attempted by the server upon receipt 1269 of a Modify Request is returned in a Modify Response, defined as 1270 follows: 1272 ModifyResponse ::= [APPLICATION 7] LDAPResult 1274 Upon receipt of a Modify Request, a server will perform the necessary 1275 modifications to the DIT. 1277 The server will return to the client a single Modify Response 1278 indicating either the successful completion of the DIT modification, 1279 or the reason that the modification failed. Note that due to the 1280 requirement for atomicity in applying the list of modifications in 1281 the Modify Request, the client may expect that no modifications of 1282 the DIT have been performed if the Modify Response received indicates 1283 any sort of error, and that all requested modifications have been 1284 performed if the Modify Response indicates successful completion of 1285 the Modify Operation. If the association changes or the connection 1286 fails, whether the modification occurred or not is indeterminate. 1288 The Modify Operation cannot be used to remove from an entry any of 1289 its distinguished values, those values which form the entry's 1290 relative distinguished name. An attempt to do so will result in the 1291 server returning the notAllowedOnRDN result code. The Modify DN 1292 Operation described in section 4.9 is used to rename an entry. 1294 Note that due to the simplifications made in LDAP, there is not a 1295 direct mapping of the modifications in an LDAP ModifyRequest onto the 1296 EntryModifications of a DAP ModifyEntry operation, and different 1297 implementations of LDAP-DAP gateways may use different means of 1298 representing the change. If successful, the final effect of the 1299 operations on the entry MUST be identical. 1301 Lightweight Directory Access Protocol Version 3 1303 4.7. Add Operation 1305 The Add Operation allows a client to request the addition of an entry 1306 into the directory. The Add Request is defined as follows: 1308 AddRequest ::= [APPLICATION 8] SEQUENCE { 1309 entry LDAPDN, 1310 attributes AttributeList } 1312 AttributeList ::= SEQUENCE OF SEQUENCE { 1313 type AttributeDescription, 1314 vals SET OF AttributeValue } 1316 Parameters of the Add Request are: 1318 - entry: the Distinguished Name of the entry to be added. Note that 1319 the server will not dereference any aliases in locating the entry 1320 to be added. 1322 - attributes: the list of attributes that make up the content of the 1323 entry being added. Clients MUST include distinguished values 1324 (those forming the entry's own RDN) in this list, the objectClass 1325 attribute, and values of any mandatory attributes of the listed 1326 object classes. Clients MUST NOT supply NO-USER-MODIFICATION 1327 attributes such as the createTimestamp or creatorsName attributes, 1328 since the server maintains these automatically. 1330 The entry named in the entry field of the AddRequest MUST NOT exist 1331 for the AddRequest to succeed. The immediate superior (parent) of the 1332 object and alias entries to be added MUST exist. For example, if the 1333 client attempted to add "CN=JS,DC=Example,DC=NET", the 1334 "DC=Example,DC=NET" entry did not exist, and the "DC=NET" entry did 1335 exist, then the server would return the noSuchObject result code with 1336 the matchedDN field containing "DC=NET". If the parent entry exists 1337 but is not in a naming context held by the server, the server SHOULD 1338 return a referral to the server holding the parent entry. 1340 Server implementations SHOULD NOT restrict where entries can be 1341 located in the directory unless DIT structure rules are in place. 1342 Some servers MAY allow the administrator to restrict the classes of 1343 entries which can be added to the directory. 1345 Upon receipt of an Add Request, a server will attempt to add the 1346 requested entry. The result of the add attempt will be returned to 1347 the client in the Add Response, defined as follows: 1349 AddResponse ::= [APPLICATION 9] LDAPResult 1351 A response of success indicates that the new entry is present in the 1352 directory. 1354 4.8. Delete Operation 1355 Lightweight Directory Access Protocol Version 3 1357 The Delete Operation allows a client to request the removal of an 1358 entry from the directory. The Delete Request is defined as follows: 1360 DelRequest ::= [APPLICATION 10] LDAPDN 1362 The Delete Request consists of the Distinguished Name of the entry to 1363 be deleted. Note that the server will not dereference aliases while 1364 resolving the name of the target entry to be removed, and that only 1365 leaf entries (those with no subordinate entries) can be deleted with 1366 this operation. 1368 The result of the delete attempted by the server upon receipt of a 1369 Delete Request is returned in the Delete Response, defined as 1370 follows: 1372 DelResponse ::= [APPLICATION 11] LDAPResult 1374 Upon receipt of a Delete Request, a server will attempt to perform 1375 the entry removal requested. The result of the delete attempt will be 1376 returned to the client in the Delete Response. 1378 4.9. Modify DN Operation 1380 The Modify DN Operation allows a client to change the leftmost (least 1381 significant) component of the name of an entry in the directory, 1382 and/or to move a subtree of entries to a new location in the 1383 directory. The Modify DN Request is defined as follows: 1385 ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { 1386 entry LDAPDN, 1387 newrdn RelativeLDAPDN, 1388 deleteoldrdn BOOLEAN, 1389 newSuperior [0] LDAPDN OPTIONAL } 1391 Parameters of the Modify DN Request are: 1393 - entry: the Distinguished Name of the entry to be changed. This 1394 entry may or may not have subordinate entries. Note that the 1395 server will not dereference any aliases in locating the entry to 1396 be changed. 1398 - newrdn: the RDN that will form the leftmost component of the new 1399 name of the entry. 1401 - deleteoldrdn: a boolean parameter that controls whether the old 1402 RDN attribute values are to be retained as attributes of the 1403 entry, or deleted from the entry. 1405 - newSuperior: if present, this is the Distinguished Name of an 1406 existing object entry which becomes the immediate superior 1407 (parent)of the existing entry. 1409 Lightweight Directory Access Protocol Version 3 1411 The result of the name change attempted by the server upon receipt of 1412 a Modify DN Request is returned in the Modify DN Response, defined as 1413 follows: 1415 ModifyDNResponse ::= [APPLICATION 13] LDAPResult 1417 Upon receipt of a ModifyDNRequest, a server will attempt to perform 1418 the name change. The result of the name change attempt will be 1419 returned to the client in the Modify DN Response. 1421 For example, if the entry named in the "entry" parameter was "cn=John 1422 Smith,c=US", the newrdn parameter was "cn=John Cougar Smith", and the 1423 newSuperior parameter was absent, then this operation would attempt 1424 to rename the entry to be "cn=John Cougar Smith,c=US". If there was 1425 already an entry with that name, the operation would fail with the 1426 entryAlreadyExists result code. 1428 The object named in newSuperior MUST exist. For example, if the 1429 client attempted to add "CN=JS,DC=Example,DC=NET", the 1430 "DC=Example,DC=NET" entry did not exist, and the "DC=NET" entry did 1431 exist, then the server would return the noSuchObject result code with 1432 the matchedDN field containing "DC=NET". 1434 If the deleteoldrdn parameter is TRUE, the values forming the old RDN 1435 are deleted from the entry. If the deleteoldrdn parameter is FALSE, 1436 the values forming the old RDN will be retained as non-distinguished 1437 attribute values of the entry. The server may not perform the 1438 operation and return an error in the result code if the setting of 1439 the deleteoldrdn parameter would cause a schema inconsistency in the 1440 entry. 1442 Note that X.500 restricts the ModifyDN operation to only affect 1443 entries that are contained within a single server. If the LDAP server 1444 is mapped onto DAP, then this restriction will apply, and the 1445 affectsMultipleDSAs result code will be returned if this error 1446 occurred. In general clients MUST NOT expect to be able to perform 1447 arbitrary movements of entries and subtrees between servers. 1449 4.10. Compare Operation 1451 The Compare Operation allows a client to compare an assertion 1452 provided with an entry in the directory. The Compare Request is 1453 defined as follows: 1455 CompareRequest ::= [APPLICATION 14] SEQUENCE { 1456 entry LDAPDN, 1457 ava AttributeValueAssertion } 1459 Parameters of the Compare Request are: 1461 - entry: the name of the entry to be compared with. Note that the 1462 server SHOULD NOT dereference any aliases in locating the entry to 1463 be compared with. 1465 Lightweight Directory Access Protocol Version 3 1467 - ava: the assertion with which an attribute in the entry is to be 1468 compared. 1470 The result of the compare attempted by the server upon receipt of a 1471 Compare Request is returned in the Compare Response, defined as 1472 follows: 1474 CompareResponse ::= [APPLICATION 15] LDAPResult 1476 Upon receipt of a Compare Request, a server will attempt to perform 1477 the requested comparison using the EQUALITY matching rule for the 1478 attribute type. The result of the comparison will be returned to the 1479 client in the Compare Response. In the event that the attribute or 1480 subtype is not present in the entry, the resultCode field is set to 1481 noSuchAttribute. If the attribute is unknown, the resultCode is set 1482 to undefinedAttributeType. Note that errors and the result of 1483 comparison are all returned in the same construct. 1485 Note that some directory systems may establish access controls which 1486 permit the values of certain attributes (such as userPassword) to be 1487 compared but not interrogated by other means. 1489 4.11. Abandon Operation 1491 The function of the Abandon Operation is to allow a client to request 1492 that the server abandon an outstanding operation. The Abandon Request 1493 is defined as follows: 1495 AbandonRequest ::= [APPLICATION 16] MessageID 1497 The MessageID MUST be that of an operation which was requested 1498 earlier in this LDAP association. The abandon request itself has its 1499 own message id. This is distinct from the id of the earlier operation 1500 being abandoned. 1502 There is no response defined in the Abandon operation. Upon reciept 1503 of an AbandonRequest, the server MAY abandon the operation identified 1504 by the MessageID. Operation responses are not sent for successfully 1505 abandoned operations, thus a client SHOULD NOT use the Abandon 1506 operation when it needs an indication of whether the operation was 1507 abandoned. For example, if a client performs an update operation 1508 (Add, Modify, or ModifyDN), and it needs to know whether the 1509 directory has changed due to the operation, it should not use the 1510 Abandon operation to cancel the update operation. 1512 Abandon and Unbind operations cannot be abandoned. The ability to 1513 abandon other (particularly update) operations is at the discretion 1514 of the server. 1516 In the event that a server receives an Abandon Request on a Search 1517 Operation in the midst of transmitting responses to the search, that 1518 server MUST cease transmitting entry responses to the abandoned 1519 Lightweight Directory Access Protocol Version 3 1521 request immediately, and MUST NOT send the SearchResponseDone. Of 1522 course, the server MUST ensure that only properly encoded LDAPMessage 1523 PDUs are transmitted. 1525 Clients MUST NOT send abandon requests for the same operation 1526 multiple times, and MUST also be prepared to receive results from 1527 operations it has abandoned (since these may have been in transit 1528 when the abandon was requested, or are not able to be abandoned). 1530 Servers MUST discard abandon requests for message IDs they do not 1531 recognize, for operations which cannot be abandoned, and for 1532 operations which have already been abandoned. 1534 4.12. Extended Operation 1536 An extension mechanism has been added in this version of LDAP, in 1537 order to allow additional operations to be defined for services not 1538 available elsewhere in this protocol, for instance digitally signed 1539 operations and results. 1541 The extended operation allows clients to make requests and receive 1542 responses with predefined syntaxes and semantics. These may be 1543 defined in RFCs or be private to particular implementations. Each 1544 request MUST have a unique OBJECT IDENTIFIER assigned to it. 1546 ExtendedRequest ::= [APPLICATION 23] SEQUENCE { 1547 requestName [0] LDAPOID, 1548 requestValue [1] OCTET STRING OPTIONAL } 1550 The requestName is a dotted-decimal representation of the OBJECT 1551 IDENTIFIER corresponding to the request. The requestValue is 1552 information in a form defined by that request, encapsulated inside an 1553 OCTET STRING. 1555 The server will respond to this with an LDAPMessage containing the 1556 ExtendedResponse. 1558 ExtendedResponse ::= [APPLICATION 24] SEQUENCE { 1559 COMPONENTS OF LDAPResult, 1560 responseName [10] LDAPOID OPTIONAL, 1561 responseValue [11] OCTET STRING OPTIONAL } 1563 If the server does not recognize the request name, it MUST return 1564 only the response fields from LDAPResult, containing the 1565 protocolError result code. 1567 The requestValue and responseValue fields contain any information 1568 associated with the operation. The format of these fields is defined 1569 by the specification of the extended operation. Implementations MUST 1570 be prepared to handle arbitrary contents of these fields, including 1571 zero bytes. Values that are defined in terms of ASN.1 and BER encoded 1572 according to Section 5.1, also follow the extensibility rules in 1573 Section 4. 1575 Lightweight Directory Access Protocol Version 3 1577 Extended operations may be specified in other documents. The 1578 specification of an extended operation consists of: 1580 - the OBJECT IDENTIFIER assigned to the ExtendedRequest.requestName 1581 (and possibly ExtendedResponse.responseName), 1583 - the format of the contents of the requestValue and responseValue 1584 (if any), 1586 - the semantics of the operation, 1588 Servers list the requestName of all ExtendedRequests they recognize 1589 in the supportedExtension attribute [Models] in the root DSE. 1591 requestValues and responseValues that are defined in terms of ASN.1 1592 and BER encoded according to Section 5.1, also follow the 1593 extensibility rules in Section 4. 1595 4.13. Start TLS Operation 1597 The Start Transport Layer Security (StartTLS) operation provides the 1598 ability to establish Transport Layer Security [RFC2246] on an LDAP 1599 connection. 1601 4.13.1. Start TLS Request 1603 A client requests TLS establishment by transmitting a Start TLS 1604 request PDU to the server. The Start TLS request is defined in terms 1605 of an ExtendedRequest. The requestName is "1.3.6.1.4.1.1466.20037", 1606 and the requestValue field is absent. 1608 The client MUST NOT send any PDUs on this connection following this 1609 request until it receives a Start TLS extended response. 1611 4.13.2. Start TLS Response 1613 When a Start TLS request is made, servers supporting the operation 1614 MUST return a Start TLS response PDU to the requestor. The Start TLS 1615 response responseName is also "1.3.6.1.4.1.1466.20037", and the 1616 response field is absent. 1618 The server MUST set the resultCode field to either success or one of 1619 the other values outlined in section 4.13.2.2. 1621 4.13.2.1. "Success" Response 1623 If the Start TLS Response contains a result code of success, this 1624 indicates that the server is willing and able to negotiate TLS. Refer 1625 to section 5.3 of [AuthMeth] for details. 1627 4.13.2.2. Response other than "success" 1628 Lightweight Directory Access Protocol Version 3 1630 If the ExtendedResponse contains a result code other than success, 1631 this indicates that the server is unwilling or unable to negotiate 1632 TLS. The following result codes have these meanings for this 1633 operation: 1635 - operationsError: operations sequencing incorrect; e.g. TLS already 1636 established) 1638 - protocolError: (TLS not supported or incorrect PDU structure) 1640 - unavailable: (e.g. some major problem with TLS, or server is 1641 shutting down) 1643 The server MUST return operationsError if the client violates any of 1644 the Start TLS extended operation sequencing requirements described in 1645 section 5.3 of [AuthMeth]. 1647 If the server does not support TLS (whether by design or by current 1648 configuration), it MUST set the resultCode field to protocolError. 1649 The client's current association is unaffected if the server does not 1650 support TLS. The client MAY proceed with any LDAP operation, or it 1651 MAY close the connection. 1653 The server MUST return unavailable if it supports TLS but cannot 1654 establish a TLS connection for some reason, e.g. the certificate 1655 server not responding, it cannot contact its TLS implementation, or 1656 if the server is in process of shutting down. The client MAY retry 1657 the StartTLS operation, or it MAY proceed with any other LDAP 1658 operation, or it MAY close the LDAP connection. 1660 4.13.3. Closing a TLS Connection 1662 Two forms of TLS connection closure--graceful and abrupt--are 1663 supported. 1665 4.13.3.1. Graceful Closure 1667 Either the client or server MAY terminate the TLS connection and 1668 leave the LDAP connection intact by sending a TLS closure alert. 1670 Before sending a TLS closure alert, the client MUST either wait for 1671 any outstanding LDAP operations to complete, or explicitly abandon 1672 them. 1674 After the initiator of a close has sent a TLS closure alert, it MUST 1675 discard any TLS messages until it has received a TLS closure alert 1676 from the other party. It will cease to send TLS Record Protocol 1677 PDUs, and following the receipt of the alert, MAY send and receive 1678 LDAP PDUs. 1680 Lightweight Directory Access Protocol Version 3 1682 The other party, if it receives a TLS closure alert, MUST immediately 1683 transmit a TLS closure alert. It will subsequently cease to send TLS 1684 Record Protocol PDUs, and MAY send and receive LDAP PDUs. 1686 After the TLS connection has been closed, the server MUST NOT send 1687 responses to any request message received before the TLS closure. 1689 4.13.3.2. Abrupt Closure 1691 Either the client or server MAY abruptly close the TLS connection by 1692 dropping the underlying transfer protocol connection. In this 1693 circumstance, a server MAY send the client a Notice of Disconnection 1694 before dropping the underlying LDAP connection. 1696 5. Protocol Element Encodings and Transfer 1698 One underlying service is defined here. Clients and servers SHOULD 1699 implement the mapping of LDAP over [TCP] described in 5.2.1. 1701 5.1. Protocol Encoding 1703 The protocol elements of LDAP are encoded for exchange using the 1704 Basic Encoding Rules (BER) [X.690] of ASN.1 [X.680]. However, due to 1705 the high overhead involved in using certain elements of the BER, the 1706 following additional restrictions are placed on BER-encodings of LDAP 1707 protocol elements: 1709 (1) Only the definite form of length encoding will be used. 1711 (2) OCTET STRING values will be encoded in the primitive form only. 1713 (3) If the value of a BOOLEAN type is true, the encoding MUST have 1714 its contents octets set to hex "FF". 1716 (4) If a value of a type is its default value, it MUST be absent. 1717 Only some BOOLEAN and INTEGER types have default values in this 1718 protocol definition. 1720 These restrictions do not apply to ASN.1 types encapsulated inside of 1721 OCTET STRING values, such as attribute values, unless otherwise 1722 noted. 1724 5.2. Transfer Protocols 1726 This protocol is designed to run over connection-oriented, reliable 1727 transports, with all 8 bits in an octet being significant in the data 1728 stream. 1730 5.2.1. Transmission Control Protocol (TCP) 1731 Lightweight Directory Access Protocol Version 3 1733 The encoded LDAPMessage PDUs are mapped directly onto the [TCP] 1734 bytestream using the BER-based encoding described in section 5.1. It 1735 is recommended that server implementations running over the TCP 1736 provide a protocol listener on the assigned port, 389. Servers may 1737 instead provide a listener on a different port number. Clients MUST 1738 support contacting servers on any valid TCP port. 1740 6. Implementation Guidelines 1742 6.1. Server Implementations 1744 The server MUST be capable of recognizing all the mandatory attribute 1745 types specified in [Models], and implement the syntaxes used by those 1746 attributes specified in [Syntaxes]. Servers MAY also recognize 1747 additional attribute type names. 1749 6.2. Client Implementations 1751 Clients that follow referrals or search continuation references MUST 1752 ensure that they do not loop between servers. They MUST NOT 1753 repeatedly contact the same server for the same request with the same 1754 target entry name, scope and filter. Some clients use a counter that 1755 is incremented each time referral handling occurs for an operation, 1756 and these kinds of clients MUST be able to handle at least ten nested 1757 referrals between the root and a leaf entry. 1759 In the absence of prior agreements with servers, clients SHOULD NOT 1760 assume that servers support any particular schemas beyond those 1761 referenced in section 6.1. Different schemas can have different 1762 attribute types with the same names. The client can retrieve the 1763 subschema entries referenced by the subschemaSubentry attribute in 1764 the entries held by the server. 1766 7. Security Considerations 1768 This version of the protocol provides facilities for simple 1769 authentication using a cleartext password, as well as any SASL 1770 mechanism [RFC2222]. SASL allows for integrity and privacy services 1771 to be negotiated. 1773 It is also permitted that the server can return its credentials to 1774 the client, if it chooses to do so. 1776 Use of cleartext password is strongly discouraged where the 1777 underlying transport service cannot guarantee confidentiality and may 1778 result in disclosure of the password to unauthorized parties. 1780 Requirements of authentication methods, SASL mechanisms, and TLS are 1781 described in [AUTHMETH]. 1783 Lightweight Directory Access Protocol Version 3 1785 When used with SASL, it should be noted that the name field of the 1786 BindRequest is not protected against modification. Thus if the 1787 distinguished name of the client (an LDAPDN) is agreed through the 1788 negotiation of the credentials, it takes precedence over any value in 1789 the unprotected name field. 1791 Implementations which cache attributes and entries obtained via LDAP 1792 MUST ensure that access controls are maintained if that information 1793 is to be provided to multiple clients, since servers may have access 1794 control policies which prevent the return of entries or attributes in 1795 search results except to particular authenticated clients. For 1796 example, caches could serve result information only to the client 1797 whose request caused it to be in the cache. 1799 Protocol servers may return referrals which redirect protocol clients 1800 to peer servers. It is possible for a rogue application to inject 1801 such referrals into the data stream in an attempt to redirect a 1802 client to a rogue server. Protocol clients are advised to be aware of 1803 this, and possibly reject referrals when confidentiality measures are 1804 in place. Protocol clients are advised to ignore referrals from the 1805 Start TLS operation. 1807 Protocol peers MUST be prepared to handle invalid and arbitrary 1808 length protocol encodings. A number of LDAP security advisories are 1809 available through [CERT]. 1811 8. Acknowledgements 1813 This document is an update to RFC 2251, by Mark Wahl, Tim Howes, and 1814 Steve Kille. Their work along with the input of individuals of the 1815 IETF LDAPEXT, LDUP, LDAPBIS, and other Working Groups is gratefully 1816 acknowledged. 1818 9. Normative References 1820 [X.500] ITU-T Rec. X.500, "The Directory: Overview of Concepts, 1821 Models and Service", 1993. 1823 [Roadmap] K. Zeilenga (editor), "LDAP: Technical Specification Road 1824 Map", draft-ietf-ldapbis-roadmap-xx.txt (a work in 1825 progress). 1827 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1828 Requirement Levels", RFC 2119, March 1997. 1830 [X.680] ITU-T Recommendation X.680 (1997) | ISO/IEC 8824-1:1998 1831 Information Technology - Abstract Syntax Notation One 1832 (ASN.1): Specification of basic notation 1834 [X.690] ITU-T Rec. X.690, "Specification of ASN.1 encoding rules: 1835 Basic, Canonical, and Distinguished Encoding Rules", 1994. 1837 Lightweight Directory Access Protocol Version 3 1839 [LDAPIANA] K. Zeilenga, "IANA Considerations for LDAP", draft-ietf- 1840 ldapbis-xx.txt (a work in progress). 1842 [ISO10646] Universal Multiple-Octet Coded Character Set (UCS) - 1843 Architecture and Basic Multilingual Plane, ISO/IEC 10646-1 1844 : 1993. 1846 [RFC2279] Yergeau, F., "UTF-8, a transformation format of Unicode 1847 and ISO 10646", RFC 2279, January 1998. 1849 [Models] K. Zeilenga, "LDAP: The Models", draft-ietf-ldapbis- 1850 models-xx.txt (a work in progress). 1852 [LDAPDN] K. Zeilenga (editor), "LDAP: String Representation of 1853 Distinguished Names", draft-ietf-ldapbis-dn-xx.txt, (a 1854 work in progress). 1856 [Syntaxes] K. Dally (editor), "LDAP: Syntaxes", draft-ietf-ldapbis- 1857 syntaxes-xx.txt, (a work in progress). 1859 [X.501] ITU-T Rec. X.501, "The Directory: Models", 1993. 1861 [X.511] ITU-T Rec. X.511, "The Directory: Abstract Service 1862 Definition", 1993. 1864 [RFC2396] Berners-Lee, T., Fielding, R., and L. Masinter Uniform 1865 Resource Identifiers (URI): Generic Syntax", RFC 2396, 1866 August 1998. 1868 [AuthMeth] R. Harrison (editor), "LDAP: Authentication Methods", 1869 draft-ietf-ldapbis-authmeth-xx.txt, (a work in progress). 1871 [RFC2222] Meyers, J., "Simple Authentication and Security Layer", 1872 RFC 2222, October 1997. 1874 [SASLPrep] Zeilenga, K., "Stringprep profile for user names and 1875 passwords", draft-ietf-sasl-saslprep-xx.txt, (a work in 1876 progress). 1878 [Unicode] The Unicode Consortium, "The Unicode Standard, Version 1879 3.2.0" is defined by "The Unicode Standard, Version 3.0" 1880 (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5), 1881 as amended by the "Unicode Standard Annex #27: Unicode 1882 3.1" (http://www.unicode.org/reports/tr27/) and by the 1883 "Unicode Standard Annex #28: Unicode 3.2" 1884 (http://www.unicode.org/reports/tr28/). 1886 [TCP] Postel, J., "Transmission Control Protocol", STD7, 1887 September 1981 1889 [IP] Postel, J., "Internet Protocol", STD5, September 1981 1890 Lightweight Directory Access Protocol Version 3 1892 10. Informative References 1894 [CERT] the CERT(R) Center, (http://www.cert.org) 1896 11. Editor's Address 1898 Jim Sermersheim 1899 Novell, Inc. 1900 1800 South Novell Place 1901 Provo, Utah 84606, USA 1902 jimse@novell.com 1903 +1 801 861-3088 1904 Lightweight Directory Access Protocol Version 3 1906 Appendix A - LDAP Result Codes 1908 This normative appendix details additional considerations regarding 1909 LDAP result codes and provides a brief, general description of each 1910 LDAP result code enumerated in Section 4.1.10. 1912 Additional result codes MAY be defined for use with extensions. 1913 Client implementations SHALL treat any result code which they do not 1914 recognize as an unknown error condition. 1916 A.1 Non-Error Result Codes 1917 These result codes (called "non-error" result codes) do not indicate 1918 an error condition: 1919 success (0), 1920 compareTrue (6), 1921 compareFalse (7), 1922 referral (10), and 1923 saslBindInProgress (14). 1925 The success, compareTrue, and compare result codes indicate 1926 successful completion (and, hence, are called to as "successful" 1927 result codes). 1929 The referral and saslBindInProgress result codes indicate the client 1930 is required to take additional action to complete the operation 1932 A.2 Result Codes 1933 Existing LDAP result codes are described as follows: 1935 success (0) 1937 Indicates successful completion of an operation. 1939 This result code is normally not returned by the compare 1940 operation, see compareFalse and compareTrue. It is possible 1941 that a future extension mechanism would allow this to be 1942 returned by a compare operation. 1944 operationsError (1) 1946 Indicates that the operation is not properly sequenced with 1947 relation to other operations (of same or different type). 1949 For example, this code is returned if the client attempts to 1950 Start TLS [RFC2246] while there are other operations 1951 outstanding or if TLS was already established. 1953 protocolError (2) 1954 Lightweight Directory Access Protocol Version 3 1956 Indicates the server received data which has incorrect 1957 structure. 1959 For bind operation only, the code may be resulted to indicate 1960 the server does not support the requested protocol version. 1962 timeLimitExceeded (3) 1964 Indicates that the time limit specified by the client was 1965 exceeded before the operation could be completed. 1967 sizeLimitExceeded (4) 1969 Indicates that the size limit specified by the client was 1970 exceeded before the operation could be completed. 1972 compareFalse (5) 1974 Indicates that the operation successfully completes and the 1975 assertion has evaluated to FALSE. 1977 This result code is normally only returned by the compare 1978 operation. 1980 compareTrue (6) 1982 Indicates that the operation successfully completes and the 1983 assertion has evaluated to TRUE. 1985 This result code is normally only returned by the compare 1986 operation. 1988 authMethodNotSupported (7) 1990 Indicates that the authentication method or mechanism is not 1991 supported. 1993 strongAuthRequired (8) 1995 Except when returned in a Notice of Disconnect (see section 1996 4.4.1), this indicates that the server requires the client to 1997 authentication using a strong(er) mechanism. 1999 referral (10) 2001 Indicates that a referral needs to be chased to complete the 2002 operation (see section 4.1.11). 2004 Lightweight Directory Access Protocol Version 3 2006 adminLimitExceeded (11) 2008 Indicates that an administrative limit has been exceeded. 2010 unavailableCriticalExtension (12) 2012 Indicates that server cannot perform a critical extension 2013 (see section 4.1.12). 2015 confidentialityRequired (13) 2017 Indicates that data confidentiality protections are required. 2019 saslBindInProgress (14) 2021 Indicates the server requires the client to send a new bind 2022 request, with the same SASL mechanism, to continue the 2023 authentication process (see section 4.2). 2025 noSuchAttribute (16) 2027 Indicates that the named entry does not contain the specified 2028 attribute or attribute value. 2030 undefinedAttributeType (17) 2032 Indicates that a request field contains an undefined 2033 attribute type. 2035 inappropriateMatching (18) 2037 Indicates that a request cannot be completed due to an 2038 inappropriate matching. 2040 constraintViolation (19) 2042 Indicates that the client supplied an attribute value which 2043 does not conform to constraints placed upon it by the data 2044 model. 2046 For example, this code is returned when the multiple values 2047 are supplied to an attribute which has a SINGLE-VALUE 2048 constraint. 2050 Lightweight Directory Access Protocol Version 3 2052 attributeOrValueExists (20) 2054 Indicates that the client supplied an attribute or value to 2055 be added to an entry already exists. 2057 invalidAttributeSyntax (21) 2059 Indicates that a purported attribute value does not conform 2060 to the syntax of the attribute. 2062 noSuchObject (32) 2064 Indicates that the object does not exist in the DIT. 2066 aliasProblem (33) 2068 Indicates that an alias problem has occurred. Typically an 2069 alias has been dereferenced which names no object. 2071 invalidDNSyntax (34) 2073 Indicates that a LDAPDN or RelativeLDAPDN field (e.g. search 2074 base, target entry, ModifyDN newrdn, etc.) of a request does 2075 not conform to the required syntax or contains attribute 2076 values which do not conform to the syntax of the attribute's 2077 type. 2079 aliasDereferencingProblem (36) 2081 Indicates that a problem occurred while dereferencing an 2082 alias. Typically an alias was encountered in a situation 2083 where it was not allowed or where access was denied. 2085 inappropriateAuthentication (48) 2087 Indicates the server requires the client which had attempted 2088 to bind anonymously or without supplying credentials to 2089 provide some form of credentials, 2091 invalidCredentials (49) 2093 Indicates the supplied password or SASL credentials are 2094 invalid. 2096 insufficientAccessRights (50) 2097 Lightweight Directory Access Protocol Version 3 2099 Indicates that the client does not have sufficient access 2100 rights to perform the operation. 2102 busy (51) 2104 Indicates that the server is busy. 2106 unavailable (52) 2108 Indicates that the server is shutting down or a subsystem 2109 necessary to complete the operation is offline. 2111 unwillingToPerform (53) 2113 Indicates that the server is unwilling to perform the 2114 operation. 2116 loopDetect (54) 2118 Indicates that the server has detected an internal loop. 2120 namingViolation (64) 2122 Indicates that the entry name violates naming restrictions. 2124 objectClassViolation (65) 2126 Indicates that the entry violates object class restrictions. 2128 notAllowedOnNonLeaf (66) 2130 Indicates that operation is inappropriately acting upon a 2131 non-leaf entry. 2133 notAllowedOnRDN (67) 2135 Indicates that the operation is inappropriately attempting to 2136 remove a value which forms the entry's relative distinguished 2137 name. 2139 entryAlreadyExists (68) 2141 Indicates that the request cannot be added fulfilled as the 2142 entry already exists. 2144 Lightweight Directory Access Protocol Version 3 2146 objectClassModsProhibited (69) 2148 Indicates that the attempt to modify the object class(es) of 2149 an entry objectClass attribute is prohibited. 2151 For example, this code is returned when a when a client 2152 attempts to modify the structural object class of an entry. 2154 affectsMultipleDSAs (71) 2156 Indicates that the operation cannot be completed as it 2157 affects multiple servers (DSAs). 2159 other (80) 2161 Indicates the server has encountered an internal error. 2163 Lightweight Directory Access Protocol Version 3 2165 Appendix B - Complete ASN.1 Definition 2167 This appendix is normative. 2169 Lightweight-Directory-Access-Protocol-V3 DEFINITIONS 2170 IMPLICIT TAGS 2171 EXTENSIBILITY IMPLIED ::= 2173 BEGIN 2175 LDAPMessage ::= SEQUENCE { 2176 messageID MessageID, 2177 protocolOp CHOICE { 2178 bindRequest BindRequest, 2179 bindResponse BindResponse, 2180 unbindRequest UnbindRequest, 2181 searchRequest SearchRequest, 2182 searchResEntry SearchResultEntry, 2183 searchResDone SearchResultDone, 2184 searchResRef SearchResultReference, 2185 modifyRequest ModifyRequest, 2186 modifyResponse ModifyResponse, 2187 addRequest AddRequest, 2188 addResponse AddResponse, 2189 delRequest DelRequest, 2190 delResponse DelResponse, 2191 modDNRequest ModifyDNRequest, 2192 modDNResponse ModifyDNResponse, 2193 compareRequest CompareRequest, 2194 compareResponse CompareResponse, 2195 abandonRequest AbandonRequest, 2196 extendedReq ExtendedRequest, 2197 extendedResp ExtendedResponse, 2198 ... }, 2199 controls [0] Controls OPTIONAL } 2201 MessageID ::= INTEGER (0 .. maxInt) 2203 maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- 2205 LDAPString ::= OCTET STRING -- UTF-8 encoded, 2206 -- [ISO10646] characters 2208 LDAPOID ::= OCTET STRING -- Constrained to numericoid [Models] 2210 LDAPDN ::= LDAPString 2212 RelativeLDAPDN ::= LDAPString 2214 AttributeDescription ::= LDAPString 2215 -- Constrained to attributedescription 2216 -- [Models] 2218 AttributeDescriptionList ::= SEQUENCE OF 2219 Lightweight Directory Access Protocol Version 3 2221 AttributeDescription 2223 AttributeValue ::= OCTET STRING 2225 AttributeValueAssertion ::= SEQUENCE { 2226 attributeDesc AttributeDescription, 2227 assertionValue AssertionValue } 2229 AssertionValue ::= OCTET STRING 2231 Attribute ::= SEQUENCE { 2232 type AttributeDescription, 2233 vals SET OF AttributeValue } 2235 MatchingRuleId ::= LDAPString 2237 LDAPResult ::= SEQUENCE { 2238 resultCode ENUMERATED { 2239 success (0), 2240 operationsError (1), 2241 protocolError (2), 2242 timeLimitExceeded (3), 2243 sizeLimitExceeded (4), 2244 compareFalse (5), 2245 compareTrue (6), 2246 authMethodNotSupported (7), 2247 strongAuthRequired (8), 2248 -- 9 reserved -- 2249 referral (10), 2250 adminLimitExceeded (11), 2251 unavailableCriticalExtension (12), 2252 confidentialityRequired (13), 2253 saslBindInProgress (14), 2254 noSuchAttribute (16), 2255 undefinedAttributeType (17), 2256 inappropriateMatching (18), 2257 constraintViolation (19), 2258 attributeOrValueExists (20), 2259 invalidAttributeSyntax (21), 2260 -- 22-31 unused -- 2261 noSuchObject (32), 2262 aliasProblem (33), 2263 invalidDNSyntax (34), 2264 -- 35 reserved for undefined isLeaf -- 2265 aliasDereferencingProblem (36), 2266 -- 37-47 unused -- 2267 inappropriateAuthentication (48), 2268 invalidCredentials (49), 2269 insufficientAccessRights (50), 2270 busy (51), 2271 unavailable (52), 2272 unwillingToPerform (53), 2273 loopDetect (54), 2274 -- 55-63 unused -- 2275 Lightweight Directory Access Protocol Version 3 2277 namingViolation (64), 2278 objectClassViolation (65), 2279 notAllowedOnNonLeaf (66), 2280 notAllowedOnRDN (67), 2281 entryAlreadyExists (68), 2282 objectClassModsProhibited (69), 2283 -- 70 reserved for CLDAP -- 2284 affectsMultipleDSAs (71), 2285 -- 72-79 unused -- 2286 other (80), 2287 ... }, 2288 -- 81-90 reserved for APIs -- 2289 matchedDN LDAPDN, 2290 diagnosticMessage LDAPString, 2291 referral [3] Referral OPTIONAL } 2293 Referral ::= SEQUENCE OF URL 2295 URL ::= LDAPString -- limited to characters permitted in 2296 -- URLs 2298 Controls ::= SEQUENCE OF Control 2300 Control ::= SEQUENCE { 2301 controlType LDAPOID, 2302 criticality BOOLEAN DEFAULT FALSE, 2303 controlValue OCTET STRING OPTIONAL } 2305 BindRequest ::= [APPLICATION 0] SEQUENCE { 2306 version INTEGER (1 .. 127), 2307 name LDAPDN, 2308 authentication AuthenticationChoice } 2310 AuthenticationChoice ::= CHOICE { 2311 simple [0] OCTET STRING, 2312 -- 1 and 2 reserved 2313 sasl [3] SaslCredentials, 2314 ... } 2316 SaslCredentials ::= SEQUENCE { 2317 mechanism LDAPString, 2318 credentials OCTET STRING OPTIONAL } 2320 BindResponse ::= [APPLICATION 1] SEQUENCE { 2321 COMPONENTS OF LDAPResult, 2322 serverSaslCreds [7] OCTET STRING OPTIONAL } 2324 UnbindRequest ::= [APPLICATION 2] NULL 2326 SearchRequest ::= [APPLICATION 3] SEQUENCE { 2327 baseObject LDAPDN, 2328 scope ENUMERATED { 2329 baseObject (0), 2330 singleLevel (1), 2331 Lightweight Directory Access Protocol Version 3 2333 wholeSubtree (2) }, 2334 derefAliases ENUMERATED { 2335 neverDerefAliases (0), 2336 derefInSearching (1), 2337 derefFindingBaseObj (2), 2338 derefAlways (3) }, 2339 sizeLimit INTEGER (0 .. maxInt), 2340 timeLimit INTEGER (0 .. maxInt), 2341 typesOnly BOOLEAN, 2342 filter Filter, 2343 attributes AttributeDescriptionList } 2345 Filter ::= CHOICE { 2346 and [0] SET SIZE (1..MAX) OF Filter, 2347 or [1] SET SIZE (1..MAX) OF Filter, 2348 not [2] Filter, 2349 equalityMatch [3] AttributeValueAssertion, 2350 substrings [4] SubstringFilter, 2351 greaterOrEqual [5] AttributeValueAssertion, 2352 lessOrEqual [6] AttributeValueAssertion, 2353 present [7] AttributeDescription, 2354 approxMatch [8] AttributeValueAssertion, 2355 extensibleMatch [9] MatchingRuleAssertion } 2357 SubstringFilter ::= SEQUENCE { 2358 type AttributeDescription, 2359 -- at least one must be present, 2360 -- initial and final can occur at most once 2361 substrings SEQUENCE OF CHOICE { 2362 initial [0] AssertionValue, 2363 any [1] AssertionValue, 2364 final [2] AssertionValue } } 2366 MatchingRuleAssertion ::= SEQUENCE { 2367 matchingRule [1] MatchingRuleId OPTIONAL, 2368 type [2] AttributeDescription OPTIONAL, 2369 matchValue [3] AssertionValue, 2370 dnAttributes [4] BOOLEAN DEFAULT FALSE } 2372 SearchResultEntry ::= [APPLICATION 4] SEQUENCE { 2373 objectName LDAPDN, 2374 attributes PartialAttributeList } 2376 PartialAttributeList ::= SEQUENCE OF SEQUENCE { 2377 type AttributeDescription, 2378 vals SET OF AttributeValue } 2380 SearchResultReference ::= [APPLICATION 19] SEQUENCE OF URL 2382 SearchResultDone ::= [APPLICATION 5] LDAPResult 2384 ModifyRequest ::= [APPLICATION 6] SEQUENCE { 2385 object LDAPDN, 2386 modification SEQUENCE OF SEQUENCE { 2387 Lightweight Directory Access Protocol Version 3 2389 operation ENUMERATED { 2390 add (0), 2391 delete (1), 2392 replace (2) }, 2393 modification AttributeTypeAndValues } } 2395 AttributeTypeAndValues ::= SEQUENCE { 2396 type AttributeDescription, 2397 vals SET OF AttributeValue } 2399 ModifyResponse ::= [APPLICATION 7] LDAPResult 2401 AddRequest ::= [APPLICATION 8] SEQUENCE { 2402 entry LDAPDN, 2403 attributes AttributeList } 2405 AttributeList ::= SEQUENCE OF SEQUENCE { 2406 type AttributeDescription, 2407 vals SET OF AttributeValue } 2409 AddResponse ::= [APPLICATION 9] LDAPResult 2411 DelRequest ::= [APPLICATION 10] LDAPDN 2413 DelResponse ::= [APPLICATION 11] LDAPResult 2415 ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { 2416 entry LDAPDN, 2417 newrdn RelativeLDAPDN, 2418 deleteoldrdn BOOLEAN, 2419 newSuperior [0] LDAPDN OPTIONAL } 2421 ModifyDNResponse ::= [APPLICATION 13] LDAPResult 2423 CompareRequest ::= [APPLICATION 14] SEQUENCE { 2424 entry LDAPDN, 2425 ava AttributeValueAssertion } 2427 CompareResponse ::= [APPLICATION 15] LDAPResult 2429 AbandonRequest ::= [APPLICATION 16] MessageID 2431 ExtendedRequest ::= [APPLICATION 23] SEQUENCE { 2432 requestName [0] LDAPOID, 2433 requestValue [1] OCTET STRING OPTIONAL } 2435 ExtendedResponse ::= [APPLICATION 24] SEQUENCE { 2436 COMPONENTS OF LDAPResult, 2437 responseName [10] LDAPOID OPTIONAL, 2438 responseValue [11] OCTET STRING OPTIONAL } 2440 END 2441 Lightweight Directory Access Protocol Version 3 2443 Appendix C - Change History 2444 2447 C.1 Changes made to RFC 2251: 2449 C.1.1 Editorial 2451 - Bibliography References: Changed all bibliography references to 2452 use a long name form for readability. 2453 - Changed occurrences of "unsupportedCriticalExtension" 2454 "unavailableCriticalExtension" 2455 - Fixed a small number of misspellings (mostly dropped letters). 2457 C.1.2 Section 1 2459 - Removed IESG note. 2461 C.1.3 Section 9 2463 - Added references to RFCs 1823, 2234, 2829 and 2830. 2465 C.2 Changes made to draft-ietf-ldapbis-protocol-00.txt: 2467 C.2.1 Section 4.1.6 2469 - In the first paragraph, clarified what the contents of an 2470 AttributeValue are. There was confusion regarding whether or not 2471 an AttributeValue that is BER encoded (due to the "binary" option) 2472 is to be wrapped in an extra OCTET STRING. 2473 - To the first paragraph, added wording that doesn't restrict other 2474 transfer encoding specifiers from being used. The previous wording 2475 only allowed for the string encoding and the ;binary encoding. 2476 - To the first paragraph, added a statement restricting multiple 2477 options that specify transfer encoding from being present. This 2478 was never specified in the previous version and was seen as a 2479 potential interoperability problem. 2480 - Added a third paragraph stating that the ;binary option is 2481 currently the only option defined that specifies the transfer 2482 encoding. This is for completeness. 2484 C.2.2 Section 4.1.7 2486 - Generalized the second paragraph to read "If an option specifying 2487 the transfer encoding is present in attributeDesc, the 2488 AssertionValue is encoded as specified by the option...". 2489 Previously, only the ;binary option was mentioned. 2491 C.2.3 Sections 4.2, 4.9, 4.10 2493 - Added alias dereferencing specifications. In the case of modDN, 2494 followed precedent set on other update operations (... alias is 2495 not dereferenced...) In the case of bind and compare stated that 2496 Lightweight Directory Access Protocol Version 3 2498 servers SHOULD NOT dereference aliases. Specifications were added 2499 because they were missing from the previous version and caused 2500 interoperability problems. Concessions were made for bind and 2501 compare (neither should have ever allowed alias dereferencing) by 2502 using SHOULD NOT language, due to the behavior of some existing 2503 implementations. 2505 C.2.4 Sections 4.5 and Appendix A 2507 - Changed SubstringFilter.substrings.initial, any, and all from 2508 LDAPString to AssertionValue. This was causing an incompatibility 2509 with X.500 and confusion among other TS RFCs. 2511 C.3 Changes made to draft-ietf-ldapbis-protocol-01.txt: 2513 C.3.1 Section 3.4 2515 - Reworded text surrounding subschemaSubentry to reflect that it is 2516 a single-valued attribute that holds the schema for the root DSE. 2517 Also noted that if the server masters entries that use differing 2518 schema, each entry's subschemaSubentry attribute must be 2519 interrogated. This may change as further fine-tuning is done to 2520 the data model. 2522 C.3.2 Section 4.1.12 2524 - Specified that the criticality field is only used for requests and 2525 not for unbind or abandon. Noted that it is ignored for all other 2526 operations. 2528 C.3.3 Section 4.2 2530 - Noted that Server behavior is undefined when the name is a null 2531 value, simple authentication is used, and a password is specified. 2533 C.3.4 Section 4.2.(various) 2535 - Changed "unauthenticated" to "anonymous" and "DN" and "LDAPDN" to 2536 "name" 2538 C.3.5 Section 4.2.2 2540 - Changed "there is no authentication or encryption being performed 2541 by a lower layer" to "the underlying transport service cannot 2542 guarantee confidentiality" 2544 C.3.6 Section 4.5.2 2546 - Removed all mention of ExtendedResponse due to lack of 2547 implementation. 2549 C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt: 2551 Lightweight Directory Access Protocol Version 3 2553 C.4.1 Section 4 2555 - Removed "typically" from "and is typically transferred" in the 2556 first paragraph. We know of no (and can conceive of no) case where 2557 this isn't true. 2558 - Added "Section 5.1 specifies how the LDAP protocol is encoded." To 2559 the first paragraph. Added this cross reference for readability. 2560 - Changed "version 3 " to "version 3 or later" in the second 2561 paragraph. This was added to clarify the original intent. 2562 - Changed "protocol version" to "protocol versions" in the third 2563 paragraph. This attribute is multi-valued with the intent of 2564 holding all supported versions, not just one. 2566 C.4.2 Section 4.1.8 2568 - Changed "when transferred in protocol" to "when transferred from 2569 the server to the client" in the first paragraph. This is to 2570 clarify that this behavior only happens when attributes are being 2571 sent from the server. 2573 C.4.3 Section 4.1.10 2575 - Changed "servers will return responses containing fields of type 2576 LDAPResult" to "servers will return responses of LDAPResult or 2577 responses containing the components of LDAPResponse". This 2578 statement was incorrect and at odds with the ASN.1. The fix here 2579 reflects the original intent. 2580 - Dropped '--new' from result codes ASN.1. This simplification in 2581 comments just reduces unneeded verbiage. 2583 C.4.4 Section 4.1.11 2585 - Changed "It contains a reference to another server (or set of 2586 servers)" to "It contains one or more references to one or more 2587 servers or services" in the first paragraph. This reflects the 2588 original intent and clarifies that the URL may point to non-LDAP 2589 services. 2591 C.4.5 Section 4.1.12 2593 - Changed "The server MUST be prepared" to "Implementations MUST be 2594 prepared" in the eighth paragraph to reflect that both client and 2595 server implementations must be able to handle this (as both parse 2596 controls). 2598 C.4.6 Section 4.4 2600 - Changed "One unsolicited notification is defined" to "One 2601 unsolicited notification (Notice of Disconnection) is defined" in 2602 the third paragraph. For clarity and readability. 2604 C.4.7 Section 4.5.1 2605 Lightweight Directory Access Protocol Version 3 2607 - Changed "checking for the existence of the objectClass attribute" 2608 to "checking for the presence of the objectClass attribute" in the 2609 last paragraph. This was done as a measure of consistency (we use 2610 the terms present and presence rather than exists and existence in 2611 search filters). 2613 C.4.8 Section 4.5.3 2615 - Changed "outstanding search operations to different servers," to 2616 "outstanding search operations" in the fifth paragraph as they may 2617 be to the same server. This is a point of clarification. 2619 C.4.9 Section 4.6 2621 - Changed "clients MUST NOT attempt to delete" to "clients MUST NOT 2622 attempt to add or delete" in the second to last paragraph. 2623 - Change "using the "delete" form" to "using the "add" or "delete" 2624 form" in the second to last paragraph. 2626 C.4.10 Section 4.7 2628 - Changed "Clients MUST NOT supply the createTimestamp or 2629 creatorsName attributes, since these will be generated 2630 automatically by the server." to "Clients MUST NOT supply NO-USER- 2631 MODIFICATION attributes such as createTimestamp or creatorsName 2632 attributes, since these are provided by the server." in the 2633 definition of the attributes field. This tightens the language to 2634 reflect the original intent and to not leave a hole in which one 2635 could interpret the two attributes mentioned as the only non- 2636 writable attributes. 2638 C.4.11 Section 4.11 2640 - Changed "has been" to "will be" in the fourth paragraph. This 2641 clarifies that the server will (not has) abandon the operation. 2643 C.5 Changes made to draft-ietf-ldapbis-protocol-03.txt: 2645 C.5.1 Section 3.2.1 2647 - Changed "An attribute is a type with one or more associated 2648 values. The attribute type is identified by a short descriptive 2649 name and an OID (object identifier). The attribute type governs 2650 whether there can be more than one value of an attribute of that 2651 type in an entry, the syntax to which the values must conform, the 2652 kinds of matching which can be performed on values of that 2653 attribute, and other functions." to " An attribute is a 2654 description (a type and zero or more options) with one or more 2655 associated values. The attribute type governs whether the 2656 attribute can have multiple values, the syntax and matching rules 2657 used to construct and compare values of that attribute, and other 2658 functions. Options indicate modes of transfer and other 2659 Lightweight Directory Access Protocol Version 3 2661 functions.". This points out that an attribute consists of both 2662 the type and options. 2664 C.5.2 Section 4 2666 - Changed "Section 5.1 specifies the encoding rules for the LDAP 2667 protocol" to "Section 5.1 specifies how the protocol is encoded 2668 and transferred." 2670 C.5.3 Section 4.1.2 2672 - Added ABNF for the textual representation of LDAPOID. Previously, 2673 there was no formal BNF for this construct. 2675 C.5.4 Section 4.1.4 2677 - Changed "This identifier may be written as decimal digits with 2678 components separated by periods, e.g. "2.5.4.10"" to "may be 2679 written as defined by ldapOID in section 4.1.2" in the second 2680 paragraph. This was done because we now have a formal BNF 2681 definition of an oid. 2683 C.5.5 Section 4.1.5 2685 - Changed the BNF for AttributeDescription to ABNF. This was done 2686 for readability and consistency (no functional changes involved). 2687 - Changed "Options present in an AttributeDescription are never 2688 mutually exclusive." to "Options MAY be mutually exclusive. An 2689 AttributeDescription with mutually exclusive options is treated as 2690 an undefined attribute type." for clarity. It is generally 2691 understood that this is the original intent, but the wording could 2692 be easily misinterpreted. 2693 - Changed "Any option could be associated with any AttributeType, 2694 although not all combinations may be supported by a server." to 2695 "Though any option or set of options could be associated with any 2696 AttributeType, the server support for certain combinations may be 2697 restricted by attribute type, syntaxes, or other factors.". This 2698 is to clarify the meaning of 'combination' (it applies both to 2699 combination of attribute type and options, and combination of 2700 options). It also gives examples of *why* they might be 2701 unsupported. 2703 C.5.6 Section 4.1.11 2705 - Changed the wording regarding 'equally capable' referrals to "If 2706 multiple URLs are present, the client assumes that any URL may be 2707 used to progress the operation.". The previous language implied 2708 that the server MUST enforce rules that it was practically 2709 incapable of. The new language highlights the original intent-- 2710 that is, that any of the referrals may be used to progress the 2711 operation, there is no inherent 'weighting' mechanism. 2713 C.5.7 Section 4.5.1 and Appendix A 2714 Lightweight Directory Access Protocol Version 3 2716 - Added the comment "-- initial and final can occur at most once", 2717 to clarify this restriction. 2719 C.5.8 Section 5.1 2721 - Changed heading from "Mapping Onto BER-based Transport Services" 2722 to "Protocol Encoding". 2724 C.5.9 Section 5.2.1 2726 - Changed "The LDAPMessage PDUs" to "The encoded LDAPMessage PDUs" 2727 to point out that the PDUs are encoded before being streamed to 2728 TCP. 2730 C.6 Changes made to draft-ietf-ldapbis-protocol-04.txt: 2732 C.6.1 Section 4.5.1 and Appendix A 2734 - Changed the ASN.1 for the and and or choices of Filter to have a 2735 lower range of 1. This was an omission in the original ASN.1 2737 C.6.2 Various 2739 - Fixed various typo's 2741 C.7 Changes made to draft-ietf-ldapbis-protocol-05.txt: 2743 C.7.1 Section 3.2.1 2745 - Added "(as defined in Section 12.4.1 of [X.501])" to the fifth 2746 paragraph when talking about "operational attributes". This is 2747 because the term "operational attributes" is never defined. 2748 Alternately, we could drag a definition into the spec, for now, 2749 I'm just pointing to the reference in X.501. 2751 C.7.2 Section 4.1.5 2753 - Changed "And is also case insensitive" to "The entire 2754 AttributeDescription is case insensitive". This is to clarify 2755 whether we're talking about the entire attribute description, or 2756 just the options. 2758 - Expounded on the definition of attribute description options. This 2759 doc now specifies a difference between transfer and tagging 2760 options and describes the semantics of each, and how and when 2761 subtyping rules apply. Now allow options to be transmitted in any 2762 order but disallow any ordering semantics to be implied. These 2763 changes are the result of ongoing input from an engineering team 2764 designed to deal with ambiguity issues surrounding attribute 2765 options. 2767 C.7.3 Sections 4.1.5.1 and 4.1.6 2768 Lightweight Directory Access Protocol Version 3 2770 - Refer to non "binary" transfer encodings as "native encoding" 2771 rather than "string" encoding to clarify and avoid confusion. 2773 C.8 Changes made to draft-ietf-ldapbis-protocol-06.txt: 2775 C.8.1 Title 2777 - Changed to "LDAP: The Protocol" to be consisted with other working 2778 group documents 2780 C.8.2 Abstract 2782 - Moved above TOC to conform to new guidelines 2784 - Reworded to make consistent with other WG documents. 2786 - Moved 2119 conventions to "Conventions" section 2788 C.8.3 Introduction 2790 - Created to conform to new guidelines 2792 C.8.4 Models 2794 - Removed section. There is only one model in this document 2795 (Protocol Model) 2797 C.8.5 Protocol Model 2799 - Removed antiquated paragraph: "In keeping with the goal of easing 2800 the costs associated with use of the directory, it is an objective 2801 of this protocol to minimize the complexity of clients so as to 2802 facilitate widespread deployment of applications capable of using 2803 the directory." 2805 - Removed antiquated paragraph concerning LDAP v1 and v2 and 2806 referrals. 2808 C.8.6 Data Model 2810 - Removed Section 3.2 and subsections. These have been moved to 2811 [Models] 2813 C.8.7 Relationship to X.500 2815 - Removed section. It has been moved to [Roadmap] 2817 C.8.8 Server Specific Data Requirements 2819 - Removed section. It has been moved to [Models] 2821 C.8.9 Elements of Protocol 2822 Lightweight Directory Access Protocol Version 3 2824 - Added "Section 5.1 specifies how the protocol is encoded and 2825 transferred." to the end of the first paragraph for reference. 2827 - Reworded notes about extensibility, and now talk about implied 2828 extensibility and the use of ellipses in the ASN.1 2830 - Removed references to LDAPv2 in third and fourth paragraphs. 2832 C.8.10 Message ID 2834 - Reworded second paragraph to "The message ID of a request MUST 2835 have a non-zero value different from the values of any other 2836 requests outstanding in the LDAP session of which this message is 2837 a part. The zero value is reserved for the unsolicited 2838 notification message." (Added notes about non-zero and the zero 2839 value). 2841 C.8.11 String Types 2843 - Removed ABNF for LDAPOID and added "Although an LDAPOID is encoded 2844 as an OCTET STRING, values are limited to the definition of 2845 numericoid given in Section 1.3 of [Models]." 2847 C.8.12 Distinguished Name and Relative Distinguished Name 2849 - Removed ABNF and referred to [Models] and [LDAPDN] where this is 2850 defined. 2852 C.8.13 Attribute Type 2854 - Removed sections. It's now in the [Models] doc. 2856 C.8.14 Attribute Description 2858 - Removed ABNF and aligned section with [Models] 2860 - Moved AttributeDescriptionList here. 2862 C.8.15 Transfer Options 2864 - Added section and consumed much of old options language (while 2865 aligning with [Models] 2867 C.8.16 Binary Transfer Option 2869 - Clarified intent regarding exactly what is to be BER encoded. 2871 - Clarified that clients must not expect ;binary when not asking for 2872 it (;binary, as opposed to ber encoded data). 2874 C.8.17 Attribute 2876 - Use the term "attribute description" in lieu of "type" 2877 Lightweight Directory Access Protocol Version 3 2879 - Clarified the fact that clients cannot rely on any apparent 2880 ordering of attribute values. 2882 C.8.18 LDAPResult 2884 - To resultCode, added ellipses "..." to the enumeration to indicate 2885 extensibility. and added a note, pointing to [LDAPIANA] 2887 - Removed error groupings ad refer to Appendix A. 2889 C.8.19 Bind Operation 2891 - Added "Prior to the BindRequest, the implied identity is 2892 anonymous. Refer to [AuthMeth] for the authentication-related 2893 semantics of this operation." to the first paragraph. 2895 - Added ellipses "..." to AuthenticationChoice and added a note 2896 "This type is extensible as defined in Section 3.6 of [LDAPIANA]. 2897 Servers that do not support a choice supplied by a client will 2898 return authMethodNotSupported in the result code of the 2899 BindResponse." 2901 - Simplified text regarding how the server handles unknown versions. 2902 Removed references to LDAPv2 2904 C.8.20 Sequencing of the Bind Request 2906 - Aligned with [AuthMeth] In particular, paragraphs 4 and 6 were 2907 removed, while a portion of 4 was retained (see C.8.9) 2909 C.8.21 Authentication and other Security Service 2911 - Section was removed. Now in [AuthMeth] 2913 C.8.22 Continuation References in the Search Result 2915 - Added "If the originating search scope was singleLevel, the scope 2916 part of the URL will be baseObject." 2918 C.8.23 Security Considerations 2920 - Removed reference to LDAPv2 2922 C.8.24 Result Codes 2924 - Added as normative appendix A 2926 C.8.25 ASN.1 2928 - Added EXTENSIBILITY IMPLIED 2930 - Added a number of comments holding referenced to [Models] and 2931 [ISO10646]. 2933 Lightweight Directory Access Protocol Version 3 2935 - Removed AttributeType. It is not used. 2937 C.9 Changes made to draft-ietf-ldapbis-protocol-07.txt: 2939 - Removed all mention of transfer encodings and the binary attribute 2940 option. Please refer to draft-legg-ldap-binary-00.txt and draft- 2941 legg-ldap-transfer-00.txt 2943 - Further alignment with [Models]. 2945 - Added extensibility ellipsis to protocol op choice 2947 - In 4.1.1, clarified when connections may be dropped due to 2948 malformed PDUs 2950 - Specified which matching rules and syntaxes are used for various 2951 filter items 2953 C.10 Changes made to draft-ietf-ldapbis-protocol-08.txt: 2955 C.10.1 Section 4.1.1.1: 2957 - Clarified when it is and isn't appropriate to return an already 2958 used message id. 2960 C.10.2 Section 4.1.11: 2962 - Clarified that a control only applies to the message it's attached 2963 to. 2965 - Explained that the criticality field is only applicable to certain 2966 request messages. 2968 - Added language regarding the combination of controls. 2970 C.10.3 Section 4.11: 2972 - Explained that Abandon and Unbind cannot be abandoned, and 2973 illustrated how to determine whether an operation has been 2974 abandoned. 2976 C.11 Changes made to draft-ietf-ldapbis-protocol-09.txt: 2978 - Fixed formatting 2980 C.12 Changes made to draft-ietf-ldapbis-protocol-10.txt: 2982 C.12.1 Section 4.1.4: 2984 - Removed second paragraph as this language exists in MODELS 2985 Lightweight Directory Access Protocol Version 3 2987 C.12.2 Section 4.2.1: 2989 - Replaced fourth paragraph. It was accidentally removed in an 2990 earlier edit. 2992 C.12.2 Section 4.13: 2994 - Added section describing the StartTLS operation (moved from 2995 authmeth) 2997 C.13 Changes made to draft-ietf-ldapbis-protocol-11.txt: 2999 C.13.1 Section 4.1.9 3001 - Changed "errorMessage" to "diagnosticMessage". Simply to indicate 3002 that the field may be non-empty even if a non-error resultCode is 3003 present. 3005 C.13.2 Section 4.2: 3007 - Reconciled language in "name" definition with [AuthMeth] 3009 C.13.3 Section 4.2.1 3011 - Renamed to "Processing of the Bind Request", and moved some text 3012 from 4.2 into this section. 3014 - Rearranged paragraphs to flow better. 3016 - Specified that (as well as failed) an abandoned bind operation 3017 will leave the connection in an anonymous state. 3019 C.13.4 Section 4.5.3 3021 - Generalized the second paragraph which cited indexing and 3022 searchreferralreferences. 3024 C.14 Changes made to draft-ietf-ldapbis-protocol-12.txt: 3026 - Reworked bind errors. 3027 - General clarifications and edits 3029 C.15 Changes made to draft-ietf-ldapbis-protocol-13.txt 3031 C.15.1 Section 2 & various 3032 - Added definitions for LDAP connection, TLS connection, and LDAP 3033 association, and updated appropriate fields to use proper terms. 3035 C.15.2 Section 4.2 3036 - Added text to authentication, specifying the way in which textual 3037 strings used as passwords are to be prepared. 3039 Lightweight Directory Access Protocol Version 3 3041 C.15.3 Section 4.5.1 3042 - Clarified derefInSearching. Specifically how it works in terms of 3043 subtree and one level searches 3045 C.15.4 Section 4.5.2 3047 - Changed MUST to SHOULD for returning textual attribute name, The 3048 MUST is unreasonable. There are likely cases (such as when the 3049 server knows multiple attributes in separate entries of a search 3050 result set share the same short name) where returning a numericoid 3051 is better than returning a short name. That is, the MUST may 3052 actually disallow servers from preventing misinterpretation of 3053 short names. This is not only an interop issue, but likely a 3054 security consideration. 3056 C.15.4 Section 4.9 3057 - Made modify consistent with add in regards to teh need of parent 3058 entries already existing. 3060 C.15.6 Section 4.13.2.2 3061 - Removed wording indicating that referrals can be returned from 3062 StartTLS 3064 C.16 Changes made to draft-ietf-ldapbis-protocol-14.txt 3066 C.16.1 Section 4.1.9 3068 - Added: If a server detects multiple errors for an operation, only 3069 one resultCode is returned. The server should return the 3070 resultCode that best indicates the nature of the error 3071 encountered. 3073 C.16.2 Section 4.1.11 3074 - Added: controlValues that are defined in terms of ASN.1 and BER 3075 encoded according to Section 5.1, also follow the extensibility 3076 rules in Section 4. 3078 - Removed: "If a SASL transfer encryption or integrity mechanism has 3079 been negotiated, that mechanism does not support the changing of 3080 credentials from one identity to another, then the client MUST 3081 instead establish a new connection." 3083 Each SASL negotiation is, generally, independent of other SASL 3084 negotiations. If there were dependencies between multiple 3085 negotiations of a particular mechanism, the mechanism technical 3086 specification should detail how applications are to deal with 3087 them. LDAP should not require any special handling. And if an LDAP 3088 client had used such a mechanism, it would have the option of 3089 using another mechanism. 3091 C.16.3 Section 4.5.2 and Section 7 3092 - Removed: "If the LDAP association is operating over a connection- 3093 oriented transport such as TCP" 3094 Lightweight Directory Access Protocol Version 3 3096 This is always true. 3098 C.16.4 Section 4.11 3099 - Added: thus a client SHOULD NOT use the Abandon operation when it 3100 needs an indication of whether the operation was abandoned. For 3101 example, if a client performs an update operation (Add, Modify, or 3102 ModifyDN), and it needs to know whether the directory has changed 3103 due to the operation, it should not use the Abandon operation to 3104 cancel the update operation. Clients can determine that an 3105 operation has been abandoned by performing a subsequent bind 3106 operation. 3108 C.16.5 Section 4.12 3110 - Added: 3111 "The requestValue and responseValue fields contain any information 3112 associated with the operation. The format of these fields is 3113 defined by the specification of the extended operation. 3114 Implementations MUST be prepared to handle arbitrary contents of 3115 these fields, including zero bytes. Values that are defined in 3116 terms of ASN.1 and BER encoded according to Section 5.1, also 3117 follow the extensibility rules in Section 4. 3119 Extended operations may be specified in other documents. The 3120 specification of an extended operation consists of: 3122 - the OBJECT IDENTIFIER assigned to the 3123 ExtendedRequest.requestName (and possibly 3124 ExtendedResponse.responseName), 3126 - the format of the contents of the requestValue and responseValue 3127 (if any), 3129 - the semantics of the operation, 3131 Servers list the requestName of all ExtendedRequests they 3132 recognize in the supportedExtension attribute [Models] in the root 3133 DSE. 3135 requestValues and responseValues that are defined in terms of 3136 ASN.1 and BER encoded according to Section 5.1, also follow the 3137 extensibility rules in Section 4." 3139 This was to align with controls and control values. 3141 C.16.6 Section 4.13.3.1 3143 - Added: After the TLS connection has been closed, the server MUST 3144 NOT send responses to any request message received before the TLS 3145 closure. 3147 C.16.7 Section A2 3148 - Removed precedence rules 3149 Lightweight Directory Access Protocol Version 3 3151 C.17 Changes made to draft-ietf-ldapbis-protocol-15.txt 3153 C.17.1 Section 4.1.8 3154 - Removed: "Servers which support matching rules for use in the 3155 extensibleMatch search filter MUST list the matching rules they 3156 implement in subschema entries, using the matchingRules 3157 attributes. The server SHOULD also list there, using the 3158 matchingRuleUse attribute, the attribute types with which each 3159 matching rule can be used. More information is given in section 3160 4.5 of [Syntaxes]." 3162 This language is moved to [Models] 3164 C.17.2 Section 4.10 3165 - Added: "In the event that the attribute or subtype is not present 3166 in the entry, the resultCode field is set to noSuchAttribute. If 3167 the attribute is unknown, the resultCode is set to 3168 undefinedAttributeType." 3170 C.17.3 Section 7 3171 - Added: Requirements of authentication methods, SASL mechanisms, 3172 and TLS are described in [AUTHMETH]. 3174 - Added: Protocol peers MUST be prepared to handle invalid and 3175 arbitrary length protocol encodings. A number of LDAP security 3176 advisories are available through [CERT]. 3178 C.17.4 Section 10 3179 - Added as Informative References 3181 C.17.5 Various 3182 - Clarified that the [LDAPURL] form or URLs in referrals specifies 3183 LDAP servers implementing TCP/IP. 3185 Appendix D - Outstanding Work Items 3187 D.1 General 3188 - Reconcile problems with [Models]. Section 3.2 was wholly removed. 3189 There were some protocol semantics in that section that need to be 3190 brought back. Specifically, there was the notion of the server 3191 implicitly adding objectclass superclasses when a value is added. 3193 D.2 Verify references. 3195 - Many referenced documents have changed. Ensure references and 3196 section numbers are correct. 3198 D.3 Review 2119 usage 3200 D.4 Reconcile with I-D Nits 3202 D.5 Various issues on ldapbis mailing list (some may already be 3203 resolved) 3204 Lightweight Directory Access Protocol Version 3 3206 - "Attribute Name Length Bounds" thread. 3208 - "Extensibility of SearchRequest.attributes" thread 3209 Lightweight Directory Access Protocol Version 3 3211 Full Copyright Statement 3213 Copyright (C) The Internet Society (2003). All Rights Reserved. 3215 This document and translations of it may be copied and furnished to 3216 others, and derivative works that comment on or otherwise explain it 3217 or assist in its implementation may be prepared, copied, published 3218 and distributed, in whole or in part, without restriction of any 3219 kind, provided that the above copyright notice and this paragraph are 3220 included on all such copies and derivative works. However, this 3221 document itself may not be modified in any way, such as by removing 3222 the copyright notice or references to the Internet Society or other 3223 Internet organizations, except as needed for the purpose of 3224 developing Internet standards in which case the procedures for 3225 copyrights defined in the Internet Standards process must be 3226 followed, or as required to translate it into languages other than 3227 English. 3229 The limited permissions granted above are perpetual and will not be 3230 revoked by the Internet Society or its successors or assigns. 3232 This document and the information contained herein is provided on an 3233 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 3234 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 3235 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 3236 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 3237 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.