view Side-By-Side changes
Internet-Draft Editor: J. Sermersheim Intended Category: Standard Track Novell, Inc Document:draft-ietf-ldapbis-protocol-06.txt Januarydraft-ietf-ldapbis-protocol-07.txt March 2002 Obsoletes: RFC 2251Lightweight Directory AccessLDAP: The Protocol(v3) 1.Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of[RFC2026].RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. Distribution of this memo is unlimited. Technical discussion of this document will take place on the IETF LDAP Revision Working Group (LDAPbis) mailing list <ietf-ldapbis@openldap.org>. Please send editorial comments directly to the editor <jimse@novell.com>. Abstract This document describes the protocol elements, along with their semantics and encodings, for the Lightweight Directory Access Protocol (LDAP). LDAP provides access to distributed directory services that act in accordance with X.500 data and service models. These protocol elements are based on those described in the X.500 Directory Access Protocol (DAP). Table of Contents 1.Status of this Memo..............................................1Introduction.....................................................2 2.Abstract.........................................................2Conventions......................................................3 3.Models...........................................................3 3.1.ProtocolModel.................................................3 3.2. Data Model.....................................................4 3.2.1. Attributes of Entries........................................4 3.2.2. Subschema Entries and Subentries.............................6 3.3. Relationship to X.500..........................................7 3.4. Server-specific Data Requirements..............................7Model...................................................3 4. Elements ofProtocol.............................................8Protocol.............................................3 4.1. CommonElements................................................8Elements................................................4 4.1.1. MessageEnvelope.............................................8Envelope.............................................4 4.1.1.1. MessageID.................................................9ID.................................................5 4.1.2. StringTypes.................................................9 4.1.3. Distinguished Name and Relative Distinguished Name..........10 4.1.4. Attribute Type..............................................10 4.1.5. Attribute Description.......................................11 4.1.5.1. Binary Option.............................................13 4.1.6. Attribute Value.............................................13Types.................................................6 Sermersheim Internet-Draft - ExpiresJulySep 2002 Page 1 Lightweight Directory Access Protocol Version 3 4.1.3. Distinguished Name and Relative Distinguished Name...........6 4.1.5. Attribute Description........................................6 4.1.5.1. Binary Transfer Option.....................................7 4.1.6. Attribute Value..............................................8 4.1.7. Attribute ValueAssertion...................................14Assertion....................................8 4.1.8.Attribute...................................................14Attribute....................................................9 4.1.9. Matching RuleIdentifier....................................15Identifier.....................................9 4.1.10. ResultMessage.............................................15Message.............................................10 4.1.11.Referral...................................................17Referral...................................................11 4.1.12.Controls...................................................18Controls...................................................12 4.2. BindOperation................................................19Operation................................................13 4.2.1. Sequencing of the BindRequest..............................20 4.2.2. Authentication and Other Security Services..................21Request..............................14 4.2.3. BindResponse...............................................21Response...............................................15 4.3. UnbindOperation..............................................22Operation..............................................16 4.4. UnsolicitedNotification......................................22Notification......................................16 4.4.1. Notice ofDisconnection.....................................23Disconnection.....................................17 4.5. SearchOperation..............................................23Operation..............................................17 4.5.1. SearchRequest..............................................24Request..............................................17 4.5.2. SearchResult...............................................27Result...............................................21 4.5.3. Continuation References in the SearchResult................28Result................22 4.6. ModifyOperation..............................................30Operation..............................................24 4.7. AddOperation.................................................31Operation.................................................25 4.8. DeleteOperation..............................................32Operation..............................................26 4.9. Modify DNOperation...........................................33Operation...........................................27 4.10. CompareOperation............................................34Operation............................................28 4.11. AbandonOperation............................................35Operation............................................29 4.12. ExtendedOperation...........................................35Operation...........................................29 5. Protocol Element Encodings andTransfer.........................36Transfer.........................30 5.1. ProtocolEncoding.............................................36Encoding.............................................30 5.2. TransferProtocols............................................36Protocols............................................30 5.2.1. Transmission Control Protocol(TCP).........................36(TCP).........................31 6. ImplementationGuidelines.......................................37Guidelines.......................................31 6.1. ServerImplementations........................................37Implementations........................................31 6.2. ClientImplementations........................................37Implementations........................................31 7. SecurityConsiderations.........................................37Considerations.........................................31 8.Acknowledgements................................................38Acknowledgements................................................32 9.Bibliography....................................................38Normative References............................................32 10. Editor'sAddress...............................................39Address...............................................33 Appendix A -Complete ASN.1 Definition.............................40LDAP Result Codes.....................................34 A.1 Non-Error Result Codes.........................................34 A.2 Error Result Codes.............................................34 A.3 Classes and Precedence of Error Result Codes...................34 AppendixBC - Change History........................................45B.1C.1 Changes made to RFC 2251:......................................45B.2C.2 Changes made to draft-ietf-ldapbis-protocol-00.txt:............45B.3C.3 Changes made to draft-ietf-ldapbis-protocol-01.txt:............46B.4C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt:............46B.5C.5 Changes made to draft-ietf-ldapbis-protocol-03.txt:............48B.6C.6 Changes made to draft-ietf-ldapbis-protocol-04.txt:............50B.7C.7 Changes made to draft-ietf-ldapbis-protocol-05.txt:............50 AppendixCD - Outstanding WorkItems................................50 2. Abstract The protocol described in this document is designed to provide access to directories supporting the [X.500] models, while not incurring the resource requirements of the X.500 Directory Access Protocol (DAP). This protocol is specifically targeted at management applications and browser applications that provide read/write interactive access toItems................................54 1. Introduction Sermersheim Internet-Draft - ExpiresJulySep 2002 Page 2 Lightweight Directory Access Protocol Version 3directories. When used with a directory supporting the X.500 protocols, itThe Directory isintended"a collection of open systems cooperating to provide directory services" [X.500]. A Directory user, which may be acomplement tohuman or other entity, accesses theX.500 DAP.Directory through a client (or Directory User Agent (DUA)). Thekey words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", and "MAY" in this document are to be interpreted as described in [RFC2119]. Key aspects of this versionclient, on behalf ofLDAP are: - Allthe directory user, interacts with one or more servers (or Directory System Agents (DSA)). Clients interact with servers using a directory access protocol. This document details the protocol elements ofLDAPv2 [RFC1777] are supported. The protocol is carried directly over TCP or other transport, bypassing much ofLightweight Directory Access Protocol, along with their semantic meanings. Following thesession/presentation overheaddescription ofX.500 DAP. - Mostprotocoldata elements can be encoded as ordinary strings (e.g., Distinguished Names). - Referrals to other servers may be returned. - SASL mechanisms may be used with LDAP to provide association security services. - Attribute values and Distinguished Names have been internationalized throughelements, it describes theuse ofway in which theISO 10646 character set. - Theprotocolcan be extended to support new operations,is encoded andcontrols may be used to extend existing operations. - Schematransferred. This document ispublished inan integral part of thedirectoryLDAP Technical Specification [Roadmap]. This document replaces RFC 2251. Appendix C holds a detailed log of changes to RFC 2251. At publication time, this appendix will beused by clients. 3. Models Interest in X.500 directory technologies in the Internet has led to effortsdistilled toreduce the high cost of entry associated with usea summary ofthese technologies. Thischanges to RFC 2251. 2. Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", and "MAY" in this documentcontinues the effortsare todefine directory protocol alternatives, updating the LDAPv2 protocol specification. 3.1.be interpreted as described in [RFC2119]. 3. Protocol Model The general model adopted by this protocol is one of clients performing protocol operations against servers. In this model, a client transmits a protocol request describing the operation to be performed to a server. The server is then responsible for performing the necessary operation(s) in the directory. Upon completion of the operation(s), the server returns a response containing any results or errors to the requesting client.In keeping with the goal of easing the costs associated with use of the directory, it is an objective of this protocol to minimize the complexity of clients so as to facilitate widespread deployment of applications capable of using the directory.Note that although servers are required to return responses whenever such responses are defined in the protocol, there is no requirement for synchronous behavior on the part of either clients or servers.Sermersheim Internet-Draft - Expires July 2002 Page 3 Lightweight Directory Access Protocol Version 3Requests and responses for multiple operations may be exchanged between a client and server in any order, provided the client eventually receives a response for every request that requires one.In LDAP versions 1 and 2, no provision was made forNote that the core protocolservers returning referrals to clients. However, for improved performance and distribution,operations defined in thisversion of the protocol permits servers to return to clients, referrals to other servers. This allows servers to offload the work of contacting other servers to progress operations. Note that the core protocol operations defined in this document can be mapped to a strict subsetdocument can be mapped to a strict subset of the X.500(1997) directory abstractservice, so it can be cleanly provided by the DAP.service. However there is not a one-to-one mapping between LDAP protocol operations and DAPoperations: serveroperations. Server implementations acting as a gateway to X.500 directories may need to make multiple DAP requests.3.2. Data Model This section provides a brief introduction to the X.500 data model, as used by LDAP.4. Elements of Protocol Sermersheim Internet-Draft - Expires Sep 2002 Page 3 Lightweight Directory Access Protocol Version 3 The LDAP protocolassumes there are one or more servers which jointly provide access to a Directory Information Tree (DIT). The treeismade up of entries. Entries have names: one or more attribute values from the entry form its relative distinguished name (RDN), which MUST be unique among all its siblings. The concatenation of the relative distinguished names of the sequence of entries fromdescribed using Abstract Syntax Notation 1 (ASN.1) [X.680], and is transferred using aparticular entry to an immediate subordinate of the rootsubset of ASN.1 Basic Encoding Rules [X.690]. Section 5.1 specifies how thetree forms that entry's Distinguished Name (DN), whichprotocol isuniqueencoded and transferred. In order to support future extensions to this protocol, extensibility is implied where it is allowed (per ASN.1). In addition, ellipses (...) have been supplied inthe tree. An example of a Distinguished Name is: CN=Steve Kille, O=Isode Limited, C=GB Some servers may hold cache or shadow copiesASN.1 types that are explicitly extensible as discussed in [LDAPIANA]. Because ofentries, which can be used to answer searchthe implied extensibility, clients andcomparison queries, but will return referrals or contact otherserversif modification operations are requested. Servers that perform caching or shadowingMUSTensure thatignore trailing SEQUENCE elements whose tags they do notviolate any access control constraints placed on the data by the originating server. The largest collection of entries, starting at an entry that is mastered by a particular server, and including all its subordinates and their subordinates, downrecognize. Changes to theentries which are mastered byLDAP protocol other than those described in [LDAPIANA] require a differentservers,version number. A client indicates the version it istermed a naming context. The rootusing as part of theDIT isbind request, described in section 4.2. If aDSA-specific Entry (DSE) andclient has notpart of any naming context: eachsent a bind, the serverhas differentMUST assume the client is using version 3 or later. Clients may determine the protocol versions a server supports by reading the supportedLDAPVersion attributevalues infrom the rootDSE. (DSA is an X.500 term forDSE [Models]. Servers which implement version 3 or later versions MUST provide this attribute. 4.1. Common Elements This section describes thedirectory server). 3.2.1. AttributesLDAPMessage envelope PDU (Protocol Data Unit) format, as well as data type definitions, which are used in the protocol operations. 4.1.1. Message Envelope For the purposes ofEntriesprotocol exchanges, all protocol operations are encapsulated in a common envelope, the LDAPMessage, which is defined as follows: LDAPMessage ::= SEQUENCE { messageID MessageID, protocolOp CHOICE { bindRequest BindRequest, bindResponse BindResponse, unbindRequest UnbindRequest, searchRequest SearchRequest, searchResEntry SearchResultEntry, searchResDone SearchResultDone, searchResRef SearchResultReference, modifyRequest ModifyRequest, modifyResponse ModifyResponse, addRequest AddRequest, addResponse AddResponse, delRequest DelRequest, delResponse DelResponse, Sermersheim Internet-Draft - ExpiresJulySep 2002 Page 4 Lightweight Directory Access Protocol Version 3Entries consist of a setmodDNRequest ModifyDNRequest, modDNResponse ModifyDNResponse, compareRequest CompareRequest, compareResponse CompareResponse, abandonRequest AbandonRequest, extendedReq ExtendedRequest, extendedResp ExtendedResponse }, controls [0] Controls OPTIONAL } MessageID ::= INTEGER (0 .. maxInt) maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- The function ofattributes. An attribute is a description (a type and zero or more options) with one or more associated values. The attribute type governs whether the attribute can have multiple values,thesyntax and matching rules usedLDAPMessage is toconstruct and compare values of that attribute, and other functions. Options indicate modes of transfer and other functions. An example ofprovide anattribute is "mail". There may be one or more values ofenvelope containing common fields required in all protocol exchanges. At thisattribute, they must be IA5 (ASCII) strings, and theytime the only common fields arecase insensitive (e.g. "foo@bar.com" will match "FOO@BAR.COM"). Schema isthecollection of attribute type definitions, object class definitionsmessage ID andother information which athe controls. If the serveruses to determine how to match a filter or attribute value assertion (inreceives acompare operation) againstPDU from theattributes of an entry, and whether to permit add and modify operations. The definition of schema for use with LDAP is given in [RFC2252] and [X.501]. Additional schema elements may be definedclient inother documents. Each entry MUST have an objectClass attribute. The objectClass attribute specifies the object classes of an entry,whichalong with the system and user schema determinethepermitted attributes of an entry. Values of this attribute mayLDAPMessage SEQUENCE tag cannot bemodified by clients, butrecognized, theobjectClass attributemessageID cannot beremoved. Servers may restrict the modifications of this attribute to preventparsed, thebasic structural classtag of theentry from being changed (e.g. one cannot change a person intoprotocolOp is not recognized as acountry). When creating an entryrequest, oradding an objectClass value to an entry, all superclasses ofthenamed classes are implicitly added as well if not already present, and the client must supply values for any mandatory attributes of new superclasses. Some attributes, termed operational attributes (as defined in Section 12.4.1encoding structures or lengths of[X.501]), are used by servers for administering the directory system itself. They are not returned in search results unless explicitly requested by name. Attributes whichdata fields arenot operational, such as "mail", will have their schema and syntax constraints enforced by servers, but servers will generally not make use of their values. Servers MUST NOT permit clients to add attributesfound toan entry unless those attributes are permitted bybe incorrect, then theobject class definitions,server MUST return theschema controlling that entry (specifiednotice of disconnection described inthe subschema û see below), or are operational attributes known to that serversection 4.4.1, with resultCode protocolError, andused for administrative purposes. Note that there is a particular objectClass 'extensibleObject' defined in [RFC2252] which permits all user attributes to be present in an entry. Entries MAY contain, among others,immediately close thefollowing operational attributes, defined in [RFC2252]. These attributes are maintained automatically byconnection. In other cases that the serverand are not modifiablecannot parse the request received byclients: - creatorsName:theDistinguished Name ofclient, theuser who added this entryserver MUST return an appropriate response to thedirectory. Sermersheim Internet-Draft - Expires July 2002 Page 5 Lightweight Directory Access Protocol Version 3 - createTimestamp:request, with thetime this entry was addedresultCode set to protocolError. If thedirectory. - modifiersName: the Distinguished Name ofclient receives a PDU from theuser who last modified this entry. - modifyTimestamp:server, which cannot be parsed, thetime this entry was last modified. - subschemaSubentry:client may discard theDistinguished Name ofPDU, or may abruptly close thesubschema entry (or subentry) which controls the schema for this entry. 3.2.2. Subschema Entries and Subentries Subschema entries are used for administering information about the directory schema,connection. The ASN.1 type Controls is defined inparticularsection 4.1.12. 4.1.1.1. Message ID All LDAPMessage envelopes encapsulating responses contain theobject classes and attribute types supported by directory servers. A single subschema entry contains all schema definitions used by entries in a particular partmessageID value of thedirectory tree. Servers which follow X.500(93) models SHOULD implement subschema using the X.500 subschema mechanisms, and so these subschemas are not ordinary entries. LDAP clients SHOULD NOT assume that servers implement anycorresponding request LDAPMessage. The message ID of a request MUST have a non-zero value different from theother aspectsvalues ofX.500 subschema. A server which masters entries and permits clients to modify these entries MUST implement and provide access to these subschema entries, so that its clients may discoverany other requests outstanding in theattributes and object classesLDAP session of whichare permitted to be present. It is strongly recommended that all other servers implementthisas well.message is a part. Thefollowing four attributes MUST be present in all subschema entries: - cn: this attributezero value is reserved for the unsolicited notification message. A client MUSTbe used to formNOT send a second request with theRDN ofsame message ID as an earlier request on thesubschema entry. - objectClass:same connection if theattribute MUST have at leastclient has not received thevalues "top" and "subschema". - objectClasses: each value of this attribute specifies an object class known tofinal response from theserver. - attributeTypes:earlier request. Otherwise the behavior is undefined. Typical clients increment a counter for eachvaluerequest. A client MUST NOT reuse the message id ofthis attribute specifiesanattribute type known toabandonRequest or of theserver. These are defined in [RFC2252]. Other attributes MAY be present in subschema entries, to reflect additional supported capabilities. These include matchingRules, matchingRuleUse, dITStructureRules, dITContentRules, nameForms and ldapSyntaxes. Servers SHOULD provideabandoned operation until it has received a response from theattributes createTimestamp and modifyTimestamp in subschema entries, in order to allow clientsserver for another request invoked subsequent tomaintain their caches of schema information.the abandonRequest, as the abandonRequest itself does not have a response. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page65 Lightweight Directory Access Protocol Version 3Clients MUST only retrieve attributes from a subschema entry by requesting a base object search of the entry, where the search filter is "(objectClass=subschema)". This will allow LDAPv3 servers which gateway to X.500(93) to detect that subentry information4.1.2. String Types The LDAPString isbeing requested. 3.3. Relationshipa notational convenience toX.500 This document defines LDAP in termsindicate that, although strings ofX.500LDAPString type encode asan X.500 access mechanism. An LDAP server MUST act in accordance withOCTET STRING types, theX.500(1993) series[ISO10646] character set (a superset ofITU recommendations when providing the service. However, itUnicode) isnot requiredused, encoded following the UTF-8 algorithm [RFC2044]. Note thatan LDAP server make use of any X.500 protocolsinproviding this service, e.g. LDAP can be mapped onto any other directory system so long astheX.500 data and service model as used in LDAP is not violated inUTF-8 algorithm characters which are theLDAP interface. 3.4. Server-specific Data Requirements An LDAP server MUST provide information about itself and other information that is specific to each server. This issame as ASCII (0x0000 through 0x007F) are represented as that same ASCII character in agroupsingle byte. The other byte values are used to form a variable-length encoding ofattributes located in the root DSE (DSA-Specific Entry), whichan arbitrary character. LDAPString ::= OCTET STRING -- UTF-8 encoded, -- ISO 10646 characters The LDAPOID isnamed with the zero-length LDAPDN. These attributes are retrievable ifaclient performsnotational convenience to indicate that the permitted value of this string is abase object search(UTF-8 encoded) dotted-decimal representation of an OBJECT IDENTIFIER. Although an LDAPOID is encoded as an OCTET STRING, values are limited to theroot with filter "(objectClass=*)", however theydefinition of numericoid given in Section 1.3 of [Models]. LDAPOID ::= OCTET STRING -- Constrained to numericoid [Models] For example, 1.3.6.1.4.1.1466.1.2.3 4.1.3. Distinguished Name and Relative Distinguished Name An LDAPDN and a RelativeLDAPDN aresubjectrespectively defined toaccess control restrictions. The root DSE MUST NOTbeincluded iftheclient performsrepresentation of asubtree search starting fromdistinguished-name and a relative-distinguished- name after encoding according to theroot. Servers may allow clientsspecification in [LDAPDN]. LDAPDN ::= LDAPString -- Constrained tomodify these attributes.distinguishedName [LDAPDN] RelativeLDAPDN ::= LDAPString -- Constrained to name-component [LDAPDN] 4.1.5. Attribute Descriptions Thefollowing attributes of the root DSEdefinition and encoding rules for attribute descriptions are defined insection 5Section 2.5 of[RFC2252]. Additional attributes may be defined in other documents.[Models]. Briefly, an attribute description is an attribute type and zero or more options. AttributeDescription ::= LDAPString -- Constrained to attributedescription -- [Models] Examples of valid AttributeDescription: Sermersheim Internet-Draft -namingContexts: naming contextsExpires Sep 2002 Page 6 Lightweight Directory Access Protocol Version 3 cn userCertificate;binary Not all options can be associated with attributes held in theserver. Naming contexts are defineddirectory. A server will treat an AttributeDescription with any options it does not implement or support as unrecognized. The order insection 17 of [X.501]. - subschemaSubentry: subschema entry (or subentry) holding the schema for the root DSE. - altServer: alternative serverswhich options appear incase this one is later unavailable. - supportedExtension:the listof supported extended operations. - supportedControl:MUST NOT be used to impart any semantic meaning. Servers MUST treat any two AttributeDescription with the same AttributeType and options as equivalent. AttributeDescriptionList describes a list ofsupported controls. - supportedSASLMechanisms:0 or more attribute descriptions. (A list ofsupported SASL security features. - supportedLDAPVersion: LDAP versions implemented by the server. If the server does not master entries and does not know the locations of schema information,zero elements has special significance in thesubschemaSubentry attribute isSearch request.) AttributeDescriptionList ::= SEQUENCE OF AttributeDescription 4.1.5.1 Transfer Options Transfer options are notpresentheld in theroot DSE. Ifdirectory, they only affect theserver masters directory entries under one or more schema rules,encoding used to transfer values. The absence of a transfer option implies theschemanative encoding. Transfer options are mutually exclusive. Specifying a transfer option when requesting attributes to be returned in a SearchRequest causes that encoding to be used foreach entry is found by readingthat attribute and its subtypes. That is, requesting name;binary requests thesubschemaSubentryattributefor that entry. Sermersheim Internet-Draft - Expires July 2002 Page 7 Lightweight Directory Access Protocol Version 3 4. Elements of Protocol The LDAP protocol is described using Abstract Syntax Notation 1 (ASN.1) [X.680],name andis transferredits subtypes (e.g., cn, sn, cn;lang_en, etc.) be returned using binary transfer. When specifying return attributes for asubsetSearchRequest, clients SHOULD avoid requesting the return ofASN.1 Basic Encoding Rules [X.690]. In order to support future extensionsattributes related tothis protocol, clientseach other in the attribute subtyping hierarchy with different transfer encodings. For example, requesting name;lang_en;binary andservers MUST ignore elements of SEQUENCE encodings whose tags they do not recognize. Section 5.1 specifiescn should be avoided as it ambiguous as to how cn;lang_en is to be transferred. In such cases, theprotocolserver's behavior isencodedundefined (the server can return the values in either, neither, or both encodings). One transfer option, "binary", is defined in this document. Additional options may be defined in IETF standards-track andtransferred. Noteexperimental RFCs. Options beginning with "x-" are reserved for private experiments. 4.1.5.2. Binary Transfer Option If the "binary" option is present in an AttributeDescription, it specifies thatunlike X.500, each change todata within theLDAPAttributeValue(s) of the attribute be transferred in protocolother than throughas BER encoded data according to theextension mechanisms will have a different version number. A client will indicateASN.1 data type corresponding to theversion it supports asattribute's LDAP syntax. The LDAP syntax is indicated by the "SYNTAX" part of thebind request, describedAttributeTypeDescription. Sermersheim Internet-Draft - Expires Sep 2002 Page 7 Lightweight Directory Access Protocol Version 3 The presence or absence of the "binary" option only affects the transfer of attribute values insection 4.2.protocol; servers store any particular attribute in a server-defined format. If a clienthas not sentrequests that abind, theserverMUST assume that version 3 or later is supportedreturn an attribute in theclient (since version 2 required that"binary" format, but theclient bind first). Clients may determineserver cannot generate that format, theprotocol versions aserversupports by readingMUST treat thesupportedLDAPVersionattributefrom the root DSE. Servers which implement version 3 or later versions MUST provide this attribute. Servers which only implement version 2 may not provide this attribute. 4.1. Common Elements This section describes the LDAPMessage envelope PDU (Protocol Data Unit) format, as well as datatypedefinitions, which are used in the protocol operations. 4.1.1. Message Envelope For the purposes of protocol exchanges, all protocol operations are encapsulated in a common envelope, the LDAPMessage, which is definedasfollows: LDAPMessage ::= SEQUENCE { messageID MessageID, protocolOp CHOICE { bindRequest BindRequest, bindResponse BindResponse, unbindRequest UnbindRequest, searchRequest SearchRequest, searchResEntry SearchResultEntry, searchResDone SearchResultDone, searchResRef SearchResultReference, modifyRequest ModifyRequest, modifyResponse ModifyResponse, addRequest AddRequest, addResponse AddResponse, delRequest DelRequest, delResponse DelResponse, modDNRequest ModifyDNRequest, modDNResponse ModifyDNResponse, compareRequest CompareRequest, Sermersheim Internet-Draft - Expires July 2002 Page 8 Lightweight Directory Access Protocol Version 3 compareResponse CompareResponse, abandonRequest AbandonRequest, extendedReq ExtendedRequest, extendedResp ExtendedResponse }, controls [0] Controls OPTIONAL } MessageID ::= INTEGER (0 .. maxInt) maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- The function of the LDAPMessage isunrecognized. Similarly, clients MUST NOT expect servers toprovidereturn anenvelope containing common fields required in all protocol exchanges. At this time the only common fields are the message ID and the controls. Ifattribute with theserver receives a PDU from"binary" option if the clientin which the LDAPMessage SEQUENCE tag cannot be recognized,requested that attribute by name without themessageID cannot"binary" option. This option is intended to beparsed, the tag of the protocolOpused with attributes whose syntax isnot recognized asarequest, or the encoding structures or lengths ofcomplex ASN.1 datafields are found totype, but may beincorrect, then the server MUST return the notice of disconnection described in section 4.4.1,associated withresultCode protocolError, and immediately close the connection. In other cases that the server cannot parse the request received by the client, the server MUST returnany attribute whose ASN.1 type is known. 4.1.6. Attribute Value A field of type AttributeValue is anappropriate responseOCTET STRING containing an encoded value of an AttributeValue data type. The value is encoded according to its native encoding definition, unless an option specifying therequest, withtransfer encoding is present in theresultCode setcompanion AttributeDescription toprotocolError. If the client receives a PDU from the server, which cannot be parsed, the client may discardthePDU, orAttributeValue (e.g. "binary"). The native encoding definitions for different syntaxes and attribute types mayabruptly closebe found in other documents, and in particular [Syntaxes]. At theconnection. The ASN.1 type Controlstime of this writing, there isdefinedonly one AttributeDescription option used to specify transfer encoding--"binary", described in section4.1.12. 4.1.1.1. Message ID All LDAPMessage envelopes encapsulating responses contain the messageID value of4.1.5.2. AttributeValue ::= OCTET STRING Note that there is no defined limit on thecorresponding request LDAPMessage. The message IDsize ofa request MUSTthis encoding; thus protocol values may include multi-megabyte attributes (e.g. photographs). Attributes may be defined which have arbitrary and non-printable syntax. Implementations MUST NOT display nor attempt to decode as ASN.1, a valuedifferent fromif its syntax is not known. The implementation may attempt to discover thevaluessubschema ofany other requests outstanding intheLDAP sessionsource entry, and retrieve the values ofwhich this message is a part. A clientattributeTypes from it. Clients MUST NOT send attribute values in asecondrequestwith the same message ID as an earlier request on the same connection if the client hasthat are notreceived the final response from the earlier request. Otherwise the behavior is undefined. Typical clients increment a counter for each request. A client MUST NOT reuse the message id of an abandonRequest or of the abandoned operation until it has received a response from the server for another request invoked subsequentvalid according to theabandonRequest, assyntax defined for theabandonRequest itself does not have a response. 4.1.2. String Typesattributes. 4.1.7. Attribute Value Assertion TheLDAPStringAttributeValueAssertion type definition isa notational conveniencesimilar toindicate that, although strings of LDAPString type encode as OCTET STRING types,the one in the X.500 directory standards. It contains an attribute description and a matching rule assertion value suitable for that type. AttributeValueAssertion ::= SEQUENCE { Sermersheim Internet-Draft - ExpiresJulySep 2002 Page98 Lightweight Directory Access Protocol Version 3[ISO10646] character set (a superset of Unicode)attributeDesc AttributeDescription, assertionValue AssertionValue } AssertionValue ::= OCTET STRING If a transfer option is present in attributeDesc, the assertionValue isused,encodedfollowingas specified by theUTF-8 algorithm [RFC2044]. Note thatoption. For example, if the "binary" option is present in theUTF-8 algorithm characters which areattributeDesc, the AssertionValue is BER encoded. For all the string-valued user attributes described in [Syntaxes], the assertion value syntax is the same asASCII (0x0000 through 0x007F) are representedthe value syntax. Clients may use attribute values asthat same ASCII character in a single byte. The other byteassertion valuesare used to form a variable-length encoding of an arbitrary character. LDAPString ::= OCTET STRING The LDAPOID is a notational convenience to indicatein compare requests and search filters. Note however that thepermittedassertion syntax may be different from the valueof this string is a (UTF-8 encoded) dotted-decimal representation ofsyntax for other attributes or for non-equality matching rules. These may have anOBJECT IDENTIFIER. LDAPOID ::= OCTET STRING A valueassertion syntax which contains only part ofLDAPOID is defined bythefollowing ABNF [RFC2234]: ldapOID = number *( DOT number ) number = ( LDIGIT *DIGIT ) / DIGIT DOT = %x2E ; "." LDIGIT = %x31-39 ; 1-9 DIGIT = %x30 / LDIGIT ; 0-9 For example, 1.3.6.1.4.1.1466.1.2.3 4.1.3. Distinguished Name and Relative Distinguished Namevalue. See section 20.2.1.8 of [X.501] for examples. 4.1.8. Attribute AnLDAPDNattribute consists of an attribute description anda RelativeLDAPDN are respectively definedone or more values of that attribute description. (Though attributes MUST have at least one value when stored, due to access control restrictions the set may be empty when transferred from therepresentation of a Distinguished Name and a Relative Distinguished Name after encoding accordingserver to thespecification in [RFC2253], such that: distinguished-name = name relative-distinguished-name = name-component where name and name-component are as definedclient. This is described in[RFC2253]. LDAPDN ::= LDAPString RelativeLDAPDN ::= LDAPString Onlysection 4.5.2, concerning the PartialAttributeList type.) AttributeTypes can be present::= SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } Each attribute value is distinct ina relative distinguished name component--the optionsthe set (no duplicates). The set ofAttribute Descriptions (next section)attribute values is unordered. Implementations MUST NOTbe usedreply upon any apparent ordering being repeatable. 4.1.9. Matching Rule Identifier A matching rule is a means of expressing how a server should compare an AssertionValue received inspecifying distinguished names. 4.1.4. Attribute Type Sermersheim Internet-Draft - Expires July 2002 Page 10 Lightweight Directory Access Protocol Version 3 An AttributeType takes on as itsa search filter with an abstract data value. The matching rule defines the syntax of the assertion value and thetextual string associated with that AttributeTypeprocess to be performed in the server. An X.501 (1993) Matching Rule is identified in the LDAP protocol by the printable representation of itsspecification. AttributeType ::= LDAPString Each attribute type has a uniqueOBJECTIDENTIFIER which has been assigned to it. This identifier may be writtenIDENTIFIER, either asdefined by ldapOID in section 4.1.2. A specification may also assignoneor more textual names for an attribute type. These names MUST begin with a letter, and only contain ASCII letters, digit characters and hyphens. They are case insensitive. These ASCII characters are identical to ISO 10646 characters whose UTF-8 encoding is a single byte between 0x00 and 0x7F. Ifof theserver has a textual name for an attribute type, it MUST use a textual name for attributes returnedstrings given insearch results. The dotted-[Syntaxes], or as decimalOBJECT IDENTIFIER is only used if there is no textual namedigits with components separated by periods, e.g. "caseIgnoreIA5Match" or "1.3.6.1.4.1.453.33.33". MatchingRuleId ::= LDAPString Sermersheim Internet-Draft - Expires Sep 2002 Page 9 Lightweight Directory Access Protocol Version 3 Servers which support matching rules foran attribute type. Attribute type textual names are non-unique, as two different specifications (neitheruse instandards track RFCs) may choosethesame name. A server which masters or shadows entries SHOULDextensibleMatch search filter MUST listalltheattribute types it supportsmatching rules they implement inthesubschema entries, using theattributeTypes attribute. Servers which support an open-ended set of attributesmatchingRules attributes. The server SHOULDinclude at least the attributeTypes value for the 'objectClass' attribute. Clients MAY retrievealso list there, using theattributeTypes value from subschema entries in order to obtainmatchingRuleUse attribute, theOBJECT IDENTIFIER and other information associated with attribute types. Someattributetype namestypes with whichare usedeach matching rule can be used. More information is given inthis versionsection 4.5 ofLDAP are described in [RFC2252]. Servers may implement additional attribute types. 4.1.5. Attribute Description An AttributeDescription[Syntaxes]. 4.1.10. Result Message The LDAPResult isa superset ofthedefinitionconstruct used in this protocol to return success or failure indications from servers to clients. To various requests, servers will return responses of LDAPResult or responses containing theAttributeType. It has the same ASN.1 definition, but allows additional options to be specified. The entire AttributeDescription is case insensitive. AttributeDescription ::= LDAPString A valuecomponents ofAttributeDescription is based onLDAPResponse to indicate thefollowing ABNF: attributeDescription = attributeType options attributeType = AttributeType ; as described in Section 4.1.4 options = *( SEMICOLON options )final status of a protocol operation request. LDAPResult ::= SEQUENCE { resultCode ENUMERATED { success (0), operationsError (1), protocolError (2), timeLimitExceeded (3), sizeLimitExceeded (4), compareFalse (5), compareTrue (6), authMethodNotSupported (7), strongAuthRequired (8), -- 9 reserved -- referral (10), adminLimitExceeded (11), unavailableCriticalExtension (12), confidentialityRequired (13), saslBindInProgress (14), noSuchAttribute (16), undefinedAttributeType (17), inappropriateMatching (18), constraintViolation (19), attributeOrValueExists (20), invalidAttributeSyntax (21), -- 22-31 unused -- noSuchObject (32), aliasProblem (33), invalidDNSyntax (34), -- 35 reserved for undefined isLeaf -- aliasDereferencingProblem (36), -- 37-47 unused -- inappropriateAuthentication (48), invalidCredentials (49), insufficientAccessRights (50), busy (51), unavailable (52), unwillingToPerform (53), loopDetect (54), -- 55-63 unused -- Sermersheim Internet-Draft - ExpiresJulySep 2002 Page1110 Lightweight Directory Access Protocol Version 3option = 1*opt-char opt-char = ALPHA / DIGIT / HYPHEN SEMICOLON = %x3B ; ";" ALPHA = %x41-5A / %x61-7A ; A-Z / a-z HYPHEN = %x2D ; "-" Examples of valid AttributeDescription: cn userCertificate;binary Not all options can be associated with attributes held in the directory. A server will treat an AttributeDescription with any options it does not implement as unrecognized.namingViolation (64), objectClassViolation (65), notAllowedOnNonLeaf (66), notAllowedOnRDN (67), entryAlreadyExists (68), objectClassModsProhibited (69), -- 70 reserved for CLDAP -- affectsMultipleDSAs (71), -- 72-79 unused -- other (80), ... }, -- 81-90 reserved for APIs -- matchedDN LDAPDN, errorMessage LDAPString, referral [3] Referral OPTIONAL } Theorder in which options appear in the list MUST NOT be used to impart any semantic meaning. Servers MUST treat any two AttributeDescription with the same AttributeType and options as equivalent. An attribute description that contains mutually exclusive options shall be treated as unrecognized. That is, "cn;binary;gser" (where "binary" and "gser" are mutually exclusive)result codes enumeration isto be treatedextensible asan unrecognized attribute. There are multiple kindsdefined in Section 3.5 ofattribute description options.[LDAPIANA]. TheLDAP technical specification details two kinds: tagging options (such as language tag options) and transfer options (such as ;binary). Other documents may detail other kinds. Tagging options can be held inmeanings of thedirectory andresult codes arenever mutually exclusive. An attribute with N tagging options is considered a direct subtype of all attributesgiven in Appendix A. The errorMessage field of this construct may, at thesame typeserver's option, be used to return a string containing a textual, human-readable (terminal control andall but one ofpage formatting characters should be avoided) error diagnostic. As this error diagnostic is not standardized, implementations MUST NOT rely on theN options.values returned. If thetype has a supertype, then the attribute is also consideredserver chooses not to return adirect subtype oftextual diagnostic, theattributeerrorMessage field of thesupertype and the N tagging options. That is, cn;lang_de;lang_en is consideredLDAPResult type MUST contain adirect subtypezero length string. For result codes ofcn;lang_de, cn;lang_en,noSuchObject, aliasProblem, invalidDNSyntax andname;lang_de;lang_en (cnaliasDereferencingProblem, the matchedDN field isa subtypeset to the name ofname). Transfer options are not held inthedirectory, they only affectlowest entry (object or alias) in theencoding useddirectory that was matched. If no aliases were dereferenced while attempting totransfer values. The absence oflocate the entry, this will be atransfer option impliestruncated form of thenative encoding. Transfer options are mutually exclusive. Specifyingname provided, or if aliases were dereferenced, of the resulting name, as defined in section 12.5 of [X.511]. The matchedDN field contains atransfer option when requesting attributeszero length string with all other result codes. 4.1.11. Referral The referral result code indicates that the contacted server does not hold the target entry of the request. The referral field is present in an LDAPResult if the LDAPResult.resultCode field value is referral, and absent with all other result codes. It contains one or more references to one or more servers or services that may be accessed via LDAP or other protocols. Referrals can be returned ina SearchRequest causes that encodingresponse tobe used for that attribute and its subtypes. That is, requesting name;binary requests the attribute nameany operation request (except unbind andits subtypes (e.g., cn, sn, cn;lang_en, etc.)abandon which do not have responses). At least one URL MUST be present in the Referral. The referral is not returnedusing binary transfer. When specifying return attributesfor aSearchRequest, clients SHOULD avoid requestingsingleLevel or wholeSubtree search in which thereturn of attributes relatedsearch scope spans multiple naming contexts, and several different servers would need toeach other inbe contacted to complete theattribute subtyping hierarchy with different transfer encodings.Sermersheim Internet-Draft - ExpiresJulySep 2002 Page1211 Lightweight Directory Access Protocol Version 3For example, requesting name;lang_en;binary and cn should be avoided asoperation. Instead, continuation references, described in section 4.5.3, are returned. Referral ::= SEQUENCE OF LDAPURL -- one or more LDAPURL ::= LDAPString -- limited to characters permitted in -- URLs If the client wishes to progress the operation, itambiguous asMUST follow the referral by contacting one of the servers. If multiple URLs are present, the client assumes that any URL may be used tohow cn;lang_en isprogress the operation. URLs for servers implementing the LDAP protocol are written according to [LDAPDN]. If an alias was dereferenced, the <dn> part of the URL MUST betransferred. In such cases,present, with theserver's behaviornew target object name. If the <dn> part isundefined (the server can returnpresent, thevaluesclient MUST use this name ineither, neither, or both encodings). Other documents may specify other kinds of options. These documents must detail how new kinds of options relateits next request totaggingprogress the operation, andtransfer options. In particular,if it is not present thedocument must describe howclient will use theoptions relation tosame name as in theattribute subtyping hierarchy. One transfer option, "binary", is definedoriginal request. Some servers (e.g. participating inthis document. Additional optionsdistributed indexing) maybe definedprovide a different filter inIETF standards-track and experimental RFCs. Options beginning with "x-" are reserveda referral forprivate experiments. The data type "AttributeDescriptionList" describesalist of 0 or more attribute types. (A list of zero elements has special significance in the Search request.) AttributeDescriptionList ::= SEQUENCE OF AttributeDescription 4.1.5.1. Binary Optionsearch operation. If the"binary" optionfilter part of the URL is present in anAttributeDescription,LDAPURL, the client MUST use this filter in its next request to progress this search, and if itoverridesis not present thenative encoding representation definedclient MUST use the same filter as it used for thatattribute in [RFC2252]. Insteadsearch. Other aspects of theattribute is tonew request may betransferredthe same or different as the request which generated the referral. Note that UTF-8 characters appearing in abinary value encodedDN or search filter may not be legal for URLs (e.g. spaces) and MUST be escaped using theBasic Encoding Rules [X.690]. The syntax% method in [RFC2396]. Other kinds of URLs may be returned, so long as thebinary valueoperation could be performed using that protocol. 4.1.12. Controls A control isan ASN.1 data type definition,a way to specify extension information. Controls whichis referenced by the "SYNTAX"are sent as part ofthe attribute type definition. The presence or absence of the "binary" option only affects the transfer of attribute values in protocol; servers store any particular attribute in a single format. Ifaclient requestsrequest apply only to that request and are not saved. Controls ::= SEQUENCE OF Control Control ::= SEQUENCE { controlType LDAPOID, criticality BOOLEAN DEFAULT FALSE, controlValue OCTET STRING OPTIONAL } The controlType field MUST be aserver returnUTF-8 encoded dotted-decimal representation of anattribute in the binary format, butOBJECT IDENTIFIER which uniquely identifies theserver cannot generate that format, the server MUST treat this attribute type as an unrecognized attribute type. Similarly, clients MUST NOT expect servers to return an attribute in binary format if the client requested that attribute by name without the "binary" option.control. Thisoption is intended to be used with attributes whose syntax is a complex ASN.1 data type, and the structure of values of that typeprevents conflicts between control names. The criticality field isneeded by clients. Examples of this kind of syntax are "Certificate"either TRUE or FALSE and"CertificateList". 4.1.6. Attribute Value A field of type AttributeValueisan OCTET STRING containing an encoded valueonly used when a control accompanies one ofan AttributeValue data type. The value is encoded according to its native encoding definition, unless an option specifying the transfer encoding is present in the companion AttributeDescription totheAttributeValue (e.g. "binary").following requests: bindRequest, Sermersheim Internet-Draft - ExpiresJulySep 2002 Page1312 Lightweight Directory Access Protocol Version 3 searchRequest, modifyRequest, addRequest, delRequest, modDNRequest, compareRequest, or extendedReq. Thenative encoding definitionsuse of the criticality field fordifferent syntaxes and attribute types may be found ina control that is part of any otherdocuments,operation is ignored andin particular [RFC2252]. Attreated as FALSE. If thetime of this writing, there is only one AttributeDescription option used to specify transfer encoding--"binary", described in section 4.1.5.1. AttributeValue ::= OCTET STRING Note that thereserver recognizes the control type and it isno defined limit onappropriate for thesizeoperation, the server will make use ofthis encoding; thus protocol values may include multi-megabyte attributes (e.g. photographs). Attributes may be defined which have arbitrary and non-printable syntax. Implementations MUST NOT display nor attempt to decode as ASN.1, a value if its syntax is not known. The implementation may attempt to discoverthesubschema ofcontrol when performing thesource entry, and retrieveoperation. If thevalues of attributeTypes from it. Clients MUST NOT send attribute values in a request that areserver does notvalid according to the syntax defined forrecognize theattributes. 4.1.7. Attribute Value Assertion The AttributeValueAssertioncontrol typedefinitionor it issimilar to the one in the X.500 directory standards. It contains an attribute description and a matching rule assertion value suitablenot appropriate forthat type. AttributeValueAssertion ::= SEQUENCE { attributeDesc AttributeDescription, assertionValue AssertionValue } AssertionValue ::= OCTET STRING If an option specifyingthetransfer encoding is present in attributeDesc,operation, and theassertionValuecriticality field isencoded as specified byTRUE, theoption. For example, ifserver MUST NOT perform the"binary" option is present inoperation, and MUST instead return theattributeDesc,resultCode unavailableCriticalExtension. If theAssertionValuecontrol isBER encoded. For all the string-valued user attributes described in [RFC2252],unrecognized or inappropriate but theassertion value syntaxcriticality field is FALSE, thesame asserver MUST ignore thevalue syntax. Clients may use attribute values as assertion values in compare requestscontrol. The controlValue contains any information associated with the control, andsearch filters. Note however thatits format is defined for theassertion syntax maycontrol. Implementations MUST bedifferent fromprepared to handle arbitrary contents of the controlValue octet string, including zero bytes. It is absent only if there is no valuesyntax for other attributes or for non-equality matching rules. These may have an assertion syntaxinformation whichcontains only part of the value. See section 20.2.1.8 of [X.501] for examples. 4.1.8. Attribute An attribute consists ofis associated with atype and one or more valuescontrol ofthatits type.(Though attributes MUST have at least one value when stored, due to access control restrictions the setThis document does not define any controls. Controls may beempty when transferred Sermersheim Internet-Draftdefined in other documents. The definition of a control consists of: -Expires July 2002 Page 14 Lightweight Directory Access Protocol Version 3 fromtheserverOBJECT IDENTIFIER assigned to theclient. Thiscontrol, - whether the control isdescribedalways noncritical, always critical, or critical at the client's option, - the format of the controlValue contents of the control. Servers list the controlType of all recognized controls insection 4.5.2, concerningthePartialAttributeList type.) Attribute ::= SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } EachsupportedControl attributevalue is distinctin theset (no duplicates).root DSE. 4.2. Bind Operation Theorderfunction ofattribute values withinthevals setBind Operation isundefined and implementation-dependent, and MUST NOTto allow authentication information to berelied upon. 4.1.9. Matching Rule Identifier A matching rule is a means of expressing how a server should compare an AssertionValue received in a search filter with an abstract data value. The matching rule defines the syntax ofexchanged between theassertion valueclient andthe processserver. Prior tobe performed intheserver. An X.501 (1993) Matching Rule is identified inBindRequest, theLDAP protocol byimplied identity is anonymous. Refer to [AuthMeth] for theprintable representationauthentication-related semantics ofits OBJECT IDENTIFIER, eitherthis operation. The Bind Request is defined asone of the strings given in [RFC2252], or as decimal digits with components separated by periods, e.g. "caseIgnoreIA5Match" or "1.3.6.1.4.1.453.33.33". MatchingRuleId ::= LDAPString Servers which support matching rules for use in the extensibleMatch search filter MUST list the matching rules they implement in subschema entries, using the matchingRules attributes. The server SHOULD also list there, using the matchingRuleUse attribute, the attribute types with which each matching rule can be used. More information is given in section 4.5 of [RFC2252]. 4.1.10. Result Message The LDAPResult is the construct used in this protocol to return success or failure indications from servers to clients. To various requests, servers will return responses of LDAPResult or responses containing the components of LDAPResponse to indicate the final status of a protocol operation request. LDAPResultfollows: BindRequest ::= [APPLICATION 0] SEQUENCE {resultCode ENUMERATEDversion INTEGER (1 .. 127), name LDAPDN, authentication AuthenticationChoice } AuthenticationChoice ::= CHOICE {success (0), operationsError (1), protocolError (2), timeLimitExceeded (3), sizeLimitExceeded (4), compareFalse (5), compareTrue (6), authMethodNotSupported (7), strongAuthRequired (8), -- 9 reserved -- referral (10),simple [0] OCTET STRING, Sermersheim Internet-Draft - ExpiresJulySep 2002 Page1513 Lightweight Directory Access Protocol Version 3adminLimitExceeded (11), unavailableCriticalExtension (12), confidentialityRequired (13), saslBindInProgress (14), noSuchAttribute (16), undefinedAttributeType (17), inappropriateMatching (18), constraintViolation (19), attributeOrValueExists (20), invalidAttributeSyntax (21), -- 22-31 unused -- noSuchObject (32), aliasProblem (33), invalidDNSyntax (34), -- 35 reserved for undefined isLeaf -- aliasDereferencingProblem (36), -- 37-47 unused -- inappropriateAuthentication (48), invalidCredentials (49), insufficientAccessRights (50), busy (51), unavailable (52), unwillingToPerform (53), loopDetect (54), -- 55-63 unused -- namingViolation (64), objectClassViolation (65), notAllowedOnNonLeaf (66), notAllowedOnRDN (67), entryAlreadyExists (68), objectClassModsProhibited (69),--701 and 2 reservedfor CLDAP -- affectsMultipleDSAs (71), -- 72-79 unused -- other (80) }, -- 81-90 reserved for APIs -- matchedDN LDAPDN, errorMessage LDAPString, referralsasl [3]ReferralSaslCredentials, ... } SaslCredentials ::= SEQUENCE { mechanism LDAPString, credentials OCTET STRING OPTIONAL }AllParameters of theresult codes withBind Request are: - version: A version number indicating theexceptionversion ofsuccess, compareFalse and compareTrue are to be treated as meaningtheoperation could notprotocol to becompletedused inits entirety. Mostthis protocol session. This document describes version 3 of theresult codes are based on problem indications from X.511 error data types. Result codes from 16 to 21 indicate an AttributeProblem, codes 32, 33, 34 and 36 indicate a NameProblem, codes 48, 49 and 50 indicate a SecurityProblem, codes 51 to 54 indicate a ServiceProblem, and codes 64 to 69LDAP protocol. Note that there is no version negotiation, and71 indicates an UpdateProblem. If athe clientreceives a result code which is not listed above, it is to be treated as an unknown error condition. Sermersheim Internet-Draft - Expires July 2002 Page 16 Lightweight Directory Access Protocol Version 3 The errorMessage field ofjust sets thisconstruct may, at the server's option, be usedparameter toreturn a string containing a textual, human-readable (terminal control and page formatting characters should be avoided) error diagnostic. As this error diagnostic is not standardized, implementations MUST NOT rely onthevalues returned.version it desires. If the serverchoosesdoes notto return a textual diagnostic, the errorMessage field ofsupport theLDAPResult type MUST contain a zero length string. For result codes of noSuchObject, aliasProblem, invalidDNSyntax and aliasDereferencingProblem,specified version, it responds with protocolError in thematchedDNresultCode fieldis set toof the BindResponse. - name: The name of thelowest entry (object or alias) in thedirectory object thatwas matched. If no aliases were dereferenced while attempting to locate the entry, this will be a truncated form of the name provided, or if aliases were dereferenced, oftheresulting name, as defined in section 12.5 of [X.511]. The matchedDN field is to be setclient wishes to bind as. This field may take on a null value (a zero lengthstringstring) for the purposes of anonymous binds, when authentication has been performed at a lower layer, or when using SASL credentials withall other result codes. 4.1.11. Referral The referral result code indicatesa mechanism that includes thecontacted server does not hold the target entry ofname in therequest. The referral fieldcredentials. Server behavior ispresent in an LDAPResult ifundefined when theLDAPResult.resultCode field valuename isreferral,a null value, simple authentication is used, andabsent with all other result codes. It contains one or more references to one or more servers or servicesa password is specified. Note thatmay be accessed via LDAP or other protocols. Referrals can be returnedthe server SHOULD NOT perform any alias dereferencing inresponsedetermining the object toany operation request (except unbind and abandon which do not have responses). At least one URL MUST be presentbind as. - authentication: information used to authenticate the name, if any, provided in theReferral. The referralBind Request. This type is extensible as defined in Section 3.6 of [LDAPIANA]. Servers that do notreturned forsupport asingleLevel or wholeSubtree searchchoice supplied by a client will return authMethodNotSupported inwhichthesearch scope spans multiple naming contexts, and several different servers would need to be contacted to completeresult code of theoperation. Instead, continuation references, described in section 4.5.3, are returned. Referral ::= SEQUENCE OF LDAPURL -- one or more LDAPURL ::= LDAPString -- limitedBindResponse. Upon receipt of a Bind Request, a protocol server will authenticate the requesting client, if necessary. The server will then return a Bind Response tocharacters permitted in -- URLs Ifthe clientwishes to progressindicating theoperation, it MUST followstatus of thereferralauthentication. Authorization is the use of this authentication information when performing operations. Authorization MAY be affected bycontacting onefactors outside of theservers. If multiple URLs are present,LDAP Bind request, such as lower layer security services. 4.2.1. Sequencing of theclient assumes that any URLBind Request For some SASL authentication mechanisms, it may beused to progress the operation. URLsnecessary forservers implementingtheLDAP protocol are written accordingclient to[RFC2255]. If an alias was dereferenced, the <dn> part of the URL MUST be present, withinvoke thenew target object name.BindRequest multiple times. Ifthe <dn> part is present,at any stage the clientMUST use this name in its next requestwishes toprogressabort theoperation, and ifbind process itis not present the client will useMAY unbind and then drop thesame nameunderlying connection. Clients MUST NOT invoke operations between two Bind requests made asin the original request. Some servers (e.g. participating in distributed indexing) may provide a different filter in a referral for a search operation. If the filterpart ofthe URL is present in an LDAPURL, the client MUST use this filter in its nexta multi-stage bind. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page1714 Lightweight Directory Access Protocol Version 3request to progress this search, and if it is not presentA client may abort a SASL bind negotiation by sending a BindRequest with a different value in the mechanism field of SaslCredentials, or an AuthenticationChoice other than sasl. If the clientMUST usesends a BindRequest with thesame filtersasl mechanism field asit used for that search. Other aspects ofan empty string, thenew request may beserver MUST return a BindResponse with authMethodNotSupported as the resultCode. This will allow clients to abort a negotiation if it wishes to try again with the sameor different asSASL mechanism. If the client did not bind before sending a requestwhich generated the referral. Note that UTF-8 characters appearing inand receives an operationsError, it may then send aDNBind Request. If this also fails orsearch filter maythe client chooses notbe legal for URLs (e.g. spaces) and MUST be escaped usingto bind on the% methodexisting connection, it will close the connection, reopen it and begin again by first sending a PDU with a Bind Request. This will aid in[RFC2396]. Other kindsinteroperating with servers implementing other versions ofURLs may be returned, so long as the operation could be performed using that protocol. 4.1.12. Controls A controlLDAP. 4.2.3. Bind Response The Bind Response isa way to specify extension information. Controls which are sentdefined aspart of a request apply only to that request and are not saved. Controls ::= SEQUENCE OF Control Controlfollows. BindResponse ::= [APPLICATION 1] SEQUENCE {controlType LDAPOID, criticality BOOLEAN DEFAULT FALSE, controlValue OCTET STRING OPTIONALCOMPONENTS OF LDAPResult, serverSaslCreds [7] OCTET STRING OPTIONAL }The controlType field MUST be a UTF-8 encoded dotted-decimal representationBindResponse consists simply of anOBJECT IDENTIFIER which uniquely identifiesindication from thecontrol. This prevents conflicts between control names. The criticality field is either TRUE or FALSE and is only used when a control accompanies oneserver of thefollowing requests: bindRequest, searchRequest, modifyRequest, addRequest, delRequest, modDNRequest, compareRequest, or extendedReq. The usestatus of thecriticality fieldclient's request fora control that is part of any other operation is ignored and treated as FALSE.authentication. If the bind was successful, the resultCode will be success, otherwise it will be one of: - operationsError: serverrecognizesencountered an internal error. - protocolError: unrecognized version number or incorrect PDU structure. - authMethodNotSupported: unrecognized SASL mechanism name. - strongAuthRequired: thecontrol typeserver requires authentication be performed with a SASL mechanism. - referral: this server cannot accept this bind andit is appropriate fortheoperation,client should try another. - saslBindInProgress: the serverwill make use ofrequires thecontrol when performingclient to send a new bind request, with theoperation. Ifsame sasl mechanism, to continue the authentication process. - inappropriateAuthentication: the serverdoes not recognizerequires thecontrol typeclient which had attempted to bind anonymously orit is not appropriate forwithout supplying credentials to provide some form of credentials. Sermersheim Internet-Draft - Expires Sep 2002 Page 15 Lightweight Directory Access Protocol Version 3 - invalidCredentials: theoperation, andwrong password was supplied or thecriticality fieldSASL credentials could not be processed. - unavailable: the server isTRUE,shutting down. If the serverMUST NOT performdoes not support theoperation, andclient's requested protocol version, it MUSTinstead returnset the resultCodeunavailableCriticalExtension.to protocolError. If thecontrol is unrecognized or inappropriate but the criticality field is FALSE,client receives a BindResponse response where theserverresultCode was protocolError, it MUSTignore the control. The controlValue contains any information associated withclose thecontrol, and its format is defined forconnection as thecontrol. Implementations MUSTserver will bepreparedunwilling tohandle arbitrary contents of the controlValue octet string, including zero bytes. It is absent only if there is no value information whichaccept further operations. (This isassociatedfor compatibility witha controlearlier versions ofits type. Sermersheim Internet-Draft - Expires July 2002 Page 18 Lightweight Directory Access Protocol Version 3 This document does not define any controls. Controls may be definedLDAP, inother documents.which the bind was always the first operation, and there was no negotiation.) ThedefinitionserverSaslCreds are used as part of acontrol consists of: - the OBJECT IDENTIFIER assignedSASL-defined bind mechanism to allow thecontrol, - whetherclient to authenticate thecontrolserver to which it isalways noncritical, always critical,communicating, orcritical at the client's option, -to perform "challenge-response" authentication. If theformat ofclient bound with thecontrolValue contents ofpassword choice, or thecontrol. Servers listSASL mechanism does not require thecontrols which they recognize inserver to return information to thesupportedControl attributeclient, then this field is not to be included in theroot DSE. 4.2. Bindresult. 4.3. Unbind Operation The function of theBindUnbind Operation is toallow authentication information to be exchanged between the client and server.terminate a protocol session. TheBind RequestUnbind Operation is defined as follows:BindRequestUnbindRequest ::= [APPLICATION0] SEQUENCE { version INTEGER (1 .. 127), name LDAPDN, authentication AuthenticationChoice } AuthenticationChoice ::= CHOICE { simple [0] OCTET STRING, -- 1 and 2 reserved sasl [3] SaslCredentials } SaslCredentials ::= SEQUENCE { mechanism LDAPString, credentials OCTET STRING OPTIONAL } Parameters of the Bind Request are: - version: A version number indicating the version2] NULL The Unbind Operation has no response defined. Upon transmission ofthe protocol to be used in thisan UnbindRequest, a protocolsession. This document describes version 3 of the LDAP protocol. Note that there is no version negotiation, and theclientjust sets this parameter to the version it desires. Ifmay assume that theclient requestsprotocolversion 2,session is terminated. Upon receipt of an UnbindRequest, a protocol server may assume thatsupportstheversion 2 protocol as described in [RFC1777] will not return any v3-specific protocol fields. (Noterequesting client has terminated the session and thatnotallLDAP servers will support protocol version 2, since theyoutstanding requests may beunable to generatediscarded, and may close theattribute syntaxes associated with version 2.) - name: The name ofconnection. 4.4. Unsolicited Notification An unsolicited notification is an LDAPMessage sent from thedirectory object thatserver to the clientwisheswhich is not in response tobind as. This field may take on a null value (a zero length string) forany LDAPMessage received by thepurposes of anonymous binds, when authentication has been performed at a lower layer, or when using SASL credentials with a mechanism that includesserver. It is used to signal an extraordinary condition in thenameserver or in thecredentials. Server behavior is undefined whenconnection between thenameclient and the server. The notification isa null value, simple authenticationof an advisory nature, and the server will not expect any response to be returned from the client. The unsolicited notification isused,structured as an LDAPMessage in which the messageID is 0 anda passwordprotocolOp isspecified.of the extendedResp form. The responseName field of the ExtendedResponse is present. The LDAPOID value MUST be unique for this notification, and not be used in any other situation. One unsolicited notification (Notice of Disconnection) is defined in this document. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page1916 Lightweight Directory Access Protocol Version 3Note4.4.1. Notice of Disconnection This notification may be used by the server to advise the client that the serverSHOULD NOT perform any alias dereferencing in determiningis about to close theobjectconnection due tobind as. - authentication: information usedan error condition. Note that this notification is NOT a response toauthenticatean unbind requested by thename, if any, provided inclient: theBind Request. Upon receipt of a Bind Request, a protocolserverwill authenticateMUST follow therequesting client, if necessary. The server will then returnprocedures of section 4.3. This notification is intended to assist clients in distinguishing between an error condition and aBind Responsetransient network failure. As with a connection close due to network failure, the clientindicatingMUST NOT assume that any outstanding requests which modified thestatus ofdirectory have succeeded or failed. The responseName is 1.3.6.1.4.1.1466.20036, theauthentication. Authorizationresponse field is absent, and theuse of this authentication information when performing operations. Authorization MAY be affected by factors outside ofresultCode is used to indicate theLDAP Bind request, such as lower layer security services. 4.2.1. Sequencing ofreason for theBind Request For some SASL authentication mechanisms, it maydisconnection. The following resultCode values are to benecessary forused in this notification: - protocolError: The server has received data from the clientto invokein which theBindRequest multiple times. If at any stageLDAPMessage structure could not be parsed. - strongAuthRequired: The server has detected that an established underlying security association protecting communication between the clientwishes to abort the bind process it MAY unbindandthen drop the underlying connection. Clients MUST NOT invokeserver has unexpectedly failed or been compromised. - unavailable: This server will stop accepting new connections and operationsbetween two Bind requests made as parton all existing connections, and be unavailable for an extended period ofa multi-stage bind. Atime. The client mayabort a SASL bind negotiation by sending a BindRequest with a different value in the mechanism fieldmake use ofSaslCredentials, or an AuthenticationChoice other than sasl. If the client sends a BindRequest with the sasl mechanism field asanempty string,alternative server. After sending this notice, the server MUSTreturn a BindResponse with authMethodNotSupported as the resultCode. This will allow clients to abort a negotiation if it wishes to try again withclose thesame SASL mechanism. Unlike LDAP v2,connection. After receiving this notice, the clientneed not send a Bind Request inMUST NOT transmit any further on thefirst PDU ofconnection, and may abruptly close the connection. 4.5. Search Operation The Search Operation allows a clientmayto requestany operations and the server MUST treat these as anonymous. If the server requiresthatthe client bind before browsing or modifying the directory, the server MAY reject a request other than binding, unbinding or an extended request with the "operationsError" result. If the client did not bind before sending a request and receives an operationsError, it may then sendaBind Request. If this also fails or the client chooses not to bindsearch be performed onthe existing connection, it will close the connection, reopen it and begin againits behalf byfirst sendingaPDU with a Bind Request.server. Thiswill aid in interoperating with servers implementing other versions of LDAP. Clients MAY send multiple bind requests on a connectioncan be used tochange their credentials. A subsequent bind process has the effect of abandoning all operations outstanding on the connection. (This simplifies server implementation.) Authenticationread attributes fromearlier binds are subsequently ignored, and so if the bind fails, the connection will be treated as anonymous. IfaSASL transfer encryptionsingle entry, from entries immediately below a particular entry, or a whole subtree of entries. 4.5.1. Search Request The Search Request is defined as follows: SearchRequest ::= [APPLICATION 3] SEQUENCE { baseObject LDAPDN, scope ENUMERATED { baseObject (0), singleLevel (1), Sermersheim Internet-Draft - ExpiresJulySep 2002 Page2017 Lightweight Directory Access Protocol Version 3integrity mechanism has been negotiated,wholeSubtree (2) }, derefAliases ENUMERATED { neverDerefAliases (0), derefInSearching (1), derefFindingBaseObj (2), derefAlways (3) }, sizeLimit INTEGER (0 .. maxInt), timeLimit INTEGER (0 .. maxInt), typesOnly BOOLEAN, filter Filter, attributes AttributeDescriptionList } Filter ::= CHOICE { andthat mechanism does[0] SET SIZE (1..MAX) OF Filter, or [1] SET SIZE (1..MAX) OF Filter, notsupport the changing of credentials from one identity to another, then the client MUST instead establish a new connection. 4.2.2. Authentication and Other Security Services The simple authentication option provides minimal authentication facilities, with the contents[2] Filter, equalityMatch [3] AttributeValueAssertion, substrings [4] SubstringFilter, greaterOrEqual [5] AttributeValueAssertion, lessOrEqual [6] AttributeValueAssertion, present [7] AttributeDescription, approxMatch [8] AttributeValueAssertion, extensibleMatch [9] MatchingRuleAssertion } SubstringFilter ::= SEQUENCE { type AttributeDescription, -- at least one must be present, -- initial and final can occur at most once substrings SEQUENCE OF CHOICE { initial [0] AssertionValue, any [1] AssertionValue, final [2] AssertionValue } } MatchingRuleAssertion ::= SEQUENCE { matchingRule [1] MatchingRuleId OPTIONAL, type [2] AttributeDescription OPTIONAL, matchValue [3] AssertionValue, dnAttributes [4] BOOLEAN DEFAULT FALSE } Parameters of theauthentication field consisting only of a cleartext password. NoteSearch Request are: - baseObject: An LDAPDN thatthe use of cleartext passwordsisnot recommended over open networks whentheunderlying transport service cannot guarantee confidentiality; seebase object entry relative to which the"Security Considerations" section. If anonymous authenticationsearch is to beperformed, thenperformed. - scope: An indicator of thesimple authentication option MUST be chosen, andscope of thepasswordsearch to be performed. The semantics ofzero length. (This is often done by LDAPv2 clients.) Typicallythename is alsopossible values ofzero length. The sasl choice allows for any mechanism defined for use with SASL [RFC2222]. The mechanismthis fieldcontainsare identical to thenamesemantics of themechanism. The credentialsscope fieldcontainsin thearbitrary data used for authentication, inside an OCTET STRING wrapper. Note that unlike some Internet application protocols where SASL is used, LDAP is not text- based, thus no base64 transformationsX.511 Search Operation. - derefAliases: An indicator as to how alias objects (as defined in X.501) areperformed onto be handled in searching. The semantics of thecredentials. If any SASL-based integritypossible values of this field are: neverDerefAliases: do not dereference aliases in searching orconfidentiality services are enabled, they take effect following the transmission by the server and reception by the client of the final BindResponse with resultCode success. The client can request that the server use authentication information from a lower layer protocol by using the SASL EXTERNAL mechanism. 4.2.3. Bind Response The Bind Response is defined as follows. BindResponse ::= [APPLICATION 1] SEQUENCE { COMPONENTS OF LDAPResult, serverSaslCreds [7] OCTET STRING OPTIONAL } BindResponse consists simply of an indication from the server ofin locating thestatusbase object of theclient's request for authentication. If the bind was successful, the resultCode will be success, otherwise it will be one of: - operationsError: server encountered an internal error. - protocolError: unrecognized version number or incorrect PDU structure. - authMethodNotSupported: unrecognized SASL mechanism name.search; Sermersheim Internet-Draft - ExpiresJulySep 2002 Page2118 Lightweight Directory Access Protocol Version 3- strongAuthRequired:derefInSearching: dereference aliases in subordinates of theserver requires authentication be performed with a SASL mechanism. - referral: this server cannot accept this bind andbase object in searching, but not in locating theclient should try another. - saslBindInProgress:base object of theserver requiressearch; derefFindingBaseObj: dereference aliases in locating theclient to send a new bind request, withbase object of thesame sasl mechanism, to continuesearch, but not when searching subordinates of theauthentication process. - inappropriateAuthentication:base object; derefAlways: dereference aliases both in searching and in locating theserver requiresbase object of theclient which had attempted to bind anonymously or without supplying credentialssearch. - sizeLimit: A size limit that restricts the maximum number of entries toprovide some formbe returned as a result ofcredentials. - invalidCredentials:thewrong password was supplied or the SASL credentials could not be processed. - unavailable: the server is shutting down. If the server does not support the client's requested protocol version, it MUST set the resultCode to protocolError. Ifsearch. A value of 0 in this field indicates that no client-requested size limit restrictions are in effect for theclient receivessearch. Servers may enforce aBindResponse response where the resultCode was protocolError, it MUST close the connection as the server will be unwillingmaximum number of entries toaccept further operations. (This isreturn. - timeLimit: A time limit that restricts the maximum time (in seconds) allowed forcompatibility with earlier versionsa search. A value ofLDAP,0 inwhich the bind was always the first operation, and there wasthis field indicates that nonegotiation.) The serverSaslCredsclient-requested time limit restrictions areused as part of a SASL-defined bind mechanism to allow the client to authenticatein effect for theserver to which it is communicating, orsearch. - typesOnly: An indicator as toperform "challenge-response" authentication. If the client bound with the password choice,whether search results will contain both attribute types and values, orthe SASL mechanism does not require the serverjust attribute types. Setting this field toreturn informationTRUE causes only attribute types (no values) tothe client, thenbe returned. Setting this fieldis notto FALSE causes both attribute types and values to beincluded inreturned. - filter: A filter that defines theresult. 4.3. Unbind Operation The function ofconditions that must be fulfilled in order for theUnbind Operation issearch toterminatematch aprotocol session. The Unbind Operation is defined as follows: UnbindRequest ::= [APPLICATION 2] NULLgiven entry. TheUnbind Operation has no response defined. Upon transmission'and', 'or' and 'not' choices can be used to form combinations of filters. At least one filter element MUST be present in anUnbindRequest, a protocol client may assume that the protocol session is terminated. Upon receipt'and' or 'or' choice. The others match against individual attribute values ofan UnbindRequest, a protocol server may assume thatentries in therequesting client has terminatedscope of thesession and that all outstanding requests may be discarded, and may closesearch. (Implementor's note: theconnection. 4.4. Unsolicited Notification An unsolicited notification'not' filter is anLDAPMessage sent fromexample of a tagged choice in an implicitly-tagged module. In BER this is treated as if the tag was explicit.) A server MUST evaluate filters according to theclient which is not in response to any LDAPMessage received by Sermersheim Internet-Draft - Expires July 2002 Page 22 Lightweight Directory Access Protocol Version 3 the server. Itthree-valued logic of X.511 (1993) section 7.8.1. In summary, a filter isusedevaluated tosignal an extraordinary condition in the servereither "TRUE", "FALSE" orin the connection between"Undefined". If theclient andfilter evaluates to TRUE for a particular entry, then theserver. The notification isattributes of that entry are returned as part ofan advisory nature, andtheserver will not expectsearch result (subject to anyresponseapplicable access control restrictions). If the filter evaluates tobe returned fromFALSE or Undefined, then theclient. The unsolicited notificationentry isstructured as an LDAPMessage in whichignored for themessageID is 0 and protocolOp issearch. A filter of theextendedResp form. The responseName field of"and" choice is TRUE if all theExtendedResponsefilters in the SET OF evaluate to TRUE, FALSE if at least one filter ispresent. The LDAPOID value MUST be unique for this notification,FALSE, andnot be used in any other situation. One unsolicited notification (Noticeotherwise Undefined. A filter ofDisconnection)the "or" choice isdefined in this document. 4.4.1. NoticeFALSE if all ofDisconnection This notification may be used bytheserver to advisefilters in theclient thatSET OF evaluate to FALSE, TRUE if at least one filter is TRUE, and Undefined otherwise. A filter of theserver"not" choice isabout to closeTRUE if theconnection due to an error condition. Note that this notificationfilter being negated isNOT a responseFALSE, FALSE if it Sermersheim Internet-Draft - Expires Sep 2002 Page 19 Lightweight Directory Access Protocol Version 3 is TRUE, and Undefined if it is Undefined. The present match evaluates to TRUE where there is anunbind requested by the client: the server MUST follow the proceduresattribute or subtype ofsection 4.3. This notification is intended to assist clientsthe specified attribute description present indistinguishing betweenanerror conditionentry, and FALSE otherwise (including atransient network failure. Aspresence test witha connection close due to network failure, the client MUST NOT assume that any outstanding requests which modified the directory have succeeded or failed.an unrecognized attribute description.) TheresponseNameextensibleMatch is1.3.6.1.4.1.1466.20036,new in this version of LDAP. If theresponsematchingRule field is absent, the type field MUST be present, and theresultCodeequality match isused to indicateperformed for that type. If thereasontype field is absent and matchingRule is present, the matchValue is compared against all attributes in an entry which support that matchingRule, and the matchingRule determines the syntax for thedisconnection. The following resultCode values areassertion value (the filter item evaluates tobe usedTRUE if it matches with at least one attribute inthis notification: - protocolError: The server has received data fromthecliententry, FALSE if it does not match any attribute inwhichtheLDAPMessage structure couldentry, and Undefined if the matchingRule is not recognized or the assertionValue cannot beparsed. - strongAuthRequired: The server has detected that an established underlying security association protecting communication betweenparsed.) If theclient and server has unexpectedly failed or been compromised. - unavailable: This server will stop accepting new connections and operations on all existing connections,type field is present and matchingRule is present, the matchingRule MUST beunavailableone permitted foran extended period of time. The client may makeuseof an alternative server. After sending this notice,with that type, otherwise theserver MUST closefilter item is undefined. If theconnection. After receiving this notice,dnAttributes field is set to TRUE, theclient MUST NOT transmit any further onmatch is applied against all theconnection,attributes in an entry's distinguished name as well, andmay abruptly closealso evaluates to TRUE if there is at least one attribute in theconnection. 4.5. Search Operation The Search Operation allows a clientdistinguished name for which the filter item evaluates torequestTRUE. (Editors note: The dnAttributes field is present so thata search be performed on its behalf by a server. This canthere does not need to beusedmultiple versions of generic matching rules such as for word matching, one to apply toread attributes from a single entry, fromentriesimmediately below a particular entry,and another to apply to entries and dn attributes as well). A filter item evaluates to Undefined when the server would not be able to determine whether the assertion value matches an entry. If an attribute description in an equalityMatch, substrings, greaterOrEqual, lessOrEqual, approxMatch or extensibleMatch filter is not recognized by the server, awhole subtreematching rule id in the extensibleMatch is not recognized by the server, the assertion value cannot be parsed, or the type ofentries. Sermersheim Internet-Draft - Expires July 2002 Page 23 Lightweight Directory Access Protocol Version 3 4.5.1. Search Request The Search Requestfiltering requested isdefined as follows: SearchRequest ::= [APPLICATION 3] SEQUENCE { baseObject LDAPDN, scope ENUMERATED { baseObject (0), singleLevel (1), wholeSubtree (2) }, derefAliases ENUMERATED { neverDerefAliases (0), derefInSearching (1), derefFindingBaseObj (2), derefAlways (3) }, sizeLimit INTEGER (0 .. maxInt), timeLimit INTEGER (0 .. maxInt), typesOnly BOOLEAN,not implemented, then the filterFilter, attributes AttributeDescriptionList } Filter ::= CHOICE {is Undefined. Thus for example if a server did not recognize the attribute type shoeSize, a filter of (shoeSize=*) would evaluate to FALSE, and[0] SET SIZE (1..MAX) OF Filter,the filters (shoeSize=12), (shoeSize>=12) and (shoeSize<=12) would evaluate to Undefined. Servers MUST NOT return errors if attribute descriptions or[1] SET SIZE (1..MAX) OF Filter,matching rule ids are not[2] Filter, equalityMatch [3] AttributeValueAssertion, substrings [4] SubstringFilter, greaterOrEqual [5] AttributeValueAssertion, lessOrEqual [6] AttributeValueAssertion, present [7] AttributeDescription, approxMatch [8] AttributeValueAssertion, extensibleMatch [9] MatchingRuleAssertion } SubstringFilter ::= SEQUENCE { type AttributeDescription, -- at least one mustrecognized, or assertion values cannot bepresent, -- initial and final can occur at most once substrings SEQUENCE OF CHOICE { initial [0] AssertionValue, any [1] AssertionValue, final [2] AssertionValue } } MatchingRuleAssertion ::= SEQUENCE { matchingRule [1] MatchingRuleId OPTIONAL, type [2] AttributeDescription OPTIONAL, matchValue [3] AssertionValue, dnAttributes [4] BOOLEAN DEFAULT FALSE } Parametersparsed. More details ofthe Search Request are:filter processing are given in section 7.8 of [X.511]. -baseObject: An LDAPDN that isattributes: A list of thebase object entry relativeattributes to be returned from each entry which matches the searchisfilter. There are two special values which may be used: an empty list with no attributes, and the attribute description string "*". Both of these signify that all user attributes are to beperformed.returned. (The "*" allows the client to request all user attributes in addition to any specified operational attributes). Sermersheim Internet-Draft - ExpiresJulySep 2002 Page2420 Lightweight Directory Access Protocol Version 3- scope: An indicator of the scope of the search toAttributes MUST beperformed. The semantics of the possible values of this field are identical to the semantics of the scope fieldnamed at most once in theX.511 Search Operation. - derefAliases: An indicator as to how alias objects (as definedlist, and are returned at most once inX.501)an entry. If there areto be handledattribute descriptions insearching. The semantics ofthepossible values of this field are: neverDerefAliases: dolist which are notdereference aliases in searching or in locatingrecognized, they are ignored by thebase object ofserver. If thesearch; derefInSearching: dereference aliasesclient does not want any attributes returned, it can specify a list containing only the attribute with OID "1.1". This OID was chosen arbitrarily and does not correspond to any attribute insubordinatesuse. Client implementors should note that even if all user attributes are requested, some attributes of thebase object in searching, butentry may not be included inlocating the base objectsearch results due to access controls or other restrictions. Furthermore, servers will not return operational attributes, such as objectClasses or attributeTypes, unless they are listed by name, since there may be extremely large number ofthe search; derefFindingBaseObj: dereference aliasesvalues for certain operational attributes. (A list of operational attributes for use inlocatingLDAP is given in [Syntaxes].) Note that an X.500 "list"-like operation can be emulated by thebase object ofclient requesting a one-level LDAP search operation with a filter checking for thesearch, but not when searching subordinatespresence of thebase object; derefAlways: dereference aliases both in searchingobjectClass attribute, andin locating thethat an X.500 "read"-like operation can be emulated by a base objectofLDAP search operation with thesearch. - sizeLimit:same filter. Asize limit that restrictsserver which provides a gateway to X.500 is not required to use themaximum number of entriesRead or List operations, although it may choose tobe returneddo so, and if it does, it must provide the same semantics asa resultthe X.500 search operation. 4.5.2. Search Result The results of thesearch. A valuesearch attempted by the server upon receipt of0 in this field indicates that no client-requested size limit restrictionsa Search Request are returned ineffect forSearch Responses, which are LDAP messages containing either SearchResultEntry, SearchResultReference, or SearchResultDone data types. SearchResultEntry ::= [APPLICATION 4] SEQUENCE { objectName LDAPDN, attributes PartialAttributeList } PartialAttributeList ::= SEQUENCE OF SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } -- implementors should note that thesearch. ServersPartialAttributeList mayenforce a maximum number-- have zero elements (if none ofentries to return. - timeLimit: A time limit that restrictsthemaximum time (in seconds) allowed for a search. A valueattributes of0 in this field indicatesthatno client-requested time limit restrictions are in effect for the search. - typesOnly: An indicator as to whether search results will contain both attribute types and values,entry -- were requested, orjust attribute types. Setting this field to TRUE causes only attribute types (no values) tocould bereturned. Setting this field to FALSE causes both attribute typesreturned), andvalues to be returned. - filter: A filterthatdefinestheconditions that must be fulfilled in order forvals set -- may also have zero elements (if types only was requested, or -- all values were excluded from thesearch to match a given entry. The 'and', 'or' and 'not' choices can be used to form combinations of filters. Atresult.) SearchResultReference ::= [APPLICATION 19] SEQUENCE OF LDAPURL -- at least onefilterLDAPURL elementMUSTmust be presentin an 'and' or 'or' choice. The others match against individual attribute values of entries in the scope of the search. (Implementor's note: the 'not' filter is an example of a tagged choice in an implicitly-tagged module. In BER this is treated as if the tag was explicit.) A server MUST evaluate filters according to the three-valued logic of X.511 (1993) section 7.8.1. In summary, a filter is evaluated to either "TRUE", "FALSE" or "Undefined". If the filter evaluates to TRUE for a particular entry, then the attributes of that entrySearchResultDone ::= [APPLICATION 5] LDAPResult Sermersheim Internet-Draft - ExpiresJulySep 2002 Page2521 Lightweight Directory Access Protocol Version 3are returned as partUpon receipt of a Search Request, a server will perform the necessary searchresult (subject to any applicable access control restrictions).of the DIT. If thefilter evaluatesLDAP session is operating over a connection-oriented transport such as TCP, the server will return toFALSE or Undefined, thentheentry is ignoredclient a sequence of responses in separate LDAP messages. There may be zero or more responses containing SearchResultEntry, one for each entry found during the search.A filter of the "and" choice is TRUE if allThere may also be zero or more responses containing SearchResultReference, one for each area not explored by this server during thefilterssearch. The SearchResultEntry and SearchResultReference PDUs may come in any order. Following all theSET OF evaluate to TRUE, FALSE if at least one filter is FALSE,SearchResultReference responses andotherwise Undefined. A filter of the "or" choice is FALSE ifallof the filters in the SET OF evaluateSearchResultEntry responses toFALSE, TRUE if at least one filter is TRUE, and Undefined otherwise. A filter ofbe returned by the"not" choice is TRUE ifserver, thefilter being negated is FALSE, FALSE if it is TRUE, and Undefined if it is Undefined. The present match evaluates to TRUE where there isserver will return a response containing the SearchResultDone, which contains anattribute or subtypeindication ofthe specified attribute description presentsuccess, or detailing any errors that have occurred. Each entry returned inan entry, and FALSE otherwise (includingapresence testSearchResultEntry will contain all attributes, complete withan unrecognized attribute description.) The extensibleMatch is newassociated values if necessary, as specified inthis version of LDAP. IfthematchingRuleattributes fieldis absent,of thetype field MUST be present,Search Request. Return of attributes is subject to access control and other administrative policy. Some attributes may be returned in binary format (indicated by theequality match is performed for that type. IfAttributeDescription in thetype field is absent and matchingRule is present,response having thematchValue is compared against all"binary" option present). Some attributes may be constructed by the server and appear in a SearchResultEntry attribute list, although they are not stored attributes of anentry which supportentry. Clients MUST NOT assume thatmatchingRule, andall attributes can be modified, even if permitted by access control. 4.5.3. Continuation References in thematchingRule determinesSearch Result If thesyntax forserver was able to locate theassertion value (the filter item evaluatesentry referred toTRUE if it matches with at least one attribute inby theentry, FALSE if it does not match any attributebaseObject but was unable to search all the entries in theentry,scope at andUndefined ifunder thematchingRule is not recognized orbaseObject, theassertionValue cannot be parsed.) Ifserver may return one or more SearchResultReference entries, each containing a reference to another set of servers for continuing thetype field is presentoperation. A server MUST NOT return any SearchResultReference if it has not located the baseObject andmatchingRulethus has not searched any entries; in this case it would return a SearchResultDone containing a referral resultCode. In the absence of indexing information provided to a server from servers holding subordinate naming contexts, SearchResultReference responses are not affected by search filters and are always returned when in scope. The SearchResultReference ispresent,of thematchingRulesame data type as the Referral. URLs for servers implementing the LDAP protocol are written according to [LDAPDN]. The <dn> part MUST beone permitted for usepresent in the URL, withthat type, otherwisethe new target object name. The client MUST use this name in its next request. Some servers (e.g. part of a distributed index exchange system) may provide a different filteritem is undefined.in the URLs of the SearchResultReference. If thednAttributes field is set to TRUE,filter part of thematchURL isapplied against all the attributespresent in anentry's distinguished name as well, and also evaluates to TRUE if there is at least one attribute inSermersheim Internet-Draft - Expires Sep 2002 Page 22 Lightweight Directory Access Protocol Version 3 LDAP URL, thedistinguished name for whichclient MUST use the new filteritem evaluatesin its next request toTRUE. (Editors note: The dnAttributes fieldprogress the search, and if the filter part ispresent so that there does not need to be multiple versions of generic matching rules such as for word matching, one to apply to entries and another to apply to entries and dn attributes as well). A filter item evaluates to Undefined whenabsent theserver would not be able to determine whetherclient will use again theassertion value matches an entry.same filter. Ifan attribute description in an equalityMatch, substrings, greaterOrEqual, lessOrEqual, approxMatch or extensibleMatch filter is not recognized bytheserver, a matching rule id inoriginating search scope was singleLevel, theextensibleMatch is not recognized byscope part of theserver,URL will be baseObject. Other aspects of theassertion value cannotnew search request may beparsed,the same or different as thetypesearch which generated the continuation references. Other kinds offiltering requested is not implemented, thenURLs may be returned so long as thefilter is Undefined. Thus for example ifoperation could be performed using that protocol. The name of an unexplored subtree in aserver didSearchResultReference need notrecognize the attribute type shoeSize, a filter of (shoeSize=*) would evaluatebe subordinate toFALSE, andthefilters (shoeSize=12), (shoeSize>=12) and (shoeSize<=12) would evaluatebase object. In order toUndefined. Serverscomplete the search, the client MUSTNOT return errors if attribute descriptions or matching rule ids are not recognized, or assertion values cannot Sermersheim Internet-Draft - Expires July 2002 Page 26 Lightweight Directory Access Protocol Version 3 be parsed. More details of filter processing are givenissue a new search operation for each SearchResultReference that is returned. Note that the abandon operation described in section7.8 of [X.511]. - attributes: A list of the attributes4.11 applies only tobe returned from each entry which matchesa particular operation sent on a connection between a client and server, and if the client has multiple outstanding searchfilter. There are two special values which may be used: an empty list with no attributes,operations, it MUST abandon each operation individually. 4.5.3.1. Example For example, suppose the contacted server (hosta) holds the entry "O=MNN,C=WW" and theattribute description string "*". Both of these signifyentry "CN=Manager,O=MNN,C=WW". It knows thatall user attributes are to be returned. (The "*" allows the client to request all user attributes in addition to specific operational attributes). Attributes MUST be named at most once ineither LDAP-capable servers (hostb) or (hostc) hold "OU=People,O=MNN,C=WW" (one is thelist,master andare returned at most once in an entry. If there are attribute descriptions inthelist which are not recognized, they are ignored byother server a shadow), and that LDAP-capable server (hostd) holds theserver.subtree "OU=Roles,O=MNN,C=WW". If a subtree search of "O=MNN,C=WW" is requested to theclient does not want any attributes returned,contacted server, itcan specify a list containing onlymay return theattribute with OID "1.1". This OID was chosen arbitrarily and does not correspond to any attribute in use.following: SearchResultEntry for O=MNN,C=WW SearchResultEntry for CN=Manager,O=MNN,C=WW SearchResultReference { ldap://hostb/OU=People,O=MNN,C=WW ldap://hostc/OU=People,O=MNN,C=WW } SearchResultReference { ldap://hostd/OU=Roles,O=MNN,C=WW } SearchResultDone (success) Client implementors should note thateven if all user attributes are requested, some attributes of the entrywhen following a SearchResultReference, additional SearchResultReference maynotbeincluded ingenerated. Continuing the example, if the client contacted the server (hostb) and issued the searchresults due to access controls or other restrictions. Furthermore, servers will not return operational attributes, such as objectClasses or attributeTypes, unless they are listed by name, since there may be extremely large number of values for certain operational attributes. (A list of operational attributesforuse in LDAP is given in [RFC2252].) Note that an X.500 "list"-like operation can be emulated bytheclient requesting a one-level LDAP search operation with a filter checkingsubtree "OU=People,O=MNN,C=WW", the server might respond as follows: SearchResultEntry for OU=People,O=MNN,C=WW SearchResultReference { ldap://hoste/OU=Managers,OU=People,O=MNN,C=WW } SearchResultReference { ldap://hostf/OU=Consultants,OU=People,O=MNN,C=WW } Sermersheim Internet-Draft - Expires Sep 2002 Page 23 Lightweight Directory Access Protocol Version 3 SearchResultDone (success) If thepresence ofcontacted server does not hold theobjectClass attribute, and that an X.500 "read"-like operation can be emulated by abase objectLDAP search operation withfor thesame filter. A server which providessearch, then it will return agateway to X.500 is not requiredreferral tousetheRead or List operations, although it may choose to do so, andclient. For example, ifit does, it must provide the same semantics astheX.500client requests a subtree searchoperation. 4.5.2. Search Result The resultsofthe search attempted by"O=XYZ,C=US" to hosta, the serverupon receipt ofmay return only aSearch Request are returned in Search Responses, which are LDAP messagesSearchResultDone containingeither SearchResultEntry, SearchResultReference, ora referral. SearchResultDonedata types. SearchResultEntry(referral) { ldap://hostg/ } 4.6. Modify Operation The Modify Operation allows a client to request that a modification of an entry be performed on its behalf by a server. The Modify Request is defined as follows: ModifyRequest ::= [APPLICATION4]6] SEQUENCE {objectNameobject LDAPDN,attributes PartialAttributeList } PartialAttributeList ::=modification SEQUENCE OF SEQUENCE {type AttributeDescription, valsoperation ENUMERATED { add (0), delete (1), replace (2) }, modification AttributeTypeAndValues } } AttributeTypeAndValues ::= SEQUENCE { type AttributeDescription, vals SET OF AttributeValue }-- implementors should note thatParameters of thePartialAttributeList may Sermersheim Internet-DraftModify Request are: -Expires July 2002 Page 27 Lightweight Directory Access Protocol Version 3 -- have zero elements (if noneobject: The object to be modified. The value of this field contains theattributesDN ofthat entry -- were requested, or could be returned), and that the vals set -- may also have zero elements (if types only was requested, or -- all values were excluded fromtheresult.) SearchResultReference ::= [APPLICATION 19] SEQUENCE OF LDAPURL -- at least one LDAPURL element mustentry to bepresent SearchResultDone ::= [APPLICATION 5] LDAPResult Upon receipt of a Search Request, amodified. The server will not perform any alias dereferencing in determining thenecessary searchobject to be modified. - modification: A list of modifications to be performed on theDIT. Ifentry. The entire list of entry modifications MUST be performed in theLDAP session is operating over a connection-oriented transport suchorder they are listed, asTCP,a single atomic operation. While individual modifications may violate theserver will returndirectory schema, the resulting entry after the entire list of modifications is performed MUST conform to theclient a sequencerequirements ofresponses in separate LDAP messages. There may be zero or more responses containing SearchResultEntry, one for each entry found duringthesearch. Theredirectory schema. The values that mayalsobezero or more responses containing SearchResultReference, one for each area not exploredtaken on bythis server duringthesearch. The SearchResultEntry and SearchResultReference PDUs may come'operation' field inany order. Following alleach modification construct have theSearchResultReference responses and all SearchResultEntry responsesfollowing semantics respectively: add: add values listed tobe returned bytheserver,given attribute, creating theserver will return a response containingattribute if necessary; delete: delete values listed from theSearchResultDone, which contains an indication of success,given attribute, removing the entire attribute if no values are listed, ordetailing any errors that have occurred. Each entry returned in a SearchResultEntry will containSermersheim Internet-Draft - Expires Sep 2002 Page 24 Lightweight Directory Access Protocol Version 3 if allattributes, complete with associatedcurrent valuesif necessary, as specified in the attributes fieldof theSearch Request. Returnattribute are listed for deletion; replace: replace all existing values ofattributes is subject to access control and other administrative policy. Some attributes may be returned in binary format (indicated bytheAttributeDescription ingiven attribute with theresponse havingnew values listed, creating the"binary" option present). Some attributes may be constructed byattribute if it did not already exist. A replace with no value will delete theserverentire attribute if it exists, andappear in a SearchResultEntryis ignored if the attributelist, although they aredoes notstored attributesexist. The result ofan entry. Clients MUST NOT assume that all attributes can be modified, even if permitted by access control. 4.5.3. Continuation References in the Search Result Iftheserver was able to locate the entry referred tomodify attempted by thebaseObject but was unable to search all the entries in the scope at and under the baseObject, theservermay return one or more SearchResultReference entries, each containing a reference to another setupon receipt ofservers for continuing the operation. A server MUST NOT return any SearchResultReference if it has not located the baseObject and thus has not searched any entries; in this case it would returnaSearchResultDone containingModify Request is returned in areferral resultCode. In the absenceModify Response, defined as follows: ModifyResponse ::= [APPLICATION 7] LDAPResult Upon receipt ofindexing information provided toa Modify Request, a serverfrom servers holding subordinate naming contexts, SearchResultReference responses are not affected by search filters and are always returned when in scope. Sermersheim Internet-Draft - Expires July 2002 Page 28 Lightweight Directory Access Protocol Version 3 The SearchResultReference is of the same data type as the Referral. URLs for servers implementingwill perform theLDAP protocol are written accordingnecessary modifications to[RFC2255]. The <dn> part MUST be present in the URL, withthenew target object name.DIT. The server will return to the clientMUST use this name in its next request. Some servers (e.g. part of a distributed index exchange system) may provideadifferent filter insingle Modify Response indicating either theURLssuccessful completion of theSearchResultReference. If the filter part ofDIT modification, or theURL is present in an LDAP URL,reason that theclient MUST usemodification failed. Note that due to thenew filterrequirement for atomicity inits next request to progressapplying thesearch, and iflist of modifications in thefilter part is absentModify Request, the clientwill use again the same filter. Other aspects of the new search requestmaybeexpect that no modifications of thesame or different as the search which generatedDIT have been performed if thecontinuation references. Other kindsModify Response received indicates any sort ofURLs may be returned so long as the operation could be performed usingerror, and thatprotocol. The nameall requested modifications have been performed if the Modify Response indicates successful completion ofan unexplored subtree in a SearchResultReference needthe Modify Operation. If the connection fails, whether the modification occurred or not is indeterminate. The Modify Operation cannot besubordinateused to remove from an entry any of its distinguished values, those values which form thebase object. In orderentry's relative distinguished name. An attempt tocomplete the search,do so will result in theclient MUST issue a new search operation for each SearchResultReference that is returned. Note thatserver returning theabandon operationerror notAllowedOnRDN. The Modify DN Operation described in section4.11 applies only4.9 is used toa particular operation sent on a connection between a client and server, and if the clientrename an entry. If an equality match filter hasmultiple outstanding search operations, itnot been defined for an attribute type, clients MUSTabandon each operation individually. 4.5.3.1. Example For example, suppose the contacted server (hosta) holds theNOT attempt to add or delete individual values of that attribute from an entry"O=MNN,C=WW" andusing theentry "CN=Manager,O=MNN,C=WW". It knows that either LDAP-capable servers (hostb)"add" or(hostc) hold "OU=People,O=MNN,C=WW" (one is the master and the other server"delete" form of ashadow),modification, and MUST instead use the "replace" form. Note thatLDAP-capable server (hostd) holdsdue to thesubtree "OU=Roles,O=MNN,C=WW". If a subtree search of "O=MNN,C=WW"simplifications made in LDAP, there isrequested to the contacted server, it may return the following: SearchResultEntry for O=MNN,C=WW SearchResultEntry for CN=Manager,O=MNN,C=WW SearchResultReference { ldap://hostb/OU=People,O=MNN,C=WW ldap://hostc/OU=People,O=MNN,C=WW } SearchResultReference { ldap://hostd/OU=Roles,O=MNN,C=WW } SearchResultDone (success) Client implementors should note that when followingnot aSearchResultReference, additional SearchResultReference may be generated. Continuing the example, ifdirect mapping of theclient contactedmodifications in an LDAP ModifyRequest onto theserver (hostb)EntryModifications of a DAP ModifyEntry operation, andissued the search for the subtree "OU=People,O=MNN,C=WW",different implementations of LDAP-DAP gateways may use different means of representing theserver might respond as follows: SearchResultEntry for OU=People,O=MNN,C=WW Sermersheim Internet-Draft - Expires July 2002 Page 29 Lightweight Directory Access Protocol Version 3 SearchResultReference { ldap://hoste/OU=Managers,OU=People,O=MNN,C=WW } SearchResultReference { ldap://hostf/OU=Consultants,OU=People,O=MNN,C=WW } SearchResultDone (success)change. If successful, thecontacted server does not hold the base object for the search, then it will return a referral to the client. For example, if the client requests a subtree searchfinal effect of"O=XYZ,C=US" to hosta,theserver may return only a SearchResultDone containing a referral. SearchResultDone (referral) { ldap://hostg/ } 4.6. Modifyoperations on the entry MUST be identical. 4.7. Add Operation TheModifyAdd Operation allows a client to requestthat a modificationthe addition of an entrybe performed on its behalf by a server.into the directory. TheModifyAdd Request is defined as follows:ModifyRequestAddRequest ::= [APPLICATION6]8] SEQUENCE {objectentry LDAPDN,modification SEQUENCE OF SEQUENCE { operation ENUMERATED { add (0), delete (1), replace (2) }, modification AttributeTypeAndValues }Sermersheim Internet-Draft - Expires Sep 2002 Page 25 Lightweight Directory Access Protocol Version 3 attributes AttributeList }AttributeTypeAndValuesAttributeList ::= SEQUENCE OF SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } Parameters of theModifyAdd Request are: -object: The objectentry: the Distinguished Name of the entry to bemodified. The value of this field contains the DN ofadded. Note that theentry to be modified. Theserver will notperformdereference anyalias dereferencingaliases indetermininglocating theobjectentry to bemodified.added. -modification: Aattributes: the list ofmodifications to be performed onattributes that make up theentry. The entire listcontent of the entrymodificationsbeing added. Clients MUSTbe performedinclude distinguished values (those forming the entry's own RDN) in this list, theorder they are listed,objectClass attribute, and values of any mandatory attributes of the listed object classes. Clients MUST NOT supply NO-USER-MODIFICATION attributes such asa single atomic operation. While individual modifications may violatethedirectory schema,createTimestamp or creatorsName attributes, since theresultingserver maintains these automatically. The entryafternamed in theentire listentry field ofmodifications is performedthe AddRequest MUSTconform toNOT exist for therequirementsAddRequest to succeed. The parent of thedirectory schema. The values that mayentry to betaken on by the 'operation' field in each modification construct haveadded MUST exist. For example, if thefollowing semantics respectively: Sermersheim Internet-Draft - Expires July 2002 Page 30 Lightweight Directory Access Protocol Version 3 add: add values listedclient attempted to add "CN=JS,O=Foo,C=US", thegiven attribute, creating the attribute if necessary; delete: delete values listed from the given attribute, removing"O=Foo,C=US" entry did not exist, and theentire attribute if no values are listed, or if all current values of"C=US" entry did exist, then theattribute are listed for deletion; replace: replace all existing values ofserver would return thegiven attributeerror noSuchObject with thenew values listed, creatingmatchedDN field containing "C=US". If theattribute if it did not already exist. A replace with no valueparent entry exists but is not in a naming context held by the server, the server SHOULD return a referral to the server holding the parent entry. Servers implementations SHOULD NOT restrict where entries can be located in the directory. Some servers MAY allow the administrator to restrict the classes of entries which can be added to the directory. Upon receipt of an Add Request, a server willdeleteattempt to perform theentire attribute if it exists, andadd requested. The result of the add attempt will be returned to the client in the Add Response, defined as follows: AddResponse ::= [APPLICATION 9] LDAPResult A response of success indicates that the new entry isignored ifpresent in theattribute doesdirectory. 4.8. Delete Operation The Delete Operation allows a client to request the removal of an entry from the directory. The Delete Request is defined as follows: DelRequest ::= [APPLICATION 10] LDAPDN The Delete Request consists of the Distinguished Name of the entry to be deleted. Note that the server will notexist.dereference aliases while resolving the name of the target entry to be removed, and that only Sermersheim Internet-Draft - Expires Sep 2002 Page 26 Lightweight Directory Access Protocol Version 3 leaf entries (those with no subordinate entries) can be deleted with this operation. The result of themodifydelete attempted by the server upon receipt of aModifyDelete Request is returned ina Modifythe Delete Response, defined as follows:ModifyResponseDelResponse ::= [APPLICATION7]11] LDAPResult Upon receipt of aModifyDelete Request, a server willperform the necessary modificationsattempt to perform theDIT.entry removal requested. Theserverresult of the delete attempt willreturnbe returned to the clienta single Modify Response indicating eitherin thesuccessful completion ofDelete Response. 4.9. Modify DN Operation The Modify DN Operation allows a client to change theDIT modification, orleftmost (least significant) component of thereason thatname of an entry in themodification failed. Note that duedirectory, or tothe requirement for atomicitymove a subtree of entries to a new location inapplyingthelistdirectory. The Modify DN Request is defined as follows: ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { entry LDAPDN, newrdn RelativeLDAPDN, deleteoldrdn BOOLEAN, newSuperior [0] LDAPDN OPTIONAL } Parameters ofmodifications inthe ModifyRequest,DN Request are: - entry: theclient may expect that no modificationsDistinguished Name of theDITentry to be changed. This entry may or may not havebeen performed ifsubordinate entries. Note that theModify Response received indicatesserver will not dereference anysort of error, andaliases in locating the entry to be changed. - newrdn: the RDN thatall requested modifications have been performed ifwill form theModify Response indicates successful completionleftmost component of theModify Operation. Ifnew name of theconnection fails,entry. - deleteoldrdn: a boolean parameter that controls whether themodification occurred or not is indeterminate. The Modify Operation cannot be usedold RDN attribute values are toremovebe retained as attributes of the entry, or deleted froman entry anythe entry. - newSuperior: if present, this is the Distinguished Name ofits distinguished values, those valuesthe entry whichformbecomes theentry's relative distinguished name. An attempt to do so willimmediate superior of the existing entry. The resultinof theserver returningname change attempted by theerror notAllowedOnRDN. Theserver upon receipt of a Modify DNOperation described in section 4.9Request isused to rename an entry. If an equality match filter has not beenreturned in the Modify DN Response, definedfor an attribute type, clients MUST NOTas follows: ModifyDNResponse ::= [APPLICATION 13] LDAPResult Upon receipt of a ModifyDNRequest, a server will attempt toadd or delete individual values of that attribute from an entry usingperform the"add" or "delete" formname change. The result ofa modification, and MUST instead usethe"replace" form. Note that duename change attempt will be returned to thesimplifications made in LDAP, there is not a direct mapping of the modificationsclient inan LDAP ModifyRequest onto the EntryModifications of a DAP ModifyEntry operation, and different implementations of LDAP-DAP gateways may use different means of representing the change. If successful, the final effect of the operations ontheentry MUST be identical. 4.7. Add OperationModify DN Response. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page3127 Lightweight Directory Access Protocol Version 3The Add Operation allows a client to requestFor example, if theaddition of anentryintonamed in thedirectory. The Add Request is defined as follows: AddRequest ::= [APPLICATION 8] SEQUENCE { entry LDAPDN, attributes AttributeList } AttributeList ::= SEQUENCE OF SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } Parameters of"entry" parameter was "cn=John Smith,c=US", theAdd Request are: - entry:newrdn parameter was "cn=John Cougar Smith", and theDistinguished Name ofnewSuperior parameter was absent, then this operation would attempt to rename the entry to beadded. Note"cn=John Cougar Smith,c=US". If there was already an entry with that name, theserver will not dereference any aliases in locatingoperation would fail with error code entryAlreadyExists. If theentry to be added. - attributes:deleteoldrdn parameter is TRUE, thelist of attributes that make upvalues forming thecontent ofold RDN are deleted from the entry. If the deleteoldrdn parameter is FALSE, theentry being added. Clients MUST include distinguishedvalues(thoseforming theentry's own RDN) in this list, the objectClass attribute, andold RDN will be retained as non-distinguished attribute values ofany mandatory attributesthe entry. The server may not perform the operation and return an error code if the setting of thelisted object classes. Clients MUST NOT supply NO-USER-MODIFICATION attributes such asdeleteoldrdn parameter would cause a schema inconsistency in thecreateTimestamp or creatorsName attributes, sinceentry. Note that X.500 restricts the ModifyDN operation to only affect entries that are contained within a single server. If the LDAP servermaintains these automatically.is mapped onto DAP, then this restriction will apply, and the resultCode affectsMultipleDSAs will be returned if this error occurred. In general clients MUST NOT expect to be able to perform arbitrary movements of entries and subtrees between servers. 4.10. Compare Operation The Compare Operation allows a client to compare an assertion provided with an entrynamedin the directory. The Compare Request is defined as follows: CompareRequest ::= [APPLICATION 14] SEQUENCE { entryfieldLDAPDN, ava AttributeValueAssertion } Parameters of theAddRequest MUST NOT exist forCompare Request are: - entry: theAddRequest to succeed. The parentname of the entry to beadded MUST exist. For example, ifcompared with. Note that theclient attempted to add "CN=JS,O=Foo,C=US",server SHOULD NOT dereference any aliases in locating the"O=Foo,C=US"entrydid not exist, andto be compared with. - ava: the"C=US" entry did exist, then the server would return the error noSuchObjectassertion withthe matchedDN field containing "C=US". If the parent entry exists but is not in a naming context held by the server, the server SHOULD return a referral to the server holding the parent entry. Servers implementations SHOULD NOT restrict where entries can be located in the directory. Some servers MAY allow the administrator to restrict the classes of entrieswhichcan be added to the directory. Upon receipt ofanAdd Request, a server will attempt to perform the add requested. The result of the add attempt will be returned to the client in the Add Response, defined as follows: AddResponse ::= [APPLICATION 9] LDAPResult A response of success indicates that the new entry is presentattribute in thedirectory. 4.8. Delete Operation The Delete Operation allows a client to request the removal of anentryfrom the directory. The Delete Requestisdefined as follows: DelRequest ::= [APPLICATION 10] LDAPDN Sermersheim Internet-Draft - Expires July 2002 Page 32 Lightweight Directory Access Protocol Version 3 The Delete Request consists of the Distinguished Name of the entry to be deleted. Note that the server will not dereference aliases while resolving the name of the target entryto beremoved, and that only leaf entries (those with no subordinate entries) can be deleted with this operation.compared. The result of thedeletecompare attempted by the server upon receipt of aDeleteCompare Request is returned in theDeleteCompare Response, defined as follows:DelResponseCompareResponse ::= [APPLICATION11]15] LDAPResult Upon receipt of aDeleteCompare Request, a server will attempt to perform theentry removal requested.requested comparison. The result of thedelete attemptcomparison will be returned to the client in theDeleteCompare Response.4.9. Modify DN Operation The Modify DN Operation allows a client to changeNote that errors and theleftmost (least significant) component of the nameresult ofan entrycomparison are all returned in thedirectory, orsame construct. Note that some directory systems may establish access controls which permit the values of certain attributes (such as userPassword) tomovebe Sermersheim Internet-Draft - Expires Sep 2002 Page 28 Lightweight Directory Access Protocol Version 3 compared but not read. In asubtreesearch result, it may be that an attribute ofentriesthat type would be returned, but with an empty set of values. 4.11. Abandon Operation The function of the Abandon Operation is to allow anew location inclient to request that thedirectory.server abandon an outstanding operation. TheModify DNAbandon Request is defined as follows:ModifyDNRequestAbandonRequest ::= [APPLICATION12] SEQUENCE { entry LDAPDN, newrdn RelativeLDAPDN, deleteoldrdn BOOLEAN, newSuperior [0] LDAPDN OPTIONAL } Parameters16] MessageID The MessageID MUST be that of an operation which was requested earlier in this connection. (The abandon request itself has its own message id. This is distinct from theModify DN Request are: - entry: the Distinguished Nameid of theentry to be changed. This entry may orearlier operation being abandoned.) There is no response defined in the Abandon Operation. Upon transmission of an Abandon Operation, a client maynot have subordinate entries. Noteexpect that theserver will not dereference any aliasesoperation identified by the Message ID inlocatingtheentry toAbandon Request will bechanged. - newrdn:abandoned. In theRDNevent thatwill form the leftmost component ofa server receives an Abandon Request on a Search Operation in thenew namemidst of transmitting responses to theentry. - deleteoldrdn: a boolean parametersearch, thatcontrols whether the old RDN attribute values areserver MUST cease transmitting entry responses tobe retained as attributes of the entry, or deleted from the entry. - newSuperior: if present, this is the Distinguished Name oftheentry which becomesabandoned request immediately, and MUST NOT send theimmediate superior ofSearchResponseDone. Of course, theexisting entry. The result ofserver MUST ensure that only properly encoded LDAPMessage PDUs are transmitted. Clients MUST NOT send abandon requests for thename change attempted bysame operation multiple times, and MUST also be prepared to receive results from operations it has abandoned (since these may have been in transit when theserver upon receiptabandon was requested). Servers MUST discard abandon requests for message IDs they do not recognize, for operations which cannot be abandoned, and for operations which have already been abandoned. 4.12. Extended Operation An extension mechanism has been added in this version ofa Modify DN Request is returnedLDAP, inthe Modify DN Response,order to allow additional operations to be definedas follows: ModifyDNResponsefor services not available elsewhere in this protocol, for instance digitally signed operations and results. The extended operation allows clients to make requests and receive responses with predefined syntaxes and semantics. These may be defined in RFCs or be private to particular implementations. Each request MUST have a unique OBJECT IDENTIFIER assigned to it. ExtendedRequest ::= [APPLICATION13] LDAPResult23] SEQUENCE { requestName [0] LDAPOID, requestValue [1] OCTET STRING OPTIONAL } Sermersheim Internet-Draft - ExpiresJulySep 2002 Page3329 Lightweight Directory Access Protocol Version 3Upon receipt of a ModifyDNRequest,The requestName is aserver will attemptdotted-decimal representation of the OBJECT IDENTIFIER corresponding toperformthename change.request. Theresult of the name change attemptrequestValue is information in a form defined by that request, encapsulated inside an OCTET STRING. The server willbe returnedrespond tothe client in the Modify DN Response. For example, if the entry named in the "entry" parameter was "cn=John Smith,c=US", the newrdn parameter was "cn=John Cougar Smith", and the newSuperior parameter was absent, thenthisoperation would attempt to rename the entry to be "cn=John Cougar Smith,c=US". If there was already an entrywiththat name,an LDAPMessage containing theoperation would fail with error code entryAlreadyExists.ExtendedResponse. ExtendedResponse ::= [APPLICATION 24] SEQUENCE { COMPONENTS OF LDAPResult, responseName [10] LDAPOID OPTIONAL, response [11] OCTET STRING OPTIONAL } If thedeleteoldrdn parameter is TRUE,server does not recognize thevalues formingrequest name, it MUST return only theold RDN are deletedresponse fields from LDAPResult, containing theentry. If the deleteoldrdn parameterprotocolError result code. 5. Protocol Element Encodings and Transfer One underlying service isFALSE, the values formingdefined here. Clients and servers SHOULD implement theold RDN will be retained as non-distinguished attribute valuesmapping ofthe entry.LDAP over TCP described in 5.2.1. 5.1. Protocol Encoding Theserver may not perform the operation and return an error code ifprotocol elements of LDAP are encoded for exchange using thesettingBasic Encoding Rules (BER) [X.690] of ASN.1 [X.680]. However, due to thedeleteoldrdn parameter would cause a schema inconsistencyhigh overhead involved in using certain elements of theentry. Note that X.500 restrictsBER, theModifyDN operation to only affect entries thatfollowing additional restrictions arecontained within a single server. If theplaced on BER-encodings of LDAPserver is mapped onto DAP, then this restriction will apply, andprotocol elements: (1) Only theresultCode affectsMultipleDSAsdefinite form of length encoding will bereturned if this error occurred. In general clients MUST NOT expect toused. (2) OCTET STRING values will beable to perform arbitrary movements of entries and subtrees between servers. 4.10. Compare Operation The Compare Operation allows a client to compare an assertion provided with an entryencoded in thedirectory. The Compare Request is defined as follows: CompareRequest ::= [APPLICATION 14] SEQUENCE { entry LDAPDN, ava AttributeValueAssertion } Parameters of the Compare Request are: - entry:primitive form only. (3) If thenamevalue of a BOOLEAN type is true, theentryencoding MUST have its contents octets set to hex "FF". (4) If a value of a type is its default value, it MUST becompared with. Note that the server SHOULD NOT dereference any aliasesabsent. Only some BOOLEAN and INTEGER types have default values inlocating the entrythis protocol definition. These restrictions do not apply tobe compared with. - ava: the assertionASN.1 types encapsulated inside of OCTET STRING values, such as attribute values, unless otherwise noted. 5.2. Transfer Protocols This protocol is designed to run over connection-oriented, reliable transports, withwhichall 8 bits in anattributeoctet being significant in theentry is to be compared.data stream. Sermersheim Internet-Draft - Expires Sep 2002 Page 30 Lightweight Directory Access Protocol Version 3 5.2.1. Transmission Control Protocol (TCP) Theresult of the compare attempted byencoded LDAPMessage PDUs are mapped directly onto theserver upon receipt of a Compare RequestTCP bytestream. It isreturned inrecommended that server implementations running over theCompare Response, defined as follows: CompareResponse ::= [APPLICATION 15] LDAPResult Upon receipt of a Compare Request,TCP MAY provide aserver will attempt to performprotocol listener on therequested comparison.assigned port, 389. Servers may instead provide a listener on a different port number. Clients MUST support contacting servers on any valid TCP port. 6. Implementation Guidelines This document describes an Internet protocol. 6.1. Server Implementations Theresultserver MUST be capable of recognizing all thecomparison will be returned tomandatory attribute type names and implement theclientsyntaxes specified inthe Compare Response. Note[Syntaxes]. Servers MAY also recognize additional attribute type names. 6.2. Client Implementations Clients which request referrals MUST ensure thaterrors andthey do not loop between servers. They MUST NOT repeatedly contact theresult of comparison are all returned insame server for the sameconstruct. Sermersheim Internet-Draft - Expires July 2002 Page 34 Lightweight Directory Access Protocol Version 3 Note that some directory systems may establish access controls which permitrequest with thevalues of certain attributes (such as userPassword) to be compared but not read. In a search result, itsame target entry name, scope and filter. Some clients may be using a counter that is incremented each time referral handling occurs for anattributeoperation, and these kinds ofthat type wouldclients MUST bereturned, butable to handle a DIT withan empty set of values. 4.11. Abandon Operation The functionat least ten layers of naming contexts between theAbandon Operation is to allowroot and aclient to request thatleaf entry. In theserver abandon an outstanding operation. The Abandon Request is defined as follows: AbandonRequest ::= [APPLICATION 16] MessageID The MessageID MUST be that of an operation which was requested earlier in this connection. (The abandon request itself has its own message id. This is distinct from the idabsence ofthe earlier operation being abandoned.) There is no response definedprior agreements with servers, clients SHOULD NOT assume that servers support any particular schemas beyond those referenced in section 6.1. Different schemas can have different attribute types with theAbandon Operation. Upon transmission of an Abandon Operation, asame names. The clientmay expect thatcan retrieve theoperation identifiedsubschema entries referenced by theMessage IDsubschemaSubentry attribute in theAbandon Request will be abandoned. In the event that a server receives an Abandon Request on a Search Operationserver's root DSE or in entries held by themidstserver. 7. Security Considerations When used with a connection-oriented transport, this version oftransmitting responses tothesearch,protocol provides facilities for simple authentication using a cleartext password, as well as any SASL mechanism [RFC2222]. SASL allows for integrity and privacy services to be negotiated. It is also permitted that the serverMUST cease transmitting entry responsescan return its credentials to theabandoned request immediately, and MUST NOT sendclient, if it chooses to do so. Sermersheim Internet-Draft - Expires Sep 2002 Page 31 Lightweight Directory Access Protocol Version 3 Use of cleartext password is strongly discouraged where theSearchResponseDone. Of course,underlying transport service cannot guarantee confidentiality and may result in disclosure of theserver MUST ensurepassword to unauthorized parties. When used with SASL, it should be noted thatonly properly encoded LDAPMessage PDUs are transmitted. Clients MUST NOT send abandon requests forthesame operation multiple times,name field of the BindRequest is not protected against modification. Thus if the distinguished name of the client (an LDAPDN) is agreed through the negotiation of the credentials, it takes precedence over any value in the unprotected name field. Implementations which cache attributes and entries obtained via LDAP MUSTalsoensure that access controls are maintained if that information is to bepreparedprovided toreceive results from operations it has abandoned (since thesemultiple clients, since servers may havebeen in transit when the abandon was requested). Servers MUST discard abandon requests for message IDs they do not recognize, for operations which cannot be abandoned, and for operationsaccess control policies whichhave already been abandoned. 4.12. Extended Operation An extension mechanism has been added in this versionprevent the return ofLDAP,entries or attributes inordersearch results except toallow additional operationsparticular authenticated clients. For example, caches could serve result information only to the client whose request caused it to bedefined for services not available elsewhereinthis protocol, for instance digitally signed operations and results. The extended operation allows clientsthe cache. 8. Acknowledgements This document is an update tomake requestsRFC 2251, by Mark Wahl, Tim Howes, andreceive responsesSteve Kille. Their work along withpredefined syntaxesthe input of individuals of the IETF LDAPEXT, LDUP, LDAPBIS, andsemantics. These may be defined in RFCs or be private to particular implementations. Each request MUST have a unique OBJECT IDENTIFIER assigned to it. ExtendedRequest ::= [APPLICATION 23] SEQUENCE { requestName [0] LDAPOID,other Working Groups is gratefully acknowledged. 9. Normative References [X.500] ITU-T Rec. X.500, "The Directory: Overview of Concepts, Models and Service", 1993. [Roadmap] K. Zeilenga (editor), "LDAP: Technical Specification Road Map", draft-ietf-ldapbis-roadmap-xx.txt (a work in progress). [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", RFC 2119, March 1997. [X.680] ITU-T Recommendation X.680 (1997) | ISO/IEC 8824-1:1998 Information Technology - Abstract Syntax Notation One (ASN.1): Specification of basic notation [X.690] ITU-T Rec. X.690, "Specification of ASN.1 encoding rules: Basic, Canonical, and Distinguished Encoding Rules", 1994. [LDAPIANA] K. Zeilenga, "IANA Considerations for LDAP", draft-ietf- ldapbis-xx.txt (a work in progress). [ISO10646] Universal Multiple-Octet Coded Character Set (UCS) - Architecture and Basic Multilingual Plane, ISO/IEC 10646-1 : 1993. [RFC2044] Yergeau, F., "UTF-8, a transformation format of Unicode and ISO 10646", RFC 2044, October 1996. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page3532 Lightweight Directory Access Protocol Version 3requestValue [1] OCTET STRING OPTIONAL } The requestName is a dotted-decimal representation of the OBJECT IDENTIFIER corresponding to the request.[Models] K. Zeilenga, "LDAP: TherequestValue is informationModels", draft-ietf-ldapbis- models-xx.txt (a work ina form defined by that request, encapsulated inside an OCTET STRING. The server will respond to this with an LDAPMessage containing the ExtendedResponse. ExtendedResponse ::= [APPLICATION 24] SEQUENCE { COMPONENTS OF LDAPResult, responseName [10] LDAPOID OPTIONAL, response [11] OCTET STRING OPTIONAL } If the server does not recognize the request name, it MUST return only the response fields from LDAPResult, containing the protocolError result code. 5. Protocol Element Encodings and Transfer One underlying service is defined here. Clients and servers SHOULD implement the mappingprogress). [LDAPDN] K. Zeilenga (editor), "LDAP: String Representation ofLDAP over TCP describedDistinguished Names", draft-ietf-ldapbis-dn-xx.txt, (a work in5.2.1. 5.1. Protocol Encoding The protocol elements of LDAP are encoded for exchange using the Basic Encoding Rules (BER) [X.690] of ASN.1 [X.680]. However, due to the high overhead involved in using certain elements of the BER, the following additional restrictions are placed on BER-encodings of LDAP protocol elements: (1) Only the definite form of length encoding will be used. (2) OCTET STRING values will be encodedprogress). [Syntaxes] K. Dally (editor), "LDAP: Syntaxes", draft-ietf-ldapbis- syntaxes-xx.txt, (a work inthe primitive form only. (3) If the value of a BOOLEAN type is true, the encoding MUST have its contents octets set to hex "FF". (4) If a value of a type is its default value, it MUST be absent. Only some BOOLEANprogress). [X.501] ITU-T Rec. X.501, "The Directory: Models", 1993. [X.511] ITU-T Rec. X.511, "The Directory: Abstract Service Definition", 1993. [RFC2396] Berners-Lee, T., Fielding, R., andINTEGER types have default values in this protocol definition. These restrictions do not apply to ASN.1 types encapsulated inside of OCTET STRING values, such as attribute values, unless otherwise noted. 5.2. Transfer Protocols This protocol is designed to run over connection-oriented, reliable transports, with all 8 bits in an octet being significantL. Masinter Uniform Resource Identifiers (URI): Generic Syntax", RFC 2396, August 1998. [AuthMeth] R. Harrison (editor), "LDAP: Authentication Methods", draft-ietf-ldapbis-authmeth-xx.txt, (a work inthe data stream. 5.2.1. Transmission Control Protocol (TCP)progress). [RFC2222] Meyers, J., "Simple Authentication and Security Layer", RFC 2222, October 1997. 10. Editor's Address Jim Sermersheim Novell, Inc. 1800 South Novell Place Provo, Utah 84606, USA jimse@novell.com +1 801 861-3088 Sermersheim Internet-Draft - ExpiresJulySep 2002 Page3633 Lightweight Directory Access Protocol Version 3The encoded LDAPMessage PDUs are mapped directly onto the TCP bytestream. It is recommended that server implementations running over the TCP MAY provide a protocol listener on the assigned port, 389. Servers may instead provide a listener on a different port number. Clients MUST support contacting servers on any valid TCP port. 6. Implementation GuidelinesAppendix A - LDAP Result Codes Thisdocument describes an Internet protocol. 6.1. Server Implementations The server MUST be capable of recognizing all the mandatory attribute type namesnormative appendix details additional considerations regarding LDAP result codes andimplement the syntaxes specifiedprovides a brief, general description of each LDAP result code enumerated in[RFC2252]. ServersSection 4.1.10. Additional result codes MAYalso recognize additional attribute type names. 6.2.be defined for use with extensions. ClientImplementations Clientsimplementations SHALL treat any result code whichrequest referrals MUST ensure thatthey do notloop between servers. They MUST NOT repeatedly contact the same server for the same request with the same target entry name, scope and filter. Some clients may be using a counter that is incremented each time referral handling occurs forrecognize as anoperation,unknown error condition. A.1 Non-Error Result Codes These result codes (called "non-error" result codes) do not indicate an error condition: success(0), compareTrue(6), compareFalse(7), referral(10), andthese kinds of clients MUST be ablesaslBindInProgress(14). The success(0), compareTrue(6), and compare(7) result codes indicate successful completion (and, hence, are called tohandle a DIT with at least ten layers of naming contexts between the rootas "successful" result codes). The referral(10) anda leaf entry. InsaslBindInProgress(14) indicate theabsenceclient is required to take additional action to complete the operation A.2 Error Result Codes A.3 Classes and Precedence ofprior agreements with servers, clients SHOULD NOT assumeError Result Codes Result codes thatservers support any particular schemas beyond those referenced in section 6.1. Different schemas can have different attribute types with the same names.indicate error conditions (and, hence, are called "error" result codes) fall into 6 classes. Theclient can retrieve the subschema entries referenced byfollowing list specifies thesubschemaSubentry attribute in the server's root DSE or in entries held by the server. 7. Security Considerations When used with a connection-oriented transport, this versionprecedence ofthe protocol provides facilities for the LDAP v2 authentication mechanism, simple authentication using a cleartext password, as well as any SASL mechanism [RFC2222]. SASL allows for integrity and privacy serviceserror classes to benegotiated. Itused when more than one error isalso permitted that the server can return its credentialsdetected [X511]: 1) Name Errors (codes 32 - 34, 36) - a problem related tothe client, if it choosesa name (DN or RDN), 2) Update Errors (codes 64 - 69, 71) - a problem related to an update operation, 3) Attribute Errors (codes 16 - 21) - a problem related to a supplied attribute, 4) Security Errors (codes 8, 13, 48 - 50) - a security related problem, 5) Service Problem (codes 3, 4, 7, 11, 12, 51 - 54, 80) - a problem related todo so. Use of cleartext password is strongly discouraged wheretheunderlying transport service cannot guarantee confidentiality and may result in disclosureprovision of thepasswordservice, and 6) Protocol Problem (codes 1, 2) - a problem related tounauthorized parties. When used with SASL,protocol structure or semantics. Server implementations SHALL NOT continue processing an operation after itshould be notedhas determined thatthe name field of the BindRequestan error isnot protected against modification. Thus ifto be reported. If thedistinguished name ofserver detects multiple errors simultaneously, theclient (an LDAPDN) is agreed throughserver SHOULD report the error with the highest precedence. Existing LDAP result codes are described as follows: Sermersheim Internet-Draft - ExpiresJulySep 2002 Page3734 Lightweight Directory Access Protocol Version 3negotiationsuccess (0) Indicates successful completion of an operation. This result code is normally not returned by thecredentials, it takes precedence over any value in the unprotected name field. Implementations which cache attributescompare operation, see compareFalse (5) andentries obtained via LDAP MUST ensure that access controls are maintained ifcompareTrue (6). operationsError (1) Indicates thatinformationthe operation is not properly sequenced with relation tobe provided to multiple clients, since servers may have access control policies which prevent the return of entriesother operations (of same orattributes in search results except to particular authenticated clients.different type). For example,caches could serve result information only tothis code is returned if the clientwhose request caused itattempts tobe inStart TLS [RFC2830] while there are other operations outstanding or if TLS was already established. For thecache. 8. Acknowledgements This document isbind operation only, the code indicates the server encountered anupdateinternal error. protocolError (2) Indicates the server received data which has incorrect structure. For bind operation only, the code may be resulted toRFC 2251,indicate the server does not support the requested protocol version. timeLimitExceeded (3) Indicates that the time limit specified byMark Wahl, Tim Howes, and Steve Kille. Their work along withtheinput of individuals ofclient was exceeded before theIETF LDAPEXT, LDUP, LDAPBIS,operation could be completed. sizeLimitExceeded (4) Indicates that the size limit specified by the client was exceeded before the operation could be completed. compareFalse (5) Indicates that the operation successfully completes andother Working Groupsthe assertion has evaluated to TRUE. This result code isgratefully acknowledged. 9. Bibliography [ISO10646] Universal Multiple-Octet Coded Character Set (UCS)normally only returned by the compare operation. compareTrue (6) Sermersheim Internet-Draft -Architecture and Basic Multilingual Plane, ISO/IEC 10646-1 : 1993. [X.500] ITU-T Rec. X.500, "The Directory: Overview of Concepts, ModelsExpires Sep 2002 Page 35 Lightweight Directory Access Protocol Version 3 Indicates that the operation successfully completes andService", 1993. [X.501] ITU-T Rec. X.501, "The Directory: Models", 1993. [X.511] ITU-T Rec. X.511, "The Directory: Abstract Service Definition", 1993. [X.680] ITU-T Rec. X.680, "Abstract Syntax Notation One (ASN.1) - Specification of Basic Notation", 1994. [X.690] ITU-T Rec. X.690, "Specification of ASN.1 encoding rules: Basic, Canonical, and Distinguished Encoding Rules", 1994. [RFC1777] Yeong, W., Howes, T., and S. Kille, "Lightweight Directory Access Protocol", RFC 1777, March 1995. [RFC1823] Howes, T., and M. Smith, "The LDAP Application Program Interface", RFC 1823, August 1995. [RFC2044] Yergeau, F., "UTF-8,the assertion has evaluated to FALSE. This result code is normally only returned by the compare operation. authMethodNotSupported (7) Indicates that authentication method or mechanism is not supported. strongAuthRequired (8) Except when returned in atransformation formatNotice ofUnicode and ISO 10646", RFC 2044, October 1996. [RFC2119] Bradner, S., "Key words for use in RFCsDisconnect (see section 4.4.1), this indicates that the server requires the client toIndicate Requirement Levels", RFC 2119, March 1997. [RFC2222] Meyers, J., "Simple Authentication and Security Layer", RFC 2222, October 1997.authentication using a strong(er) mechanism. referral (10) Indicates that a referral needs to be chased to complete the operation (see section 4.1.11). adminLimitExceeded (11) Indicates that an admnistrative limit has been exceeded. unavailableCriticalExtension (12) Indicates that server cannot perform a critical extension (see section 4.1.12). confidentialityRequired (13) Indicates that data confidentiality protections are required. saslBindInProgress (14) Indicates the server requires the client to send a new bind request, with the same sasl mechanism, to continue the authentication process (see section 4.2). noSuchAttribute (16) Indicates that the named entry does not contain the specified attribute or attribute value. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page3836 Lightweight Directory Access Protocol Version 3[RFC2234] Crocker, D., and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", RFC 2234, November 1997. [RFC2252] Wahl, M., Coulbeck, A., Howes, T., and S. Kille, "Lightweight Directory Access Protocol (v3): Attribute Syntax Definitions", RFC 2252, December 1997. [RFC2253] Kille, S., Wahl, M., and T. Howes, "Lightweight Directory Access Protocol (v3): UTF-8 String Representation of Distinguished Names", RFC 2253, December 1997. [RFC2255] Howes, T., and M. Smith, "The LDAP URL Format", RFC 2255, December 1997. [RFC2396] Berners-Lee, T., Fielding, R., and L. Masinter Uniform Resource Identifiers (URI): Generic Syntax", RFC 2396, August 1998. [RFC2829] Wahl, M., Alvestrand, H., Hodges, J., and R. Morgan, "Authentication Methods for LDAP", RFC 2829, May 2000 [RFC2830] Hodges, J., Morgan, R., and M. Wahl "Lightweight Directory Access Protocol (v3): Extension for Transport Layer Security", RFC 2830, May 2000 10. Editor's Address Jim Sermersheim Novell, Inc. 1800 South Novell Place Provo, Utah 84606, USA jimse@novell.com +1 801 861-3088undefinedAttributeType (17) Indicates that a request field contains an undefined attribute type. inappropriateMatching (18) Indicates that a request cannot be completed due to an inappropriate matching. constraintViolation (19) Indicates that the client supplied an attribute value which does not conform to constraints placed upon it by the data model. For example, this code is returned when the multiple values are supplied to an attribute which has a SINGLE-VALUE constraint. attributeOrValueExists (20) Indicates that the client supplied an attribute or value to be added to an entry already exists. invalidAttributeSyntax (21) Indicates that a purported attribute value does not conform to the syntax of the attribute. noSuchObject (32) Indicates that the object does not exist in the DIT. aliasProblem (33) Indicates that an alias problem has occurred. invalidDNSyntax (34) Indicates that a LDAPDN or RelativeLDAPDN field (e.g. search base, target entry, ModifyDN newrdn, etc.) of a request does not conform to the required syntax or contains attribute values which do not conform to the syntax of the attribute's type. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page3937 Lightweight Directory Access Protocol Version 3Appendix A - Complete ASN.1 Definition Lightweight-Directory-Access-Protocol-V3 DEFINITIONS IMPLICIT TAGS ::= BEGIN LDAPMessage ::= SEQUENCE { messageID MessageID, protocolOp CHOICE { bindRequest BindRequest, bindResponse BindResponse, unbindRequest UnbindRequest, searchRequest SearchRequest, searchResEntry SearchResultEntry, searchResDone SearchResultDone, searchResRef SearchResultReference, modifyRequest ModifyRequest, modifyResponse ModifyResponse, addRequest AddRequest, addResponse AddResponse, delRequest DelRequest, delResponse DelResponse, modDNRequest ModifyDNRequest, modDNResponse ModifyDNResponse, compareRequest CompareRequest, compareResponse CompareResponse, abandonRequest AbandonRequest, extendedReq ExtendedRequest, extendedResp ExtendedResponse }, controls [0] Controls OPTIONAL } MessageID ::= INTEGER (0 .. maxInt) maxInt INTEGER ::= 2147483647 -- (2^^31aliasDereferencingProblem (36) Indicates that a problem in dereferencing an alias. inappropriateAuthentication (48) Indicates the server requires the client which had attempted to bind anonymously or without supplying credentials to provide some form of credentials, invalidCredentials (49) Indicates the supplied credentials are invalid. insufficientAccessRights (50) Indicates that the client does not have sufficient access rights to perform the operation. busy (51) Indicates that the server is busy. unavailable (52) Indicates that the server is shutting down or a subsystem necessary to complete the operation is offline. unwillingToPerform (53) Indicates that the server is unwilling to perform the operation. loopDetect (54) Indicates that the server has detected an internal loop. namingViolation (64) Indicates that the entry name violates naming restrictions. objectClassViolation (65) Indicates that the entry violates object class restrictions. Sermersheim Internet-Draft -1) -- LDAPString ::= OCTET STRING LDAPOID ::= OCTET STRING LDAPDN ::= LDAPString RelativeLDAPDN ::= LDAPString AttributeType ::= LDAPString AttributeDescription ::= LDAPString AttributeDescriptionList ::= SEQUENCE OF AttributeDescription AttributeValue ::= OCTET STRING AttributeValueAssertion ::= SEQUENCE {Expires Sep 2002 Page 38 Lightweight Directory Access Protocol Version 3 notAllowedOnNonLeaf (66) Indicates that operation is inappropriately acting upon a non-leaf entry. notAllowedOnRDN (67) Indicates that the operation is inappropriately attempting to remove a value which forms the entry's relative distinguished name. entryAlreadyExists (68) Indicates that the request cannot be added fulfilled as the entry already exists. objectClassModsProhibited (69) Indicates that the attempt to modify the object class(es) of an entry objectClass attribute is prohibited. For example, this code is returned when a when a client attempts to modify the structural object class of an entry. affectsMultipleDSAs (71) Indicates that the operation cannot be completed as it affects multiple servers (DSAs). other (80) Indicates the server has encountered an internal error. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page4039 Lightweight Directory Access Protocol Version 3attributeDesc AttributeDescription,Appendix B - Complete ASN.1 Definition This appendix is normative. Lightweight-Directory-Access-Protocol-V3 DEFINITIONS IMPLICIT TAGS EXTENSIBILITY IMPLIED ::= BEGIN LDAPMessage ::= SEQUENCE { messageID MessageID, protocolOp CHOICE { bindRequest BindRequest, bindResponse BindResponse, unbindRequest UnbindRequest, searchRequest SearchRequest, searchResEntry SearchResultEntry, searchResDone SearchResultDone, searchResRef SearchResultReference, modifyRequest ModifyRequest, modifyResponse ModifyResponse, addRequest AddRequest, addResponse AddResponse, delRequest DelRequest, delResponse DelResponse, modDNRequest ModifyDNRequest, modDNResponse ModifyDNResponse, compareRequest CompareRequest, compareResponse CompareResponse, abandonRequest AbandonRequest, extendedReq ExtendedRequest, extendedResp ExtendedResponse }, controls [0] Controls OPTIONAL } MessageID ::= INTEGER (0 .. maxInt) maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- LDAPString ::= OCTET STRING -- UTF-8 encoded, -- [ISO10646] characters LDAPOID ::= OCTET STRING -- Constrained to numericoid [Models] LDAPDN ::= LDAPString RelativeLDAPDN ::= LDAPString AttributeDescription ::= LDAPString -- Constrained to attributedescription -- [Models] AttributeDescriptionList ::= SEQUENCE OF AttributeDescription Sermersheim Internet-Draft - Expires Sep 2002 Page 40 Lightweight Directory Access Protocol Version 3 AttributeValue ::= OCTET STRING AttributeValueAssertion ::= SEQUENCE { attributeDesc AttributeDescription, assertionValue AssertionValue } AssertionValue ::= OCTET STRING Attribute ::= SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } MatchingRuleId ::= LDAPString LDAPResult ::= SEQUENCE { resultCode ENUMERATED { success (0), operationsError (1), protocolError (2), timeLimitExceeded (3), sizeLimitExceeded (4), compareFalse (5), compareTrue (6), authMethodNotSupported (7), strongAuthRequired (8), -- 9 reserved -- referral (10), adminLimitExceeded (11), unavailableCriticalExtension (12), confidentialityRequired (13), saslBindInProgress (14), noSuchAttribute (16), undefinedAttributeType (17), inappropriateMatching (18), constraintViolation (19), attributeOrValueExists (20), invalidAttributeSyntax (21), -- 22-31 unused -- noSuchObject (32), aliasProblem (33), invalidDNSyntax (34), -- 35 reserved for undefined isLeaf -- aliasDereferencingProblem (36), -- 37-47 unused -- inappropriateAuthentication (48), invalidCredentials (49), insufficientAccessRights (50), busy (51), unavailable (52), unwillingToPerform (53), loopDetect (54), -- 55-63 unused -- namingViolation (64),objectClassViolation (65), notAllowedOnNonLeaf (66), notAllowedOnRDN (67), entryAlreadyExists (68),Sermersheim Internet-Draft - ExpiresJulySep 2002 Page 41 Lightweight Directory Access Protocol Version 3 objectClassViolation (65), notAllowedOnNonLeaf (66), notAllowedOnRDN (67), entryAlreadyExists (68), objectClassModsProhibited (69), -- 70 reserved for CLDAP -- affectsMultipleDSAs (71), -- 72-79 unused -- other(80)(80), ... }, -- 81-90 reserved for APIs -- matchedDN LDAPDN, errorMessage LDAPString, referral [3] Referral OPTIONAL } Referral ::= SEQUENCE OF LDAPURL LDAPURL ::= LDAPString -- limited to characters permitted in -- URLs Controls ::= SEQUENCE OF Control Control ::= SEQUENCE { controlType LDAPOID, criticality BOOLEAN DEFAULT FALSE, controlValue OCTET STRING OPTIONAL } BindRequest ::= [APPLICATION 0] SEQUENCE { version INTEGER (1 .. 127), name LDAPDN, authentication AuthenticationChoice } AuthenticationChoice ::= CHOICE { simple [0] OCTET STRING, -- 1 and 2 reserved sasl [3]SaslCredentialsSaslCredentials, ... } SaslCredentials ::= SEQUENCE { mechanism LDAPString, credentials OCTET STRING OPTIONAL } BindResponse ::= [APPLICATION 1] SEQUENCE { COMPONENTS OF LDAPResult, serverSaslCreds [7] OCTET STRING OPTIONAL } UnbindRequest ::= [APPLICATION 2] NULL SearchRequest ::= [APPLICATION 3] SEQUENCE { baseObject LDAPDN, scope ENUMERATED { baseObject (0), singleLevel (1), wholeSubtree (2) }, Sermersheim Internet-Draft - Expires Sep 2002 Page 42 Lightweight Directory Access Protocol Version 3 derefAliases ENUMERATED { neverDerefAliases (0), derefInSearching (1), derefFindingBaseObj (2), derefAlways (3) }, sizeLimit INTEGER (0 .. maxInt),Sermersheim Internet-Draft - Expires July 2002 Page 42 Lightweight Directory Access Protocol Version 3timeLimit INTEGER (0 .. maxInt), typesOnly BOOLEAN, filter Filter, attributes AttributeDescriptionList } Filter ::= CHOICE { and [0] SET SIZE (1..MAX) OF Filter, or [1] SET SIZE (1..MAX) OF Filter, not [2] Filter, equalityMatch [3] AttributeValueAssertion, substrings [4] SubstringFilter, greaterOrEqual [5] AttributeValueAssertion, lessOrEqual [6] AttributeValueAssertion, present [7] AttributeDescription, approxMatch [8] AttributeValueAssertion, extensibleMatch [9] MatchingRuleAssertion } SubstringFilter ::= SEQUENCE { type AttributeDescription, -- at least one must be present, -- initial and final can occur at most once substrings SEQUENCE OF CHOICE { initial [0] AssertionValue, any [1] AssertionValue, final [2] AssertionValue } } MatchingRuleAssertion ::= SEQUENCE { matchingRule [1] MatchingRuleId OPTIONAL, type [2] AttributeDescription OPTIONAL, matchValue [3] AssertionValue, dnAttributes [4] BOOLEAN DEFAULT FALSE } SearchResultEntry ::= [APPLICATION 4] SEQUENCE { objectName LDAPDN, attributes PartialAttributeList } PartialAttributeList ::= SEQUENCE OF SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } SearchResultReference ::= [APPLICATION 19] SEQUENCE OF LDAPURL SearchResultDone ::= [APPLICATION 5] LDAPResult ModifyRequest ::= [APPLICATION 6] SEQUENCE { object LDAPDN, modification SEQUENCE OF SEQUENCE { operation ENUMERATED { Sermersheim Internet-Draft - Expires Sep 2002 Page 43 Lightweight Directory Access Protocol Version 3 add (0), delete (1), replace (2) }, modification AttributeTypeAndValues } } AttributeTypeAndValues ::= SEQUENCE {Sermersheim Internet-Draft - Expires July 2002 Page 43 Lightweight Directory Access Protocol Version 3type AttributeDescription, vals SET OF AttributeValue } ModifyResponse ::= [APPLICATION 7] LDAPResult AddRequest ::= [APPLICATION 8] SEQUENCE { entry LDAPDN, attributes AttributeList } AttributeList ::= SEQUENCE OF SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } AddResponse ::= [APPLICATION 9] LDAPResult DelRequest ::= [APPLICATION 10] LDAPDN DelResponse ::= [APPLICATION 11] LDAPResult ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { entry LDAPDN, newrdn RelativeLDAPDN, deleteoldrdn BOOLEAN, newSuperior [0] LDAPDN OPTIONAL } ModifyDNResponse ::= [APPLICATION 13] LDAPResult CompareRequest ::= [APPLICATION 14] SEQUENCE { entry LDAPDN, ava AttributeValueAssertion } CompareResponse ::= [APPLICATION 15] LDAPResult AbandonRequest ::= [APPLICATION 16] MessageID ExtendedRequest ::= [APPLICATION 23] SEQUENCE { requestName [0] LDAPOID, requestValue [1] OCTET STRING OPTIONAL } ExtendedResponse::= [APPLICATION 24] SEQUENCE { COMPONENTS OF LDAPResult, responseName [10] LDAPOID OPTIONAL, response [11] OCTET STRING OPTIONAL } END::= [APPLICATION 24] SEQUENCE { COMPONENTS OF LDAPResult, responseName [10] LDAPOID OPTIONAL, response [11] OCTET STRING OPTIONAL } END Sermersheim Internet-Draft - Expires Sep 2002 Page 44 Lightweight Directory Access Protocol Version 3 Appendix C - Change History C.1 Changes made to RFC 2251: C.1.1 Editorial - Bibliography References: Changed all bibliography references to use a long name form for readability. - Changed occurrences of "unsupportedCriticalExtension" "unavailableCriticalExtension" - Fixed a small number of misspellings (mostly dropped letters). C.1.2 Section 1 - Removed IESG note. C.1.3 Section 9 - Added references to RFCs 1823, 2234, 2829 and 2830. C.2 Changes made to draft-ietf-ldapbis-protocol-00.txt: C.2.1 Section 4.1.6 - In the first paragraph, clarified what the contents of an AttributeValue are. There was confusion regarding whether or not an AttributeValue that is BER encoded (due to the "binary" option) is to be wrapped in an extra OCTET STRING. - To the first paragraph, added wording that doesn't restrict other transfer encoding specifiers from being used. The previous wording only allowed for the string encoding and the ;binary encoding. - To the first paragraph, added a statement restricting multiple options that specify transfer encoding from being present. This was never specified in the previous version and was seen as a potential interoperability problem. - Added a third paragraph stating that the ;binary option is currently the only option defined that specifies the transfer encoding. This is for completeness. C.2.2 Section 4.1.7 - Generalized the second paragraph to read "If an option specifying the transfer encoding is present in attributeDesc, the AssertionValue is encoded as specified by the option...". Previously, only the ;binary option was mentioned. C.2.3 Sections 4.2, 4.9, 4.10 - Added alias dereferencing specifications. In the case of modDN, followed precedent set on other update operations (... alias is not dereferenced...) In the case of bind and compare stated that servers SHOULD NOT dereference aliases. Specifications were added because they were missing from the previous version and caused Sermersheim Internet-Draft - Expires Sep 2002 Page 45 Lightweight Directory Access Protocol Version 3 interoperability problems. Concessions were made for bind and compare (neither should have ever allowed alias dereferencing) by using SHOULD NOT language, due to the behavior of some existing implementations. C.2.4 Sections 4.5 and Appendix A - Changed SubstringFilter.substrings.initial, any, and all from LDAPString to AssertionValue. This was causing an incompatibility with X.500 and confusion among other TS RFCs. C.3 Changes made to draft-ietf-ldapbis-protocol-01.txt: C.3.1 Section 3.4 - Reworded text surrounding subschemaSubentry to reflect that it is a single-valued attribute that holds the schema for the root DSE. Also noted that if the server masters entries that use differing schema, each entry's subschemaSubentry attribute must be interrogated. This may change as further fine-tuning is done to the data model. C.3.2 Section 4.1.12 - Specified that the criticality field is only used for requests and not for unbind or abandon. Noted that it is ignored for all other operations. C.3.3 Section 4.2 - Noted that Server behavior is undefined when the name is a null value, simple authentication is used, and a password is specified. C.3.4 Section 4.2.(various) - Changed "unauthenticated" to "anonymous" and "DN" and "LDAPDN" to "name" C.3.5 Section 4.2.2 - Changed "there is no authentication or encryption being performed by a lower layer" to "the underlying transport service cannot guarantee confidentiality" C.3.6 Section 4.5.2 - Removed all mention of ExtendedResponse due to lack of implementation. C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt: C.4.1 Section 4 Sermersheim Internet-Draft - ExpiresJulySep 2002 Page4446 Lightweight Directory Access Protocol Version 3Appendix B-Change History B.1 Changes made to RFC 2251: B.1.1 EditorialRemoved "typically" from "and is typically transferred" in the first paragraph. We know of no (and can conceive of no) case where this isn't true. -Bibliography References: Changed all bibliography references to use a long name formAdded "Section 5.1 specifies how the LDAP protocol is encoded." To the first paragraph. Added this cross reference for readability. - Changedoccurrences of "unsupportedCriticalExtension" "unavailableCriticalExtension" - Fixed a small number of misspellings (mostly dropped letters). B.1.2 Section 1 - Removed IESG note. B.1.3 Section 9 - Added references"version 3 " toRFCs 1823, 2234, 2829 and 2830. B.2 Changes made"version 3 or later" in the second paragraph. This was added todraft-ietf-ldapbis-protocol-00.txt: B.2.1 Section 4.1.6clarify the original intent. -InChanged "protocol version" to "protocol versions" in thefirst paragraph, clarified whatthird paragraph. This attribute is multi-valued with thecontentsintent ofan AttributeValue are. There was confusion regarding whether orholding all supported versions, notan AttributeValue that is BER encoded (duejust one. C.4.2 Section 4.1.8 - Changed "when transferred in protocol" to "when transferred from the"binary" option) isserver tobe wrappedthe client" inan extra OCTET STRING. - Tothe firstparagraph, added wording that doesn't restrict other transfer encoding specifiers from being used. The previous wordingparagraph. This is to clarify that this behavior onlyallowed for the string encoding andhappens when attributes are being sent from the;binary encoding.server. C.4.3 Section 4.1.10 -ToChanged "servers will return responses containing fields of type LDAPResult" to "servers will return responses of LDAPResult or responses containing thefirst paragraph, added acomponents of LDAPResponse". This statementrestricting multiple options that specify transfer encodingwas incorrect and at odds with the ASN.1. The fix here reflects the original intent. - Dropped '--new' frombeing present.result codes ASN.1. Thiswas never specifiedsimplification inthe previous version and was seen as a potential interoperability problem.comments just reduces unneeded verbiage. C.4.4 Section 4.1.11 -AddedChanged "It contains athird paragraph stating thatreference to another server (or set of servers)" to "It contains one or more references to one or more servers or services" in the;binary option is currentlyfirst paragraph. This reflects theonly option definedoriginal intent and clarifies thatspecifiesthetransfer encoding. This is for completeness. B.2.2URL may point to non-LDAP services. C.4.5 Section4.1.74.1.12 -GeneralizedChanged "The server MUST be prepared" to "Implementations MUST be prepared" in thesecondeighth paragraph toread "If an option specifying the transfer encodingreflect that both client and server implementations must be able to handle this (as both parse controls). C.4.6 Section 4.4 - Changed "One unsolicited notification ispresent in attributeDesc, the AssertionValuedefined" to "One unsolicited notification (Notice of Disconnection) isencoded as specified by the option...". Previously, onlydefined" in the;binary option was mentioned. B.2.3 Sections 4.2, 4.9, 4.10third paragraph. For clarity and readability. C.4.7 Section 4.5.1 -Added alias dereferencing specifications. InChanged "checking for thecaseexistence ofmodDN, followed precedent set on other update operations (... alias is not dereferenced...) InthecaseobjectClass attribute" to "checking for the presence ofbind and compare stated that servers SHOULD NOT dereference aliases. Specifications were added because they were missing fromtheprevious version and causedobjectClass attribute" in the last paragraph. This was done as a measure of consistency (we use Sermersheim Internet-Draft - ExpiresJulySep 2002 Page4547 Lightweight Directory Access Protocol Version 3interoperability problems. Concessions were made for bindthe terms present andcompare (neither should have ever allowed alias dereferencing) by using SHOULDpresence rather than exists and existence in search filters). C.4.8 Section 4.5.3 - Changed "outstanding search operations to different servers," to "outstanding search operations" in the fifth paragraph as they may be to the same server. This is a point of clarification. C.4.9 Section 4.6 - Changed "clients MUST NOTlanguage, dueattempt to delete" to "clients MUST NOT attempt to add or delete" in thebehaviorsecond to last paragraph. - Change "using the "delete" form" to "using the "add" or "delete" form" in the second to last paragraph. C.4.10 Section 4.7 - Changed "Clients MUST NOT supply the createTimestamp or creatorsName attributes, since these will be generated automatically by the server." to "Clients MUST NOT supply NO-USER- MODIFICATION attributes such as createTimestamp or creatorsName attributes, since these are provided by the server." in the definition ofsome existing implementations. B.2.4 Sections 4.5the attributes field. This tightens the language to reflect the original intent andAppendix Ato not leave a hole in which one could interpret the two attributes mentioned as the only non- writable attributes. C.4.11 Section 4.11 - ChangedSubstringFilter.substrings.initial, any, and all from LDAPString"has been" toAssertionValue."will be" in the fourth paragraph. Thiswas causing an incompatibility with X.500 and confusion among other TS RFCs. B.3clarifies that the server will (not has) abandon the operation. C.5 Changes made todraft-ietf-ldapbis-protocol-01.txt: B.3.1draft-ietf-ldapbis-protocol-03.txt: C.5.1 Section3.43.2.1 -Reworded text surrounding subschemaSubentry to reflect that itChanged "An attribute is asingle-valuedtype with one or more associated values. The attribute type is identified by a short descriptive name and an OID (object identifier). The attribute type governs whether there can be more than one value of an attribute of thatholds the schema fortype in an entry, theroot DSE. Also noted that ifsyntax to which theserver masters entries that use differing schema, each entry's subschemaSubentry attributevalues mustbe interrogated. This may change as further fine-tuning is done toconform, thedata model. B.3.2 Section 4.1.12 - Specifiedkinds of matching which can be performed on values of thatthe criticality field is only used for requestsattribute, andnot for unbind or abandon. Noted that it is ignored for allotheroperations. B.3.3 Section 4.2 - Noted that Server behavior is undefined when the name is a null value, simple authenticationfunctions." to " An attribute isused, andapassword is specified. B.3.4 Section 4.2.(various) - Changed "unauthenticated" to "anonymous" and "DN"description (a type and"LDAPDN" to "name" B.3.5 Section 4.2.2 - Changed "there is no authenticationzero orencryption being performed by a lower layer"more options) with one or more associated values. The attribute type governs whether the attribute can have multiple values, the syntax and matching rules used to"the underlying transport service cannot guarantee confidentiality" B.3.6 Section 4.5.2 - Removed all mentionconstruct and compare values ofExtendedResponse due to lackthat attribute, and other functions. Options indicate modes ofimplementation. B.4 Changes made to draft-ietf-ldapbis-protocol-02.txt: B.4.1transfer and other functions.". This points out that an attribute consists of both the type and options. C.5.2 Section 4 Sermersheim Internet-Draft - ExpiresJulySep 2002 Page4648 Lightweight Directory Access Protocol Version 3 -Removed "typically" from "and is typically transferred" in the first paragraph. We know of no (and can conceive of no) case where this isn't true. - AddedChanged "Section 5.1 specifieshow the LDAP protocol is encoded." Tothefirst paragraph. Added this cross referenceencoding rules forreadability. - Changed "version 3 " to "version 3 or later" in the second paragraph. This was added to clarify the original intent. - Changed "protocol version" to "protocol versions" in the third paragraph. This attribute is multi-valued withtheintent of holding all supported versions, not just one. B.4.2 Section 4.1.8 - Changed "when transferred inLDAP protocol" to"when transferred from the server to the client" in"Section 5.1 specifies how thefirst paragraph. Thisprotocol isto clarify that this behavior only happens when attributes are being sent from the server. B.4.3encoded and transferred." C.5.3 Section4.1.104.1.2 -Changed "servers will return responses containing fields of type LDAPResult" to "servers will return responses of LDAPResult or responses containingAdded ABNF for thecomponentstextual representation ofLDAPResponse". This statementLDAPOID. Previously, there wasincorrect and at odds with the ASN.1. The fix here reflects the original intent. - Dropped '--new' from result codes ASN.1. This simplification in comments just reduces unneeded verbiage. B.4.4no formal BNF for this construct. C.5.4 Section4.1.114.1.4 - Changed"It contains a reference to another server (or set of servers)" to "It contains one or more references"This identifier may be written as decimal digits with components separated by periods, e.g. "2.5.4.10"" toone or more servers or services""may be written as defined by ldapOID in section 4.1.2" in thefirstsecond paragraph. Thisreflectswas done because we now have a formal BNF definition of an oid. C.5.5 Section 4.1.5 - Changed theoriginal intentBNF for AttributeDescription to ABNF. This was done for readability andclarifiesconsistency (no functional changes involved). - Changed "Options present in an AttributeDescription are never mutually exclusive." to "Options MAY be mutually exclusive. An AttributeDescription with mutually exclusive options is treated as an undefined attribute type." for clarity. It is generally understood that this is theURL may point to non-LDAP services. B.4.5 Section 4.1.12original intent, but the wording could be easily misinterpreted. - Changed"The server MUST"Any option could beprepared"associated with any AttributeType, although not all combinations may be supported by a server." to"Implementations MUST"Though any option or set of options could beprepared" inassociated with any AttributeType, theeighth paragraph to reflect that both client andserverimplementations mustsupport for certain combinations may beablerestricted by attribute type, syntaxes, or other factors.". This is tohandle this (asclarify the meaning of 'combination' (it applies bothparse controls). B.4.6 Section 4.4 - Changed "One unsolicited notification is defined"to"One unsolicited notification (Noticecombination ofDisconnection) is defined" in the third paragraph. For clarityattribute type andreadability. B.4.7options, and combination of options). It also gives examples of *why* they might be unsupported. C.5.6 Section4.5.14.1.11 - Changed"checking for the existence oftheobjectClass attribute"wording regarding 'equally capable' referrals to"checking for"If multiple URLs are present, thepresence ofclient assumes that any URL may be used to progress theobjectClass attribute" inoperation.". The previous language implied that thelast paragraph. Thisserver MUST enforce rules that it wasdone as a measurepractically incapable of. The new language highlights the original intent-- that is, that any ofconsistency (we usethe referrals may be used to progress the operation, there is no inherent 'weighting' mechanism. C.5.7 Section 4.5.1 and Appendix A - Added the comment "-- initial and final can occur at most once", to clarify this restriction. C.5.8 Section 5.1 Sermersheim Internet-Draft - ExpiresJulySep 2002 Page4749 Lightweight Directory Access Protocol Version 3 - Changed heading from "Mapping Onto BER-based Transport Services" to "Protocol Encoding". C.5.9 Section 5.2.1 - Changed "The LDAPMessage PDUs" to "The encoded LDAPMessage PDUs" to point out that theterms present and presence rather than exists and existence in search filters). B.4.8PDUs are encoded before being streamed to TCP. C.6 Changes made to draft-ietf-ldapbis-protocol-04.txt: C.6.1 Section4.5.34.5.1 and Appendix A - Changed"outstanding search operationsthe ASN.1 for the and and or choices of Filter todifferent servers,"have a lower range of 1. This was an omission in the original ASN.1 C.6.2 Various - Fixed various typo's C.7 Changes made to"outstanding search operations"draft-ietf-ldapbis-protocol-05.txt: C.7.1 Section 3.2.1 - Added "(as defined in Section 12.4.1 of [X.501])" to the fifth paragraphas they may bewhen talking about "operational attributes". This is because the term "operational attributes" is never defined. Alternately, we could drag a definition into the spec, for now, I'm just pointing to thesame server. This is a point of clarification. B.4.9reference in X.501. C.7.2 Section4.64.1.5 - Changed"clients MUST NOT attempt to delete""And is also case insensitive" to"clients MUST NOT attempt"The entire AttributeDescription is case insensitive". This is toaddclarify whether we're talking about the entire attribute description, ordelete" injust thesecond to last paragraph.options. -Change "using the "delete" form" to "usingExpounded on the"add" or "delete" form" indefinition of attribute description options. This doc now specifies a difference between transfer and tagging options and describes thesecondsemantics of each, and how and when subtyping rules apply. Now allow options tolast paragraph. B.4.10 Section 4.7 - Changed "Clients MUST NOT supply the createTimestamp or creatorsName attributes, since these willbegenerated automatically by the server."transmitted in any order but disallow any ordering semantics to"Clients MUST NOT supply NO-USER- MODIFICATION attributes such as createTimestamp or creatorsName attributes, since thesebe implied. These changes areprovided by the server." inthedefinitionresult ofthe attributes field. This tightens the languageongoing input from an engineering team designed toreflect the original intentdeal with ambiguity issues surrounding attribute options. C.7.3 Sections 4.1.5.1 and 4.1.6 - Refer tonot leave a hole in which one could interpret the two attributes mentionednon "binary" transfer encodings asthe only non- writable attributes. B.4.11 Section 4.11"native encoding" rather than "string" encoding to clarify and avoid confusion. C.8 Changes made to draft-ietf-ldapbis-protocol-05.txt: Sermersheim Internet-Draft - Expires Sep 2002 Page 50 Lightweight Directory Access Protocol Version 3 C.8.1 Title - Changed to "LDAP: The Protocol" to be consisted with other working group documents C.8.2 Abstract -Changed "has been"Moved above TOC to"will be" in the fourth paragraph. This clarifies that the server will (not has) abandon the operation. B.5 Changes madeconform todraft-ietf-ldapbis-protocol-03.txt: B.5.1 Section 3.2.1new guidelines -Changed "An attribute is a typeReworded to make consistent withone or more associated values. The attribute typeother WG documents. - Moved 2119 conventions to "Conventions" section C.8.3 Introduction - Created to conform to new guidelines C.8.4 Models - Removed section. There isidentified by a short descriptive name and an OID (object identifier). The attribute type governs whether there can be more thanonly onevalue of an attribute of that typemodel inan entry, the syntax to whichthis document (Protocol Model) C.8.5 Protocol Model - Removed antiquated paragraph: "In keeping with thevalues must conform,goal of easing thekindscosts associated with use ofmatching which can be performed on valuesthe directory, it is an objective ofthat attribute, and other functions."this protocol to" An attribute is a description (a type and zero or more options) with one or more associated values. The attribute type governs whetherminimize theattribute can have multiple values,complexity of clients so as to facilitate widespread deployment of applications capable of using thesyntaxdirectory." - Removed antiquated paragraph concerning LDAP v1 andmatching rules used to constructv2 andcompare values of that attribute,referrals. C.8.6 Data Model - Removed Section 3.2 andother functions. Options indicate modessubsections. These have been moved to [Models] C.8.7 Relationship to X.500 - Removed section. It has been moved to [Roadmap] C.8.8 Server Specific Data Requirements - Removed section. It has been moved to [Models] C.8.9 Elements oftransfer and other functions.". This points out that an attribute consistsProtocol - Added "Section 5.1 specifies how the protocol is encoded and transferred." to the end ofboththetypefirst paragraph for reference. - Reworded notes about extensibility, andoptions. B.5.2 Section 4now talk about implied extensibility and the use of ellipses in the ASN.1 Sermersheim Internet-Draft - ExpiresJulySep 2002 Page4851 Lightweight Directory Access Protocol Version 3 -Changed "Section 5.1 specifies the encoding rules for the LDAP protocol"Removed references to"Section 5.1 specifies how the protocol is encodedLDAPv2 in third andtransferred." B.5.3 Section 4.1.2 - Added ABNF for the textual representation of LDAPOID. Previously, there was no formal BNF for this construct. B.5.4 Section 4.1.4fourth paragraphs. C.8.10 Message ID -Changed "This identifier may be written as decimal digits with components separated by periods, e.g. "2.5.4.10"" to "may be written as defined by ldapOID in section 4.1.2" in theReworded secondparagraph. This was done because we nowparagraph to "The message ID of a request MUST have aformal BNF definition of an oid. B.5.5 Section 4.1.5 - Changednon-zero value different from theBNF for AttributeDescription to ABNF. This was done for readability and consistency (no functional changes involved). - Changed "Options presentvalues of any other requests outstanding inan AttributeDescription are never mutually exclusive." to "Options MAY be mutually exclusive. An AttributeDescription with mutually exclusive options is treated as an undefined attribute type." for clarity. It is generally understood thatthe LDAP session of which this message isthe original intent, but the wording could be easily misinterpreted. - Changed "Any option could be associated with any AttributeType, although not all combinations may be supported byaserver." to "Though any option or set of options could be associated with any AttributeType,part. The zero value is reserved for the unsolicited notification message." (Added notes about non-zero and theserver supportzero value). C.8.11 String Types - Removed ABNF forcertain combinations may be restricted by attribute type, syntaxes, or other factors.". ThisLDAPOID and added "Although an LDAPOID is encoded as an OCTET STRING, values are limited toclarifythemeaningdefinition of'combination' (it applies both to combinationnumericoid given in Section 1.3 ofattribute type[Models]." C.8.12 Distinguished Name andoptions,Relative Distinguished Name - Removed ABNF andcombination of options). It also gives examples of *why* they might be unsupported. B.5.6 Section 4.1.11referred to [Models] and [LDAPDN] where this is defined. C.8.13 Attribute Type -ChangedRemoved sections. It's now in thewording[Models] doc. C.8.14 Attribute Description - Removed ABNF and aligned section with [Models] - Moved AttributeDescriptionList here. C.8.15 Transfer Options - Added section and consumed much of old options language (while aligning with [Models] C.8.16 Binary Transfer Option - Clarified intent regarding'equally capable' referralsexactly what is to"If multiple URLs are present, the client assumes that any URL maybeused to progress the operation.". The previous language implied that the server MUST enforce rulesBER encoded. - Clarified that clients must not expect ;binary when not asking for itwas practically incapable of. The new language highlights the original intent-- that is, that any of the referrals may be used(;binary, as opposed toprogressber encoded data). C.8.17 Attribute - Use theoperation, there is no inherent 'weighting' mechanism. B.5.7 Section 4.5.1 and Appendix Aterm "attribute description" in lieu of "type" -AddedClarified thecomment "-- initial and final can occur at most once", to clarify this restriction. B.5.8 Section 5.1fact that clients cannot rely on any apparent ordering of attribute values. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page4952 Lightweight Directory Access Protocol Version 3 C.8.18 LDAPResult -Changed heading from "Mapping Onto BER-based Transport Services" to "Protocol Encoding". B.5.9 Section 5.2.1 - Changed "The LDAPMessage PDUs" to "The encoded LDAPMessage PDUs"To resultCode, added ellipses "..." topoint out thatthePDUs are encoded before being streamed to TCP. B.6 Changes madeenumeration todraft-ietf-ldapbis-protocol-04.txt: B.6.1 Section 4.5.1indicate extensibility. and added a note, pointing to [LDAPIANA] - Removed error groupings ad refer to AppendixAA. C.8.19 Bind Operation -ChangedAdded "Prior to theASN.1BindRequest, the implied identity is anonymous. Refer to [AuthMeth] for theand and or choicesauthentication-related semantics ofFilterthis operation." tohave a lower range of 1. This was an omission intheoriginal ASN.1 B.6.2 Various - Fixed various typo's B.7 Changes made to draft-ietf-ldapbis-protocol-05.txt: B.7.1 Section 3.2.1first paragraph. - Added"(asellipses "..." to AuthenticationChoice and added a note "This type is extensible as defined in Section12.4.13.6 of[X.501])" to the fifth paragraph when talking about "operational attributes". This is because the term "operational attributes" is never defined. Alternately, we could drag[LDAPIANA]. Servers that do not support adefinition into the spec, for now, I'm just pointing to the referencechoice supplied by a client will return authMethodNotSupported inX.501. B.7.2 Section 4.1.5 - Changed "And is also case insensitive" to "The entire AttributeDescription is case insensitive". This is to clarify whether we're talking abouttheentire attribute description, or justresult code of theoptions.BindResponse." -Expounded onSimplified text regarding how thedefinitionserver handles unknown versions. Removed references to LDAPv2 C.8.20 Sequencing ofattribute description options. This doc now specifies a difference between transfer and tagging options and describesthesemantics of each,Bind Request - Aligned with [AuthMeth] In particular, paragraphs 4 andhow6 were removed, while a portion of 4 was retained (see C.8.9) C.8.21 Authentication andwhen subtyping rules apply.other Security Service - Section was removed. Nowallow options to be transmittedinany order but disallow any ordering semantics to be implied. These changes are[AuthMeth] C.8.22 Continuation References in the Search Result - Added "If theresultoriginating search scope was singleLevel, the scope part ofongoing input from an engineering team designed to deal with ambiguity issues surrounding attribute options. B.7.3 Sections 4.1.5.1 and 4.1.6the URL will be baseObject." C.8.23 Security Considerations -ReferRemoved reference tonon "binary" transfer encodingsLDAPv2 C.8.24 Result Codes - Added as"native encoding" rather than "string" encodingnormative appendix A C.8.25 ASN.1 - Added EXTENSIBILITY IMPLIED - Added a number of comments holding referenced toclarify[Models] andavoid confusion. Appendix C[ISO10646]. -Outstanding Work ItemsRemoved AttributeType. It is not used. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page5053 Lightweight Directory Access Protocol Version 3C.1Appendix D - Outstanding Work Items D.1 Integrate result codes draft. - The result codes draft should be reconciled with this draft. Operation-specific instructions will reside with operations while the error-specific sections will be added as an appendix.C.2 Section 3.1 - Add "This also increases the complexity of clients in this version." to fourth paragraph. C.3 Section 4 - Change "MUST ignore elements of SEQUENCE encodings whose tags they do not recognize" to "MUST ignore tagged elements of SEQUENCE encodingsNote thatthey do not recognize" in the first paragraph. - Change "version 2 may not provide this attribute." to "version 2 MAY NOT provide this attribute, or a root DSE." in the third paragraph. C.4 Section 4.1.1 - Change "the client may discard the PDU, or may abruptly close the connection." to "the client MAY discard the PDU, or MAY abruptly close the connection." in the fourth paragraph. C.5 Section 4.1.1.1 - Add "If an unsolicited notification as described in section 4.4there issent fromaserver, the messageID value MUST be zero."result codes appendix now. Still need tofirst paragraph.reconcile with each operation. D.2 Verify references. -Change "MUST have a value different" to "MUSTMany referenced documents havea non-zero value different" in the second paragraph.changed. Ensure references and section numbers are correct. D.3 Usage of Naming Context - Make sure occurrences of "namingcontext" and naming context" are consistent with [Models]. D.5 Section 4.1.1.1 - Remove "or of the abandoned operation until it has received a response from the server for another request invoked subsequent to the abandonRequest," from the fourth paragraph as this imposes synchronous behavior on the server.C.7 Section 4.1.4 - Add "Note that due to the restriction above, and due to this allowance, servers MUST ensure that, within a controlling subschema, no two attributes be named the same." to the fifth paragraph. - Resolve issue on list with the subject "Attribute Type character set". C.8 Section 4.1.5 - Change "A server may treat" to "A server MUST treat" in the second to last paragraph. - Change "A server MUST treat an AttributeDescription with any options it does not implement as an unrecognized attribute type." Sermersheim Internet-Draft - Expires July 2002 Page 51 Lightweight Directory Access Protocol Version 3 to "A server MUST treat an AttributeDescription with any options it does not implement or support as an unrecognized attribute type." in the second to last paragraph. - Clarify the statement "An AttributeDescription with one or more options is treated as a subtype of the attribute type without any options". There is an unresolved thread titles "RFC 2596 questions" on the ietf-ldapext list regarding this. C.9D.9 Section4.1.5.14.1.5.2 - Add "Servers SHOULD only return attributes with printable string representations as binary when clients request binary transfer." to the second paragraph. - Clarify whether the "binary" attribute type option is to be treated as a subtype.C.10D.10 Section 4.1.6 - Change "containing an encoded value of an AttributeValue data type" to "containing an encoded attribute value data type"C.11D.11 Section 4.1.7 - Change "For all the string-valued user attributes described in [5], the assertion value syntax is the same as the value syntax." to "The assertion value syntax for all attributes using human- readable syntaxes as described in [RFC2252] is the same as the value syntax unless otherwise noted (an example being objectIdentifierFirstComponentMatch)." in the third paragraph. - Find out what the last sentence in third paragraph means (Clients may use attributes...)- Add a fourth paragraph: "Servers SHOULD NOT generate codes 81-90 as these are reserved for use by historical APIs [RFC 1823]. Later API specifications SHOULD avoid using the resultCode enumeration to represent anything other than a protocol result indication." C.13D.13 Section 4.1.11 - Add "after locating the target entry" to the first paragraph.C.14Sermersheim Internet-Draft - Expires Sep 2002 Page 54 Lightweight Directory Access Protocol Version 3 D.14 Section 4.1.12 - Specify whether or not servers are to advertise the OIDs of known response controls.C.15D.15 Section 4.2 - Change "LDAPDN" to "identity" in the definition of the name field. - Rework definition of the name field to enumerate empty password and name combinations. <Needs more work following discussion on list>C.17D.17 Section 4.2.2 - Add "as the authentication identity" to second paragraph.Sermersheim Internet-Draft - Expires July 2002 Page 52 Lightweight Directory Access Protocol Version 3 C.18D.18 Section 4.2.3 - Change "If the bind was successful, the resultCode will be success, otherwise it will be one of" to "If the bind was successful, the resultCode will be success, otherwise it MAY be one of" in the third paragraph. <May need further refinement when reconciled with resultCode draft>. - Change "operationsError" to "other" as a result code. - Change "If the client bound with the password choice" to "If the client bound with the simple choice" in the last paragraph.C.19D.19 Section 4.3 - Change "a protocol client may assume that the protocol session is terminated and MAY close the connection." to "a protocol client MUST assume that the protocol session is terminated and MAY close the connection." in the second paragraph. - Change "a protocol server may assume" to "a protocol server MUST assume" in the second paragraph. - Change "and may close the connection" to "and MUST close the connection" in the second paragraph.C.20D.20 Section 4.4 - Add "Servers SHOULD NOT assume LDAPv3 clients understand or recognize unsolicited notifications or unsolicited controls other than Notice of Disconnection defined below. Servers SHOULD avoid sending unsolicited notifications unless they know (by related request or other means) that the client can make use of the notification." as a fourth paragraph.C.21D.21 Section 4.5.1 - Make sure the use of "subordinates" in the derefInSearching definition is correct. See "derefInSearching" on list.C.22D.22 Section 4.5.2 Sermersheim Internet-Draft - Expires Sep 2002 Page 55 Lightweight Directory Access Protocol Version 3 - Add "associated with a search operation" to the sixth paragraph. - Same problem as inC.5. C.23D.5. D.23 Section 4.5.3 - Add "Similarly, a server MUST NOT return a SearchResultReference when the scope of the search is baseObject. If a client receives such a SearchResultReference it MUST interpret is as a protocol error and MUST NOT follow it." to the first paragraph. - Add "If the scope part of the LDAP URL is present, the client MUST use the new scope in its next request to progress the search. If the scope part is absent the client MUST use subtree scope to complete subtree searches and base scope to complete one level searches." to the third paragraph.Sermersheim Internet-Draft - Expires July 2002 Page 53 Lightweight Directory Access Protocol Version 3 C.24D.24 Section 4.5.3.1 - Change examples to use dc naming.C.25D.25 Section 4.6 - Resolve the meaning of "and is ignored if the attribute does not exist". See "modify: "non-existent attribute"" on the list.C.26D.26 Section 4.7 - Change examples to use dc naming. - Clarify the paragraph that talks about structure rules. See "discussing structure rules" on the list.C.27D.27 Section 4.10 - Specify what happens when the attr is missing vs. attr isn't in schema. Also what happens if there's no equality matching rule.C.28D.28 Section 4.11 - Change "(since these may have been in transit when the abandon was requested)." to "(since these may either have been in transit when the abandon was requested, or are not able to be abandoned)." in the fifth paragraph. - Add "Abandon and Unbind operations are not able to be abandoned. Other operations, in particular update operations, or operations that have been chained, may not be abandonable (or immediately abandonable)." as the sixth paragraph.C.29D.29 Section 4.12 - Change "digitally signed operations and results" to "for instance StartTLS [RFC2830]"C.30D.30 Section 5.1 Sermersheim Internet-Draft - Expires Sep 2002 Page 56 Lightweight Directory Access Protocol Version 3 - Add "control and extended operation values" to last paragraph. See "LBER (BER Restrictions)" on list.C.31D.31 Section 5.2.1 - Add "using the BER-based described in section 5.1".C.32D.32 Section 6.1 - Add "that are used by those attributes" to the first paragraph. - Add "Servers which support update operations MUST, and other servers SHOULD, support strong authentication mechanisms described in [RFC2829]." as a second paragraph. - Add "Servers which provide access to sensitive information MUST, and other servers SHOULD support privacy protections such as those described in [RFC2829] and [RFC2830]." as a third paragraph.Sermersheim Internet-Draft - Expires July 2002 Page 54 Lightweight Directory Access Protocol Version 3 C.33D.33 Section 7 - Add "Servers which support update operations MUST, and other servers SHOULD, support strong authentication mechanisms described in [RFC2829]." as a fourth paragraph. - Add "In order to automatically follow referrals, clients may need to hold authentication secrets. This poses significant privacy and security concerns and SHOULD be avoided." as a sixth paragraph. - Add "This document provides a mechanism which clients may use to discover operational attributes. Those relying on security by obscurity should implement appropriate access controls to restricts access to operational attributes per local policy." as an eighth paragraph. - Add "This document provides a mechanism which clients may use to discover operational attributes. Those relying on security by obscurity should implement appropriate access controls to restricts access to operational attributes per local policy." as an eighth paragraph. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page5557 Lightweight Directory Access Protocol Version 3 Full Copyright Statement Copyright (C) The Internet Society(2001).(2002). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Sermersheim Internet-Draft - ExpiresJulySep 2002 Page5658 ----