idnits 2.17.1 draft-ietf-ldapbis-protocol-21.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 : ---------------------------------------------------------------------------- == There are 1 instance of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. == 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. -- The draft header indicates that this document obsoletes RFC2251, but the abstract doesn't seem to mention this, which it should. -- The draft header indicates that this document obsoletes RFC2830, but the abstract doesn't seem to mention this, which it should. 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 (Jan 2004) is 7407 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 2681 -- Looks like a reference, but probably isn't: '3' on line 2625 == Missing Reference: 'APPLICATION 0' is mentioned on line 2558, but not defined == Missing Reference: 'SASLprep' is mentioned on line 724, but not defined == Missing Reference: 'Stringprep' is mentioned on line 724, but not defined == Missing Reference: 'APPLICATION 1' is mentioned on line 2573, but not defined -- Looks like a reference, but probably isn't: '7' on line 2609 == Missing Reference: 'APPLICATION 2' is mentioned on line 2578, but not defined == Missing Reference: 'APPLICATION 3' is mentioned on line 2580, but not defined -- Looks like a reference, but probably isn't: '1' on line 2682 -- Looks like a reference, but probably isn't: '2' on line 2624 -- Looks like a reference, but probably isn't: '4' on line 2626 -- Looks like a reference, but probably isn't: '5' on line 2607 -- Looks like a reference, but probably isn't: '6' on line 2608 -- Looks like a reference, but probably isn't: '8' on line 2610 -- Looks like a reference, but probably isn't: '9' on line 2611 == Missing Reference: 'APPLICATION 4' is mentioned on line 2628, but not defined == Missing Reference: 'APPLICATION 19' is mentioned on line 2636, but not defined == Missing Reference: 'APPLICATION 5' is mentioned on line 2639, but not defined == Missing Reference: 'APPLICATION 6' is mentioned on line 2641, but not defined == Missing Reference: 'APPLICATION 7' is mentioned on line 2650, but not defined == Missing Reference: 'APPLICATION 8' is mentioned on line 2652, but not defined == Missing Reference: 'APPLICATION 9' is mentioned on line 2658, but not defined == Missing Reference: 'APPLICATION 10' is mentioned on line 2660, but not defined == Missing Reference: 'APPLICATION 11' is mentioned on line 2662, but not defined == Missing Reference: 'APPLICATION 12' is mentioned on line 2664, but not defined == Missing Reference: 'APPLICATION 13' is mentioned on line 2670, but not defined == Missing Reference: 'APPLICATION 14' is mentioned on line 2672, but not defined == Missing Reference: 'APPLICATION 15' is mentioned on line 2676, but not defined == Missing Reference: 'APPLICATION 16' is mentioned on line 2678, but not defined == Missing Reference: 'APPLICATION 23' is mentioned on line 2680, but not defined == Missing Reference: 'APPLICATION 24' is mentioned on line 2684, but not defined -- Looks like a reference, but probably isn't: '10' on line 2686 -- Looks like a reference, but probably isn't: '11' on line 2689 == Missing Reference: 'APPLICATION 25' is mentioned on line 1760, but not defined == Missing Reference: 'RFC2251' is mentioned on line 1801, but not defined ** Obsolete undefined reference: RFC 2251 (Obsoleted by RFC 4510, RFC 4511, RFC 4512, RFC 4513) == Missing Reference: 'Keywords' is mentioned on line 2836, but not defined == Unused Reference: 'IP' is defined on line 2083, but no explicit reference was found in the text == Unused Reference: 'SASLPrep' is defined on line 2119, but no explicit reference was found in the text == Unused Reference: 'StringPrep' is defined on line 2123, but no explicit reference was found in the text ** Obsolete normative reference: RFC 2234 (ref. 'ABNF') (Obsoleted by RFC 4234) -- No information found for draft-ietf-ldapbis-authmeth-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'AuthMeth' -- Possible downref: Non-RFC (?) normative reference: ref. 'BER' -- Possible downref: Non-RFC (?) normative reference: ref. 'ISO10646' -- 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-bcp64-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'LDAPIANA' -- No information found for draft-ietf-ldapbis-url-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'LDAPURL' -- No information found for draft-rharrison-ldap-intermediate-resp-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'LIMR' -- 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-roadmap-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'Roadmap' -- No information found for draft-ietf-sasl-rfc2222bis-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'SASL' -- No information found for draft-ietf-sasl-saslprep-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'SASLPrep' -- No information found for draft-hoffman-rfc3454bis-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'StringPrep' -- 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 793 (ref. 'TCP') (Obsoleted by RFC 9293) -- No information found for draft-ietf-tls-rfc2246-bis-xx - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'TLS' -- Possible downref: Non-RFC (?) normative reference: ref. 'Unicode' ** Obsolete normative reference: RFC 2396 (ref. 'URI') (Obsoleted by RFC 3986) Summary: 5 errors (**), 0 flaws (~~), 32 warnings (==), 43 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet-Draft Editor: J. Sermersheim 2 Intended Category: Standard Track Novell, Inc 3 Document: draft-ietf-ldapbis-protocol-21.txt Jan 2004 4 Obsoletes: RFC 2251, 2830, [LIMR] 6 LDAP: The Protocol 8 Status of this Memo 10 This document is an Internet-Draft and is in full conformance with 11 all provisions of Section 10 of RFC2026. 13 Internet-Drafts are working documents of the Internet Engineering 14 Task Force (IETF), its areas, and its working groups. Note that other 15 groups may also distribute working documents as Internet-Drafts. 16 Internet-Drafts are draft documents valid for a maximum of six months 17 and may be updated, replaced, or obsoleted by other documents at any 18 time. It is inappropriate to use Internet-Drafts as reference 19 material or to cite them other than as "work in progress." 21 The list of current Internet-Drafts can be accessed at 22 http://www.ietf.org/ietf/1id-abstracts.txt 24 The list of Internet-Draft Shadow Directories can be accessed at 25 http://www.ietf.org/shadow.html. 27 Distribution of this memo is unlimited. Technical discussion of this 28 document will take place on the IETF LDAP Revision Working Group 29 (LDAPbis) mailing list . Please send 30 editorial comments directly to the editor . 32 Abstract 34 This document describes the protocol elements, along with their 35 semantics and encodings, of the Lightweight Directory Access Protocol 36 (LDAP). LDAP provides access to distributed directory services that 37 act in accordance with X.500 data and service models. These protocol 38 elements are based on those described in the X.500 Directory Access 39 Protocol (DAP). 41 Table of Contents 43 1. Introduction....................................................2 44 1.1. Relationship to Obsolete Specifications.......................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 Lightweight Directory Access Protocol Version 3 53 4.1.3. Distinguished Name and Relative Distinguished Name..........6 54 4.1.4. Attribute Descriptions......................................7 55 4.1.5. Attribute Value.............................................7 56 4.1.6. Attribute Value Assertion...................................7 57 4.1.7. Attribute and PartialAttribute..............................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...............................................13 63 4.3. Unbind Operation.............................................16 64 4.4. Unsolicited Notification.....................................16 65 4.5. Search Operation.............................................17 66 4.6. Modify Operation.............................................26 67 4.7. Add Operation................................................27 68 4.8. Delete Operation.............................................28 69 4.9. Modify DN Operation..........................................28 70 4.10. Compare Operation...........................................30 71 4.11. Abandon Operation...........................................30 72 4.12. Extended Operation..........................................31 73 4.13. IntermediateResponse Message................................32 74 4.13.1. Usage with LDAP ExtendedRequest and ExtendedResponse......33 75 4.13.2. Usage with LDAP Request Controls..........................34 76 4.14. StartTLS Operation..........................................34 77 5. Protocol Element Encodings and Transfer........................36 78 5.1. Protocol Encoding............................................37 79 5.2. Transfer Protocols...........................................37 80 6. Security Considerations........................................37 81 7. Acknowledgements...............................................39 82 8. Normative References...........................................39 83 9. Informative References.........................................40 84 10. IANA Considerations...........................................41 85 11. Editor's Address..............................................41 86 Appendix A - LDAP Result Codes....................................42 87 A.1 Non-Error Result Codes........................................42 88 A.2 Result Codes..................................................42 89 Appendix B - Complete ASN.1 Definition............................46 90 Appendix C - Changes..............................................52 91 C.1 Changes made to made to RFC 2251:.............................52 92 C.2 Changes made to made to RFC 2830:.............................57 93 C.3 Changes made to made to [LIMR]:...............................58 95 1. Introduction 97 The Directory is "a collection of open systems cooperating to provide 98 directory services" [X.500]. A directory user, which may be a human 99 or other entity, accesses the Directory through a client (or 100 Directory User Agent (DUA)). The client, on behalf of the directory 101 user, interacts with one or more servers (or Directory System Agents 102 (DSA)). Clients interact with servers using a directory access 103 protocol. 105 Lightweight Directory Access Protocol Version 3 107 This document details the protocol elements of the Lightweight 108 Directory Access Protocol (LDAP), along with their semantics. 109 Following the description of protocol elements, it describes the way 110 in which the protocol elements are encoded and transferred. 112 1.1. Relationship to Obsolete Specifications 114 This document is an integral part of the LDAP Technical Specification 115 [Roadmap] which obsoletes the previously defined LDAP technical 116 specification, RFC 3377, in its entirety. 118 This document obsoletes all of RFC 2251 except the following: 119 Sections 3.2, 3.4, 4.1.3 (last paragraph), 4.1.4, 4.1.5, 4.1.5.1, 120 4.1.9 (last paragraph), 5.1, 6.1, and 6.2 (last paragraph) are 121 obsoleted by [Models]. 122 Section 3.3 is obsoleted by [Roadmap]. 123 Sections 4.2.1 (portions), and 4.2.2 are obsoleted by [AuthMeth]. 125 Appendix C.1 summarizes substantive changes to the remaining 126 sections. 128 This document obsoletes RFC 2830, Sections 2 and 4 in entirety. The 129 remainder of RFC 2830 is obsoleted by [AuthMeth]. Appendix C.2 130 summarizes substantive changes to the remaining sections. 132 This document also obsoletes [LIMR] in entrirety. 133 <> 137 2. Conventions 139 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 140 "SHOULD", "SHOULD NOT", "RECOMMENDED", and "MAY" in this document are 141 to be interpreted as described in [Keyword]. 143 The terms "connection" and "LDAP connection" both refer to the 144 underlying transport protocol connection between two protocol peers. 146 The term "TLS connection" refers to a [TLS]-protected LDAP 147 connection. 149 The terms "association" and "LDAP association" both refer to the 150 association of the LDAP connection and its current authentication and 151 authorization state. 153 3. Protocol Model 155 The general model adopted by this protocol is one of clients 156 performing protocol operations against servers. In this model, a 157 client transmits a protocol request describing the operation to be 158 performed to a server. The server is then responsible for performing 159 Lightweight Directory Access Protocol Version 3 161 the necessary operation(s) in the Directory. Upon completion of an 162 operation, the server typically returns a response containing 163 appropriate data to the requesting client. 165 Although servers are required to return responses whenever such 166 responses are defined in the protocol, there is no requirement for 167 synchronous behavior on the part of either clients or servers. 168 Requests and responses for multiple operations generally may be 169 exchanged between a client and server in any order, provided the 170 client eventually receives a response for every request that requires 171 one. 173 The core protocol operations defined in this document can be mapped 174 to a subset of the X.500 (1993) Directory Abstract Service [X.511]. 175 However there is not a one-to-one mapping between LDAP operations and 176 X.500 Directory Access Protocol (DAP) operations. Server 177 implementations acting as a gateway to X.500 directories may need to 178 make multiple DAP requests to service a single LDAP request. 180 4. Elements of Protocol 182 The protocol is described using Abstract Syntax Notation One 183 ([ASN.1]), and is transferred using a subset of ASN.1 Basic Encoding 184 Rules ([BER]). Section 5.1 specifies how the protocol elements are 185 encoded and transferred. 187 In order to support future extensions to this protocol, extensibility 188 is implied where it is allowed (per ASN.1). In addition, ellipses 189 (...) have been supplied in ASN.1 types that are explicitly 190 extensible as discussed in [LDAPIANA]. Because of the implied 191 extensibility, clients and servers MUST (unless otherwise specified) 192 ignore trailing SEQUENCE components whose tags they do not recognize. 194 Changes to the protocol other than through the extension mechanisms 195 described here require a different version number. A client indicates 196 the version it is using as part of the bind request, described in 197 Section 4.2. If a client has not sent a bind, the server MUST assume 198 the client is using version 3 or later. 200 Clients may determine the protocol versions a server supports by 201 reading the 'supportedLDAPVersion' attribute from the root DSE (DSA- 202 Specific Entry) [Models]. 204 4.1. Common Elements 206 This section describes the LDAPMessage envelope Protocol Data Unit 207 (PDU) format, as well as data type definitions, which are used in the 208 protocol operations. 210 4.1.1. Message Envelope 211 Lightweight Directory Access Protocol Version 3 213 For the purposes of protocol exchanges, all protocol operations are 214 encapsulated in a common envelope, the LDAPMessage, which is defined 215 as follows: 217 LDAPMessage ::= SEQUENCE { 218 messageID MessageID, 219 protocolOp CHOICE { 220 bindRequest BindRequest, 221 bindResponse BindResponse, 222 unbindRequest UnbindRequest, 223 searchRequest SearchRequest, 224 searchResEntry SearchResultEntry, 225 searchResDone SearchResultDone, 226 searchResRef SearchResultReference, 227 modifyRequest ModifyRequest, 228 modifyResponse ModifyResponse, 229 addRequest AddRequest, 230 addResponse AddResponse, 231 delRequest DelRequest, 232 delResponse DelResponse, 233 modDNRequest ModifyDNRequest, 234 modDNResponse ModifyDNResponse, 235 compareRequest CompareRequest, 236 compareResponse CompareResponse, 237 abandonRequest AbandonRequest, 238 extendedReq ExtendedRequest, 239 extendedResp ExtendedResponse, 240 intermediateResponse IntermediateResponse 241 ... }, 242 controls [0] Controls OPTIONAL } 244 MessageID ::= INTEGER (0 .. maxInt) 246 maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- 248 The ASN.1 type Controls is defined in Section 4.1.11. 250 The function of the LDAPMessage is to provide an envelope containing 251 common fields required in all protocol exchanges. At this time the 252 only common fields are the message ID and the controls. 254 If the server receives a PDU from the client in which the LDAPMessage 255 SEQUENCE tag cannot be recognized, the messageID cannot be parsed, 256 the tag of the protocolOp is not recognized as a request, or the 257 encoding structures or lengths of data fields are found to be 258 incorrect, then the server SHOULD return the Notice of Disconnection 259 described in Section 4.4.1, with the resultCode set to protocolError, 260 and MUST immediately close the connection. 262 In other cases where the client or server cannot parse a PDU, it 263 SHOULD abruptly close the connection where further communication 264 (including providing notice) would be pernicious. Otherwise, server 265 implementations MUST return an appropriate response to the request, 266 with the resultCode set to protocolError. 268 Lightweight Directory Access Protocol Version 3 270 4.1.1.1. Message ID 272 All LDAPMessage envelopes encapsulating responses contain the 273 messageID value of the corresponding request LDAPMessage. 275 The message ID of a request MUST have a non-zero value different from 276 the values of any other requests outstanding in the LDAP association 277 of which this message is a part. The zero value is reserved for the 278 unsolicited notification message. 280 Typical clients increment a counter for each request. 282 A client MUST NOT send a request with the same message ID as an 283 earlier request on the same LDAP association unless it can be 284 determined that the server is no longer servicing the earlier request 285 (e.g. after the final response is received, or a subsequent bind 286 completes). Otherwise the behavior is undefined. For this purpose, 287 note that abandon and abandoned operations do not send responses. 289 4.1.2. String Types 291 The LDAPString is a notational convenience to indicate that, although 292 strings of LDAPString type encode as ASN.1 OCTET STRING types, the 293 [ISO10646] character set (a superset of [Unicode]) is used, encoded 294 following the [UTF-8] algorithm. Note that Unicode characters U+0000 295 through U+007F are the same as ASCII 0 through 127, respectively, and 296 have the same single octet UTF-8 encoding. Other Unicode characters 297 have a multiple octet UTF-8 encoding. 299 LDAPString ::= OCTET STRING -- UTF-8 encoded, 300 -- [ISO10646] characters 302 The LDAPOID is a notational convenience to indicate that the 303 permitted value of this string is a (UTF-8 encoded) dotted-decimal 304 representation of an OBJECT IDENTIFIER. Although an LDAPOID is 305 encoded as an OCTET STRING, values are limited to the definition of 306 given in Section 1.4 of [Models]. 308 LDAPOID ::= OCTET STRING -- Constrained to [Models] 310 For example, 312 1.3.6.1.4.1.1466.1.2.3 314 4.1.3. Distinguished Name and Relative Distinguished Name 316 An LDAPDN is defined to be the representation of a Distinguished Name 317 (DN) after encoding according to the specification in [LDAPDN]. 319 LDAPDN ::= LDAPString 320 Lightweight Directory Access Protocol Version 3 322 -- Constrained to [LDAPDN] 324 A RelativeLDAPDN is defined to be the representation of a Relative 325 Distinguished Name (RDN) after encoding according to the 326 specification in [LDAPDN]. 328 RelativeLDAPDN ::= LDAPString 329 -- Constrained to [LDAPDN] 331 4.1.4. Attribute Descriptions 333 The definition and encoding rules for attribute descriptions are 334 defined in Section 2.5 of [Models]. Briefly, an attribute description 335 is an attribute type and zero or more options. 337 AttributeDescription ::= LDAPString 338 -- Constrained to 339 -- [Models] 341 4.1.5. Attribute Value 343 A field of type AttributeValue is an OCTET STRING containing an 344 encoded attribute value. The attribute value is encoded according to 345 the LDAP-specific encoding definition of its corresponding syntax. 346 The LDAP-specific encoding definitions for different syntaxes and 347 attribute types may be found in other documents and in particular 348 [Syntaxes]. 350 AttributeValue ::= OCTET STRING 352 Note that there is no defined limit on the size of this encoding; 353 thus protocol values may include multi-megabyte attribute values 354 (e.g. photographs). 356 Attribute values may be defined which have arbitrary and non- 357 printable syntax. Implementations MUST NOT display nor attempt to 358 decode an attribute value if its syntax is not known. The 359 implementation may attempt to discover the subschema of the source 360 entry, and retrieve the descriptions of 'attributeTypes' from it 361 [Models]. 363 Clients MUST only send attribute values in a request that are valid 364 according to the syntax defined for the attributes. 366 4.1.6. Attribute Value Assertion 368 The AttributeValueAssertion (AVA) type definition is similar to the 369 one in the X.500 Directory standards. It contains an attribute 370 description and a matching rule ([Models Section 4.1.3) assertion 371 value suitable for that type. Elements of this type are typically 372 Lightweight Directory Access Protocol Version 3 374 used to assert that the value in assertionValue matches a value of an 375 attribute. 377 AttributeValueAssertion ::= SEQUENCE { 378 attributeDesc AttributeDescription, 379 assertionValue AssertionValue } 381 AssertionValue ::= OCTET STRING 383 The syntax of the AssertionValue depends on the context of the LDAP 384 operation being performed. For example, the syntax of the EQUALITY 385 matching rule for an attribute is used when performing a Compare 386 operation. Often this is the same syntax used for values of the 387 attribute type, but in some cases the assertion syntax differs from 388 the value syntax. See objectIdentiferFirstComponentMatch in 389 [Syntaxes] for an example. 391 4.1.7. Attribute and PartialAttribute 393 Attributes and partial attributes consist of an attribute description 394 and attribute values. A PartialAttribute allows zero values, while 395 Attribute requires at least one value. 397 PartialAttribute ::= SEQUENCE { 398 type AttributeDescription, 399 vals SET OF value AttributeValue } 401 Attribute ::= PartialAttribute(WITH COMPONENTS { 402 ..., 403 vals (SIZE(1..MAX))}) 405 No two attribute values are equivalent as described by Section 2.3 of 406 [Models]. The set of attribute values is unordered. Implementations 407 MUST NOT rely upon the ordering being repeatable. 409 4.1.8. Matching Rule Identifier 411 Matching rules are defined in Section 4.1.3 of [Models]. A matching 412 rule is identified in the protocol by the printable representation of 413 either its , or one of its short name descriptors 414 [Models], e.g. 'caseIgnoreMatch' or '2.5.13.2'. 416 MatchingRuleId ::= LDAPString 418 4.1.9. Result Message 420 The LDAPResult is the construct used in this protocol to return 421 success or failure indications from servers to clients. To various 422 requests, servers will return responses of LDAPResult or responses 423 containing the components of LDAPResult to indicate the final status 424 of a protocol operation request. 426 Lightweight Directory Access Protocol Version 3 428 LDAPResult ::= SEQUENCE { 429 resultCode ENUMERATED { 430 success (0), 431 operationsError (1), 432 protocolError (2), 433 timeLimitExceeded (3), 434 sizeLimitExceeded (4), 435 compareFalse (5), 436 compareTrue (6), 437 authMethodNotSupported (7), 438 strongAuthRequired (8), 439 -- 9 reserved -- 440 referral (10), 441 adminLimitExceeded (11), 442 unavailableCriticalExtension (12), 443 confidentialityRequired (13), 444 saslBindInProgress (14), 445 noSuchAttribute (16), 446 undefinedAttributeType (17), 447 inappropriateMatching (18), 448 constraintViolation (19), 449 attributeOrValueExists (20), 450 invalidAttributeSyntax (21), 451 -- 22-31 unused -- 452 noSuchObject (32), 453 aliasProblem (33), 454 invalidDNSyntax (34), 455 -- 35 reserved for undefined isLeaf -- 456 aliasDereferencingProblem (36), 457 -- 37-47 unused -- 458 inappropriateAuthentication (48), 459 invalidCredentials (49), 460 insufficientAccessRights (50), 461 busy (51), 462 unavailable (52), 463 unwillingToPerform (53), 464 loopDetect (54), 465 -- 55-63 unused -- 466 namingViolation (64), 467 objectClassViolation (65), 468 notAllowedOnNonLeaf (66), 469 notAllowedOnRDN (67), 470 entryAlreadyExists (68), 471 objectClassModsProhibited (69), 472 -- 70 reserved for CLDAP -- 473 affectsMultipleDSAs (71), 474 -- 72-79 unused -- 475 other (80), 476 ... }, 477 matchedDN LDAPDN, 478 diagnosticMessage LDAPString, 479 referral [3] Referral OPTIONAL } 480 Lightweight Directory Access Protocol Version 3 482 The resultCode enumeration is extensible as defined in Section 3.6 of 483 [LDAPIANA]. The meanings of the listed result codes are given in 484 Appendix A. If a server detects multiple errors for an operation, 485 only one result code is returned. The server should return the result 486 code that best indicates the nature of the error encountered. 488 The diagnosticMessage field of this construct may, at the server's 489 option, be used to return a string containing a textual, human- 490 readable (terminal control and page formatting characters should be 491 avoided) diagnostic message. As this diagnostic message is not 492 standardized, implementations MUST NOT rely on the values returned. 493 If the server chooses not to return a textual diagnostic, the 494 diagnosticMessage field MUST be empty. 496 For certain result codes (typically, but not restricted to 497 noSuchObject, aliasProblem, invalidDNSyntax and 498 aliasDereferencingProblem), the matchedDN field is set to the name of 499 the lowest entry (object or alias) in the Directory that was matched. 500 If no aliases were dereferenced while attempting to locate the entry, 501 this will be a truncated form of the name provided, or if aliases 502 were dereferenced, of the resulting name, as defined in Section 12.5 503 of [X.511]. Otherwise the matchedDN field is empty. 505 4.1.10. Referral 507 The referral result code indicates that the contacted server does not 508 hold the target entry of the request. The referral field is present 509 in an LDAPResult if the resultCode field value is referral, and 510 absent with all other result codes. It contains one or more 511 references to one or more servers or services that may be accessed 512 via LDAP or other protocols. Referrals can be returned in response to 513 any operation request (except unbind and abandon which do not have 514 responses). At least one URI MUST be present in the Referral. 516 During a search operation, after the baseObject is located, and 517 entries are being evaluated, the referral is not returned. Instead, 518 continuation references, described in Section 4.5.3, are returned 519 when other servers would need to be contacted to complete the 520 operation. 522 Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI 524 URI ::= LDAPString -- limited to characters permitted in 525 -- URIs 527 If the client wishes to progress the operation, it MUST follow the 528 referral by contacting one of the supported services. If multiple 529 URIs are present, the client assumes that any supported URI may be 530 used to progress the operation. 532 Clients that follow referrals MUST ensure that they do not loop 533 between servers. They MUST NOT repeatedly contact the same server for 534 the same request with the same target entry name, scope and filter. 536 Lightweight Directory Access Protocol Version 3 538 Some clients use a counter that is incremented each time referral 539 handling occurs for an operation, and these kinds of clients MUST be 540 able to handle at least ten nested referrals between the root and a 541 leaf entry. 543 A URI for a server implementing LDAP and accessible via [TCP]/[IP] 544 (v4 or v6) is written as an LDAP URL according to [LDAPURL]. 546 When an LDAP URL is used, the following instructions are followed: 548 - If an alias was dereferenced, the part of the URL MUST be 549 present, with the new target object name. UTF-8 encoded characters 550 appearing in the string representation of a DN or search filter 551 may not be legal for URLs (e.g. spaces) and MUST be escaped using 552 the % method in [URI]. 553 - It is RECOMMENDED that the part be present to avoid 554 ambiguity. 555 - If the part is present, the client MUST use this name in its 556 next request to progress the operation, and if it is not present 557 the client will use the same name as in the original request. 558 - Some servers (e.g. participating in distributed indexing) may 559 provide a different filter in a URL of a referral for a search 560 operation. 561 - If the part of the LDAP URL is present, the client MUST 562 use this filter in its next request to progress this search, and 563 if it is not present the client MUST use the same filter as it 564 used for that search. 565 - For search, it is RECOMMENDED that the part be present to 566 avoid ambiguity. 567 - If the part is missing, the scope of the original search 568 is used by the client to progress the operation. 569 - Other aspects of the new request may be the same as or different 570 from the request which generated the referral. 572 Other kinds of URIs may be returned. The syntax and semantics of such 573 URIs is left to future specifications. Clients may ignore URIs that 574 they do not support. 576 4.1.11. Controls 578 Controls provide a mechanism whereby the semantics and arguments of 579 existing LDAP operations may be extended. One or more controls may be 580 attached to a single LDAP message. A control only affects the 581 semantics of the message it is attached to. 583 Controls sent by clients are termed 'request controls' and those sent 584 by servers are termed 'response controls'. 585 When an extension calls for a particular response control to be sent 586 in response to a request control, the response and request controls 587 are termed to be "paired". 589 Controls ::= SEQUENCE OF control Control 590 Lightweight Directory Access Protocol Version 3 592 Control ::= SEQUENCE { 593 controlType LDAPOID, 594 criticality BOOLEAN DEFAULT FALSE, 595 controlValue OCTET STRING OPTIONAL } 597 The controlType field is the dotted-decimal representation of an 598 OBJECT IDENTIFIER which uniquely identifies the control, or the 599 request control and its paired response control. This provides 600 unambiguous naming of controls. 602 The criticality field only has meaning in controls attached to 603 request messages (except unbindRequest). For controls attached to 604 response messages and the unbindRequest, the criticality field SHOULD 605 be FALSE, and MUST be ignored by the receiving protocol peer. A value 606 of TRUE indicates that it is unacceptable to perform the operation 607 without applying the semantics of the control and FALSE otherwise. 608 Specifically, the criticality field is applied as follows: 610 - Regardless of the value of the criticality field, if the server 611 recognizes the control type and it is appropriate for the 612 operation, the server is to make use of the control when 613 performing the operation. 615 - If the server does not recognize the control type or it is not 616 appropriate for the operation, and the criticality field is TRUE, 617 the server MUST NOT perform the operation, and for operations that 618 have a response message, MUST return unavailableCriticalExtension 619 in the resultCode. 621 - If the server does not recognize the control type or it is not 622 appropriate for the operation, and the criticality field is FALSE, 623 the server MUST ignore the control. 625 The controlValue may contain information associated with the 626 controlType. Its format is defined by the specification of the 627 control. Implementations MUST be prepared to handle arbitrary 628 contents of the controlValue octet string, including zero bytes. It 629 is absent only if there is no value information which is associated 630 with a control of its type. When a controlValue is defined in terms 631 of ASN.1, and BER encoded according to Section 5.1, it also follows 632 the extensibility rules in Section 4. 634 Servers list the controlType of all request controls they recognize 635 in the supportedControl attribute in the root DSE (Section 5.1 of 636 [Models]). 638 Controls SHOULD NOT be combined unless the semantics of the 639 combination has been specified. The semantics of control 640 combinations, if specified, are generally found in the control 641 specification most recently published. In the absence of combination 642 semantics, the behavior of the operation is undefined. 643 Additionally, unless order-dependent semantics are given in a 644 specification, the order of a combination of controls in the SEQUENCE 645 is ignored. 647 Lightweight Directory Access Protocol Version 3 649 This document does not specify any controls. Controls may be 650 specified in other documents. Documents detailing control extensions 651 are to provide for each control: 653 - the OBJECT IDENTIFIER assigned to the control, 655 - direction as to what value the sender should provide for the 656 criticality field (note: the semantics of the criticality field 657 are defined above should not be altered by the control's 658 specification), 660 - whether information is to be present in the controlValue field, 661 and if so, the format of the controlValue contents, 663 - the semantics of the control, and 665 - optionally, semantics regarding the combination of the control 666 with other controls. 668 4.2. Bind Operation 670 The function of the Bind Operation is to allow authentication 671 information to be exchanged between the client and server. The Bind 672 operation should be thought of as the "authenticate" operation. 673 Authentication and security-related semantics of this operation are 674 given in [AuthMeth]. 676 The Bind Request is defined as follows: 678 BindRequest ::= [APPLICATION 0] SEQUENCE { 679 version INTEGER (1 .. 127), 680 name LDAPDN, 681 authentication AuthenticationChoice } 683 AuthenticationChoice ::= CHOICE { 684 simple [0] OCTET STRING, 685 -- 1 and 2 reserved 686 sasl [3] SaslCredentials, 687 ... } 689 SaslCredentials ::= SEQUENCE { 690 mechanism LDAPString, 691 credentials OCTET STRING OPTIONAL } 693 Fields of the Bind Request are: 695 - version: A version number indicating the version of the protocol 696 to be used in this LDAP association. This document describes 697 version 3 of the protocol. There is no version negotiation. The 698 client sets this field to the version it desires. If the server 699 does not support the specified version, it MUST respond with 700 protocolError in the resultCode field of the BindResponse. 702 Lightweight Directory Access Protocol Version 3 704 - name: The name of the Directory object that the client wishes to 705 bind as. This field may take on a null value (a zero length 706 string) for the purposes of anonymous binds ([AuthMeth] Section 707 5.1) or when using Simple Authentication and Security Layer [SASL] 708 authentication ([AuthMeth] Section 3.3.2). Server behavior is 709 undefined when the name is a null value, simple authentication is 710 used, and a non-null password is specified. Where the server 711 attempts to locate the named object, it SHALL NOT perform alias 712 dereferencing. 714 - authentication: information used in authentication. This type is 715 extensible as defined in Section 3.7 of [LDAPIANA]. Servers that 716 do not support a choice supplied by a client return 717 authMethodNotSupported in the resultCode field of the 718 BindResponse. 720 Textual passwords (consisting of a character sequence with a known 721 character set and encoding) transferred to the server using the 722 simple AuthenticationChoice SHALL be transferred as [UTF-8] 723 encoded [Unicode]. Prior to transfer, clients SHOULD prepare text 724 passwords by applying the [SASLprep] profile of the [Stringprep] 725 algorithm. Passwords consisting of other data (such as random 726 octets) MUST NOT be altered. The determination of whether a 727 password is textual is a local client matter. 729 Authorization is the use of this authentication information when 730 performing operations. Authorization MAY be affected by factors 731 outside of the LDAP Bind Request, such as those provided by lower 732 layer security services. 734 4.2.1. Processing of the Bind Request 736 Before processing a BindRequest, all outstanding operations MUST 737 either complete or be abandoned. The server may either wait for the 738 outstanding operations to complete, or abandon them. The server then 739 proceeds to authenticate the client in either a single-step, or 740 multi-step bind process. Each step requires the server to return a 741 BindResponse to indicate the status of authentication. 743 If the client did not bind before sending a request and receives an 744 operationsError to that request, it may then send a Bind Request. If 745 this also fails or the client chooses not to bind on the existing 746 connection, it may close the connection, reopen it and begin again by 747 first sending a PDU with a Bind Request. This will aid in 748 interoperating with servers implementing other versions of LDAP. 750 Clients may send multiple Bind Requests on a connection to change the 751 authentication and/or security associations or to complete a multi- 752 stage bind process. Authentication from earlier binds is subsequently 753 ignored. 755 Lightweight Directory Access Protocol Version 3 757 For some SASL authentication mechanisms, it may be necessary for the 758 client to invoke the BindRequest multiple times. This is indicated by 759 the server sending a BindResponse with the resultCode set to 760 saslBindInProgress. This indicates that the server requires the 761 client to send a new bind request, with the same sasl mechanism, to 762 continue the authentication process. Clients MUST NOT invoke 763 operations between two Bind Requests made as part of a multi-stage 764 bind. 766 A client may abort a SASL bind negotiation by sending a BindRequest 767 with a different value in the mechanism field of SaslCredentials, or 768 an AuthenticationChoice other than sasl. 770 If the client sends a BindRequest with the sasl mechanism field as an 771 empty string, the server MUST return a BindResponse with 772 authMethodNotSupported as the resultCode. This will allow clients to 773 abort a negotiation if it wishes to try again with the same SASL 774 mechanism. 776 A failed Bind Operation has the effect of placing the connection in 777 an anonymous state. 779 4.2.2. Bind Response 781 The Bind Response is defined as follows. 783 BindResponse ::= [APPLICATION 1] SEQUENCE { 784 COMPONENTS OF LDAPResult, 785 serverSaslCreds [7] OCTET STRING OPTIONAL } 787 BindResponse consists simply of an indication from the server of the 788 status of the client's request for authentication. 790 A successful bind operation is indicated by a BindResponse with a 791 resultCode set to success. Otherwise, an appropriate result code is 792 set in the BindResponse. For bind, the protocolError result code may 793 be used to indicate that the version number supplied by the client is 794 unsupported. 796 If the client receives a BindResponse where the resultCode field is 797 protocolError, it is to assume that the server does not support this 798 version of LDAP. While the client may be able proceed with another 799 version of this protocol (this may or may not require establishing a 800 new connection), how to proceed with another version of this protocol 801 is beyond the scope of this document. Clients which are unable or 802 unwilling to proceed SHOULD drop the underlying connection. 804 The serverSaslCreds field is used as part of a SASL-defined bind 805 mechanism to allow the client to authenticate the server to which it 806 is communicating, or to perform "challenge-response" authentication. 807 If the client bound with the simple choice, or the SASL mechanism 808 does not require the server to return information to the client, then 809 this field SHALL NOT be included in the BindResponse. 811 Lightweight Directory Access Protocol Version 3 813 4.3. Unbind Operation 815 The function of the Unbind Operation is to terminate an LDAP 816 association and connection. The Unbind operation is not the 817 antithesis of the Bind operation as the name implies. The naming of 818 these operations is historical. The Unbind operation should be 819 thought of as the "quit" operation. 821 The Unbind Operation is defined as follows: 823 UnbindRequest ::= [APPLICATION 2] NULL 825 The Unbind Operation has no response defined. Upon transmission of 826 the UnbindRequest, each protocol peer is to consider the LDAP 827 association terminated, MUST cease transmission of messages to the 828 other peer, and MUST close the connection. Outstanding operations are 829 handled as specified in Section 5.2. 831 4.4. Unsolicited Notification 833 An unsolicited notification is an LDAPMessage sent from the server to 834 the client which is not in response to any LDAPMessage received by 835 the server. It is used to signal an extraordinary condition in the 836 server or in the connection between the client and the server. The 837 notification is of an advisory nature, and the server will not expect 838 any response to be returned from the client. 840 The unsolicited notification is structured as an LDAPMessage in which 841 the messageID is zero and protocolOp is of the extendedResp form (See 842 Section 4.12). The responseName field of the ExtendedResponse always 843 contains an LDAPOID which is unique for this notification. 845 One unsolicited notification (Notice of Disconnection) is defined in 846 this document. The specification of an unsolicited notification 847 consists of: 849 - the OBJECT IDENTIFIER assigned to the notification (to be 850 specified in the responseName, 852 - the format of the contents (if any) of the responseValue, 854 - the circumstances which will cause the notification to be 855 returned, and 857 - the semantics of the operation. 859 4.4.1. Notice of Disconnection 861 This notification may be used by the server to advise the client that 862 the server is about to close the connection due to an error 863 condition. This notification is intended to assist clients in 864 Lightweight Directory Access Protocol Version 3 866 distinguishing between an error condition and a transient network 867 failure. Note that this notification is not a response to an unbind 868 requested by the client. Outstanding operations are handled as 869 specified in Section 5.2. 871 The responseName is 1.3.6.1.4.1.1466.20036, the response field is 872 absent, and the resultCode is used to indicate the reason for the 873 disconnection. 875 The following result codes have these meanings when used in this 876 notification: 878 - protocolError: The server has received data from the client in 879 which the LDAPMessage structure could not be parsed. 881 - strongAuthRequired: The server has detected that an established 882 security association between the client and server has 883 unexpectedly failed or been compromised, or that the server now 884 requires the client to authenticate using a strong(er) mechanism. 886 - unavailable: This server will stop accepting new connections and 887 operations on all existing connections, and be unavailable for an 888 extended period of time. The client may make use of an alternative 889 server. 891 Upon transmission of the Notice of Disconnection, the server is to 892 consider the LDAP association terminated, MUST cease transmission of 893 messages to the client, and MUST close the connection. 895 4.5. Search Operation 897 The Search Operation is used to request a server to return, subject 898 to access controls and other restrictions, a set of entries matching 899 a complex search criterion. This can be used to read attributes from 900 a single entry, from entries immediately subordinate to a particular 901 entry, or a whole subtree of entries. 903 4.5.1. Search Request 905 The Search Request is defined as follows: 907 SearchRequest ::= [APPLICATION 3] SEQUENCE { 908 baseObject LDAPDN, 909 scope ENUMERATED { 910 baseObject (0), 911 singleLevel (1), 912 wholeSubtree (2) }, 913 derefAliases ENUMERATED { 914 neverDerefAliases (0), 915 derefInSearching (1), 916 derefFindingBaseObj (2), 917 derefAlways (3) }, 918 Lightweight Directory Access Protocol Version 3 920 sizeLimit INTEGER (0 .. maxInt), 921 timeLimit INTEGER (0 .. maxInt), 922 typesOnly BOOLEAN, 923 filter Filter, 924 attributes AttributeSelection } 926 AttributeSelection ::= SEQUENCE OF selection LDAPString 927 -- constrained to below 929 Filter ::= CHOICE { 930 and [0] SET SIZE (1..MAX) OF filter Filter, 931 or [1] SET SIZE (1..MAX) OF filter Filter, 932 not [2] Filter, 933 equalityMatch [3] AttributeValueAssertion, 934 substrings [4] SubstringFilter, 935 greaterOrEqual [5] AttributeValueAssertion, 936 lessOrEqual [6] AttributeValueAssertion, 937 present [7] AttributeDescription, 938 approxMatch [8] AttributeValueAssertion, 939 extensibleMatch [9] MatchingRuleAssertion } 941 SubstringFilter ::= SEQUENCE { 942 type AttributeDescription, 943 -- initial and final can occur at most once 944 substrings SEQUENCE SIZE (1..MAX) OF substring CHOICE { 945 initial [0] AssertionValue, 946 any [1] AssertionValue, 947 final [2] AssertionValue } } 949 MatchingRuleAssertion ::= SEQUENCE { 950 matchingRule [1] MatchingRuleId OPTIONAL, 951 type [2] AttributeDescription OPTIONAL, 952 matchValue [3] AssertionValue, 953 dnAttributes [4] BOOLEAN DEFAULT FALSE } 955 Fields of the Search Request are: 957 - baseObject: The name of the base object entry relative to which 958 the search is to be performed. 960 - scope: Specifies the scope of the search to be performed. The 961 semantics (as described in [X.511]) of the possible values of this 962 field are: 964 baseObject: The scope is constrained to the entry named by 965 baseObject. 967 singleLevel: The scope is constrained to the immediate 968 subordinates of the entry named by baseObject. 970 wholeSubtree: the scope is constrained to the entry named by 971 the baseObject, and all its subordinates. 973 Lightweight Directory Access Protocol Version 3 975 - derefAliases: An indicator as to how alias entries (as defined in 976 [Models]) are to be handled in searching. The semantics of the 977 possible values of this field are: 979 neverDerefAliases: Do not dereference aliases in searching or 980 in locating the base object of the search. 982 derefInSearching: While searching, dereference any alias entry 983 subordinate to the base object which is also in the search 984 scope. The filter is applied to the dereferenced object(s). If 985 the search scope is wholeSubtree, the search continues in the 986 subtree of any dereferenced object. Aliases in that subtree are 987 also dereferenced. Servers SHOULD eliminate duplicate entries 988 that arise due to alias dereferencing while searching. 990 derefFindingBaseObj: Dereference aliases in locating the base 991 object of the search, but not when searching subordinates of 992 the base object. 994 derefAlways: Dereference aliases both in searching and in 995 locating the base object of the search. 996 Servers MUST detect looping while dereferencing aliases in order 997 to prevent denial of service attacks of this nature. 999 - sizeLimit: A size limit that restricts the maximum number of 1000 entries to be returned as a result of the search. A value of zero 1001 in this field indicates that no client-requested size limit 1002 restrictions are in effect for the search. Servers may also 1003 enforce a maximum number of entries to return. 1005 - timeLimit: A time limit that restricts the maximum time (in 1006 seconds) allowed for a search. A value of zero in this field 1007 indicates that no client-requested time limit restrictions are in 1008 effect for the search. Servers may also enforce a maximum time 1009 limit for the search. 1011 - typesOnly: An indicator as to whether search results are to 1012 contain both attribute descriptions and values, or just attribute 1013 descriptions. Setting this field to TRUE causes only attribute 1014 descriptions (no values) to be returned. Setting this field to 1015 FALSE causes both attribute descriptions and values to be 1016 returned. 1018 - filter: A filter that defines the conditions that must be 1019 fulfilled in order for the search to match a given entry. 1021 The 'and', 'or' and 'not' choices can be used to form combinations 1022 of filters. At least one filter element MUST be present in an 1023 'and' or 'or' choice. The others match against individual 1024 attribute values of entries in the scope of the search. 1025 (Implementor's note: the 'not' filter is an example of a tagged 1026 choice in an implicitly-tagged module. In BER this is treated as 1027 if the tag was explicit.) 1028 Lightweight Directory Access Protocol Version 3 1030 A server MUST evaluate filters according to the three-valued logic 1031 of X.511 (1993) Section 7.8.1. In summary, a filter is evaluated 1032 to either "TRUE", "FALSE" or "Undefined". If the filter evaluates 1033 to TRUE for a particular entry, then the attributes of that entry 1034 are returned as part of the search result (subject to any 1035 applicable access control restrictions). If the filter evaluates 1036 to FALSE or Undefined, then the entry is ignored for the search. 1038 A filter of the "and" choice is TRUE if all the filters in the SET 1039 OF evaluate to TRUE, FALSE if at least one filter is FALSE, and 1040 otherwise Undefined. A filter of the "or" choice is FALSE if all 1041 of the filters in the SET OF evaluate to FALSE, TRUE if at least 1042 one filter is TRUE, and Undefined otherwise. A filter of the 'not' 1043 choice is TRUE if the filter being negated is FALSE, FALSE if it 1044 is TRUE, and Undefined if it is Undefined. 1046 The present match evaluates to TRUE where there is an attribute or 1047 subtype of the specified attribute description present in an 1048 entry, and FALSE otherwise (including a presence test with an 1049 unrecognized attribute description.) 1051 The matching rule for equalityMatch filter items is defined by the 1052 EQUALITY matching rule for the attribute type. 1054 There SHALL be at most one 'initial', and at most one 'final' in 1055 the 'substrings' of a SubstringFilter. If 'initial' is present, it 1056 SHALL be the first element of 'substrings'. If 'final' is present, 1057 it SHALL be the last element of 'substrings'. 1058 The matching rule for AssertionValues in a substrings filter item 1059 is defined by the SUBSTR matching rule for the attribute type. 1060 Note that the AssertionValue in a substrings filter item conforms 1061 to the assertion syntax of the EQUALITY matching rule for the 1062 attribute type rather than the assertion syntax of the SUBSTR 1063 matching rule for the attribute type. Conceptually, the entire 1064 SubstringFilter is converted into an assertion value of the 1065 substrings matching rule prior to applying the rule. 1067 The matching rule for the greaterOrEqual filter item is defined by 1068 the ORDERING and EQUALITY matching rules for the attribute type. 1070 The matching rule for the lessOrEqual filter item is defined by 1071 the ORDERING matching rule for the attribute type. 1073 An approxMatch filter item evaluates to TRUE when there is a value 1074 of the attribute or subtype for which some locally-defined 1075 approximate matching algorithm (e.g. spelling variations, phonetic 1076 match, etc.) returns TRUE. If an item matches for equality, it 1077 also satisfies an approximate match. If approximate matching is 1078 not supported, this filter item should be treated as an 1079 equalityMatch. 1081 An extensibleMatch filter item is evaluated as follows: 1083 Lightweight Directory Access Protocol Version 3 1085 If the matchingRule field is absent, the type field MUST be 1086 present, and an equality match is performed for that type. 1088 If the type field is absent and the matchingRule is present, the 1089 matchValue is compared against all attributes in an entry which 1090 support that matchingRule. The matchingRule determines the 1091 syntax for the assertion value. The filter item evaluates to 1092 TRUE if it matches with at least one attribute in the entry, 1093 FALSE if it does not match any attribute in the entry, and 1094 Undefined if the matchingRule is not recognized or the 1095 assertionValue is invalid. 1097 If the type field is present and the matchingRule is present, 1098 the matchValue is compared against entry attributes of the 1099 specified type. In this case, the matchingRule MUST be one 1100 suitable for use with the specified type (see [Syntaxes]), 1101 otherwise the filter item is Undefined. 1103 If the dnAttributes field is set to TRUE, the match is 1104 additionally applied against all the AttributeValueAssertions in 1105 an entry's distinguished name, and evaluates to TRUE if there is 1106 at least one attribute in the distinguished name for which the 1107 filter item evaluates to TRUE. The dnAttributes field is present 1108 to alleviate the need for multiple versions of generic matching 1109 rules (such as word matching), where one applies to entries and 1110 another applies to entries and dn attributes as well. 1112 A filter item evaluates to Undefined when the server would not be 1113 able to determine whether the assertion value matches an entry. If 1114 an attribute description in an equalityMatch, substrings, 1115 greaterOrEqual, lessOrEqual, approxMatch or extensibleMatch filter 1116 is not recognized by the server, a matching rule id in the 1117 extensibleMatch is not recognized by the server, the assertion 1118 value is invalid, or the type of filtering requested is not 1119 implemented, then the filter is Undefined. Thus for example if a 1120 server did not recognize the attribute type shoeSize, a filter of 1121 (shoeSize=*) would evaluate to FALSE, and the filters 1122 (shoeSize=12), (shoeSize>=12) and (shoeSize<=12) would evaluate to 1123 Undefined. 1125 Servers MUST NOT return errors if attribute descriptions or 1126 matching rule ids are not recognized, assertion values are 1127 invalid, or the assertion syntax is not supported. More details of 1128 filter processing are given in Section 7.8 of [X.511]. 1130 - attributes: A list of the attributes to be returned from each 1131 entry which matches the search filter. LDAPString values of this 1132 field are constrained to the following Augmented Backus-Naur Form 1133 ([ABNF]): 1135 attributeSelection = attributedescription / selectionspecial 1137 selectionspecial = noattrs / alluserattrs 1138 Lightweight Directory Access Protocol Version 3 1140 noattrs = %x31.2E.31 ; "1.1" 1142 alluserattrs = %x2A ; asterisk ("*") 1144 The production is defined in Section 2.5 of 1145 [Models]. 1147 There are three special cases which may exist in the attribute 1148 selection: 1149 - an empty list with no attributes, 1150 - a list containing "*" (with zero or more attribute 1151 descriptions), and 1152 - a list containing only "1.1". 1154 An empty list requests the return of all user attributes. 1156 A list containing "*" requests all user attributes in addition to 1157 other listed (operational) attributes. 1159 A list containing only the OID "1.1" indicates that no values are 1160 to be returned. If "1.1" is provided with other values, the "1.1" 1161 value is ignored. This OID was chosen because it does not (and can 1162 not) correspond to any attribute in use. 1164 Client implementors should note that even if all user attributes 1165 are requested, some attributes and/or attribute values of the 1166 entry may not be included in search results due to access controls 1167 or other restrictions. Furthermore, servers will not return 1168 operational attributes, such as objectClasses or attributeTypes, 1169 unless they are listed by name. Operational attributes are 1170 described in [Models]. 1172 Attributes are returned at most once in an entry. If an attribute 1173 description is named more than once in the list, the subsequent 1174 names are ignored. If an attribute description in the list is not 1175 recognized, it is ignored by the server. 1177 Note that an X.500 "list"-like operation can be emulated by the 1178 client requesting a one-level LDAP search operation with a filter 1179 checking for the presence of the 'objectClass' attribute, and that an 1180 X.500 "read"-like operation can be emulated by a base object LDAP 1181 search operation with the same filter. A server which provides a 1182 gateway to X.500 is not required to use the Read or List operations, 1183 although it may choose to do so, and if it does, it must provide the 1184 same semantics as the X.500 search operation. 1186 4.5.2. Search Result 1188 The results of the search operation are returned as zero or more 1189 searchResultEntry messages, zero or more SearchResultReference 1190 messages, followed by a single searchResultDone message. 1192 SearchResultEntry ::= [APPLICATION 4] SEQUENCE { 1193 Lightweight Directory Access Protocol Version 3 1195 objectName LDAPDN, 1196 attributes PartialAttributeList } 1198 PartialAttributeList ::= SEQUENCE OF 1199 partialAttribute PartialAttribute 1200 -- Note that the PartialAttributeList may hold zero elements. 1201 -- This may happen when none of the attributes of an entry 1202 -- were requested, or could be returned. 1203 -- Note also that the partialAttribute vals set may hold zero 1204 -- elements. This may happen when typesOnly is requested, access 1205 -- controls prevent the return of values, or other reasons. 1207 SearchResultReference ::= [APPLICATION 19] SEQUENCE 1208 SIZE (1..MAX) OF uri URI 1210 SearchResultDone ::= [APPLICATION 5] LDAPResult 1212 Each SearchResultEntry represents an entry found during the search. 1213 Each SearchResultReference represents an area not yet explored during 1214 the search. The SearchResultEntry and SearchResultReference PDUs may 1215 come in any order. Following all the SearchResultReference and 1216 SearchResultEntry responses, the server returns a SearchResultDone 1217 response, which contains an indication of success, or detailing any 1218 errors that have occurred. 1220 Each entry returned in a SearchResultEntry will contain all 1221 appropriate attributes as specified in the attributes field of the 1222 Search Request. Return of attributes is subject to access control and 1223 other administrative policy. 1225 Some attributes may be constructed by the server and appear in a 1226 SearchResultEntry attribute list, although they are not stored 1227 attributes of an entry. Clients SHOULD NOT assume that all attributes 1228 can be modified, even if permitted by access control. 1230 If the server's schema defines short names [Models] for an attribute 1231 type then the server SHOULD use one of those names in attribute 1232 descriptions for that attribute type (in preference to using the 1233 [Models] format of the attribute type's object 1234 identifier). The server SHOULD NOT use the short name if that name is 1235 known by the server to be ambiguous, or otherwise likely to cause 1236 interoperability problems. 1238 4.5.3. Continuation References in the Search Result 1240 If the server was able to locate the entry referred to by the 1241 baseObject but was unable to search one or more non-local entries, 1242 the server may return one or more SearchResultReference entries, each 1243 containing a reference to another set of servers for continuing the 1244 operation. A server MUST NOT return any SearchResultReference if it 1245 has not located the baseObject and thus has not searched any entries; 1246 in this case it would return a SearchResultDone containing a referral 1247 result code. 1249 Lightweight Directory Access Protocol Version 3 1251 If a server holds a copy or partial copy of the subordinate naming 1252 context [Section 5 of Models], it may use the search filter to 1253 determine whether or not to return a SearchResultReference response. 1254 Otherwise SearchResultReference responses are always returned when in 1255 scope. 1257 The SearchResultReference is of the same data type as the Referral. 1259 A URI for a server implementing LDAP and accessible via [TCP]/[IP] 1260 (v4 or v6) is written as an LDAP URL according to [LDAPURL]. 1262 In order to complete the search, the client issues a new search 1263 operation for each SearchResultReference that is returned. Note that 1264 the abandon operation described in Section 4.11 applies only to a 1265 particular operation sent on an association between a client and 1266 server. The client must abandon subsequent search operations it 1267 wishes to individually. 1269 Clients that follow search continuation references MUST ensure that 1270 they do not loop between servers. They MUST NOT repeatedly contact 1271 the same server for the same request with the same target entry name, 1272 scope and filter. Some clients use a counter that is incremented each 1273 time search result reference handling occurs for an operation, and 1274 these kinds of clients MUST be able to handle at least ten nested 1275 search result references between the root and a leaf entry. 1277 When an LDAP URL is used, the following instructions are followed: 1279 - The part of the URL MUST be present, with the new target 1280 object name. The client MUST use this name when following the 1281 reference. UTF-8 encoded characters appearing in the string 1282 representation of a DN or search filter may not be legal for URLs 1283 (e.g. spaces) and MUST be escaped using the % method in [URI]. 1284 - Some servers (e.g. participating in distributed indexing) may 1285 provide a different filter in a URL of a SearchResultReference. 1286 - If the part of the URL is present, the client MUST use 1287 this filter in its next request to progress this search, and if it 1288 is not present the client MUST use the same filter as it used for 1289 that search. 1290 - If the originating search scope was singleLevel, the part 1291 of the URL will be "base". 1292 - it is RECOMMENDED that the part be present to avoid 1293 ambiguity. 1294 - Other aspects of the new search request may be the same as or 1295 different from the search request which generated the 1296 SearchResultReference. 1297 - The name of an unexplored subtree in a SearchResultReference need 1298 not be subordinate to the base object. 1300 Other kinds of URIs may be returned. The syntax and semantics of such 1301 URIs is left to future specifications. Clients may ignore URIs that 1302 they do not support. 1304 Lightweight Directory Access Protocol Version 3 1306 4.5.3.1. Examples 1308 For example, suppose the contacted server (hosta) holds the entry 1309 and the entry . It 1310 knows that either LDAP-capable servers (hostb) or (hostc) hold 1311 (one is the master and the other server 1312 a shadow), and that LDAP-capable server (hostd) holds the subtree 1313 . If a wholeSubtree search of 1314 is requested to the contacted server, it may 1315 return the following: 1317 SearchResultEntry for DC=Example,DC=NET 1318 SearchResultEntry for CN=Manager,DC=Example,DC=NET 1319 SearchResultReference { 1320 ldap://hostb/OU=People,DC=Example,DC=NET??sub 1321 ldap://hostc/OU=People,DC=Example,DC=NET??sub } 1322 SearchResultReference { 1323 ldap://hostd/OU=Roles,DC=Example,DC=NET??sub } 1324 SearchResultDone (success) 1326 Client implementors should note that when following a 1327 SearchResultReference, additional SearchResultReference may be 1328 generated. Continuing the example, if the client contacted the server 1329 (hostb) and issued the search for the subtree 1330 , the server might respond as follows: 1332 SearchResultEntry for OU=People,DC=Example,DC=NET 1333 SearchResultReference { 1334 ldap://hoste/OU=Managers,OU=People,DC=Example,DC=NET??sub } 1335 SearchResultReference { 1336 ldap://hostf/OU=Consultants,OU=People,DC=Example,DC=NET??sub } 1337 SearchResultDone (success) 1339 Similarly, if a singleLevel search of is 1340 requested to the contacted server, it may return the following: 1342 SearchResultEntry for CN=Manager,DC=Example,DC=NET 1343 SearchResultReference { 1344 ldap://hostb/OU=People,DC=Example,DC=NET??base 1345 ldap://hostc/OU=People,DC=Example,DC=NET??base } 1346 SearchResultReference { 1347 ldap://hostd/OU=Roles,DC=Example,DC=NET??base } 1348 SearchResultDone (success) 1350 If the contacted server does not hold the base object for the search, 1351 then it will return a referral to the client. For example, if the 1352 client requests a subtree search of to hosta, the 1353 server may return only a SearchResultDone containing a referral. 1355 SearchResultDone (referral) { 1356 ldap://hostg/DC=Example,DC=ORG??sub } 1357 Lightweight Directory Access Protocol Version 3 1359 4.6. Modify Operation 1361 The Modify Operation allows a client to request that a modification 1362 of an entry be performed on its behalf by a server. The Modify 1363 Request is defined as follows: 1365 ModifyRequest ::= [APPLICATION 6] SEQUENCE { 1366 object LDAPDN, 1367 changes SEQUENCE OF change SEQUENCE { 1368 operation ENUMERATED { 1369 add (0), 1370 delete (1), 1371 replace (2) }, 1372 modification PartialAttribute } } 1374 Fields of the Modify Request are: 1376 - object: The name of the object to be modified. The value of this 1377 field contains the DN of the entry to be modified. The server 1378 SHALL NOT perform any alias dereferencing in determining the 1379 object to be modified. 1381 - changes: A list of modifications to be performed on the entry. The 1382 entire list of modifications MUST be performed in the order they 1383 are listed as a single atomic operation. While individual 1384 modifications may violate certain aspects of the directory schema 1385 (such as the object class definition and DIT content rule), the 1386 resulting entry after the entire list of modifications is 1387 performed MUST conform to the requirements of the directory schema 1388 [Models]. 1390 - operation: Used to specify the type of modification being 1391 performed. Each operation type acts on the following 1392 modification. The values of this field have the following 1393 semantics respectively: 1395 add: add values listed to the modification attribute, 1396 creating the attribute if necessary; 1398 delete: delete values listed from the modification attribute, 1399 removing the entire attribute if no values are listed, or if 1400 all current values of the attribute are listed for deletion; 1402 replace: replace all existing values of the modification 1403 attribute with the new values listed, creating the attribute 1404 if it did not already exist. A replace with no value will 1405 delete the entire attribute if it exists, and is ignored if 1406 the attribute does not exist. 1408 - modification: A PartialAttribute (which may have an empty SET 1409 of vals) used to hold the attribute type or attribute type and 1410 values being modified. 1412 Lightweight Directory Access Protocol Version 3 1414 Upon receipt of a Modify Request, the server attempts to perform the 1415 necessary modifications to the DIT and returns the result in a Modify 1416 Response, defined as follows: 1418 ModifyResponse ::= [APPLICATION 7] LDAPResult 1420 The server will return to the client a single Modify Response 1421 indicating either the successful completion of the DIT modification, 1422 or the reason that the modification failed. Due to the requirement 1423 for atomicity in applying the list of modifications in the Modify 1424 Request, the client may expect that no modifications of the DIT have 1425 been performed if the Modify Response received indicates any sort of 1426 error, and that all requested modifications have been performed if 1427 the Modify Response indicates successful completion of the Modify 1428 Operation. If the association changes or the connection fails, 1429 whether the modification occurred or not is indeterminate. 1431 The Modify Operation cannot be used to remove from an entry any of 1432 its distinguished values, i.e. those values which form the entry's 1433 relative distinguished name. An attempt to do so will result in the 1434 server returning the notAllowedOnRDN result code. The Modify DN 1435 Operation described in Section 4.9 is used to rename an entry. 1437 Note that due to the simplifications made in LDAP, there is not a 1438 direct mapping of the changes in an LDAP ModifyRequest onto the 1439 changes of a DAP ModifyEntry operation, and different implementations 1440 of LDAP-DAP gateways may use different means of representing the 1441 change. If successful, the final effect of the operations on the 1442 entry MUST be identical. 1444 4.7. Add Operation 1446 The Add Operation allows a client to request the addition of an entry 1447 into the Directory. The Add Request is defined as follows: 1449 AddRequest ::= [APPLICATION 8] SEQUENCE { 1450 entry LDAPDN, 1451 attributes AttributeList } 1453 AttributeList ::= SEQUENCE OF attribute Attribute 1455 Fields of the Add Request are: 1457 - entry: the name of the entry to be added. The server SHALL NOT 1458 dereference any aliases in locating the entry to be added. 1460 - attributes: the list of attributes that, along with those from the 1461 RDN, make up the content of the entry being added. Clients MUST 1462 include the 'objectClass' attribute, and values of any mandatory 1463 attributes of the listed object classes. Clients MUST NOT supply 1464 NO-USER-MODIFICATION attributes such as the createTimestamp or 1465 creatorsName attributes, since the server maintains these 1466 automatically. 1468 Lightweight Directory Access Protocol Version 3 1470 The entry named in the entry field of the AddRequest MUST NOT exist 1471 for the AddRequest to succeed. The immediate superior (parent) of an 1472 object or alias entry to be added MUST exist. For example, if the 1473 client attempted to add , the 1474 entry did not exist, and the entry did 1475 exist, then the server would return the noSuchObject result code with 1476 the matchedDN field containing . If the parent entry exists 1477 but is not in a naming context [Section 5 of Models] held by the 1478 server, the server SHOULD return a referral to the server holding the 1479 parent entry. 1481 Server implementations SHOULD NOT restrict where entries can be 1482 located in the Directory unless DIT structure rules are in place. 1483 Some servers allow the administrator to restrict the classes of 1484 entries which can be added to the Directory. 1486 Upon receipt of an Add Request, a server will attempt to add the 1487 requested entry. The result of the add attempt will be returned to 1488 the client in the Add Response, defined as follows: 1490 AddResponse ::= [APPLICATION 9] LDAPResult 1492 A response of success indicates that the new entry has been added to 1493 the Directory. 1495 4.8. Delete Operation 1497 The Delete Operation allows a client to request the removal of an 1498 entry from the Directory. The Delete Request is defined as follows: 1500 DelRequest ::= [APPLICATION 10] LDAPDN 1502 The Delete Request consists of the name of the entry to be deleted. 1503 The server SHALL NOT dereference aliases while resolving the name of 1504 the target entry to be removed. 1506 Only leaf entries (those with no subordinate entries) can be deleted 1507 with this operation. 1509 Upon receipt of a Delete Request, a server will attempt to perform 1510 the entry removal requested and return the result in the Delete 1511 Response defined as follows: 1513 DelResponse ::= [APPLICATION 11] LDAPResult 1515 4.9. Modify DN Operation 1517 The Modify DN Operation allows a client to change the Relative 1518 Distinguished Name (RDN) of an entry in the Directory, and/or to move 1519 a subtree of entries to a new location in the Directory. The Modify 1520 DN Request is defined as follows: 1522 Lightweight Directory Access Protocol Version 3 1524 ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { 1525 entry LDAPDN, 1526 newrdn RelativeLDAPDN, 1527 deleteoldrdn BOOLEAN, 1528 newSuperior [0] LDAPDN OPTIONAL } 1530 Fields of the Modify DN Request are: 1532 - entry: the name of the entry to be changed. This entry may or may 1533 not have subordinate entries. 1535 - newrdn: the new RDN of the entry. If an attribute value in the 1536 newrdn does not already exist in the entry (either as part of the 1537 old RDN or as a non-distinguished value), it is added. If it 1538 cannot be added, an appropriate error is returned. 1540 - deleteoldrdn: a boolean field that controls whether the old RDN 1541 attribute values are to be retained as attributes of the entry, or 1542 deleted from the entry. 1544 - newSuperior: if present, this is the name of an existing object 1545 entry which becomes the immediate superior (parent) of the 1546 existing entry. 1548 The server SHALL NOT dereference any aliases in locating the objects 1549 named in entry or newSuperior. 1551 Upon receipt of a ModifyDNRequest, a server will attempt to perform 1552 the name change and return the result in the Modify DN Response, 1553 defined as follows: 1555 ModifyDNResponse ::= [APPLICATION 13] LDAPResult 1557 For example, if the entry named in the entry field was , the newrdn field was , and the 1559 newSuperior field was absent, then this operation would attempt to 1560 rename the entry to be . If there was 1561 already an entry with that name, the operation would fail with the 1562 entryAlreadyExists result code. 1564 The object named in newSuperior MUST exist. For example, if the 1565 client attempted to add , the 1566 entry did not exist, and the entry did 1567 exist, then the server would return the noSuchObject result code with 1568 the matchedDN field containing . 1570 If the deleteoldrdn field is TRUE, the attribute values forming the 1571 old RDN but not the new RDN are deleted from the entry. If the 1572 deleteoldrdn field is FALSE, the attribute values forming the old RDN 1573 will be retained as non-distinguished attribute values of the entry. 1574 The server MUST fail the operation and return an error in the result 1575 code if the setting of the deleteoldrdn field would cause a schema 1576 inconsistency in the entry. 1578 Lightweight Directory Access Protocol Version 3 1580 Note that X.500 restricts the ModifyDN operation to only affect 1581 entries that are contained within a single server. If the LDAP server 1582 is mapped onto DAP, then this restriction will apply, and the 1583 affectsMultipleDSAs result code will be returned if this error 1584 occurred. In general, clients MUST NOT expect to be able to perform 1585 arbitrary movements of entries and subtrees between servers or 1586 between naming contexts. 1588 4.10. Compare Operation 1590 The Compare Operation allows a client to compare an assertion value 1591 with the values of a particular attribute in a particular entry in 1592 the Directory. The Compare Request is defined as follows: 1594 CompareRequest ::= [APPLICATION 14] SEQUENCE { 1595 entry LDAPDN, 1596 ava AttributeValueAssertion } 1598 Fields of the Compare Request are: 1600 - entry: the name of the entry to be compared. The server SHALL NOT 1601 dereference any aliases in locating the entry to be compared. 1603 - ava: holds the attribute description and assertion value with 1604 which an attribute in the entry is to be compared. 1606 Upon receipt of a Compare Request, a server will attempt to perform 1607 the requested comparison and return the result in the Compare 1608 Response, defined as follows: 1610 CompareResponse ::= [APPLICATION 15] LDAPResult 1612 The resultCode field is set to compareTrue, compareFalse, or an 1613 appropriate error. compareTrue indicates that the assertion value in 1614 the ava field is equivalent to a value of the attribute or subtype 1615 (according to the attribute's EQUALITY matching rule). compareFalse 1616 indicates that the comparison of the assertion value in the ava field 1617 and the values of the attribute or subtype resulted in an Undefined 1618 (Section 4.5.1) or non-equivalent match. 1620 In the event that the attribute or subtype is not present in the 1621 entry, the resultCode field is set to noSuchAttribute. If the 1622 attribute is unknown, the resultCode is set to 1623 undefinedAttributeType. If the attribute or subtype has no equality 1624 matching rule, innapropriateMatching is returned in the resultCode. 1626 Note that some directory systems may establish access controls which 1627 permit the values of certain attributes (such as userPassword) to be 1628 compared but not interrogated by other means. 1630 4.11. Abandon Operation 1631 Lightweight Directory Access Protocol Version 3 1633 The function of the Abandon Operation is to allow a client to request 1634 that the server abandon an outstanding operation. The Abandon Request 1635 is defined as follows: 1637 AbandonRequest ::= [APPLICATION 16] MessageID 1639 The MessageID is that of an operation which was requested earlier in 1640 this LDAP association. The abandon request itself has its own message 1641 id. This is distinct from the id of the earlier operation being 1642 abandoned. 1644 There is no response defined in the Abandon operation. Upon receipt 1645 of an AbandonRequest, the server MAY abandon the operation identified 1646 by the MessageID. Operation responses are not sent for successfully 1647 abandoned operations, thus the application of the Abandon operation 1648 is limited to uses where the client does not require an indication of 1649 its outcome. 1651 Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned. 1652 The ability to abandon other (particularly update) operations is at 1653 the discretion of the server. 1655 In the event that a server receives an Abandon Request on a Search 1656 Operation in the midst of transmitting responses to the search, that 1657 server MUST cease transmitting entry responses to the abandoned 1658 request immediately, and MUST NOT send the SearchResponseDone. Of 1659 course, the server MUST ensure that only properly encoded LDAPMessage 1660 PDUs are transmitted. 1662 Clients should not send abandon requests for the same operation 1663 multiple times, and MUST also be prepared to receive results from 1664 operations it has abandoned (since these may have been in transit 1665 when the abandon was requested, or are not able to be abandoned). 1667 Servers MUST discard abandon requests for message IDs they do not 1668 recognize, for operations which cannot be abandoned, and for 1669 operations which have already been abandoned. 1671 4.12. Extended Operation 1673 The extended operation allows additional operations to be defined for 1674 services not already available in the protocol. For example, to add 1675 operations to install transport layer security (see Section 4.14). 1677 The extended operation allows clients to make requests and receive 1678 responses with predefined syntaxes and semantics. These may be 1679 defined in RFCs or be private to particular implementations. 1681 Each extended operation consists of an extended request and an 1682 extended response. 1684 ExtendedRequest ::= [APPLICATION 23] SEQUENCE { 1685 Lightweight Directory Access Protocol Version 3 1687 requestName [0] LDAPOID, 1688 requestValue [1] OCTET STRING OPTIONAL } 1690 The requestName is a dotted-decimal representation of the unique 1691 OBJECT IDENTIFIER corresponding to the request. The requestValue is 1692 information in a form defined by that request, encapsulated inside an 1693 OCTET STRING. 1695 The server will respond to this with an LDAPMessage containing an 1696 ExtendedResponse. 1698 ExtendedResponse ::= [APPLICATION 24] SEQUENCE { 1699 COMPONENTS OF LDAPResult, 1700 responseName [10] LDAPOID OPTIONAL, 1701 responseValue [11] OCTET STRING OPTIONAL } 1703 The responseName is typically not required to be present as the 1704 syntax and semantics of the response (including the format of the 1705 responseValue) is implicitly known and associated with the request by 1706 the messageID. 1708 If the requestName is not recognized by the server, the server MUST 1709 NOT provide a responseName nor a responseValue and MUST return a 1710 resultCode of protocolError. 1712 The requestValue and responseValue fields contain any information 1713 associated with the operation. The format of these fields is defined 1714 by the specification of the extended operation. Implementations MUST 1715 be prepared to handle arbitrary contents of these fields, including 1716 zero bytes. Values that are defined in terms of ASN.1 and BER encoded 1717 according to Section 5.1, also follow the extensibility rules in 1718 Section 4. 1720 It is RECOMMENDED that servers list the requestName of extended 1721 operations they support in the 'supportedExtension' attribute of the 1722 root DSE [Models]. 1724 Extended operations may be specified in other documents. The 1725 specification of an extended operation consists of: 1727 - the OBJECT IDENTIFIER assigned to the requestName (and possibly 1728 responseName), 1730 - the format of the contents of the requestValue and responseValue 1731 (if any), and 1733 - the semantics of the operation. 1735 4.13. IntermediateResponse Message 1737 While the Search operation provides a mechanism to return multiple 1738 response messages for a single search request, other operations, by 1739 nature, do not provide for multiple response messages. 1741 Lightweight Directory Access Protocol Version 3 1743 The IntermediateResponse message provides a general mechanism for 1744 defining single-request/multiple-response operations in LDAP. This 1745 message is intended to be used in conjunction with the extended 1746 operation to define new single-request/multiple-response operations 1747 or in conjunction with a control when extending existing LDAP 1748 operations in a way that requires them to return intermediate 1749 response information. 1751 It is intended that the definitions and descriptions of extended 1752 operations and controls that make use of the IntermediateResponse 1753 message will define the circumstances when an IntermediateResponse 1754 message can be sent by a server and the associated meaning of an 1755 IntermediateResponse message sent in a particular circumstance. 1756 Similarly, it is intended that clients will explicitly solicit 1757 IntermediateResponse messages by issuing operations that specifically 1758 call for their return. 1760 IntermediateResponse ::= [APPLICATION 25] SEQUENCE { 1761 responseName [0] LDAPOID OPTIONAL, 1762 responseValue [1] OCTET STRING OPTIONAL } 1764 IntermediateResponse messages SHALL NOT be returned to the client 1765 unless the client issues a request that specifically solicits their 1766 return. This document defines two forms of solicitation: extended 1767 operation and request control. 1769 Although the responseName and responseValue are optional in some 1770 circumstances, generally speaking IntermediateResponse messages have 1771 a predefined responseName and a responseValue. The value of the 1772 responseName (if present), the syntax of the responseValue (if 1773 present) and the semantics associated with a particular 1774 IntermediateResponse message MUST be specified in documents 1775 describing the extended operation or request control that uses them. 1776 Sections 4.13.1 and 4.13.2 describe additional requirements on the 1777 inclusion of responseName and responseValue in IntermediateResponse 1778 messages. 1780 4.13.1. Usage with LDAP ExtendedRequest and ExtendedResponse 1782 A single-request/multiple-response operation may be defined using a 1783 single ExtendedRequest message to solicit zero or more 1784 IntermediateResponse messages of one or more kinds followed by an 1785 ExtendedResponse message. 1787 An extended operation that defines the return of multiple kinds of 1788 IntermediateResponse messages MUST provide and document a mechanism 1789 for the client to distinguish the kind of IntermediateResponse 1790 message being sent. This SHALL be accomplished by using different 1791 responseName values for each type of IntermediateResponse message 1792 associated with the extended operation or by including identifying 1793 information in the responseValue of each type of IntermediateResponse 1794 message associated with the extended operation. 1796 Lightweight Directory Access Protocol Version 3 1798 4.13.2. Usage with LDAP Request Controls 1800 Any LDAP operation may be extended by the addition of one or more 1801 controls ([RFC2251] Section 4.1.12). A control's semantics may 1802 include the return of zero or more IntermediateResponse messages 1803 prior to returning the final result code for the operation. One or 1804 more kinds of IntermediateResponse messages may be sent in response 1805 to a request control. 1807 All IntermediateResponse messages associated with request controls 1808 SHALL include a responseName. This requirement ensures that the 1809 client can correctly identify the source of IntermediateResponse 1810 messages when: 1812 - two or more controls using IntermediateResponse messages are 1813 included in a request for any LDAP operation or 1815 - one or more controls using IntermediateResponse messages are 1816 included in a request with an LDAP extended operation that uses 1817 IntermediateResponse messages. 1819 A request control that defines the return of multiple kinds of 1820 IntermediateResponse messages MUST provide and document a mechanism 1821 for the client to distinguish the kind of IntermediateResponse 1822 message being sent. This SHALL be accomplished by using different 1823 responseName values for each type of IntermediateResponse message 1824 associated with the request control or by including identifying 1825 information in the responseValue of each type of IntermediateResponse 1826 message associated with the request control. 1828 4.14. StartTLS Operation 1830 The Start Transport Layer Security (StartTLS) operation provides the 1831 ability to establish Transport Layer Security ([TLS]) on an LDAP 1832 connection. The StartTLS operation is defined using the extended 1833 operation mechanism described in Section 4.12. 1835 4.14.1. StartTLS Request 1837 A client requests TLS establishment by transmitting a StartTLS 1838 request PDU to the server. The StartTLS request is defined in terms 1839 of an ExtendedRequest. The requestName is "1.3.6.1.4.1.1466.20037", 1840 and the requestValue field is always absent. 1842 The client MUST NOT send any PDUs on this connection following this 1843 request until it receives a StartTLS extended response and completes 1844 TLS negotiations. 1846 Lightweight Directory Access Protocol Version 3 1848 4.14.2. StartTLS Response 1850 When a StartTLS request is made, servers supporting the operation 1851 MUST return a StartTLS response PDU to the requestor. The 1852 responseName is also "1.3.6.1.4.1.1466.20037", and the responseValue 1853 field is absent. 1855 The server provides a resultCode field to either success or one of 1856 the other values outlined in Section 4.14.2.2. 1858 4.14.2.1. "Success" Response 1860 If the StartTLS Response contains a resultCode of success, this 1861 indicates that the server is willing and able to negotiate TLS. Refer 1862 to Section 4 of [AuthMeth] for details. 1864 4.14.2.2. Response other than "success" 1866 If the ExtendedResponse contains a result code other than success, 1867 this indicates that the server is unwilling or unable to negotiate 1868 TLS. The following result codes have these meanings for this 1869 operation: 1871 - operationsError: operations sequencing incorrect; e.g. TLS is 1872 already established. 1874 - protocolError: TLS is not supported or incorrect PDU structure. 1876 - unavailable: Some major problem with TLS, or the server is 1877 shutting down. 1879 The server MUST return operationsError if the client violates any of 1880 the StartTLS extended operation sequencing requirements described in 1881 Section 4 of [AuthMeth]. 1883 If the server does not support TLS (whether by design or by current 1884 configuration), it MUST return the protocolError resultCode. The 1885 client's current association is unaffected if the server does not 1886 support TLS. The client may proceed with any LDAP operation, or it 1887 may close the connection. 1889 The server MUST return unavailable if it supports TLS but cannot 1890 establish a TLS connection for some reason, e.g. the certificate 1891 server not responding, it cannot contact its TLS implementation, or 1892 if the server is in process of shutting down. The client may retry 1893 the StartTLS operation, or it may proceed with any other LDAP 1894 operation, or it may close the LDAP connection. 1896 4.14.3. Closing a TLS Connection 1897 Lightweight Directory Access Protocol Version 3 1899 Two forms of TLS connection closure -- graceful and abrupt -- are 1900 supported. These do not involve LDAP PDUs, but are preformed at the 1901 underlying layers. 1903 4.14.3.1. Graceful Closure 1905 Either the client or server MAY terminate the TLS connection and 1906 leave the LDAP connection intact by sending and receiving a TLS 1907 closure alert. 1909 The initiating protocol peer sends the TLS closure alert. If it 1910 wishes to leave the LDAP connection intact, it then MUST cease to 1911 send further PDUs and MUST ignore any received PDUs until it receives 1912 a TLS closure alert from the other peer. 1914 Once the initiating protocol peer receives a TLS closure alert from 1915 the other peer it MAY send and receive LDAP PDUs. 1917 When a protocol peer receives the initial TLS closure alert, it may 1918 choose to allow the underlying LDAP connection to remain intact. In 1919 this case, it MUST immediately transmit a TLS closure alert. 1920 Following this, it MAY send and receive LDAP PDUs. 1922 Protocol peers MAY drop the underlying LDAP connection after sending 1923 or receiving a TLS closure alert. 1925 After the TLS connection has been closed, the server MUST NOT send 1926 responses to any request message received before the TLS closure. 1927 Thus, clients wishing to receive responses to messages sent while the 1928 TLS connection is intact MUST wait for those message responses before 1929 sending the TLS closure alert. 1931 4.14.3.2. Abrupt Closure 1933 Either the client or server MAY abruptly close the TLS connection by 1934 dropping the underlying transfer protocol connection. In this 1935 circumstance, a server MAY send the client a Notice of Disconnection 1936 before dropping the underlying LDAP connection. Outstanding 1937 operations are handled as specified in Section 5.2. 1939 5. Protocol Element Encodings and Transfer 1941 One underlying service, LDAP over TCP, is defined here. This service 1942 is generally applicable to applications providing or consuming X.500- 1943 based directory services on the Internet. 1945 Implementations of LDAP over TCP MUST implement the mapping as 1946 described in Section 5.2.1 1947 Lightweight Directory Access Protocol Version 3 1949 5.1. Protocol Encoding 1951 The protocol elements of LDAP SHALL be encoded for exchange using the 1952 Basic Encoding Rules [BER] of [ASN.1] with the following 1953 restrictions: 1955 - Only the definite form of length encoding is used. 1957 - OCTET STRING values are encoded in the primitive form only. 1959 - If the value of a BOOLEAN type is true, the encoding of the value 1960 octet is set to hex "FF". 1962 - If a value of a type is its default value, it is absent. Only some 1963 BOOLEAN and INTEGER types have default values in this protocol 1964 definition. 1966 These restrictions are meant to ease the overhead of encoding and 1967 decoding certain elements in BER. 1969 These restrictions do not apply to ASN.1 types encapsulated inside of 1970 OCTET STRING values, such as attribute values, unless otherwise 1971 stated. 1973 5.2. Transfer Protocols 1975 This protocol is designed to run over connection-oriented, reliable 1976 transports, with all 8 bits in an octet being significant in the data 1977 stream. Protocol operations are tied to a connection, thus if the 1978 connection is closed or dropped, the operation is aborted. When this 1979 happens, any outstanding operations on the server are, when possible, 1980 abandoned, and when not possible, completed without transmission of 1981 the response. Also, if the connection is closed or dropped, the 1982 client MUST NOT assume that any outstanding requests which modified 1983 the Directory have succeeded or failed. 1985 5.2.1. Transmission Control Protocol (TCP) 1987 The encoded LDAPMessage PDUs are mapped directly onto the [TCP] 1988 bytestream using the BER-based encoding described in Section 5.1. It 1989 is recommended that server implementations running over the TCP 1990 provide a protocol listener on the Internet Assigned Numbers 1991 Authority (IANA)-assigned LDAP port, 389 [PortReg]. Servers may 1992 instead provide a listener on a different port number. Clients MUST 1993 support contacting servers on any valid TCP port. 1995 6. Security Considerations 1997 This version of the protocol provides facilities for simple 1998 authentication using a cleartext password, as well as any [SASL] 1999 Lightweight Directory Access Protocol Version 3 2001 mechanism. SASL allows for integrity and privacy services to be 2002 negotiated. 2004 It is also permitted that the server can return its credentials to 2005 the client, if it chooses to do so. 2007 Use of cleartext password is strongly discouraged where the 2008 underlying transport service cannot guarantee confidentiality and may 2009 result in disclosure of the password to unauthorized parties. 2011 Servers are encouraged to prevent directory modifications by clients 2012 that have authenticated anonymously [AuthMeth]. 2014 Requirements of authentication methods, SASL mechanisms, and TLS are 2015 described in [AuthMeth]. 2017 It should be noted that SASL authentication exchanges do not provide 2018 data confidentiality nor integrity protection for the version or name 2019 fields of the bind request nor the resultCode, diagnosticMessage, or 2020 referral fields of the bind response nor of any information contained 2021 in controls attached to bind request or responses. Thus information 2022 contained in these fields SHOULD NOT be relied on unless otherwise 2023 protected (such as by establishing protections at the transport 2024 layer). 2026 Server implementors should plan for the possibility of an identity 2027 associated with an LDAP connection being deleted, renamed, or 2028 modified, and take appropriate actions to prevent insecure side 2029 effects. Likewise, server implementors should plan for the 2030 possibility of an associated identity's credentials becoming invalid, 2031 or an identity's privileges being changed. The ways in which these 2032 issues are addressed are application and/or implementation specific. 2034 Implementations which cache attributes and entries obtained via LDAP 2035 MUST ensure that access controls are maintained if that information 2036 is to be provided to multiple clients, since servers may have access 2037 control policies which prevent the return of entries or attributes in 2038 search results except to particular authenticated clients. For 2039 example, caches could serve result information only to the client 2040 whose request caused it to be in the cache. 2042 Servers may return referrals or search result references which 2043 redirect clients to peer servers. It is possible for a rogue 2044 application to inject such referrals into the data stream in an 2045 attempt to redirect a client to a rogue server. Clients are advised 2046 to be aware of this, and possibly reject referrals when 2047 confidentiality measures are not in place. Clients are advised to 2048 reject referrals from the StartTLS operation. 2050 Protocol peers MUST be prepared to handle invalid and arbitrary 2051 length protocol encodings. A number of LDAP security advisories are 2052 available through [CERT]. 2054 Lightweight Directory Access Protocol Version 3 2056 7. Acknowledgements 2058 This document is based on RFC 2251 by Mark Wahl, Tim Howes, and Steve 2059 Kille. It is also based on RFC 2830 by Jeff Hodges, RL "Bob" Morgan, 2060 and Mark Wahl. Their work along with the input of individuals of the 2061 IETF ASID, LDAPEXT, LDUP, LDAPBIS, and other Working Groups is 2062 gratefully acknowledged. 2064 8. Normative References 2066 [ABNF] Crocker, D. and P. Overell, "Augmented BNF for Syntax 2067 Specifications: ABNF", RFC 2234, November 1997. 2069 [ASN.1] ITU-T Recommendation X.680 (07/2002) | ISO/IEC 8824-1:2002 2070 "Information Technology - Abstract Syntax Notation One 2071 (ASN.1): Specification of basic notation" 2073 [AuthMeth] Harrison, R., "LDAP: Authentication Methods and Connection 2074 Level Security Mechanisms", draft-ietf-ldapbis-authmeth- 2075 xx.txt, (a work in progress). 2077 [BER] ITU-T Rec. X.690 (07/2002) | ISO/IEC 8825-1:2002, 2078 "Information technology - ASN.1 encoding rules: 2079 Specification of Basic Encoding Rules (BER), Canonical 2080 Encoding Rules (CER) and Distinguished Encoding Rules 2081 (DER)", 2002. 2083 [IP] Postel, J., "Internet Protocol", STD5 and RFC 791, 2084 September 1981 2086 [ISO10646] Universal Multiple-Octet Coded Character Set (UCS) - 2087 Architecture and Basic Multilingual Plane, ISO/IEC 10646-1 2088 : 1993. 2090 [Keyword] Bradner, S., "Key words for use in RFCs to Indicate 2091 Requirement Levels", RFC 2119, March 1997. 2093 [LDAPDN] Zeilenga, K., "LDAP: String Representation of 2094 Distinguished Names", draft-ietf-ldapbis-dn-xx.txt, (a 2095 work in progress). 2097 [LDAPIANA] Zeilenga, K., "IANA Considerations for LDAP", draft-ietf- 2098 ldapbis-bcp64-xx.txt, (a work in progress). 2100 [LDAPURL] Smith, M., "LDAP: Uniform Resource Locator", draft-ietf- 2101 ldapbis-url-xx.txt, (a work in progress). 2103 [LIMR] Harrison, R., and K. Zeilenga, "The Lightweight Directory 2104 Access Protocol (LDAP) Intermediate Response Message", 2105 draft-rharrison-ldap-intermediate-resp-xx.txt (a work in 2106 progress). 2108 Lightweight Directory Access Protocol Version 3 2110 [Models] Zeilenga, K., "LDAP: Directory Information Models", draft- 2111 ietf-ldapbis-models-xx.txt (a work in progress). 2113 [Roadmap] Zeilenga, K., "LDAP: Technical Specification Road Map", 2114 draft-ietf-ldapbis-roadmap-xx.txt (a work in progress). 2116 [SASL] Melnikov, A., "Simple Authentication and Security Layer", 2117 draft-ietf-sasl-rfc2222bis-xx.txt (a work in progress). 2119 [SASLPrep] Zeilenga, K., "Stringprep profile for user names and 2120 passwords", draft-ietf-sasl-saslprep-xx.txt, (a work in 2121 progress). 2123 [StringPrep] Hoffman P. and M. Blanchet, "Preparation of 2124 Internationalized Strings ('stringprep')", draft-hoffman- 2125 rfc3454bis-xx.txt, a work in progress. 2127 [Syntaxes] Legg, S., and K. Dally, "LDAP: Syntaxes and Matching 2128 Rules", draft-ietf-ldapbis-syntaxes-xx.txt, (a work in 2129 progress). 2131 [TCP] Postel, J., "Transmission Control Protocol", STD7 and RFC 2132 793, September 1981 2134 [TLS] Dierks, T. and C. Allen. "The TLS Protocol Version 1.1", 2135 draft-ietf-tls-rfc2246-bis-xx.txt, a work in progress. 2137 [Unicode] The Unicode Consortium, "The Unicode Standard, Version 2138 3.2.0" is defined by "The Unicode Standard, Version 3.0" 2139 (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5), 2140 as amended by the "Unicode Standard Annex #27: Unicode 2141 3.1" (http://www.unicode.org/reports/tr27/) and by the 2142 "Unicode Standard Annex #28: Unicode 3.2" 2143 (http://www.unicode.org/reports/tr28/). 2145 [URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2146 Resource Identifiers (URI): Generic Syntax", RFC 2396, 2147 August 1998. 2149 [UTF-8] Yergeau, F., "UTF-8, a transformation format of ISO 2150 10646", STD63 and RFC3629, November 2003. 2152 [X.500] ITU-T Rec. X.500, "The Directory: Overview of Concepts, 2153 Models and Service", 1993. 2155 [X.501] ITU-T Rec. X.501, "The Directory: Models", 1993. 2157 [X.511] ITU-T Rec. X.511, "The Directory: Abstract Service 2158 Definition", 1993. 2160 9. Informative References 2162 [CERT] The CERT(R) Center, http://www.cert.org 2163 Lightweight Directory Access Protocol Version 3 2165 [PortReg] IANA, "Port Numbers", 2166 http://www.iana.org/assignments/port-numbers 2168 10. IANA Considerations 2170 It is requested that the Internet Assigned Numbers Authority (IANA) 2171 update the LDAP result code registry to indicate that this document 2172 provides the definitive technical specification for result codes 0- 2173 36, 48-54, 64-70, 80-90. 2175 It is requested that the IANA update the LDAP Protocol Mechanism 2176 registry to indicate that this document and [AuthMeth] provides the 2177 definitive technical specification for the Start TLS 2178 (1.3.6.1.4.1.1466.20037) extended operation. 2180 It is requested that the IANA update the occurrence of "RFC XXXX" in 2181 Appendix B with this RFC number at publication. 2183 11. Editor's Address 2185 Jim Sermersheim 2186 Novell, Inc. 2187 1800 South Novell Place 2188 Provo, Utah 84606, USA 2189 jimse@novell.com 2190 +1 801 861-3088 2191 Lightweight Directory Access Protocol Version 3 2193 Appendix A - LDAP Result Codes 2195 This normative appendix details additional considerations regarding 2196 LDAP result codes and provides a brief, general description of each 2197 LDAP result code enumerated in Section 4.1.9. 2199 Additional result codes MAY be defined for use with extensions 2200 [LDAPIANA]. Client implementations SHALL treat any result code which 2201 they do not recognize as an unknown error condition. 2203 A.1 Non-Error Result Codes 2205 These result codes (called "non-error" result codes) do not indicate 2206 an error condition: 2207 success (0), 2208 compareTrue (6), 2209 compareFalse (7), 2210 referral (10), and 2211 saslBindInProgress (14). 2213 The success, compareTrue, and compareFalse result codes indicate 2214 successful completion (and, hence, are referred to as "successful" 2215 result codes). 2217 The referral and saslBindInProgress result codes indicate the client 2218 is required to take additional action to complete the operation. 2220 A.2 Result Codes 2222 Existing LDAP result codes are described as follows: 2224 success (0) 2225 Indicates the successful completion of an operation. Note: 2226 this code is not used with the compare operation. See 2227 compareTrue (5) and compareFalse (6). 2229 operationsError (1) 2230 Indicates that the operation is not properly sequenced with 2231 relation to other operations (of same or different type). 2233 For example, this code is returned if the client attempts to 2234 StartTLS [TLS] while there are other operations outstanding 2235 or if TLS was already established. 2237 protocolError (2) 2238 Indicates the server received data which has incorrect 2239 structure. 2241 For bind operation only, this code is also used to indicate 2242 that the server does not support the requested protocol 2243 version. 2245 Lightweight Directory Access Protocol Version 3 2247 timeLimitExceeded (3) 2248 Indicates that the time limit specified by the client was 2249 exceeded before the operation could be completed. 2251 sizeLimitExceeded (4) 2252 Indicates that the size limit specified by the client was 2253 exceeded before the operation could be completed. 2255 compareFalse (5) 2256 Indicates that the compare operation has successfully 2257 completed and the assertion has evaluated to FALSE. 2259 compareTrue (6) 2260 Indicates that the compare operation has successfully 2261 completed and the assertion has evaluated to TRUE. 2263 authMethodNotSupported (7) 2264 Indicates that the authentication method or mechanism is not 2265 supported. 2267 strongAuthRequired (8) 2268 Indicates that the server has detected that an established 2269 security association between the client and server has 2270 unexpectedly failed or been compromised, or that the server 2271 now requires the client to authenticate using a strong(er) 2272 mechanism. 2274 referral (10) 2275 Indicates that a referral needs to be chased to complete the 2276 operation (see Section 4.1.10). 2278 adminLimitExceeded (11) 2279 Indicates that an administrative limit has been exceeded. 2281 unavailableCriticalExtension (12) 2282 Indicates that the server is unable or unwilling to perform a 2283 critical control (see Section 4.1.11). 2285 confidentialityRequired (13) 2286 Indicates that data confidentiality protections are required. 2288 saslBindInProgress (14) 2289 Indicates the server requires the client to send a new bind 2290 request, with the same SASL mechanism, to continue the 2291 authentication process (see Section 4.2). 2293 noSuchAttribute (16) 2294 Indicates that the named entry does not contain the specified 2295 attribute or attribute value. 2297 undefinedAttributeType (17) 2298 Indicates that a request field contains an unrecognized 2299 attribute description. 2301 Lightweight Directory Access Protocol Version 3 2303 inappropriateMatching (18) 2304 Indicates that an attempt was made, e.g. in an assertion, to 2305 use a matching rule not defined for the attribute type 2306 concerned. 2308 constraintViolation (19) 2309 Indicates that the client supplied an attribute value which 2310 does not conform to the constraints placed upon it by the 2311 data model. 2313 For example, this code is returned when multiple values are 2314 supplied to an attribute which has a SINGLE-VALUE constraint. 2316 attributeOrValueExists (20) 2317 Indicates that the client supplied an attribute or value to 2318 be added to an entry, but the attribute or value already 2319 exists. 2321 invalidAttributeSyntax (21) 2322 Indicates that a purported attribute value does not conform 2323 to the syntax of the attribute. 2325 noSuchObject (32) 2326 Indicates that the object does not exist in the DIT. 2328 aliasProblem (33) 2329 Indicates that an alias problem has occurred. For example, 2330 the code may used to indicate an alias has been dereferenced 2331 which names no object. 2333 invalidDNSyntax (34) 2334 Indicates that an LDAPDN or RelativeLDAPDN field (e.g. search 2335 base, target entry, ModifyDN newrdn, etc.) of a request does 2336 not conform to the required syntax or contains attribute 2337 values which do not conform to the syntax of the attribute's 2338 type. 2340 aliasDereferencingProblem (36) 2341 Indicates that a problem occurred while dereferencing an 2342 alias. Typically an alias was encountered in a situation 2343 where it was not allowed or where access was denied. 2345 inappropriateAuthentication (48) 2346 Indicates the server requires the client which had attempted 2347 to bind anonymously or without supplying credentials to 2348 provide some form of credentials. 2350 invalidCredentials (49) 2351 Indicates that the provided credentials (e.g. the user's name 2352 and password) are invalid. 2354 insufficientAccessRights (50) 2355 Indicates that the client does not have sufficient access 2356 rights to perform the operation. 2358 Lightweight Directory Access Protocol Version 3 2360 busy (51) 2361 Indicates that the server is too busy to service the 2362 operation. 2364 unavailable (52) 2365 Indicates that the server is shutting down or a subsystem 2366 necessary to complete the operation is offline. 2368 unwillingToPerform (53) 2369 Indicates that the server is unwilling to perform the 2370 operation. 2372 loopDetect (54) 2373 Indicates that the server has detected an internal loop (e.g. 2374 while dereferencing aliases or chaining an operation). 2376 namingViolation (64) 2377 Indicates that the entry's name violates naming restrictions. 2379 objectClassViolation (65) 2380 Indicates that the entry violates object class restrictions. 2382 notAllowedOnNonLeaf (66) 2383 Indicates that the operation is inappropriately acting upon a 2384 non-leaf entry. 2386 notAllowedOnRDN (67) 2387 Indicates that the operation is inappropriately attempting to 2388 remove a value which forms the entry's relative distinguished 2389 name. 2391 entryAlreadyExists (68) 2392 Indicates that the request cannot be fulfilled (added, moved, 2393 or renamed) as the target entry already exists. 2395 objectClassModsProhibited (69) 2396 Indicates that an attempt to modify the object class(es) of 2397 an entry's 'objectClass' attribute is prohibited. 2399 For example, this code is returned when a client attempts to 2400 modify the structural object class of an entry. 2402 affectsMultipleDSAs (71) 2403 Indicates that the operation cannot be completed as it 2404 affects multiple servers (DSAs). 2406 other (80) 2407 Indicates the server has encountered an internal error. 2409 Lightweight Directory Access Protocol Version 3 2411 Appendix B - Complete ASN.1 Definition 2413 This appendix is normative. 2415 Lightweight-Directory-Access-Protocol-V3 2416 -- Copyright (C) The Internet Society (2003). This version of 2417 -- this ASN.1 module is part of RFC XXXX; see the RFC itself 2418 -- for full legal notices. 2419 DEFINITIONS 2420 IMPLICIT TAGS 2421 EXTENSIBILITY IMPLIED ::= 2423 BEGIN 2425 LDAPMessage ::= SEQUENCE { 2426 messageID MessageID, 2427 protocolOp CHOICE { 2428 bindRequest BindRequest, 2429 bindResponse BindResponse, 2430 unbindRequest UnbindRequest, 2431 searchRequest SearchRequest, 2432 searchResEntry SearchResultEntry, 2433 searchResDone SearchResultDone, 2434 searchResRef SearchResultReference, 2435 modifyRequest ModifyRequest, 2436 modifyResponse ModifyResponse, 2437 addRequest AddRequest, 2438 addResponse AddResponse, 2439 delRequest DelRequest, 2440 delResponse DelResponse, 2441 modDNRequest ModifyDNRequest, 2442 modDNResponse ModifyDNResponse, 2443 compareRequest CompareRequest, 2444 compareResponse CompareResponse, 2445 abandonRequest AbandonRequest, 2446 extendedReq ExtendedRequest, 2447 extendedResp ExtendedResponse, 2448 intermediateResponse IntermediateResponse 2449 ... }, 2450 controls [0] Controls OPTIONAL } 2452 MessageID ::= INTEGER (0 .. maxInt) 2454 maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- 2456 LDAPString ::= OCTET STRING -- UTF-8 encoded, 2457 -- [ISO10646] characters 2459 LDAPOID ::= OCTET STRING -- Constrained to [Models] 2461 LDAPDN ::= LDAPString -- Constrained to 2462 -- [LDAPDN] 2464 RelativeLDAPDN ::= LDAPString -- Constrained to 2465 Lightweight Directory Access Protocol Version 3 2467 -- [LDAPDN] 2469 AttributeDescription ::= LDAPString 2470 -- Constrained to 2471 -- [Models] 2473 AttributeValue ::= OCTET STRING 2475 AttributeValueAssertion ::= SEQUENCE { 2476 attributeDesc AttributeDescription, 2477 assertionValue AssertionValue } 2479 AssertionValue ::= OCTET STRING 2481 PartialAttribute ::= SEQUENCE { 2482 type AttributeDescription, 2483 vals SET OF value AttributeValue } 2485 Attribute ::= PartialAttribute(WITH COMPONENTS { 2486 ..., 2487 vals (SIZE(1..MAX))}) 2489 MatchingRuleId ::= LDAPString 2491 LDAPResult ::= SEQUENCE { 2492 resultCode ENUMERATED { 2493 success (0), 2494 operationsError (1), 2495 protocolError (2), 2496 timeLimitExceeded (3), 2497 sizeLimitExceeded (4), 2498 compareFalse (5), 2499 compareTrue (6), 2500 authMethodNotSupported (7), 2501 strongAuthRequired (8), 2502 -- 9 reserved -- 2503 referral (10), 2504 adminLimitExceeded (11), 2505 unavailableCriticalExtension (12), 2506 confidentialityRequired (13), 2507 saslBindInProgress (14), 2508 noSuchAttribute (16), 2509 undefinedAttributeType (17), 2510 inappropriateMatching (18), 2511 constraintViolation (19), 2512 attributeOrValueExists (20), 2513 invalidAttributeSyntax (21), 2514 -- 22-31 unused -- 2515 noSuchObject (32), 2516 aliasProblem (33), 2517 invalidDNSyntax (34), 2518 -- 35 reserved for undefined isLeaf -- 2519 aliasDereferencingProblem (36), 2520 -- 37-47 unused -- 2521 Lightweight Directory Access Protocol Version 3 2523 inappropriateAuthentication (48), 2524 invalidCredentials (49), 2525 insufficientAccessRights (50), 2526 busy (51), 2527 unavailable (52), 2528 unwillingToPerform (53), 2529 loopDetect (54), 2530 -- 55-63 unused -- 2531 namingViolation (64), 2532 objectClassViolation (65), 2533 notAllowedOnNonLeaf (66), 2534 notAllowedOnRDN (67), 2535 entryAlreadyExists (68), 2536 objectClassModsProhibited (69), 2537 -- 70 reserved for CLDAP -- 2538 affectsMultipleDSAs (71), 2539 -- 72-79 unused -- 2540 other (80), 2541 ... }, 2542 matchedDN LDAPDN, 2543 diagnosticMessage LDAPString, 2544 referral [3] Referral OPTIONAL } 2546 Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI 2548 URI ::= LDAPString -- limited to characters permitted in 2549 -- URIs 2551 Controls ::= SEQUENCE OF control Control 2553 Control ::= SEQUENCE { 2554 controlType LDAPOID, 2555 criticality BOOLEAN DEFAULT FALSE, 2556 controlValue OCTET STRING OPTIONAL } 2558 BindRequest ::= [APPLICATION 0] SEQUENCE { 2559 version INTEGER (1 .. 127), 2560 name LDAPDN, 2561 authentication AuthenticationChoice } 2563 AuthenticationChoice ::= CHOICE { 2564 simple [0] OCTET STRING, 2565 -- 1 and 2 reserved 2566 sasl [3] SaslCredentials, 2567 ... } 2569 SaslCredentials ::= SEQUENCE { 2570 mechanism LDAPString, 2571 credentials OCTET STRING OPTIONAL } 2573 BindResponse ::= [APPLICATION 1] SEQUENCE { 2574 COMPONENTS OF LDAPResult, 2575 serverSaslCreds [7] OCTET STRING OPTIONAL } 2576 Lightweight Directory Access Protocol Version 3 2578 UnbindRequest ::= [APPLICATION 2] NULL 2580 SearchRequest ::= [APPLICATION 3] SEQUENCE { 2581 baseObject LDAPDN, 2582 scope ENUMERATED { 2583 baseObject (0), 2584 singleLevel (1), 2585 wholeSubtree (2) }, 2586 derefAliases ENUMERATED { 2587 neverDerefAliases (0), 2588 derefInSearching (1), 2589 derefFindingBaseObj (2), 2590 derefAlways (3) }, 2591 sizeLimit INTEGER (0 .. maxInt), 2592 timeLimit INTEGER (0 .. maxInt), 2593 typesOnly BOOLEAN, 2594 filter Filter, 2595 attributes AttributeSelection } 2597 AttributeSelection ::= SEQUENCE OF selection LDAPString 2598 -- constrained to 2599 -- in section 4.5.1. 2601 Filter ::= CHOICE { 2602 and [0] SET SIZE (1..MAX) OF filter Filter, 2603 or [1] SET SIZE (1..MAX) OF filter Filter, 2604 not [2] Filter, 2605 equalityMatch [3] AttributeValueAssertion, 2606 substrings [4] SubstringFilter, 2607 greaterOrEqual [5] AttributeValueAssertion, 2608 lessOrEqual [6] AttributeValueAssertion, 2609 present [7] AttributeDescription, 2610 approxMatch [8] AttributeValueAssertion, 2611 extensibleMatch [9] MatchingRuleAssertion } 2613 SubstringFilter ::= SEQUENCE { 2614 type AttributeDescription, 2615 -- at least one must be present, 2616 -- initial and final can occur at most once 2617 substrings SEQUENCE SIZE (1..MAX) OF substring CHOICE { 2618 initial [0] AssertionValue, 2619 any [1] AssertionValue, 2620 final [2] AssertionValue } } 2622 MatchingRuleAssertion ::= SEQUENCE { 2623 matchingRule [1] MatchingRuleId OPTIONAL, 2624 type [2] AttributeDescription OPTIONAL, 2625 matchValue [3] AssertionValue, 2626 dnAttributes [4] BOOLEAN DEFAULT FALSE } 2628 SearchResultEntry ::= [APPLICATION 4] SEQUENCE { 2629 objectName LDAPDN, 2630 attributes PartialAttributeList } 2631 Lightweight Directory Access Protocol Version 3 2633 PartialAttributeList ::= SEQUENCE OF 2634 partialAttribute PartialAttribute 2636 SearchResultReference ::= [APPLICATION 19] SEQUENCE 2637 SIZE (1..MAX) OF uri URI 2639 SearchResultDone ::= [APPLICATION 5] LDAPResult 2641 ModifyRequest ::= [APPLICATION 6] SEQUENCE { 2642 object LDAPDN, 2643 changes SEQUENCE OF change SEQUENCE { 2644 operation ENUMERATED { 2645 add (0), 2646 delete (1), 2647 replace (2) }, 2648 modification PartialAttribute } } 2650 ModifyResponse ::= [APPLICATION 7] LDAPResult 2652 AddRequest ::= [APPLICATION 8] SEQUENCE { 2653 entry LDAPDN, 2654 attributes AttributeList } 2656 AttributeList ::= SEQUENCE OF attribute Attribute 2658 AddResponse ::= [APPLICATION 9] LDAPResult 2660 DelRequest ::= [APPLICATION 10] LDAPDN 2662 DelResponse ::= [APPLICATION 11] LDAPResult 2664 ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { 2665 entry LDAPDN, 2666 newrdn RelativeLDAPDN, 2667 deleteoldrdn BOOLEAN, 2668 newSuperior [0] LDAPDN OPTIONAL } 2670 ModifyDNResponse ::= [APPLICATION 13] LDAPResult 2672 CompareRequest ::= [APPLICATION 14] SEQUENCE { 2673 entry LDAPDN, 2674 ava AttributeValueAssertion } 2676 CompareResponse ::= [APPLICATION 15] LDAPResult 2678 AbandonRequest ::= [APPLICATION 16] MessageID 2680 ExtendedRequest ::= [APPLICATION 23] SEQUENCE { 2681 requestName [0] LDAPOID, 2682 requestValue [1] OCTET STRING OPTIONAL } 2684 ExtendedResponse ::= [APPLICATION 24] SEQUENCE { 2685 COMPONENTS OF LDAPResult, 2686 responseName [10] LDAPOID OPTIONAL, 2687 Lightweight Directory Access Protocol Version 3 2689 responseValue [11] OCTET STRING OPTIONAL } 2691 END 2692 Lightweight Directory Access Protocol Version 3 2694 Appendix C - Changes 2696 This appendix is non-normative. 2698 This appendix summarizes substantive changes made to RFC 2251 and RFC 2699 2830. 2701 C.1 Changes made to made to RFC 2251: 2703 This section summarizes the substantive changes made to Sections 1, 2704 2, 3.1, and 4 through the remainder of RFC 2251. Readers should 2705 consult [Models] and [AuthMeth] for summaries of changes to other 2706 sections. 2708 C.1.1 Section 1 2710 - Removed IESG note. Post publication of RFC 2251, mandatory LDAP 2711 authentication mechanisms have been standardized which are 2712 sufficient to remove this note. See [AuthMeth] for authentication 2713 mechanisms. 2715 C.1.2 Section 3.1 and others 2717 - Removed notes giving history between LDAP v1, v2 and v3. Instead, 2718 added sufficient language so that this document can stand on its 2719 own. 2721 C.1.3 Section 4 2723 - Clarified where the extensibility features of ASN.1 apply to the 2724 protocol. This change also affected various ASN.1 types. 2725 - Removed the requirement that servers which implement version 3 or 2726 later MUST provide the 'supportedLDAPVersion' attribute. This 2727 statement provided no interoperability advantages. 2729 C.1.4 Section 4.1.1 2731 - There was a mandatory requirement for the server to return a 2732 Notice of Disconnection and drop the connection when a PDU is 2733 malformed in a certain way. This has been clarified such that the 2734 server SHOULD return the Notice of Disconnection, and MUST drop 2735 the connection. 2737 C.1.5 Section 4.1.1.1 2739 - Clarified that the messageID of requests MUST be non-zero. 2741 Lightweight Directory Access Protocol Version 3 2743 - Clarified when it is and isn't appropriate to return an already 2744 used message id. RFC 2251 accidentally imposed synchronous server 2745 behavior in its wording of this. 2747 C.1.6 Section 4.1.2 2749 - Stated that LDAPOID is constrained to from [Models]. 2751 C.1.7 Section 4.1.5.1 2753 - Removed the Binary Option from the specification. There are 2754 numerous interoperability problems associated with this method of 2755 alternate attribute type encoding. Work to specify a suitable 2756 replacement is ongoing. 2758 C.1.8 Section 4.1.6 2760 - Removed references to the "binary" encoding as it has been removed 2761 from the specification. 2763 C.1.9 Section 4.1.7 2765 - Removed references to the "binary" encoding as it has been removed 2766 from the specification. 2768 C.1.10 Section 4.1.8 2770 - Combined the definitions of PartialAttribute and Attribute here, 2771 and defined Attribute in terms of PartialAttribute. 2773 C.1.11 Section 4.1.10 2775 - Renamed "errorMessage" to "diagnosticMessage" as it is allowed to 2776 be sent for non-error results. 2777 - Moved some language into Appendix A, and refer the reader there. 2778 - Allowed matchedDN to be present for other result codes than those 2779 listed in RFC 2251. 2781 C.1.12 Section 4.1.11 2783 - Defined referrals in terms of URIs rather than URLs. 2784 - Removed the requirement that all referral URIs MUST be equally 2785 capable of progressing the operation. The statement was ambiguous 2786 and provided no instructions on how to carry it out. 2787 - Added the requirement that clients MUST NOT loop between servers. 2788 - Clarified the instructions for using LDAPURLs in referrals, and in 2789 doing so added a recommendation that the scope part be present. 2791 Lightweight Directory Access Protocol Version 3 2793 C.1.13 Section 4.1.12 2795 - Specified how control values defined in terms of ASN.1 are to be 2796 encoded. 2797 - Noted that the criticality field is only applied to request 2798 messages (except unbindRequest), and must be ignored when present 2799 on response messages and unbindRequest. 2800 - Added language regarding combinations of controls on a message. 2801 - Changed "The server MUST be prepared" to "Implementations MUST be 2802 prepared" in the eighth paragraph to reflect that both client and 2803 server implementations must be able to handle this (as both parse 2804 controls). 2806 C.1.14 Section 4.2 2808 - Mandated that servers return protocolError when the version is not 2809 supported. 2810 - Clarified behavior when the simple authentication is used, the 2811 name is empty and the password is non-empty. 2812 - Required servers to not dereference aliases for bind. This was 2813 added for consistency with other operations and to help ensure 2814 data consistency. 2815 - Required that textual passwords be transferred as UTF-8 encoded 2816 Unicode, and added recommendations on string preparation. This was 2817 to help ensure interoperability of passwords being sent from 2818 different clients. 2820 C.1.15 Section 4.2.1 2822 - This section was largely reorganized for readability and language 2823 was added to clarify the authentication state of failed and 2824 abandoned bind operations. 2825 - Removed: "If a SASL transfer encryption or integrity mechanism has 2826 been negotiated, that mechanism does not support the changing of 2827 credentials from one identity to another, then the client MUST 2828 instead establish a new connection." 2829 Each SASL negotiation is, generally, independent of other SASL 2830 negotiations. If there were dependencies between multiple 2831 negotiations of a particular mechanism, the mechanism technical 2832 specification should detail how applications are to deal with 2833 them. LDAP should not require any special handling. And if an LDAP 2834 client had used such a mechanism, it would have the option of 2835 using another mechanism. 2836 - Dropped MUST imperative in paragraph 3 to align with [Keywords]. 2838 C.1.16 Section 4.2.3 2839 Lightweight Directory Access Protocol Version 3 2841 - Moved most error-related text to Appendix A, and added text 2842 regarding certain errors used in conjunction with the bind 2843 operation. 2844 - Prohibited the server from specifying serverSaslCreds when not 2845 appropriate. 2847 C.1.17 Section 4.3 2849 - Required both peers to cease transmission and close the connection 2850 for the unbind operation. 2852 C.1.18 Section 4.4 2854 - Added instructions for future specifications of Unsolicited 2855 Notifications. 2857 C.1.19 Section 4.5.1 2859 - SearchRequest attributes is now defined as an AttributeSelection 2860 type rather than AttributeDescriptionList, and an ABNF is 2861 provided. 2862 - SearchRequest attributes may contain duplicate attribute 2863 descriptions. This was previously prohibited. Now servers are 2864 instructed to ignore subsequent names when they are duplicated. 2865 This was relaxed in order to allow different short names and also 2866 OIDs to be requested for an attribute. 2867 - The Filter choices 'and' and 'or', and the SubstringFilter 2868 substrings types are now defined with a lower bound of 1. 2869 - The SubstringFilter substrings 'initial, 'any', and 'final' types 2870 are now AssertionValue rather than LDAPString. Also, added 2871 imperatives stating that 'initial' (if present) must be listed 2872 first, and 'final' (if present) must be listed last. 2873 - Clarified the semantics of the derefAliases choices. 2874 - Added instructions for equalityMatch, substrings, greaterOrEqual, 2875 lessOrEqual, and approxMatch. 2877 C.1.20 Section 4.5.2 2879 - Recommended that servers not use attribute short names when it 2880 knows they are ambiguous or may cause interoperability problems. 2881 - Removed all mention of ExtendedResponse due to lack of 2882 implementation. 2884 C.1.21 Section 4.5.3 2886 - Made changes similar to those made to Section 4.1.11. 2888 C.1.22 Section 4.5.3.1 2889 Lightweight Directory Access Protocol Version 3 2891 - Fixed examples to adhere to changes made to Section 4.5.3. 2893 C.1.23 Section 4.6 2895 - Removed restriction that required an EQUALITY matching rule in 2896 order to perform value delete modifications. It is sufficiently 2897 documented that in absence of an equality matching rule, octet 2898 equality is used. 2899 - Replaced AttributeTypeAndValues with Attribute as they are 2900 equivalent. 2901 - Clarified what type of modification changes might temporarily 2902 violate schema. 2904 C.1.24 Section 4.7 2906 - Aligned Add operation with X.511 in that the attributes of the RDN 2907 are used in conjunction with the listed attributes to create the 2908 entry. Previously, Add required that the distinguished values be 2909 present in the listed attributes. 2911 C.1.25 Section 4.9 2913 - Required servers to not dereference aliases for modify DN. This 2914 was added for consistency with other operations and to help ensure 2915 data consistency. 2916 - Allow modify DN to fail when moving between naming contexts. 2917 - Specified what happens when the attributes of the newrdn are no 2918 present on the entry. 2920 C.1.26 Section 4.10 2922 - Clarified the semantics of Compare when the attribute is not 2923 present and when it is unknown. 2924 - Clarified that an Undefined compare results in a compareFalse 2925 resultCode. 2926 - Required servers to not dereference aliases for compare. This was 2927 added for consistency with other operations and to help ensure 2928 data consistency. 2930 C.1.27 Section 4.11 2932 - Explained that since abandon returns no response, clients should 2933 not use it if they need to know the outcome. 2934 - Specified that Abandon and Unbind cannot be abandoned. 2936 C.1.28 Section 4.12 2938 - Specified how values of extended operations defined in terms of 2939 ASN.1 are to be encoded. 2941 Lightweight Directory Access Protocol Version 3 2943 - Added instructions on what extended operation specifications 2944 consist of. 2945 - Added a recommendation that servers advertise supported extended 2946 operations. 2948 C.1.29 Section 5.2 2950 - Moved referral-specific instructions into referral-related 2951 sections. 2953 C.1.30 Section 7 2955 - Reworded notes regarding SASL not protecting certain aspects of 2956 the LDAP bind PDU. 2957 - Noted that Servers are encouraged to prevent directory 2958 modifications by clients that have authenticated anonymously 2959 [AuthMeth]. 2960 - Added a note regarding the scenario where an identity is changed 2961 (deleted, privileges or credentials modified, etc.). 2962 - Warned against following referrals that may have been injected in 2963 the data stream. 2964 - Added a note regarding malformed and long encodings. 2966 C.1.31 Appendix A 2968 - Added "EXTESIBILITY IMPLIED" to ASN.1 definition. 2969 - Removed AttributeType. It is not used. 2971 C.2 Changes made to made to RFC 2830: 2973 This section summarizes the substantive changes made to Sections of 2974 RFC 2830. Readers should consult [AuthMeth] for summaries of changes 2975 to other sections. 2977 C.2.1 Section 2.3 2979 - Removed wording indicating that referrals can be returned from 2980 StartTLS 2981 - Removed requirement that only a narrow set of result codes can be 2982 returned. Some result codes are required in certain scenarios, but 2983 any other may be returned if appropriate. 2985 C.2.1 Section 4.13.3.1 2987 - Reworded most of this section and added the requirement that after 2988 the TLS connection has been closed, the server MUST NOT send 2989 responses to any request message received before the TLS closure. 2991 Lightweight Directory Access Protocol Version 3 2993 C.3 Changes made to made to [LIMR]: 2995 - In general, all technical language was transferred in whole. 2996 Supporting and background language seen as redundant due to its 2997 presence in this document was omitted. 2999 Lightweight Directory Access Protocol Version 3 3001 Intellectual Property Rights 3003 The IETF takes no position regarding the validity or scope of any 3004 intellectual property or other rights that might be claimed to 3005 pertain to the implementation or use of the technology described in 3006 this document or the extent to which any license under such rights 3007 might or might not be available; neither does it represent that it 3008 has made any effort to identify any such rights. Information on the 3009 IETF's procedures with respect to rights in standards-track and 3010 standards-related documentation can be found in BCP-11. Copies of 3011 claims of rights made available for publication and any assurances of 3012 licenses to be made available, or the result of an attempt made to 3013 obtain a general license or permission for the use of such 3014 proprietary rights by implementors or users of this specification can 3015 be obtained from the IETF Secretariat. 3017 The IETF invites any interested party to bring to its attention any 3018 copyrights, patents or patent applications, or other proprietary 3019 rights which may cover technology that may be required to practice 3020 this standard. Please address the information to the IETF Executive 3021 Director. 3023 Full Copyright Statement 3025 Copyright (C) The Internet Society (2003). All Rights Reserved. 3027 This document and translations of it may be copied and furnished to 3028 others, and derivative works that comment on or otherwise explain it 3029 or assist in its implementation may be prepared, copied, published 3030 and distributed, in whole or in part, without restriction of any 3031 kind, provided that the above copyright notice and this paragraph are 3032 included on all such copies and derivative works. However, this 3033 document itself may not be modified in any way, such as by removing 3034 the copyright notice or references to the Internet Society or other 3035 Internet organizations, except as needed for the purpose of 3036 developing Internet standards in which case the procedures for 3037 copyrights defined in the Internet Standards process must be 3038 followed, or as required to translate it into languages other than 3039 English. 3041 The limited permissions granted above are perpetual and will not be 3042 revoked by the Internet Society or its successors or assigns. 3044 This document and the information contained herein is provided on an 3045 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 3046 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 3047 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 3048 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 3049 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.