draft-ietf-ldapbis-protocol-17.txt   draft-ietf-ldapbis-protocol-18.txt 
Internet-Draft Editor: J. Sermersheim Internet-Draft Editor: J. Sermersheim
Intended Category: Standard Track Novell, Inc Intended Category: Standard Track Novell, Inc
Document: draft-ietf-ldapbis-protocol-17.txt Sep 2003 Document: draft-ietf-ldapbis-protocol-18.txt Oct 2003
Obsoletes: RFC 2251 Obsoletes: RFC 2251
LDAP: The Protocol LDAP: The Protocol
Status of this Memo Status of this Memo
This document is an Internet-Draft and is in full conformance with This document is an Internet-Draft and is in full conformance with
all provisions of Section 10 of RFC2026. all provisions of Section 10 of RFC2026.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
skipping to change at line 36 skipping to change at line 36
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
Distribution of this memo is unlimited. Technical discussion of this Distribution of this memo is unlimited. Technical discussion of this
document will take place on the IETF LDAP Revision Working Group document will take place on the IETF LDAP Revision Working Group
(LDAPbis) mailing list <ietf-ldapbis@openldap.org>. Please send (LDAPbis) mailing list <ietf-ldapbis@openldap.org>. Please send
editorial comments directly to the editor <jimse@novell.com>. editorial comments directly to the editor <jimse@novell.com>.
Abstract Abstract
This document describes the protocol elements, along with their This document describes the protocol elements, along with their
semantics and encodings, for the Lightweight Directory Access semantics and encodings, of the Lightweight Directory Access Protocol
Protocol (LDAP). LDAP provides access to distributed directory (LDAP). LDAP provides access to distributed directory services that
services that act in accordance with X.500 data and service models. act in accordance with X.500 data and service models. These protocol
These protocol elements are based on those described in the X.500 elements are based on those described in the X.500 Directory Access
Directory Access Protocol (DAP). Protocol (DAP).
Table of Contents Table of Contents
1. Introduction....................................................3 1. Introduction....................................................3
2. Conventions.....................................................3 2. Conventions.....................................................3
3. Protocol Model..................................................3 3. Protocol Model..................................................3
4. Elements of Protocol............................................4 4. Elements of Protocol............................................4
4.1. Common Elements...............................................4 4.1. Common Elements...............................................4
4.1.1. Message Envelope............................................4 4.1.1. Message Envelope............................................4
4.1.2. String Types................................................6 4.1.2. String Types................................................6
4.1.3. Distinguished Name and Relative Distinguished Name..........6 4.1.3. Distinguished Name and Relative Distinguished Name..........6
Sermersheim Internet-Draft - Expires Mar 2004 Page 1 Sermersheim Internet-Draft - Expires Apr 2004 Page 1
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
4.1.4. Attribute Descriptions......................................7 4.1.4. Attribute Descriptions......................................7
4.1.5. Attribute Value.............................................7 4.1.5. Attribute Value.............................................7
4.1.6. Attribute Value Assertion...................................7 4.1.6. Attribute Value Assertion...................................7
4.1.7. Attribute...................................................8 4.1.7. Attribute...................................................8
4.1.8. Matching Rule Identifier....................................8 4.1.8. Matching Rule Identifier....................................8
4.1.9. Result Message..............................................8 4.1.9. Result Message..............................................8
4.1.10. Referral..................................................10 4.1.10. Referral..................................................10
4.1.11. Controls..................................................11 4.1.11. Controls..................................................11
4.2. Bind Operation...............................................12 4.2. Bind Operation...............................................12
4.3. Unbind Operation.............................................15 4.3. Unbind Operation.............................................15
4.4. Unsolicited Notification.....................................15 4.4. Unsolicited Notification.....................................15
4.5. Search Operation.............................................16 4.5. Search Operation.............................................16
4.6. Modify Operation.............................................24 4.6. Modify Operation.............................................24
4.7. Add Operation................................................25 4.7. Add Operation................................................26
4.8. Delete Operation.............................................26 4.8. Delete Operation.............................................26
4.9. Modify DN Operation..........................................27 4.9. Modify DN Operation..........................................27
4.10. Compare Operation...........................................28 4.10. Compare Operation...........................................28
4.11. Abandon Operation...........................................29 4.11. Abandon Operation...........................................29
4.12. Extended Operation..........................................30 4.12. Extended Operation..........................................29
4.13. Start TLS Operation.........................................31 4.13. Start TLS Operation.........................................31
5. Protocol Element Encodings and Transfer........................33 5. Protocol Element Encodings and Transfer........................33
5.1. Protocol Encoding............................................33 5.1. Protocol Encoding............................................33
5.2. Transfer Protocols...........................................33 5.2. Transfer Protocols...........................................33
6. Implementation Guidelines......................................33 6. Implementation Guidelines......................................33
6.1. Server Implementations.......................................34 6.1. Server Implementations.......................................33
6.2. Client Implementations.......................................34 6.2. Client Implementations.......................................34
7. Security Considerations........................................34 7. Security Considerations........................................34
8. Acknowledgements...............................................35 8. Acknowledgements...............................................35
9. Normative References...........................................35 9. Normative References...........................................35
10. Informative References........................................37 10. Informative References........................................37
11. IANA Considerations...........................................37 11. IANA Considerations...........................................37
12. Editor's Address..............................................37 12. Editor's Address..............................................37
Appendix A - LDAP Result Codes....................................38 Appendix A - LDAP Result Codes....................................38
A.1 Non-Error Result Codes........................................38 A.1 Non-Error Result Codes........................................38
A.2 Result Codes..................................................38 A.2 Result Codes..................................................38
Appendix C - Change History.......................................49 Appendix C - Change History.......................................47
C.1 Changes made to RFC 2251:.....................................49 C.1 Changes made to RFC 2251:.....................................47
C.2 Changes made to draft-ietf-ldapbis-protocol-00.txt:...........49 C.2 Changes made to draft-ietf-ldapbis-protocol-00.txt:...........47
C.3 Changes made to draft-ietf-ldapbis-protocol-01.txt:...........50 C.3 Changes made to draft-ietf-ldapbis-protocol-01.txt:...........48
C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt:...........50 C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt:...........48
C.5 Changes made to draft-ietf-ldapbis-protocol-03.txt:...........52 C.5 Changes made to draft-ietf-ldapbis-protocol-03.txt:...........50
C.6 Changes made to draft-ietf-ldapbis-protocol-04.txt:...........54 C.6 Changes made to draft-ietf-ldapbis-protocol-04.txt:...........52
C.7 Changes made to draft-ietf-ldapbis-protocol-05.txt:...........54 C.7 Changes made to draft-ietf-ldapbis-protocol-05.txt:...........52
C.8 Changes made to draft-ietf-ldapbis-protocol-06.txt:...........55 C.8 Changes made to draft-ietf-ldapbis-protocol-06.txt:...........53
C.9 Changes made to draft-ietf-ldapbis-protocol-07.txt:...........58 C.9 Changes made to draft-ietf-ldapbis-protocol-07.txt:...........56
C.10 Changes made to draft-ietf-ldapbis-protocol-08.txt:..........58 C.10 Changes made to draft-ietf-ldapbis-protocol-08.txt:..........56
C.11 Changes made to draft-ietf-ldapbis-protocol-09.txt:..........58 C.11 Changes made to draft-ietf-ldapbis-protocol-09.txt:..........56
C.12 Changes made to draft-ietf-ldapbis-protocol-10.txt:..........58 C.12 Changes made to draft-ietf-ldapbis-protocol-10.txt:..........56
C.13 Changes made to draft-ietf-ldapbis-protocol-11.txt:..........59 C.13 Changes made to draft-ietf-ldapbis-protocol-11.txt:..........57
C.14 Changes made to draft-ietf-ldapbis-protocol-12.txt:..........59 C.14 Changes made to draft-ietf-ldapbis-protocol-12.txt:..........57
C.15 Changes made to draft-ietf-ldapbis-protocol-13.txt...........59 C.15 Changes made to draft-ietf-ldapbis-protocol-13.txt...........57
C.16 Changes made to draft-ietf-ldapbis-protocol-14.txt...........60 C.16 Changes made to draft-ietf-ldapbis-protocol-14.txt...........58
C.17 Changes made to draft-ietf-ldapbis-protocol-15.txt...........62 C.17 Changes made to draft-ietf-ldapbis-protocol-15.txt...........60
C.18 Changes made to draft-ietf-ldapbis-protocol-16.txt...........62 C.18 Changes made to draft-ietf-ldapbis-protocol-16.txt...........60
Sermersheim Internet-Draft - Expires Mar 2004 Page 2 Sermersheim Internet-Draft - Expires Apr 2004 Page 2
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
Appendix D - Outstanding Work Items...............................63 C.19 Changes made to draft-ietf-ldapbis-protocol-17.txt...........61
1. Introduction 1. Introduction
The Directory is "a collection of open systems cooperating to provide The Directory is "a collection of open systems cooperating to provide
directory services" [X.500]. A Directory user, which may be a human directory services" [X.500]. A directory user, which may be a human
or other entity, accesses the Directory through a client (or or other entity, accesses the Directory through a client (or
Directory User Agent (DUA)). The client, on behalf of the directory Directory User Agent (DUA)). The client, on behalf of the directory
user, interacts with one or more servers (or Directory System Agents user, interacts with one or more servers (or Directory System Agents
(DSA)). Clients interact with servers using a directory access (DSA)). Clients interact with servers using a directory access
protocol. protocol.
This document details the protocol elements of Lightweight Directory This document details the protocol elements of the Lightweight
Access Protocol, along with their semantics. Following the Directory Access Protocol (LDAP), along with their semantics.
description of protocol elements, it describes the way in which the Following the description of protocol elements, it describes the way
protocol is encoded and transferred. in which the protocol elements are encoded and transferred.
This document is an integral part of the LDAP Technical Specification This document is an integral part of the LDAP Technical Specification
[Roadmap]. [Roadmap].
This document replaces RFC 2251. Appendix C holds a detailed log of This document replaces RFC 2251. Appendix C holds a detailed log of
changes to RFC 2251. Prior to Working Group Last Call, this appendix changes to RFC 2251. After Working Group Last Call, this appendix
will be distilled to a summary of changes to RFC 2251. will be distilled to a summary of changes to RFC 2251.
2. Conventions 2. Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", and "MAY" in this document are "SHOULD", "SHOULD NOT", "RECOMMENDED", and "MAY" in this document are
to be interpreted as described in [RFC2119]. to be interpreted as described in [Keyword].
The terms "connection" and "LDAP connection" both refer to the The terms "connection" and "LDAP connection" both refer to the
underlying transport protocol connection between two protocol peers. underlying transport protocol connection between two protocol peers.
The term "TLS connection" refers to a TLS-protected LDAP connection. The term "TLS connection" refers to a TLS-protected LDAP connection.
The terms "association" and "LDAP association" both refer to the The terms "association" and "LDAP association" both refer to the
association of the LDAP connection and its current authentication and association of the LDAP connection and its current authentication and
authorization state. authorization state.
3. Protocol Model 3. Protocol Model
The general model adopted by this protocol is one of clients The general model adopted by this protocol is one of clients
performing protocol operations against servers. In this model, a performing protocol operations against servers. In this model, a
client transmits a protocol request describing the operation to be client transmits a protocol request describing the operation to be
performed to a server. The server is then responsible for performing performed to a server. The server is then responsible for performing
skipping to change at line 156 skipping to change at line 159
The terms "association" and "LDAP association" both refer to the The terms "association" and "LDAP association" both refer to the
association of the LDAP connection and its current authentication and association of the LDAP connection and its current authentication and
authorization state. authorization state.
3. Protocol Model 3. Protocol Model
The general model adopted by this protocol is one of clients The general model adopted by this protocol is one of clients
performing protocol operations against servers. In this model, a performing protocol operations against servers. In this model, a
client transmits a protocol request describing the operation to be client transmits a protocol request describing the operation to be
performed to a server. The server is then responsible for performing performed to a server. The server is then responsible for performing
the necessary operation(s) in the directory. Upon completion of the the necessary operation(s) in the Directory. Upon completion of the
operation(s), the server returns a response containing an appropriate operation(s), the server returns a response containing an appropriate
result code to the requesting client. result code to the requesting client.
Sermersheim Internet-Draft - Expires Apr 2004 Page 3
Lightweight Directory Access Protocol Version 3
Although servers are required to return responses whenever such Although servers are required to return responses whenever such
responses are defined in the protocol, there is no requirement for responses are defined in the protocol, there is no requirement for
synchronous behavior on the part of either clients or servers. synchronous behavior on the part of either clients or servers.
Requests and responses for multiple operations may be exchanged Requests and responses for multiple operations may be exchanged
Sermersheim Internet-Draft - Expires Mar 2004 Page 3
Lightweight Directory Access Protocol Version 3
between a client and server in any order, provided the client between a client and server in any order, provided the client
eventually receives a response for every request that requires one. eventually receives a response for every request that requires one.
The core protocol operations defined in this document can be mapped The core protocol operations defined in this document can be mapped
to a subset of the X.500 (1997) directory abstract service. However to a subset of the X.500 (1993) Directory Abstract Service. However
there is not a one-to-one mapping between LDAP protocol operations there is not a one-to-one mapping between LDAP protocol operations
and DAP operations. Server implementations acting as a gateway to and X.500 Directory Access Protocol (DAP) operations. Server
X.500 directories may need to make multiple DAP requests. implementations acting as a gateway to X.500 directories may need to
make multiple DAP requests to service a single LDAP request.
4. Elements of Protocol 4. Elements of Protocol
The LDAP protocol is described using Abstract Syntax Notation 1 The LDAP protocol is described using Abstract Syntax Notation One
(ASN.1) [X.680], and is transferred using a subset of ASN.1 Basic [ASN.1], and is transferred using a subset of ASN.1 Basic Encoding
Encoding Rules [X.690]. Section 5.1 specifies how the protocol is Rules [BER]. Section 5.1 specifies how the protocol elements are
encoded and transferred. encoded and transferred.
In order to support future Standards Track extensions to this In order to support future Standards Track extensions to this
protocol, extensibility is implied where it is allowed (per ASN.1). protocol, extensibility is implied where it is allowed (per ASN.1).
In addition, ellipses (...) have been supplied in ASN.1 types that In addition, ellipses (...) have been supplied in ASN.1 types that
are explicitly extensible as discussed in [LDAPIANA]. Because of the are explicitly extensible as discussed in [LDAPIANA]. Because of the
implied extensibility, clients and servers MUST (unless otherwise implied extensibility, clients and servers MUST (unless otherwise
specified) ignore trailing SEQUENCE elements whose tags they do not specified) ignore trailing SEQUENCE components whose tags they do not
recognize. recognize.
Changes to the LDAP protocol other than through the extension Changes to the LDAP protocol other than through the extension
mechanisms described here require a different version number. A mechanisms described here require a different version number. A
client indicates the version it is using as part of the bind request, client indicates the version it is using as part of the bind request,
described in section 4.2. If a client has not sent a bind, the server described in section 4.2. If a client has not sent a bind, the server
MUST assume the client is using version 3 or later. MUST assume the client is using version 3 or later.
Clients may determine the protocol versions a server supports by Clients may determine the protocol versions a server supports by
reading the supportedLDAPVersion attribute from the root DSE reading the supportedLDAPVersion attribute from the root DSE (DSA-
[Models]. Servers which implement version 3 or later MUST provide Specific Entry) [Models]. Servers which implement version 3 or later
this attribute. MUST provide this attribute.
4.1. Common Elements 4.1. Common Elements
This section describes the LDAPMessage envelope PDU (Protocol Data This section describes the LDAPMessage envelope PDU (Protocol Data
Unit) format, as well as data type definitions, which are used in the Unit) format, as well as data type definitions, which are used in the
protocol operations. protocol operations.
4.1.1. Message Envelope 4.1.1. Message Envelope
For the purposes of protocol exchanges, all protocol operations are For the purposes of protocol exchanges, all protocol operations are
encapsulated in a common envelope, the LDAPMessage, which is defined encapsulated in a common envelope, the LDAPMessage, which is defined
as follows: as follows:
Sermersheim Internet-Draft - Expires Apr 2004 Page 4
Lightweight Directory Access Protocol Version 3
LDAPMessage ::= SEQUENCE { LDAPMessage ::= SEQUENCE {
messageID MessageID, messageID MessageID,
protocolOp CHOICE { protocolOp CHOICE {
bindRequest BindRequest, bindRequest BindRequest,
Sermersheim Internet-Draft - Expires Mar 2004 Page 4
Lightweight Directory Access Protocol Version 3
bindResponse BindResponse, bindResponse BindResponse,
unbindRequest UnbindRequest, unbindRequest UnbindRequest,
searchRequest SearchRequest, searchRequest SearchRequest,
searchResEntry SearchResultEntry, searchResEntry SearchResultEntry,
searchResDone SearchResultDone, searchResDone SearchResultDone,
searchResRef SearchResultReference, searchResRef SearchResultReference,
modifyRequest ModifyRequest, modifyRequest ModifyRequest,
modifyResponse ModifyResponse, modifyResponse ModifyResponse,
addRequest AddRequest, addRequest AddRequest,
addResponse AddResponse, addResponse AddResponse,
skipping to change at line 257 skipping to change at line 259
maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) --
The function of the LDAPMessage is to provide an envelope containing The function of the LDAPMessage is to provide an envelope containing
common fields required in all protocol exchanges. At this time the common fields required in all protocol exchanges. At this time the
only common fields are the message ID and the controls. only common fields are the message ID and the controls.
If the server receives a PDU from the client in which the LDAPMessage If the server receives a PDU from the client in which the LDAPMessage
SEQUENCE tag cannot be recognized, the messageID cannot be parsed, SEQUENCE tag cannot be recognized, the messageID cannot be parsed,
the tag of the protocolOp is not recognized as a request, or the the tag of the protocolOp is not recognized as a request, or the
encoding structures or lengths of data fields are found to be encoding structures or lengths of data fields are found to be
incorrect, then the server MAY return the Notice of Disconnection incorrect, then the server SHOULD return the Notice of Disconnection
described in section 4.4.1, with the resultCode set to protocolError, described in section 4.4.1, with the resultCode set to protocolError,
and MUST immediately close the connection. and MUST immediately close the connection.
In other cases where the client or server cannot parse a PDU, it In other cases where the client or server cannot parse a PDU, it
SHOULD abruptly close the connection where further communication SHOULD abruptly close the connection where further communication
(including providing notice) would be pernicious. Otherwise, server (including providing notice) would be pernicious. Otherwise, server
implementations MUST return an appropriate response to the request, implementations MUST return an appropriate response to the request,
with the resultCode set to protocolError. with the resultCode set to protocolError.
The ASN.1 type Controls is defined in section 4.1.11. The ASN.1 type Controls is defined in section 4.1.11.
4.1.1.1. Message ID 4.1.1.1. Message ID
Sermersheim Internet-Draft - Expires Apr 2004 Page 5
Lightweight Directory Access Protocol Version 3
All LDAPMessage envelopes encapsulating responses contain the All LDAPMessage envelopes encapsulating responses contain the
messageID value of the corresponding request LDAPMessage. messageID value of the corresponding request LDAPMessage.
The message ID of a request MUST have a non-zero value different from The message ID of a request MUST have a non-zero value different from
the values of any other requests outstanding in the LDAP association the values of any other requests outstanding in the LDAP association
Sermersheim Internet-Draft - Expires Mar 2004 Page 5
Lightweight Directory Access Protocol Version 3
of which this message is a part. The zero value is reserved for the of which this message is a part. The zero value is reserved for the
unsolicited notification message. unsolicited notification message.
Typical clients increment a counter for each request. Typical clients increment a counter for each request.
A client MUST NOT send a request with the same message ID as an A client MUST NOT send a request with the same message ID as an
earlier request on the same LDAP association unless it can be earlier request on the same LDAP association unless it can be
determined that the server is no longer servicing the earlier determined that the server is no longer servicing the earlier
request. Otherwise the behavior is undefined. For operations that do request. Otherwise the behavior is undefined. For operations that do
not return responses (unbind, abandon, and abandoned operations), the not return responses (unbind, abandon, and abandoned operations), the
client SHOULD assume the operation is in progress until a subsequent client SHOULD assume the operation is in progress until a subsequent
bind request completes. bind request completes.
4.1.2. String Types 4.1.2. String Types
The LDAPString is a notational convenience to indicate that, although The LDAPString is a notational convenience to indicate that, although
strings of LDAPString type encode as OCTET STRING types, the strings of LDAPString type encode as OCTET STRING types, the
[ISO10646] character set (a superset of [Unicode]) is used, encoded [ISO10646] character set (a superset of [Unicode]) is used, encoded
following the UTF-8 algorithm [RFC2279]. Note that in the UTF-8 following the [UTF-8] algorithm. Note that Unicode characters U+0000
algorithm characters which are the same as ASCII (0x0000 through through U+007F are the same as ASCII 0 through 127, respectively, and
0x007F) are represented as that same ASCII character in a single have the same single octet UTF-8 encoding. Other Unicode characters
byte. The other byte values are used to form a variable-length have a multiple octet UTF-8 encoding.
encoding of an arbitrary character.
LDAPString ::= OCTET STRING -- UTF-8 encoded, LDAPString ::= OCTET STRING -- UTF-8 encoded,
-- ISO 10646 characters -- [ISO10646] characters
The LDAPOID is a notational convenience to indicate that the The LDAPOID is a notational convenience to indicate that the
permitted value of this string is a (UTF-8 encoded) dotted-decimal permitted value of this string is a (UTF-8 encoded) dotted-decimal
representation of an OBJECT IDENTIFIER. Although an LDAPOID is representation of an OBJECT IDENTIFIER. Although an LDAPOID is
encoded as an OCTET STRING, values are limited to the definition of encoded as an OCTET STRING, values are limited to the definition of
numericoid given in Section 1.3 of [Models]. <numericoid> given in Section 1.3 of [Models].
LDAPOID ::= OCTET STRING -- Constrained to numericoid [Models] LDAPOID ::= OCTET STRING -- Constrained to <numericoid> [Models]
For example, For example,
1.3.6.1.4.1.1466.1.2.3 1.3.6.1.4.1.1466.1.2.3
4.1.3. Distinguished Name and Relative Distinguished Name 4.1.3. Distinguished Name and Relative Distinguished Name
An LDAPDN and a RelativeLDAPDN are respectively defined to be the An LDAPDN is defined to be the representation of a distinguished name
representation of a distinguished-name and a relative-distinguished- (DN) after encoding according to the specification in [LDAPDN].
name after encoding according to the specification in [LDAPDN].
LDAPDN ::= LDAPString LDAPDN ::= LDAPString
-- Constrained to distinguishedName [LDAPDN] -- Constrained to <distinguishedName> [LDAPDN]
RelativeLDAPDN ::= LDAPString
-- Constrained to name-component [LDAPDN]
Sermersheim Internet-Draft - Expires Mar 2004 Page 6 Sermersheim Internet-Draft - Expires Apr 2004 Page 6
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
A RelativeLDAPDN is defined to be the representation of a relative
distinguished name (RDN) after encoding according to the
specification in [LDAPDN].
RelativeLDAPDN ::= LDAPString
-- Constrained to <name-component> [LDAPDN]
4.1.4. Attribute Descriptions 4.1.4. Attribute Descriptions
The definition and encoding rules for attribute descriptions are The definition and encoding rules for attribute descriptions are
defined in Section 2.5 of [Models]. Briefly, an attribute description defined in Section 2.5 of [Models]. Briefly, an attribute description
is an attribute type and zero or more options. is an attribute type and zero or more options.
AttributeDescription ::= LDAPString AttributeDescription ::= LDAPString
-- Constrained to attributedescription -- Constrained to <attributedescription>
-- [Models] -- [Models]
4.1.5. Attribute Value 4.1.5. Attribute Value
A field of type AttributeValue is an OCTET STRING containing an A field of type AttributeValue is an OCTET STRING containing an
encoded attribute value data type. The value is encoded according to encoded attribute value. The attribute value is encoded according to
its LDAP-specific encoding definition. The LDAP-specific encoding the LDAP-specific encoding definition of its corresponding syntax.
definitions for different syntaxes and attribute types may be found The LDAP-specific encoding definitions for different syntaxes and
in other documents and in particular [Syntaxes]. attribute types may be found in other documents and in particular
[Syntaxes].
AttributeValue ::= OCTET STRING AttributeValue ::= OCTET STRING
Note that there is no defined limit on the size of this encoding; Note that there is no defined limit on the size of this encoding;
thus protocol values may include multi-megabyte attributes (e.g. thus protocol values may include multi-megabyte attributes (e.g.
photographs). photographs).
Attributes may be defined which have arbitrary and non-printable Attributes may be defined which have arbitrary and non-printable
syntax. Implementations MUST NOT display nor attempt to decode as syntax. Implementations MUST NOT display nor attempt to decode a
ASN.1, a value if its syntax is not known. The implementation may value if its syntax is not known. The implementation may attempt to
attempt to discover the subschema of the source entry, and retrieve discover the subschema of the source entry, and retrieve the
the values of attributeTypes from it. descriptions of attributeTypes from it [Models].
Clients MUST NOT send attribute values in a request that are not Clients MUST NOT send attribute values in a request that are not
valid according to the syntax defined for the attributes. valid according to the syntax defined for the attributes.
4.1.6. Attribute Value Assertion 4.1.6. Attribute Value Assertion
The AttributeValueAssertion type definition is similar to the one in The AttributeValueAssertion type definition is similar to the one in
the X.500 directory standards. It contains an attribute description the X.500 Directory standards. It contains an attribute description
and a matching rule assertion value suitable for that type. and a matching rule assertion value suitable for that type.
AttributeValueAssertion ::= SEQUENCE { AttributeValueAssertion ::= SEQUENCE {
attributeDesc AttributeDescription, attributeDesc AttributeDescription,
assertionValue AssertionValue } assertionValue AssertionValue }
Sermersheim Internet-Draft - Expires Apr 2004 Page 7
Lightweight Directory Access Protocol Version 3
AssertionValue ::= OCTET STRING AssertionValue ::= OCTET STRING
The syntax of the AssertionValue depends on the context of the LDAP The syntax of the AssertionValue depends on the context of the LDAP
operation being performed. For example, the syntax of the EQUALITY operation being performed. For example, the syntax of the EQUALITY
matching rule for an attribute is used when performing a Compare matching rule for an attribute is used when performing a Compare
operation. Often this is the same syntax used for values of the operation. Often this is the same syntax used for values of the
attribute type, but in some cases the assertion syntax differs from attribute type, but in some cases the assertion syntax differs from
the value syntax. See objectIdentiferFirstComponentMatch in the value syntax. See objectIdentiferFirstComponentMatch in
[Syntaxes] for an example. [Syntaxes] for an example.
Sermersheim Internet-Draft - Expires Mar 2004 Page 7
Lightweight Directory Access Protocol Version 3
4.1.7. Attribute 4.1.7. Attribute
An attribute consists of an attribute description and one or more An attribute consists of an attribute description and one or more
values of that attribute description. (Though attributes MUST have at values of that attribute description.
least one value when stored, due to access control restrictions the
set may be empty when transferred from the server to the client. This
is described in section 4.5.2, concerning the PartialAttributeList
type.)
Attribute ::= SEQUENCE { Attribute ::= SEQUENCE {
type AttributeDescription, type AttributeDescription,
vals SET OF AttributeValue } vals SET SIZE (1..MAX) OF value AttributeValue }
Each attribute value is distinct in the set (no duplicates). The set Each attribute value is distinct in the set (no duplicates). The set
of attribute values is unordered. Implementations MUST NOT reply upon of attribute values is unordered. Implementations MUST NOT rely upon
any apparent ordering being repeatable. the ordering being repeatable.
4.1.8. Matching Rule Identifier 4.1.8. Matching Rule Identifier
Matching rules are defined in 4.1.3 of [Models]. A matching rule is Matching rules are defined in 4.1.3 of [Models]. A matching rule is
identified in the LDAP protocol by the printable representation of identified in the LDAP protocol by the printable representation of
either its numericoid, or one of its short name descriptors, e.g. either its <numericoid>, or one of its short name descriptors
"caseIgnoreIA5Match" or "1.3.6.1.4.1.453.33.33". [Models], e.g. "caseIgnoreIA5Match" or "1.3.6.1.4.1.453.33.33".
MatchingRuleId ::= LDAPString MatchingRuleId ::= LDAPString
4.1.9. Result Message 4.1.9. Result Message
The LDAPResult is the construct used in this protocol to return The LDAPResult is the construct used in this protocol to return
success or failure indications from servers to clients. To various success or failure indications from servers to clients. To various
requests, servers will return responses of LDAPResult or responses requests, servers will return responses of LDAPResult or responses
containing the components of LDAPResult to indicate the final status containing the components of LDAPResult to indicate the final status
of a protocol operation request. of a protocol operation request.
skipping to change at line 436 skipping to change at line 436
success (0), success (0),
operationsError (1), operationsError (1),
protocolError (2), protocolError (2),
timeLimitExceeded (3), timeLimitExceeded (3),
sizeLimitExceeded (4), sizeLimitExceeded (4),
compareFalse (5), compareFalse (5),
compareTrue (6), compareTrue (6),
authMethodNotSupported (7), authMethodNotSupported (7),
strongAuthRequired (8), strongAuthRequired (8),
-- 9 reserved -- -- 9 reserved --
Sermersheim Internet-Draft - Expires Apr 2004 Page 8
Lightweight Directory Access Protocol Version 3
referral (10), referral (10),
adminLimitExceeded (11), adminLimitExceeded (11),
unavailableCriticalExtension (12), unavailableCriticalExtension (12),
confidentialityRequired (13), confidentialityRequired (13),
Sermersheim Internet-Draft - Expires Mar 2004 Page 8
Lightweight Directory Access Protocol Version 3
saslBindInProgress (14), saslBindInProgress (14),
noSuchAttribute (16), noSuchAttribute (16),
undefinedAttributeType (17), undefinedAttributeType (17),
inappropriateMatching (18), inappropriateMatching (18),
constraintViolation (19), constraintViolation (19),
attributeOrValueExists (20), attributeOrValueExists (20),
invalidAttributeSyntax (21), invalidAttributeSyntax (21),
-- 22-31 unused -- -- 22-31 unused --
noSuchObject (32), noSuchObject (32),
aliasProblem (33), aliasProblem (33),
skipping to change at line 493 skipping to change at line 493
[LDAPIANA]. The meanings of the result codes are given in Appendix A. [LDAPIANA]. The meanings of the result codes are given in Appendix A.
If a server detects multiple errors for an operation, only one result If a server detects multiple errors for an operation, only one result
code is returned. The server should return the result code that best code is returned. The server should return the result code that best
indicates the nature of the error encountered. indicates the nature of the error encountered.
The diagnosticMessage field of this construct may, at the server's The diagnosticMessage field of this construct may, at the server's
option, be used to return a string containing a textual, human- option, be used to return a string containing a textual, human-
readable (terminal control and page formatting characters should be readable (terminal control and page formatting characters should be
avoided) diagnostic message. As this diagnostic message is not avoided) diagnostic message. As this diagnostic message is not
standardized, implementations MUST NOT rely on the values returned. standardized, implementations MUST NOT rely on the values returned.
If the server chooses not to return a textual diagnostic, the
diagnosticMessage field of the LDAPResult type MUST contain a zero
length string.
Sermersheim Internet-Draft - Expires Mar 2004 Page 9 Sermersheim Internet-Draft - Expires Apr 2004 Page 9
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
If the server chooses not to return a textual diagnostic, the
diagnosticMessage field MUST be empty.
For certain result codes (typically, but not restricted to For certain result codes (typically, but not restricted to
noSuchObject, aliasProblem, invalidDNSyntax and noSuchObject, aliasProblem, invalidDNSyntax and
aliasDereferencingProblem), the matchedDN field is set to the name of aliasDereferencingProblem), the matchedDN field is set to the name of
the lowest entry (object or alias) in the directory that was matched. the lowest entry (object or alias) in the Directory that was matched.
If no aliases were dereferenced while attempting to locate the entry, If no aliases were dereferenced while attempting to locate the entry,
this will be a truncated form of the name provided, or if aliases this will be a truncated form of the name provided, or if aliases
were dereferenced, of the resulting name, as defined in section 12.5 were dereferenced, of the resulting name, as defined in section 12.5
of [X.511]. Unless otherwise defined, the matchedDN field contains a of [X.511]. Otherwise the matchedDN field is empty.
zero length string with all other result codes.
4.1.10. Referral 4.1.10. Referral
The referral result code indicates that the contacted server does not The referral result code indicates that the contacted server does not
hold the target entry of the request. The referral field is present hold the target entry of the request. The referral field is present
in an LDAPResult if the resultCode field value is referral, and in an LDAPResult if the resultCode field value is referral, and
absent with all other result codes. It contains one or more absent with all other result codes. It contains one or more
references to one or more servers or services that may be accessed references to one or more servers or services that may be accessed
via LDAP or other protocols. Referrals can be returned in response to via LDAP or other protocols. Referrals can be returned in response to
any operation request (except unbind and abandon which do not have any operation request (except unbind and abandon which do not have
responses). At least one URL MUST be present in the Referral. responses). At least one URI MUST be present in the Referral.
During a search operation, after the baseObject is located, and During a search operation, after the baseObject is located, and
entries are being evaluated, the referral is not returned. Instead, entries are being evaluated, the referral is not returned. Instead,
continuation references, described in section 4.5.3, are returned continuation references, described in section 4.5.3, are returned
when the search scope spans multiple naming contexts, and several when the search scope spans multiple naming contexts, and several
different servers would need to be contacted to complete the different servers would need to be contacted to complete the
operation. operation.
Referral ::= SEQUENCE OF URL -- one or more Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI
URL ::= LDAPString -- limited to characters permitted in URI ::= LDAPString -- limited to characters permitted in
-- URLs -- URIs
If the client wishes to progress the operation, it MUST follow the If the client wishes to progress the operation, it MUST follow the
referral by contacting one of the servers. If multiple URLs are referral by contacting one of the services. If multiple URIs are
present, the client assumes that any URL may be used to progress the present, the client assumes that any URI may be used to progress the
operation. operation.
A URL for a server implementing LDAP and accessible via [TCP]/[IP] A URI for a server implementing LDAP and accessible via [TCP]/[IP]
(v4 or v6) is written as an LDAP URL according to [LDAPURL]. (v4 or v6) is written as an LDAP URL according to [LDAPURL].
When an LDAP URL is used, the following instructions are followed: When an LDAP URL is used, the following instructions are followed:
- If an alias was dereferenced, the <dn> part of the URL MUST be - If an alias was dereferenced, the <dn> part of the URL MUST be
present, with the new target object name. Note that UTF-8 present, with the new target object name. Note that UTF-8
characters appearing in a DN or search filter may not be legal characters appearing in a DN or search filter may not be legal
for URLs (e.g. spaces) and MUST be escaped using the % method in for URLs (e.g. spaces) and MUST be escaped using the % method in
[RFC2396]. [URI].
- If the <dn> part is present, the client MUST use this name in - If the <dn> part is present, the client MUST use this name in
its next request to progress the operation, and if it is not its next request to progress the operation, and if it is not
present the client will use the same name as in the original present the client will use the same name as in the original
request. request.
Sermersheim Internet-Draft - Expires Mar 2004 Page 10 Sermersheim Internet-Draft - Expires Apr 2004 Page 10
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
- Some servers (e.g. participating in distributed indexing) may - Some servers (e.g. participating in distributed indexing) may
provide a different filter in a URL of a referral for a search provide a different filter in a URL of a referral for a search
operation. operation.
- If the filter part of the LDAP URL is present, the client MUST - If the <filter> part of the LDAP URL is present, the client MUST
use this filter in its next request to progress this search, and use this filter in its next request to progress this search, and
if it is not present the client MUST use the same filter as it if it is not present the client MUST use the same filter as it
used for that search. used for that search.
- Other aspects of the new request may be the same or different as - Other aspects of the new request may be the same as or different
the request which generated the referral. from the request which generated the referral.
Other kinds of URLs may be returned, so long as the operation could Other kinds of URIs may be returned, so long as the operation could
be performed using that protocol. The definition of such URLs and be performed using that protocol. The definition of such URIs and
instructions on their use is left to future specifications. instructions on their use is left to future specifications.
4.1.11. Controls 4.1.11. Controls
A control is a way to specify extension information for an LDAP A control is a way to specify extension information for an LDAP
message. A control only alters the semantics of the message it is message. A control only alters the semantics of the message it is
attached to. attached to.
Controls ::= SEQUENCE OF Control Controls ::= SEQUENCE OF control Control
Control ::= SEQUENCE { Control ::= SEQUENCE {
controlType LDAPOID, controlType LDAPOID,
criticality BOOLEAN DEFAULT FALSE, criticality BOOLEAN DEFAULT FALSE,
controlValue OCTET STRING OPTIONAL } controlValue OCTET STRING OPTIONAL }
The controlType field MUST be a UTF-8 encoded dotted-decimal The controlType field is the UTF-8 encoded dotted-decimal
representation of an OBJECT IDENTIFIER which uniquely identifies the representation of an OBJECT IDENTIFIER which uniquely identifies the
control. This prevents conflicts between control names. control, or the request control and its paired response control. This
prevents conflicts between control names.
The criticality field is either TRUE or FALSE and only applies to The criticality field is either TRUE or FALSE and only applies to
request messages that have a corresponding response message. For all request messages that have a corresponding response message. For all
other messages (such as abandonRequest, unbindRequest and all other messages (such as abandonRequest, unbindRequest and all
response messages), the criticality field is treated as FALSE. response messages), the criticality field SHOULD be FALSE.
If the server recognizes the control type and it is appropriate for If the server recognizes the control type and it is appropriate for
the operation, the server will make use of the control when the operation, the server will make use of the control when
performing the operation. performing the operation.
If the server does not recognize the control type or it is not If the server does not recognize the control type or it is not
appropriate for the operation, and the criticality field is TRUE, the appropriate for the operation, and the criticality field is TRUE, the
server MUST NOT perform the operation, and MUST instead set the server MUST NOT perform the operation, and for operations that have a
resultCode to unavailableCriticalExtension. response, MUST set the resultCode to unavailableCriticalExtension.
If the control is unrecognized or inappropriate but the criticality If the control is unrecognized or inappropriate but the criticality
field is FALSE, the server MUST ignore the control. field is FALSE, the server MUST ignore the control.
The controlValue contains any information associated with the The controlValue contains any information associated with the
control. Its format is defined by the specification of the control. control. Its format is defined by the specification of the control.
Implementations MUST be prepared to handle arbitrary contents of the Implementations MUST be prepared to handle arbitrary contents of the
controlValue octet string, including zero bytes. It is absent only if controlValue octet string, including zero bytes. It is absent only if
Sermersheim Internet-Draft - Expires Mar 2004 Page 11 Sermersheim Internet-Draft - Expires Apr 2004 Page 11
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
there is no value information which is associated with a control of there is no value information which is associated with a control of
its type. controlValues that are defined in terms of ASN.1 and BER its type. controlValues that are defined in terms of ASN.1 and BER
encoded according to Section 5.1, also follow the extensibility rules encoded according to Section 5.1, also follow the extensibility rules
in Section 4. in Section 4.
Servers list the controlType of all request controls they recognize
in the supportedControl attribute [Models] in the root DSE.
Controls SHOULD NOT be combined unless the semantics of the
combination has been specified. The semantics of control
combinations, if specified, are generally found in the control
specification most recently published. In the absence of combination
semantics, the behavior of the operation is undefined.
Additionally, unless order-dependent semantics are given in a
specification, the order of a combination of controls in the SEQUENCE
is ignored.
This document does not specify any controls. Controls may be This document does not specify any controls. Controls may be
specified in other documents. The specification of a control consists specified in other documents. The specification of a control consists
of: of:
- the OBJECT IDENTIFIER assigned to the control, - the OBJECT IDENTIFIER assigned to the control,
- whether the control is always non critical, always critical, or - whether the control is always non critical, always critical, or
critical at the client's option, optionally critical,
- the format of the controlValue contents of the control, - whether there is information associated with the control, and if
so, the format of the controlValue contents,
- the semantics of the control, - the semantics of the control, and
- and optionally, semantics regarding the combination of the control - optionally, semantics regarding the combination of the control
with other controls. with other controls.
Servers list the controlType of all request controls they recognize
in the supportedControl attribute [Models] in the root DSE.
Controls should not be combined unless the semantics of the
combination has been specified. The semantics of control
combinations, if specified, are generally found in the control
specification most recently published. In the absence of combination
semantics, the behavior of the operation is undefined.
Additionally, the order of a combination of controls in the SEQUENCE
is ignored unless the control specification(s) describe(s)
combination semantics.
4.2. Bind Operation 4.2. Bind Operation
The function of the Bind Operation is to allow authentication The function of the Bind Operation is to allow authentication
information to be exchanged between the client and server. Prior to information to be exchanged between the client and server.
the first BindRequest, the implied identity is anonymous. Refer to Authentication and security-related semantics of this operation are
[AuthMeth] for the authentication-related semantics of this given in [AuthMeth].
operation.
The Bind Request is defined as follows: The Bind Request is defined as follows:
BindRequest ::= [APPLICATION 0] SEQUENCE { BindRequest ::= [APPLICATION 0] SEQUENCE {
version INTEGER (1 .. 127), version INTEGER (1 .. 127),
name LDAPDN, name LDAPDN,
authentication AuthenticationChoice } authentication AuthenticationChoice }
AuthenticationChoice ::= CHOICE { AuthenticationChoice ::= CHOICE {
simple [0] OCTET STRING, simple [0] OCTET STRING,
-- 1 and 2 reserved -- 1 and 2 reserved
sasl [3] SaslCredentials, sasl [3] SaslCredentials,
... } ... }
Sermersheim Internet-Draft - Expires Mar 2004 Page 12 Sermersheim Internet-Draft - Expires Apr 2004 Page 12
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
SaslCredentials ::= SEQUENCE { SaslCredentials ::= SEQUENCE {
mechanism LDAPString, mechanism LDAPString,
credentials OCTET STRING OPTIONAL } credentials OCTET STRING OPTIONAL }
Parameters of the Bind Request are: Parameters of the Bind Request are:
- version: A version number indicating the version of the protocol - version: A version number indicating the version of the protocol
to be used in this protocol association. This document describes to be used in this protocol association. This document describes
version 3 of the LDAP protocol. Note that there is no version version 3 of the LDAP protocol. Note that there is no version
negotiation, and the client just sets this parameter to the negotiation. The client sets this parameter to the version it
version it desires. If the server does not support the specified desires. If the server does not support the specified version, it
version, it MUST respond with protocolError in the resultCode MUST respond with protocolError in the resultCode field of the
field of the BindResponse. BindResponse.
- name: The name of the directory object that the client wishes to - name: The name of the Directory object that the client wishes to
bind as. This field may take on a null value (a zero length bind as. This field may take on a null value (a zero length
string) for the purposes of anonymous binds ([AuthMeth] section 7) string) for the purposes of anonymous binds ([AuthMeth] section 7)
or when using SASL authentication ([AuthMeth] section 4.3). Server or when using Simple Authentication and Security Layer [SASL]
behavior is undefined when the name is a null value, simple authentication ([AuthMeth] section 4.3). Server behavior is
authentication is used, and a password is specified. The server undefined when the name is a null value, simple authentication is
SHOULD NOT perform any alias dereferencing in determining the used, and a password is specified. The server SHALL NOT perform
object to bind as. alias dereferencing in determining the object to bind as.
- authentication: information used to authenticate the name, if any, - authentication: information used to authenticate the name, if any,
provided in the Bind Request. This type is extensible as defined provided in the Bind Request. This type is extensible as defined
in Section 3.6 of [LDAPIANA]. Servers that do not support a choice in Section 3.6 of [LDAPIANA]. Servers that do not support a choice
supplied by a client will return authMethodNotSupported in the supplied by a client will return authMethodNotSupported in the
resultCode field of the BindResponse. The simple form of an resultCode field of the BindResponse.
AuthenticationChoice specifies a simple password to be used for The simple form of an AuthenticationChoice specifies a simple
authentication. To improve matching, applications SHOULD prepare password to be used for authentication. Passwords consisting of
textual strings used as passwords. Applications which prepare character data (text passwords) SHALL be transferred as [UTF-8]
textural strings used as password are REQUIRED to prepare them by encoded [Unicode]. Prior to transfer, clients SHOULD prepare text
transcoding the string to [Unicode], apply [SASLprep], and encode passwords by applying the [SASLprep] profile of the [Stringprep]
as UTF-8. algorithm. Passwords consisting of other data (such as random
octets) MUST NOT be altered.
Authorization is the use of this authentication information when Authorization is the use of this authentication information when
performing operations. Authorization MAY be affected by factors performing operations. Authorization MAY be affected by factors
outside of the LDAP Bind Request, such as lower layer security outside of the LDAP Bind Request, such as those provided by lower
services. layer security services.
4.2.1. Processing of the Bind Request 4.2.1. Processing of the Bind Request
Upon receipt of a BindRequest, the server MUST ensure there are no Before processing a BindResponse, all outstanding operations MUST
outstanding operations in progress on the connection (this simplifies either complete or be abandoned. The server may either wait for the
server implementation). To do this, the server may cause them to be outstanding operations to complete, or abandon them. The server then
abandoned or allow them to finish. The server then proceeds to proceeds to authenticate the client in either a single-step, or
authenticate the client in either a single-step, or multi-step bind multi-step bind process. Each step requires the server to return a
process. Each step requires the server to return a BindResponse to BindResponse to indicate the status of authentication.
indicate the status of authentication.
If the client did not bind before sending a request and receives an If the client did not bind before sending a request and receives an
operationsError, it may then send a Bind Request. If this also fails operationsError to that request, it may then send a Bind Request. If
Sermersheim Internet-Draft - Expires Mar 2004 Page 13 Sermersheim Internet-Draft - Expires Apr 2004 Page 13
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
or the client chooses not to bind on the existing connection, it may this also fails or the client chooses not to bind on the existing
close the connection, reopen it and begin again by first sending a connection, it may close the connection, reopen it and begin again by
PDU with a Bind Request. This will aid in interoperating with servers first sending a PDU with a Bind Request. This will aid in
implementing other versions of LDAP. interoperating with servers implementing other versions of LDAP.
Clients MAY send multiple Bind Requests on a connection to change Clients may send multiple Bind Requests on a connection to change the
their credentials. Authentication from earlier binds is subsequently authentication and/or security associations or to complete a multi-
stage bind process. Authentication from earlier binds is subsequently
ignored. ignored.
For some SASL authentication mechanisms, it may be necessary for the For some SASL authentication mechanisms, it may be necessary for the
client to invoke the BindRequest multiple times. This is indicated by client to invoke the BindRequest multiple times. This is indicated by
the server sending a BindResponse with the resultCode set to the server sending a BindResponse with the resultCode set to
saslBindInProgress. This indicates that the server requires the saslBindInProgress. This indicates that the server requires the
client to send a new bind request, with the same sasl mechanism, to client to send a new bind request, with the same sasl mechanism, to
continue the authentication process. If at any stage the client continue the authentication process. If at any stage the client
wishes to abort the bind process it MAY unbind and then drop the wishes to abort the bind process it MAY unbind and then drop the
underlying connection. Clients MUST NOT invoke operations between two underlying connection. Clients MUST NOT invoke operations between two
skipping to change at line 777 skipping to change at line 778
BindResponse ::= [APPLICATION 1] SEQUENCE { BindResponse ::= [APPLICATION 1] SEQUENCE {
COMPONENTS OF LDAPResult, COMPONENTS OF LDAPResult,
serverSaslCreds [7] OCTET STRING OPTIONAL } serverSaslCreds [7] OCTET STRING OPTIONAL }
BindResponse consists simply of an indication from the server of the BindResponse consists simply of an indication from the server of the
status of the client's request for authentication. status of the client's request for authentication.
A successful bind operation is indicated by a BindResponse with a A successful bind operation is indicated by a BindResponse with a
resultCode set to success. Otherwise, an appropriate result code is resultCode set to success. Otherwise, an appropriate result code is
set in the BindResponse. For bind, the protocolError result code may
Sermersheim Internet-Draft - Expires Mar 2004 Page 14 Sermersheim Internet-Draft - Expires Apr 2004 Page 14
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
set in the BindResponse. For bind, the protocolError result code may
be used to indicate that the version number supplied by the client is be used to indicate that the version number supplied by the client is
unsupported. unsupported.
If the client receives a BindResponse response where the resultCode If the client receives a BindResponse response where the resultCode
field is protocolError, it MUST close the connection as the server field is protocolError, it MUST close the connection as the server
will be unwilling to accept further operations. (This is for will be unwilling to accept further operations. (This is for
compatibility with earlier versions of LDAP, in which the bind was compatibility with earlier versions of LDAP, in which the bind was
always the first operation, and there was no negotiation.) always the first operation, and there was no negotiation.)
The serverSaslCreds are used as part of a SASL-defined bind mechanism The serverSaslCreds are used as part of a SASL-defined bind mechanism
to allow the client to authenticate the server to which it is to allow the client to authenticate the server to which it is
communicating, or to perform "challenge-response" authentication. If communicating, or to perform "challenge-response" authentication. If
the client bound with the simple choice, or the SASL mechanism does the client bound with the simple choice, or the SASL mechanism does
not require the server to return information to the client, then this not require the server to return information to the client, then this
field is not to be included in the BindResponse. field SHALL NOT be included in the BindResponse.
4.3. Unbind Operation 4.3. Unbind Operation
The function of the Unbind Operation is to terminate an LDAP The function of the Unbind Operation is to terminate an LDAP
association and connection. The Unbind Operation is defined as association and connection. The Unbind Operation is defined as
follows: follows:
UnbindRequest ::= [APPLICATION 2] NULL UnbindRequest ::= [APPLICATION 2] NULL
The Unbind Operation has no response defined. Upon transmission of an The Unbind Operation has no response defined. Upon transmission of
UnbindRequest, a protocol client MUST assume that the LDAP the UnbindRequest, each protocol peer is to consider the LDAP
association is terminated. Upon receipt of an UnbindRequest, a association terminated, MUST cease transmission of messages to the
protocol server MUST assume that the requesting client has terminated other peer, and MUST close the connection. Any outstanding operations
the association and that all outstanding requests may be discarded, on the server are, when possible, abandoned, and when not possible,
and MUST close the connection. completed without transmission of the response.
4.4. Unsolicited Notification 4.4. Unsolicited Notification
An unsolicited notification is an LDAPMessage sent from the server to An unsolicited notification is an LDAPMessage sent from the server to
the client which is not in response to any LDAPMessage received by the client which is not in response to any LDAPMessage received by
the server. It is used to signal an extraordinary condition in the the server. It is used to signal an extraordinary condition in the
server or in the connection between the client and the server. The server or in the connection between the client and the server. The
notification is of an advisory nature, and the server will not expect notification is of an advisory nature, and the server will not expect
any response to be returned from the client. any response to be returned from the client.
The unsolicited notification is structured as an LDAPMessage in which The unsolicited notification is structured as an LDAPMessage in which
the messageID is 0 and protocolOp is of the extendedResp form. The the messageID is zero and protocolOp is of the extendedResp form. The
responseName field of the ExtendedResponse is present. The LDAPOID responseName field of the ExtendedResponse always contains an LDAPOID
value MUST be unique for this notification, and not be used in any which is unique for this notification.
other situation.
One unsolicited notification (Notice of Disconnection) is defined in One unsolicited notification (Notice of Disconnection) is defined in
this document. this document.
4.4.1. Notice of Disconnection 4.4.1. Notice of Disconnection
Sermersheim Internet-Draft - Expires Mar 2004 Page 15 Sermersheim Internet-Draft - Expires Apr 2004 Page 15
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
This notification may be used by the server to advise the client that This notification may be used by the server to advise the client that
the server is about to close the connection due to an error the server is about to close the connection due to an error
condition. Note that this notification is NOT a response to an unbind condition. Note that this notification is NOT a response to an unbind
requested by the client: the server MUST follow the procedures of requested by the client: the server MUST follow the procedures of
section 4.3. This notification is intended to assist clients in section 4.3. This notification is intended to assist clients in
distinguishing between an error condition and a transient network distinguishing between an error condition and a transient network
failure. As with a connection close due to network failure, the failure. As with a connection close due to network failure, the
client MUST NOT assume that any outstanding requests which modified client MUST NOT assume that any outstanding requests which modified
the directory have succeeded or failed. the Directory have succeeded or failed.
The responseName is 1.3.6.1.4.1.1466.20036, the response field is The responseName is 1.3.6.1.4.1.1466.20036, the response field is
absent, and the resultCode is used to indicate the reason for the absent, and the resultCode is used to indicate the reason for the
disconnection. disconnection.
The following result codes have these meanings when used in this The following result codes have these meanings when used in this
notification: notification:
- protocolError: The server has received data from the client in - protocolError: The server has received data from the client in
which the LDAPMessage structure could not be parsed. which the LDAPMessage structure could not be parsed.
skipping to change at line 866 skipping to change at line 866
- strongAuthRequired: The server has detected that an established - strongAuthRequired: The server has detected that an established
security association between the client and server has security association between the client and server has
unexpectedly failed or been compromised, or that the server now unexpectedly failed or been compromised, or that the server now
requires the client to authenticate using a strong(er) mechanism. requires the client to authenticate using a strong(er) mechanism.
- unavailable: This server will stop accepting new connections and - unavailable: This server will stop accepting new connections and
operations on all existing connections, and be unavailable for an operations on all existing connections, and be unavailable for an
extended period of time. The client may make use of an alternative extended period of time. The client may make use of an alternative
server. server.
After sending this notice, the server MUST close the connection. Upon transmission of the UnbindRequest, each protocol peer is to
After receiving this notice, the client MUST NOT transmit any further consider the LDAP association terminated, MUST cease transmission of
on the connection, and may abruptly close the connection. messages to the other peer, and MUST close the connection.
4.5. Search Operation 4.5. Search Operation
The Search Operation allows a client to request that a search be The Search Operation is used to request a server to return, subject
performed on its behalf by a server. This can be used to read to access controls and other restrictions, a set of entries matching
attributes from a single entry, from entries immediately below a a complex search criterion. This can be used to read attributes from
particular entry, or a whole subtree of entries. a single entry, from entries immediately subordinate to a particular
entry, or a whole subtree of entries.
4.5.1. Search Request 4.5.1. Search Request
The Search Request is defined as follows: The Search Request is defined as follows:
SearchRequest ::= [APPLICATION 3] SEQUENCE { SearchRequest ::= [APPLICATION 3] SEQUENCE {
baseObject LDAPDN, baseObject LDAPDN,
scope ENUMERATED { scope ENUMERATED {
baseObject (0), baseObject (0),
singleLevel (1), singleLevel (1),
wholeSubtree (2) }, wholeSubtree (2) },
derefAliases ENUMERATED {
Sermersheim Internet-Draft - Expires Mar 2004 Page 16 Sermersheim Internet-Draft - Expires Apr 2004 Page 16
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
derefAliases ENUMERATED {
neverDerefAliases (0), neverDerefAliases (0),
derefInSearching (1), derefInSearching (1),
derefFindingBaseObj (2), derefFindingBaseObj (2),
derefAlways (3) }, derefAlways (3) },
sizeLimit INTEGER (0 .. maxInt), sizeLimit INTEGER (0 .. maxInt),
timeLimit INTEGER (0 .. maxInt), timeLimit INTEGER (0 .. maxInt),
typesOnly BOOLEAN, typesOnly BOOLEAN,
filter Filter, filter Filter,
attributes AttributeSelection } attributes AttributeSelection }
AttributeSelection ::= SEQUENCE OF AttributeSelection ::= SEQUENCE OF selection LDAPString
LDAPString -- constrained to the <attributeSelection> ABNF below
-- constrained to the attributeSelection below
Filter ::= CHOICE { Filter ::= CHOICE {
and [0] SET SIZE (1..MAX) OF Filter, and [0] SET SIZE (1..MAX) OF filter Filter,
or [1] SET SIZE (1..MAX) OF Filter, or [1] SET SIZE (1..MAX) OF filter Filter,
not [2] Filter, not [2] Filter,
equalityMatch [3] AttributeValueAssertion, equalityMatch [3] AttributeValueAssertion,
substrings [4] SubstringFilter, substrings [4] SubstringFilter,
greaterOrEqual [5] AttributeValueAssertion, greaterOrEqual [5] AttributeValueAssertion,
lessOrEqual [6] AttributeValueAssertion, lessOrEqual [6] AttributeValueAssertion,
present [7] AttributeDescription, present [7] AttributeDescription,
approxMatch [8] AttributeValueAssertion, approxMatch [8] AttributeValueAssertion,
extensibleMatch [9] MatchingRuleAssertion } extensibleMatch [9] MatchingRuleAssertion }
SubstringFilter ::= SEQUENCE { SubstringFilter ::= SEQUENCE {
type AttributeDescription, type AttributeDescription,
-- at least one must be present, -- at least one must be present,
-- initial and final can occur at most once -- initial and final can occur at most once
substrings SEQUENCE OF CHOICE { substrings SEQUENCE SIZE (1..MAX) OF substring CHOICE {
initial [0] AssertionValue, initial [0] AssertionValue,
any [1] AssertionValue, any [1] AssertionValue,
final [2] AssertionValue } } final [2] AssertionValue } }
MatchingRuleAssertion ::= SEQUENCE { MatchingRuleAssertion ::= SEQUENCE {
matchingRule [1] MatchingRuleId OPTIONAL, matchingRule [1] MatchingRuleId OPTIONAL,
type [2] AttributeDescription OPTIONAL, type [2] AttributeDescription OPTIONAL,
matchValue [3] AssertionValue, matchValue [3] AssertionValue,
dnAttributes [4] BOOLEAN DEFAULT FALSE } dnAttributes [4] BOOLEAN DEFAULT FALSE }
Parameters of the Search Request are: Parameters of the Search Request are:
- baseObject: An LDAPDN that is the base object entry relative to - baseObject: The name of the base object entry relative to which
which the search is to be performed. the search is to be performed.
- scope: An indicator of the scope of the search to be performed. - scope: Specifies the scope of the search to be performed. The
The semantics of the possible values of this field are identical semantics (as described in [X.511]) of the possible values of this
to the semantics of the scope field in the X.511 Search Operation. field are:
baseObject: The scope is constrained to the entry named by
baseObject.
Sermersheim Internet-Draft - Expires Apr 2004 Page 17
Lightweight Directory Access Protocol Version 3
oneLevel: The scope is constrained to the immediate
subordinates of the entry named by baseObject.
wholeSubtree: the scope is constrained to the entry named
by the baseObject, and all its subordinates.
- derefAliases: An indicator as to how alias objects (as defined in - derefAliases: An indicator as to how alias objects (as defined in
[X.501]) are to be handled in searching. The semantics of the [X.501]) are to be handled in searching. The semantics of the
possible values of this field are: possible values of this field are:
Sermersheim Internet-Draft - Expires Mar 2004 Page 17
Lightweight Directory Access Protocol Version 3
neverDerefAliases: Do not dereference aliases in searching neverDerefAliases: Do not dereference aliases in searching
or in locating the base object of the search. or in locating the base object of the search.
derefInSearching: While searching, dereference any alias derefInSearching: While searching, dereference any alias
object subordinate to the base object which is also in the object subordinate to the base object which is also in the
search scope. The filter is applied to the dereferenced search scope. The filter is applied to the dereferenced
object(s). If the search scope is wholeSubtree, the search object(s). If the search scope is wholeSubtree, the search
continues in the subtree of any dereferenced object. continues in the subtree of any dereferenced object.
Aliases in that subtree are also dereferenced. Servers Aliases in that subtree are also dereferenced. Servers
SHOULD detect looping in this process to prevent denial of SHOULD detect looping in this process to prevent denial of
skipping to change at line 977 skipping to change at line 986
- sizeLimit: A size limit that restricts the maximum number of - sizeLimit: A size limit that restricts the maximum number of
entries to be returned as a result of the search. A value of 0 in entries to be returned as a result of the search. A value of 0 in
this field indicates that no client-requested size limit this field indicates that no client-requested size limit
restrictions are in effect for the search. Servers may enforce a restrictions are in effect for the search. Servers may enforce a
maximum number of entries to return. maximum number of entries to return.
- timeLimit: A time limit that restricts the maximum time (in - timeLimit: A time limit that restricts the maximum time (in
seconds) allowed for a search. A value of 0 in this field seconds) allowed for a search. A value of 0 in this field
indicates that no client-requested time limit restrictions are in indicates that no client-requested time limit restrictions are in
effect for the search. effect for the search. Servers may enforce a maximum time limit
for the search.
- typesOnly: An indicator as to whether search results will contain - typesOnly: An indicator as to whether search results are to
both attribute descriptions and values, or just attribute contain both attribute descriptions and values, or just attribute
descriptions. Setting this field to TRUE causes only attribute descriptions. Setting this field to TRUE causes only attribute
descriptions (no values) to be returned. Setting this field to descriptions (no values) to be returned. Setting this field to
FALSE causes both attribute descriptions and values to be FALSE causes both attribute descriptions and values to be
returned. returned.
- filter: A filter that defines the conditions that must be - filter: A filter that defines the conditions that must be
fulfilled in order for the search to match a given entry. fulfilled in order for the search to match a given entry.
The 'and', 'or' and 'not' choices can be used to form combinations The 'and', 'or' and 'not' choices can be used to form combinations
of filters. At least one filter element MUST be present in an of filters. At least one filter element MUST be present in an
Sermersheim Internet-Draft - Expires Apr 2004 Page 18
Lightweight Directory Access Protocol Version 3
'and' or 'or' choice. The others match against individual 'and' or 'or' choice. The others match against individual
attribute values of entries in the scope of the search. attribute values of entries in the scope of the search.
(Implementor's note: the 'not' filter is an example of a tagged (Implementor's note: the 'not' filter is an example of a tagged
choice in an implicitly-tagged module. In BER this is treated as choice in an implicitly-tagged module. In BER this is treated as
if the tag was explicit.) if the tag was explicit.)
A server MUST evaluate filters according to the three-valued logic 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 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 either "TRUE", "FALSE" or "Undefined". If the filter evaluates
to TRUE for a particular entry, then the attributes of that entry to TRUE for a particular entry, then the attributes of that entry
are returned as part of the search result (subject to any are returned as part of the search result (subject to any
applicable access control restrictions). If the filter evaluates applicable access control restrictions). If the filter evaluates
Sermersheim Internet-Draft - Expires Mar 2004 Page 18
Lightweight Directory Access Protocol Version 3
to FALSE or Undefined, then the entry is ignored for the search. to FALSE or Undefined, then the entry is ignored for the search.
A filter of the "and" choice is TRUE if all the filters in the SET A filter of the "and" choice is TRUE if all the filters in the SET
OF evaluate to TRUE, FALSE if at least one filter is FALSE, and OF evaluate to TRUE, FALSE if at least one filter is FALSE, and
otherwise Undefined. A filter of the "or" choice is FALSE if all otherwise Undefined. A filter of the "or" choice is FALSE if all
of the filters in the SET OF evaluate to FALSE, TRUE if at least of the filters in the SET OF evaluate to FALSE, TRUE if at least
one filter is TRUE, and Undefined otherwise. A filter of the "not" one filter is TRUE, and Undefined otherwise. A filter of the "not"
choice is TRUE if the filter being negated is FALSE, FALSE if it choice is TRUE if the filter being negated is FALSE, FALSE if it
is TRUE, and Undefined if it is Undefined. is TRUE, and Undefined if it is Undefined.
skipping to change at line 1037 skipping to change at line 1047
Note that the AssertionValue in a substrings filter item MUST Note that the AssertionValue in a substrings filter item MUST
conform to the assertion syntax of the EQUALITY matching rule for conform to the assertion syntax of the EQUALITY matching rule for
the attribute type rather than the assertion syntax of the SUBSTR the attribute type rather than the assertion syntax of the SUBSTR
matching rule for the attribute type. The entire SubstringFilter matching rule for the attribute type. The entire SubstringFilter
is converted into an assertion value of the substrings matching is converted into an assertion value of the substrings matching
rule prior to applying the rule. rule prior to applying the rule.
The matching rule for greaterOrEqual and lessOrEqual filter items The matching rule for greaterOrEqual and lessOrEqual filter items
is defined by the ORDERING matching rule for the attribute type. is defined by the ORDERING matching rule for the attribute type.
The matching semantics for approxMatch filter items is The approxMatch evaluates to TRUE when there is a value of the
implementation-defined. If approximate matching is not supported attribute or subtype for which some locally-defined approximate
by the server, the filter item should be treated as an matching algorithm (e.g. spelling variations, phonetic match,
equalityMatch. etc.) returns TRUE. If an item matches for equality, it also
satisfies an approximate match. If approximate matching is not
supported, this filter item should be treated as an equalityMatch.
The extensibleMatch is new in this version of LDAP. If the An extensibleMatch is evaluated as follows:
matchingRule field is absent, the type field MUST be present, and
the equality match is performed for that type. If the type 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 the
assertion value (the filter item evaluates to TRUE if it matches
with at least one attribute in the entry, FALSE if it does not
match any attribute in the entry, and Undefined if the
matchingRule is not recognized or the assertionValue cannot be
parsed.) If the type field is present and matchingRule is present,
the matchingRule MUST be one permitted for use with that type,
otherwise the filter item is undefined. If the dnAttributes field
is set to TRUE, the match is applied against all the
AttributeValueAssertions in an entry's distinguished name as well,
and also evaluates to TRUE if there is at least one attribute in
the distinguished name for which the filter item evaluates to
TRUE. (Editors note: The dnAttributes field is present so that
there does not need to be multiple versions of generic matching
Sermersheim Internet-Draft - Expires Mar 2004 Page 19 If the matchingRule field is absent, the type field MUST be
present, and an equality match is performed for that type.
Sermersheim Internet-Draft - Expires Apr 2004 Page 19
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
rules such as for word matching, one to apply to entries and If the type field is absent and the matchingRule is present, the
another to apply to entries and dn attributes as well). matchValue is compared against all attributes in an entry which
support that matchingRule. The matchingRule determines the
syntax for the assertion value. The filter item evaluates to
TRUE if it matches with at least one attribute in the entry,
FALSE if it does not match any attribute in the entry, and
Undefined if the matchingRule is not recognized or the
assertionValue is invalid.
If the type field is present and the matchingRule is present,
the matchValue is compared against entry attributes of the
specified type. In this case, the matchingRule MUST be one
suitable for use with the specified type (see [Syntaxes]),
otherwise the filter item is undefined.
If the dnAttributes field is set to TRUE, the match is
additionally applied against all the AttributeValueAssertions in
an entry's distinguished name, and evaluates to TRUE if there is
at least one attribute in the distinguished name for which the
filter item evaluates to TRUE. The dnAttributes field is present
to alleviate the need for multiple versions of generic matching
rules (such as word matching), where one applies to entries and
another applies to entries and dn attributes as well.
A filter item evaluates to Undefined when the server would not be A filter item evaluates to Undefined when the server would not be
able to determine whether the assertion value matches an entry. If able to determine whether the assertion value matches an entry. If
an attribute description in an equalityMatch, substrings, an attribute description in an equalityMatch, substrings,
greaterOrEqual, lessOrEqual, approxMatch or extensibleMatch filter greaterOrEqual, lessOrEqual, approxMatch or extensibleMatch filter
is not recognized by the server, a matching rule id in the is not recognized by the server, a matching rule id in the
extensibleMatch is not recognized by the server, the assertion extensibleMatch is not recognized by the server, the assertion
value cannot be parsed, or the type of filtering requested is not value is invalid, or the type of filtering requested is not
implemented, then the filter is Undefined. Thus for example if a implemented, then the filter is Undefined. Thus for example if a
server did not recognize the attribute type shoeSize, a filter of server did not recognize the attribute type shoeSize, a filter of
(shoeSize=*) would evaluate to FALSE, and the filters (shoeSize=*) would evaluate to FALSE, and the filters
(shoeSize=12), (shoeSize>=12) and (shoeSize<=12) would evaluate to (shoeSize=12), (shoeSize>=12) and (shoeSize<=12) would evaluate to
Undefined. Undefined.
Servers MUST NOT return errors if attribute descriptions or Servers MUST NOT return errors if attribute descriptions or
matching rule ids are not recognized, or assertion values cannot matching rule ids are not recognized, assertion values are
be parsed. More details of filter processing are given in section invalid, or the assertion syntax is not supported. More details of
7.8 of [X.511]. filter processing are given in section 7.8 of [X.511].
- attributes: A list of the attributes to be returned from each - attributes: A list of the attributes to be returned from each
entry which matches the search filter. LDAPString values of this entry which matches the search filter. LDAPString values of this
field are constrained to the following ABNF: field are constrained to the following ABNF:
attributeSelection = noattrs / attributeSelection = noattrs /
*( attributedescription / specialattr ) *( attributedescription / specialattr )
noattrs = %x31 %x2E %x31 ; "1.1" noattrs = %x31 %x2E %x31 ; "1.1"
attributedescription = ; attributedescription from 2.5 of [Models]
specialattr = ASTERISK specialattr = ASTERISK
ASTERISK = %x2A ; asterisk ("*") ASTERISK = %x2A ; asterisk ("*")
Sermersheim Internet-Draft - Expires Apr 2004 Page 20
Lightweight Directory Access Protocol Version 3
<attributedescription> is defined in Section 2.5 of [Models].
There are two special values which may be used: an empty list with There are two special values which may be used: an empty list with
no attributes, and the attribute description string "*". Both of no attributes, and the attribute description string "*". Both of
these signify that all user attributes are to be returned. (The these signify that all user attributes are to be returned. (The
"*" allows the client to request all user attributes in addition "*" allows the client to request all user attributes in addition
to any specified operational attributes). to any specified operational attributes). Client implementors
should note that even if all user attributes are requested, some
attributes and or attribute values of the entry may not be
included in search 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. Operational attributes are described in
[Models].
Attributes MUST be named at most once in the list, and are Attributes MUST NOT be named more than once in the list, and are
returned at most once in an entry. If there are attribute returned at most once in an entry. If there are attribute
descriptions in the list which are not recognized, they are descriptions in the list which are not recognized, they are
ignored by the server. ignored by the server.
If the client does not want any attributes returned, it can If the client does not want any attributes returned, it can
specify a list containing only the attribute with OID "1.1". This specify a list containing only the attribute with OID "1.1". This
OID was chosen arbitrarily and does not correspond to any OID was chosen because it does not (and can not) correspond to any
attribute in use. attribute in use.
Client implementors should note that even if all user attributes
are requested, some attributes of the entry may not be included in
Sermersheim Internet-Draft - Expires Mar 2004 Page 20
Lightweight Directory Access Protocol Version 3
search 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 of values for
certain operational attributes. (A list of operational attributes
for use in LDAP is given in [Syntaxes].)
Note that an X.500 "list"-like operation can be emulated by the Note that an X.500 "list"-like operation can be emulated by the
client requesting a one-level LDAP search operation with a filter client requesting a one-level LDAP search operation with a filter
checking for the presence of the objectClass attribute, and that an checking for the presence of the objectClass attribute, and that an
X.500 "read"-like operation can be emulated by a base object LDAP X.500 "read"-like operation can be emulated by a base object LDAP
search operation with the same filter. A server which provides a search operation with the same filter. A server which provides a
gateway to X.500 is not required to use the Read or List operations, gateway to X.500 is not required to use the Read or List operations,
although it may choose to do so, and if it does, it must provide the although it may choose to do so, and if it does, it must provide the
same semantics as the X.500 search operation. same semantics as the X.500 search operation.
4.5.2. Search Result 4.5.2. Search Result
The results of the search attempted by the server upon receipt of a The results of the search operation are returned as zero or more
Search Request are returned in Search Responses, which are LDAP searchResultEntry messages, zero or more SearchResultReference
messages containing SearchResultEntry, SearchResultReference, or messages, followed by a single searchResultDone message.
SearchResultDone data types.
SearchResultEntry ::= [APPLICATION 4] SEQUENCE { SearchResultEntry ::= [APPLICATION 4] SEQUENCE {
objectName LDAPDN, objectName LDAPDN,
attributes PartialAttributeList } attributes PartialAttributeList }
PartialAttributeList ::= SEQUENCE OF SEQUENCE { PartialAttributeList ::= SEQUENCE OF
type AttributeDescription, attribute PartialAttribute
vals SET OF AttributeValue } -- Note that the PartialAttributeList may hold zero elements.
-- implementors should note that the PartialAttributeList may -- This may happen when none of the attributes of an entry
-- have zero elements (if none of the attributes of that entry -- were requested, or could be returned.
-- 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 from the result.)
SearchResultReference ::= [APPLICATION 19] SEQUENCE OF URL PartialAttribute ::= SEQUENCE {
-- at least one URL element must be present type AttributeDescription,
SearchResultDone ::= [APPLICATION 5] LDAPResult Sermersheim Internet-Draft - Expires Apr 2004 Page 21
Lightweight Directory Access Protocol Version 3
Upon receipt of a Search Request, a server will perform the necessary vals SET OF value AttributeValue }
search of the DIT. -- Note that the vals set may hold zero elements.
-- This may happen when typesOnly is requested, access controls
-- prevent the return of values, or other reasons.
The server will return to the client a sequence of responses in SearchResultReference ::= [APPLICATION 19] SEQUENCE
separate LDAP messages. There may be zero or more responses SIZE (1..MAX) OF uri URI
containing SearchResultEntry, one for each entry found during the
search. There may also be zero or more responses containing
SearchResultReference, one for each area not explored by this server
during the search. The SearchResultEntry and SearchResultReference
PDUs may come in any order. Following all the SearchResultReference
responses and all SearchResultEntry responses to be returned by the
server, the server will return a response containing the
Sermersheim Internet-Draft - Expires Mar 2004 Page 21 SearchResultDone ::= [APPLICATION 5] LDAPResult
Lightweight Directory Access Protocol Version 3
SearchResultDone, which contains an indication of success, or Each SearchResultEntry represents an entry found during the search.
detailing any errors that have occurred. Each SearchResultReference represents an area not yet explored during
the search. The SearchResultEntry and SearchResultReference PDUs may
come in any order. Following all the SearchResultReference and
SearchResultEntry responses, the server returns a SearchResultDone
response, which contains an indication of success, or detailing any
errors that have occurred.
Each entry returned in a SearchResultEntry will contain all Each entry returned in a SearchResultEntry will contain all
appropriate attributes as specified in the attributes field of the appropriate attributes as specified in the attributes field of the
Search Request. Return of attributes is subject to access control and Search Request. Return of attributes is subject to access control and
other administrative policy. other administrative policy.
Some attributes may be constructed by the server and appear in a Some attributes may be constructed by the server and appear in a
SearchResultEntry attribute list, although they are not stored SearchResultEntry attribute list, although they are not stored
attributes of an entry. Clients SHOULD NOT assume that all attributes attributes of an entry. Clients SHOULD NOT assume that all attributes
can be modified, even if permitted by access control. can be modified, even if permitted by access control.
If the server's schema defines a textual name for an attribute type, If the server's schema defines short names [Models] for an attribute
it SHOULD use a textual name for attributes of that attribute type by type then the server SHOULD use one of those names in attribute
specifying one of the textual names as the value of the attribute descriptions for that attribute type (in preference to using the
type. Otherwise, the server uses the object identifier for the <numericoid> [Models] format of the attribute type's object
attribute type by specifying the object identifier, in ldapOID form, identifier). The server SHOULD NOT use the short name if that name is
as the value of attribute type. If the server determines that known by the server to be ambiguous, or otherwise likely to cause
returning a textual name will cause interoperability problems, it interoperability problems.
SHOULD return the ldapOID form of the attribute type.
4.5.3. Continuation References in the Search Result 4.5.3. Continuation References in the Search Result
If the server was able to locate the entry referred to by the If the server was able to locate the entry referred to by the
baseObject but was unable to search all the entries in the scope at baseObject but was unable to search all the entries in the scope at
and under the baseObject, the server may return one or more and subordinate to the baseObject, the server may return one or more
SearchResultReference entries, each containing a reference to another SearchResultReference entries, each containing a reference to another
set of servers for continuing the operation. A server MUST NOT return set of servers for continuing the operation. A server MUST NOT return
any SearchResultReference if it has not located the baseObject and any SearchResultReference if it has not located the baseObject and
thus has not searched any entries; in this case it would return a thus has not searched any entries; in this case it would return a
SearchResultDone containing a referral result code. SearchResultDone containing a referral result code.
If a server holds a copy or partial copy of the subordinate naming If a server holds a copy or partial copy of the subordinate naming
context, it may use the search filter to determine whether or not to context, it may use the search filter to determine whether or not to
return a SearchResultReference response. Otherwise return a SearchResultReference response. Otherwise
SearchResultReference responses are always returned when in scope. SearchResultReference responses are always returned when in scope.
The SearchResultReference is of the same data type as the Referral. The SearchResultReference is of the same data type as the Referral.
A URL for a server implementing LDAP and accessible via [TCP]/[IP] Sermersheim Internet-Draft - Expires Apr 2004 Page 22
Lightweight Directory Access Protocol Version 3
A URI for a server implementing LDAP and accessible via [TCP]/[IP]
(v4 or v6) is written as an LDAP URL according to [LDAPURL]. (v4 or v6) is written as an LDAP URL according to [LDAPURL].
When an LDAP URL is used, the following instructions are followed: When an LDAP URL is used, the following instructions are followed:
- The <dn> part of the URL MUST be present, with the new target - The <dn> part of the URL MUST be present, with the new target
object name. The client MUST use this name when following the object name. The client MUST use this name when following the
referral. Note that UTF-8 characters appearing in a DN or search referral. Note that UTF-8 characters appearing in a DN or search
filter may not be legal for URLs (e.g. spaces) and MUST be filter may not be legal for URLs (e.g. spaces) and MUST be
escaped using the % method in [RFC2396]. escaped using the % method in [URI].
- Some servers (e.g. participating in distributed indexing) may - Some servers (e.g. participating in distributed indexing) may
provide a different filter in a URL of a SearchResultReference. provide a different filter in a URL of a SearchResultReference.
- If the filter part of the URL is present, the client MUST use - If the <filter> part of the URL is present, the client MUST use
this filter in its next request to progress this search, and if this filter in its next request to progress this search, and if
Sermersheim Internet-Draft - Expires Mar 2004 Page 22
Lightweight Directory Access Protocol Version 3
it is not present the client MUST use the same filter as it used it is not present the client MUST use the same filter as it used
for that search. for that search.
- If the originating search scope was singleLevel, the scope part - If the originating search scope was singleLevel, the <scope>
of the URL will be baseObject. part of the URL will be "base".
- Other aspects of the new search request may be the same or - Other aspects of the new search request may be the same as or
different as the search request which generated the different from the search request which generated the
SearchResultReference. SearchResultReference.
- The name of an unexplored subtree in a SearchResultReference - The name of an unexplored subtree in a SearchResultReference
need not be subordinate to the base object. need not be subordinate to the base object.
Other kinds of URLs may be returned, so long as the operation could Other kinds of URIs may be returned, so long as the operation could
be performed using that protocol. The definition of such URLs and be performed using that protocol. The definition of such URIs and
instructions on their use is left to future specifications. instructions on their use is left to future specifications.
In order to complete the search, the client MUST issue a new search In order to complete the search, the client issues a new search
operation for each SearchResultReference that is returned. Note that operation for each SearchResultReference that is returned. Note that
the abandon operation described in section 4.11 applies only to a the abandon operation described in section 4.11 applies only to a
particular operation sent on an association between a client and particular operation sent on an association between a client and
server, and if the client has multiple outstanding search operations, server. The client must abandon subsequent search operations it
it MUST abandon each operation individually. wishes to individually.
4.5.3.1. Example 4.5.3.1. Example
For example, suppose the contacted server (hosta) holds the entry For example, suppose the contacted server (hosta) holds the entry
"DC=Example,DC=NET" and the entry "CN=Manager,DC=Example,DC=NET". It "DC=Example,DC=NET" and the entry "CN=Manager,DC=Example,DC=NET". It
knows that either LDAP-capable servers (hostb) or (hostc) hold knows that either LDAP-capable servers (hostb) or (hostc) hold
"OU=People,DC=Example,DC=NET" (one is the master and the other server "OU=People,DC=Example,DC=NET" (one is the master and the other server
a shadow), and that LDAP-capable server (hostd) holds the subtree a shadow), and that LDAP-capable server (hostd) holds the subtree
"OU=Roles,DC=Example,DC=NET". If a subtree search of "OU=Roles,DC=Example,DC=NET". If a subtree search of
"DC=Example,DC=NET" is requested to the contacted server, it may "DC=Example,DC=NET" is requested to the contacted server, it may
return the following: return the following:
SearchResultEntry for DC=Example,DC=NET SearchResultEntry for DC=Example,DC=NET
SearchResultEntry for CN=Manager,DC=Example,DC=NET SearchResultEntry for CN=Manager,DC=Example,DC=NET
SearchResultReference { SearchResultReference {
ldap://hostb/OU=People,DC=Example,DC=NET ldap://hostb/OU=People,DC=Example,DC=NET
ldap://hostc/OU=People,DC=Example,DC=NET } ldap://hostc/OU=People,DC=Example,DC=NET }
SearchResultReference { SearchResultReference {
ldap://hostd/OU=Roles,DC=Example,DC=NET } ldap://hostd/OU=Roles,DC=Example,DC=NET }
Sermersheim Internet-Draft - Expires Apr 2004 Page 23
Lightweight Directory Access Protocol Version 3
SearchResultDone (success) SearchResultDone (success)
Client implementors should note that when following a Client implementors should note that when following a
SearchResultReference, additional SearchResultReference may be SearchResultReference, additional SearchResultReference may be
generated. Continuing the example, if the client contacted the server generated. Continuing the example, if the client contacted the server
(hostb) and issued the search for the subtree (hostb) and issued the search for the subtree
"OU=People,DC=Example,DC=NET", the server might respond as follows: "OU=People,DC=Example,DC=NET", the server might respond as follows:
SearchResultEntry for OU=People,DC=Example,DC=NET SearchResultEntry for OU=People,DC=Example,DC=NET
SearchResultReference { SearchResultReference {
ldap://hoste/OU=Managers,OU=People,DC=Example,DC=NET } ldap://hoste/OU=Managers,OU=People,DC=Example,DC=NET }
SearchResultReference { SearchResultReference {
ldap://hostf/OU=Consultants,OU=People,DC=Example,DC=NET } ldap://hostf/OU=Consultants,OU=People,DC=Example,DC=NET }
SearchResultDone (success) SearchResultDone (success)
Sermersheim Internet-Draft - Expires Mar 2004 Page 23
Lightweight Directory Access Protocol Version 3
If the contacted server does not hold the base object for the search, If the contacted server does not hold the base object for the search,
then it will return a referral to the client. For example, if the then it will return a referral to the client. For example, if the
client requests a subtree search of "DC=Example,DC=ORG" to hosta, the client requests a subtree search of "DC=Example,DC=ORG" to hosta, the
server may return only a SearchResultDone containing a referral. server may return only a SearchResultDone containing a referral.
SearchResultDone (referral) { SearchResultDone (referral) {
ldap://hostg/DC=Example,DC=ORG??sub } ldap://hostg/DC=Example,DC=ORG??sub }
4.6. Modify Operation 4.6. Modify Operation
The Modify Operation allows a client to request that a modification The Modify Operation allows a client to request that a modification
of an entry be performed on its behalf by a server. The Modify of an entry be performed on its behalf by a server. The Modify
Request is defined as follows: Request is defined as follows:
ModifyRequest ::= [APPLICATION 6] SEQUENCE { ModifyRequest ::= [APPLICATION 6] SEQUENCE {
object LDAPDN, object LDAPDN,
changes SEQUENCE OF SEQUENCE { changes SEQUENCE OF change SEQUENCE {
operation ENUMERATED { operation ENUMERATED {
add (0), add (0),
delete (1), delete (1),
replace (2) }, replace (2) },
modification Attribute } } modification PartialAttribute } }
Parameters of the Modify Request are: Parameters of the Modify Request are:
- object: The object to be modified. The value of this field - object: The name of the object to be modified. The value of this
contains the DN of the entry to be modified. The server will not field contains the DN of the entry to be modified. The server
perform any alias dereferencing in determining the object to be SHALL NOT perform any alias dereferencing in determining the
modified. object to be modified.
- changes: A list of modifications to be performed on the entry. The - changes: A list of modifications to be performed on the entry. The
entire list of modifications MUST be performed in the order they entire list of modifications MUST be performed in the order they
are listed, as a single atomic operation. While individual are listed, as a single atomic operation. While individual
modifications may violate certain aspects of the directory schema modifications may violate certain aspects of the directory schema
(such as the object class definition and DIT content rule), the (such as the object class definition and DIT content rule), the
resulting entry after the entire list of modifications is resulting entry after the entire list of modifications is
performed MUST conform to the requirements of the directory performed MUST conform to the requirements of the directory
schema. schema.
Sermersheim Internet-Draft - Expires Apr 2004 Page 24
Lightweight Directory Access Protocol Version 3
- operation: Used to specify the type of modification being - operation: Used to specify the type of modification being
performed. Each operation type acts on the following performed. Each operation type acts on the following
modification. The values of this field have the following modification. The values of this field have the following
semantics respectively: semantics respectively:
add: add values listed to the modification attribute, add: add values listed to the modification attribute,
creating the attribute if necessary; creating the attribute if necessary;
delete: delete values listed from the modification delete: delete values listed from the modification
attribute, removing the entire attribute if no values are attribute, removing the entire attribute if no values are
listed, or if all current values of the attribute are listed, or if all current values of the attribute are
listed for deletion; listed for deletion;
Sermersheim Internet-Draft - Expires Mar 2004 Page 24
Lightweight Directory Access Protocol Version 3
replace: replace all existing values of the modification replace: replace all existing values of the modification
attribute with the new values listed, creating the attribute with the new values listed, creating the
attribute if it did not already exist. A replace with no attribute if it did not already exist. A replace with no
value will delete the entire attribute if it exists, and is value will delete the entire attribute if it exists, and is
ignored if the attribute does not exist. ignored if the attribute does not exist.
- modification: An Attribute (which may have an empty SET of vals) - modification: A PartialAttribute (which may have an empty SET of
used to hold the Attribute Type or Attribute Type and values vals) used to hold the attribute type or attribute type and
being modified. values being modified.
The result of the modification attempted by the server upon receipt Upon receipt of a Modify Request, the server attempts to perform the
of a Modify Request is returned in a Modify Response, defined as necessary modifications to the DIT and returns the result in a Modify
follows: Response, defined as follows:
ModifyResponse ::= [APPLICATION 7] LDAPResult ModifyResponse ::= [APPLICATION 7] LDAPResult
Upon receipt of a Modify Request, a server will perform the necessary
modifications to the DIT.
The server will return to the client a single Modify Response The server will return to the client a single Modify Response
indicating either the successful completion of the DIT modification, indicating either the successful completion of the DIT modification,
or the reason that the modification failed. Note that due to the or the reason that the modification failed. Note that due to the
requirement for atomicity in applying the list of modifications in requirement for atomicity in applying the list of modifications in
the Modify Request, the client may expect that no modifications of the Modify Request, the client may expect that no modifications of
the DIT have been performed if the Modify Response received indicates the DIT have been performed if the Modify Response received indicates
any sort of error, and that all requested modifications have been any sort of error, and that all requested modifications have been
performed if the Modify Response indicates successful completion of performed if the Modify Response indicates successful completion of
the Modify Operation. If the association changes or the connection the Modify Operation. If the association changes or the connection
fails, whether the modification occurred or not is indeterminate. fails, whether the modification occurred or not is indeterminate.
The Modify Operation cannot be used to remove from an entry any of The Modify Operation cannot be used to remove from an entry any of
its distinguished values, those values which form the entry's its distinguished values, i.e. those values which form the entry's
relative distinguished name. An attempt to do so will result in the relative distinguished name. An attempt to do so will result in the
server returning the notAllowedOnRDN result code. The Modify DN server returning the notAllowedOnRDN result code. The Modify DN
Operation described in section 4.9 is used to rename an entry. Operation described in section 4.9 is used to rename an entry.
Note that due to the simplifications made in LDAP, there is not a Note that due to the simplifications made in LDAP, there is not a
direct mapping of the changes in an LDAP ModifyRequest onto the direct mapping of the changes in an LDAP ModifyRequest onto the
changes of a DAP ModifyEntry operation, and different implementations changes of a DAP ModifyEntry operation, and different implementations
of LDAP-DAP gateways may use different means of representing the of LDAP-DAP gateways may use different means of representing the
change. If successful, the final effect of the operations on the change. If successful, the final effect of the operations on the
entry MUST be identical. entry MUST be identical.
Sermersheim Internet-Draft - Expires Apr 2004 Page 25
Lightweight Directory Access Protocol Version 3
4.7. Add Operation 4.7. Add Operation
The Add Operation allows a client to request the addition of an entry The Add Operation allows a client to request the addition of an entry
into the directory. The Add Request is defined as follows: into the Directory. The Add Request is defined as follows:
AddRequest ::= [APPLICATION 8] SEQUENCE { AddRequest ::= [APPLICATION 8] SEQUENCE {
entry LDAPDN, entry LDAPDN,
attributes AttributeList } attributes AttributeList }
AttributeList ::= SEQUENCE OF SEQUENCE { AttributeList ::= SEQUENCE OF attribute Attribute
Sermersheim Internet-Draft - Expires Mar 2004 Page 25
Lightweight Directory Access Protocol Version 3
type AttributeDescription,
vals SET OF AttributeValue }
Parameters of the Add Request are: Parameters of the Add Request are:
- entry: the Distinguished Name of the entry to be added. Note that - entry: the name of the entry to be added. Note that the server
the server will not dereference any aliases in locating the entry SHALL NOT dereference any aliases in locating the entry to be
to be added. added.
- attributes: the list of attributes that make up the content of the - attributes: the list of attributes that make up the content of the
entry being added. Clients MUST include distinguished values entry being added. Clients MUST include distinguished values
(those forming the entry's own RDN) in this list, the objectClass (those forming the entry's own RDN) in this list, the objectClass
attribute, and values of any mandatory attributes of the listed attribute, and values of any mandatory attributes of the listed
object classes. Clients MUST NOT supply NO-USER-MODIFICATION object classes. Clients MUST NOT supply NO-USER-MODIFICATION
attributes such as the createTimestamp or creatorsName attributes, attributes such as the createTimestamp or creatorsName attributes,
since the server maintains these automatically. since the server maintains these automatically.
The entry named in the entry field of the AddRequest MUST NOT exist The entry named in the entry field of the AddRequest MUST NOT exist
for the AddRequest to succeed. The immediate superior (parent) of the for the AddRequest to succeed. The immediate superior (parent) of an
object and alias entries to be added MUST exist. For example, if the object or alias entry to be added MUST exist. For example, if the
client attempted to add "CN=JS,DC=Example,DC=NET", the client attempted to add "CN=JS,DC=Example,DC=NET", the
"DC=Example,DC=NET" entry did not exist, and the "DC=NET" entry did "DC=Example,DC=NET" entry did not exist, and the "DC=NET" entry did
exist, then the server would return the noSuchObject result code with exist, then the server would return the noSuchObject result code with
the matchedDN field containing "DC=NET". If the parent entry exists the matchedDN field containing "DC=NET". If the parent entry exists
but is not in a naming context held by the server, the server SHOULD but is not in a naming context held by the server, the server SHOULD
return a referral to the server holding the parent entry. return a referral to the server holding the parent entry.
Server implementations SHOULD NOT restrict where entries can be Server implementations SHOULD NOT restrict where entries can be
located in the directory unless DIT structure rules are in place. located in the Directory unless DIT structure rules are in place.
Some servers MAY allow the administrator to restrict the classes of Some servers allow the administrator to restrict the classes of
entries which can be added to the directory. entries which can be added to the Directory.
Upon receipt of an Add Request, a server will attempt to add the Upon receipt of an Add Request, a server will attempt to add the
requested entry. The result of the add attempt will be returned to requested entry. The result of the add attempt will be returned to
the client in the Add Response, defined as follows: the client in the Add Response, defined as follows:
AddResponse ::= [APPLICATION 9] LDAPResult AddResponse ::= [APPLICATION 9] LDAPResult
A response of success indicates that the new entry is present in the A response of success indicates that the new entry is present in the
directory. Directory.
4.8. Delete Operation 4.8. Delete Operation
Sermersheim Internet-Draft - Expires Apr 2004 Page 26
Lightweight Directory Access Protocol Version 3
The Delete Operation allows a client to request the removal of an The Delete Operation allows a client to request the removal of an
entry from the directory. The Delete Request is defined as follows: entry from the Directory. The Delete Request is defined as follows:
DelRequest ::= [APPLICATION 10] LDAPDN DelRequest ::= [APPLICATION 10] LDAPDN
The Delete Request consists of the Distinguished Name of the entry to The Delete Request consists of the name of the entry to be deleted.
be deleted. Note that the server will not dereference aliases while The server SHALL NOT dereference aliases while resolving the name of
resolving the name of the target entry to be removed, and that only the target entry to be removed.
leaf entries (those with no subordinate entries) can be deleted with
this operation.
Sermersheim Internet-Draft - Expires Mar 2004 Page 26 Only leaf entries (those with no subordinate entries) can be deleted
Lightweight Directory Access Protocol Version 3 with this operation.
The result of the delete attempted by the server upon receipt of a Upon receipt of a Delete Request, a server will attempt to perform
Delete Request is returned in the Delete Response, defined as the entry removal requested and return the result in the Delete
follows: Response defined as follows:
DelResponse ::= [APPLICATION 11] LDAPResult DelResponse ::= [APPLICATION 11] LDAPResult
Upon receipt of a Delete Request, a server will attempt to perform
the entry removal requested. The result of the delete attempt will be
returned to the client in the Delete Response.
4.9. Modify DN Operation 4.9. Modify DN Operation
The Modify DN Operation allows a client to change the leftmost (least The Modify DN Operation allows a client to change the Relative
significant) component of the name of an entry in the directory, Distinguished Name (RDN) of an entry in the Directory, and/or to move
and/or to move a subtree of entries to a new location in the a subtree of entries to a new location in the Directory. The Modify
directory. The Modify DN Request is defined as follows: DN Request is defined as follows:
ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { ModifyDNRequest ::= [APPLICATION 12] SEQUENCE {
entry LDAPDN, entry LDAPDN,
newrdn RelativeLDAPDN, newrdn RelativeLDAPDN,
deleteoldrdn BOOLEAN, deleteoldrdn BOOLEAN,
newSuperior [0] LDAPDN OPTIONAL } newSuperior [0] LDAPDN OPTIONAL }
Parameters of the Modify DN Request are: Parameters of the Modify DN Request are:
- entry: the Distinguished Name of the entry to be changed. This - entry: the name of the entry to be changed. This entry may or may
entry may or may not have subordinate entries. Note that the not have subordinate entries. Note that the server SHALL NOT
server will not dereference any aliases in locating the entry to dereference any aliases in locating the entry to be changed.
be changed.
- newrdn: the RDN that will form the leftmost component of the new - newrdn: the new RDN of the entry.
name of the entry.
- deleteoldrdn: a boolean parameter that controls whether the old - deleteoldrdn: a boolean parameter that controls whether the old
RDN attribute values are to be retained as attributes of the RDN attribute values are to be retained as attributes of the
entry, or deleted from the entry. entry, or deleted from the entry.
- newSuperior: if present, this is the Distinguished Name of an - newSuperior: if present, this is the name of an existing object
existing object entry which becomes the immediate superior entry which becomes the immediate superior (parent) of the
(parent)of the existing entry. existing entry.
The result of the name change attempted by the server upon receipt of Upon receipt of a ModifyDNRequest, a server will attempt to perform
a Modify DN Request is returned in the Modify DN Response, defined as the name change and return the result in the Modify DN Response,
follows: defined as follows:
ModifyDNResponse ::= [APPLICATION 13] LDAPResult ModifyDNResponse ::= [APPLICATION 13] LDAPResult
Upon receipt of a ModifyDNRequest, a server will attempt to perform Sermersheim Internet-Draft - Expires Apr 2004 Page 27
the name change. The result of the name change attempt will be
returned to the client in the Modify DN Response.
Sermersheim Internet-Draft - Expires Mar 2004 Page 27
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
For example, if the entry named in the "entry" parameter was "cn=John 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 Smith,c=US", the newrdn parameter was "cn=John Cougar Smith", and the
newSuperior parameter was absent, then this operation would attempt newSuperior parameter was absent, then this operation would attempt
to rename the entry to be "cn=John Cougar Smith,c=US". If there was to rename the entry to be "cn=John Cougar Smith,c=US". If there was
already an entry with that name, the operation would fail with the already an entry with that name, the operation would fail with the
entryAlreadyExists result code. entryAlreadyExists result code.
The object named in newSuperior MUST exist. For example, if the The object named in newSuperior MUST exist. For example, if the
client attempted to add "CN=JS,DC=Example,DC=NET", the client attempted to add "CN=JS,DC=Example,DC=NET", the
"DC=Example,DC=NET" entry did not exist, and the "DC=NET" entry did "DC=Example,DC=NET" entry did not exist, and the "DC=NET" entry did
exist, then the server would return the noSuchObject result code with exist, then the server would return the noSuchObject result code with
the matchedDN field containing "DC=NET". the matchedDN field containing "DC=NET".
If the deleteoldrdn parameter is TRUE, the values forming the old RDN If the deleteoldrdn parameter is TRUE, the values forming the old RDN
are deleted from the entry. If the deleteoldrdn parameter is FALSE, are deleted from the entry. If the deleteoldrdn parameter is FALSE,
the values forming the old RDN will be retained as non-distinguished the values forming the old RDN will be retained as non-distinguished
attribute values of the entry. The server may not perform the attribute values of the entry. The server MUST fail the operation and
operation and return an error in the result code if the setting of return an error in the result code if the setting of the deleteoldrdn
the deleteoldrdn parameter would cause a schema inconsistency in the parameter would cause a schema inconsistency in the entry.
entry.
Note that X.500 restricts the ModifyDN operation to only affect Note that X.500 restricts the ModifyDN operation to only affect
entries that are contained within a single server. If the LDAP server entries that are contained within a single server. If the LDAP server
is mapped onto DAP, then this restriction will apply, and the is mapped onto DAP, then this restriction will apply, and the
affectsMultipleDSAs result code will be returned if this error affectsMultipleDSAs result code will be returned if this error
occurred. In general clients MUST NOT expect to be able to perform occurred. In general, clients MUST NOT expect to be able to perform
arbitrary movements of entries and subtrees between servers. arbitrary movements of entries and subtrees between servers or
between naming contexts.
4.10. Compare Operation 4.10. Compare Operation
The Compare Operation allows a client to compare an assertion The Compare Operation allows a client to compare an assertion
provided with an entry in the directory. The Compare Request is provided with an entry in the Directory. The Compare Request is
defined as follows: defined as follows:
CompareRequest ::= [APPLICATION 14] SEQUENCE { CompareRequest ::= [APPLICATION 14] SEQUENCE {
entry LDAPDN, entry LDAPDN,
ava AttributeValueAssertion } ava AttributeValueAssertion }
Parameters of the Compare Request are: Parameters of the Compare Request are:
- entry: the name of the entry to be compared with. Note that the - entry: the name of the entry to be compared. Note that the server
server SHOULD NOT dereference any aliases in locating the entry to SHALL NOT dereference any aliases in locating the entry to be
be compared with. compared.
- ava: the assertion with which an attribute in the entry is to be - ava: the assertion with which an attribute in the entry is to be
compared. compared.
The result of the compare attempted by the server upon receipt of a Upon receipt of a Compare Request, a server will attempt to perform
Compare Request is returned in the Compare Response, defined as the requested comparison using the EQUALITY matching rule for the
follows: attribute type and return the result in the Compare Response, defined
as follows:
CompareResponse ::= [APPLICATION 15] LDAPResult CompareResponse ::= [APPLICATION 15] LDAPResult
Sermersheim Internet-Draft - Expires Mar 2004 Page 28 Sermersheim Internet-Draft - Expires Apr 2004 Page 28
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
Upon receipt of a Compare Request, a server will attempt to perform In the event that the attribute or subtype is not present in the
the requested comparison using the EQUALITY matching rule for the entry, the resultCode field is set to noSuchAttribute. If the
attribute type. The result of the comparison will be returned to the attribute is unknown, the resultCode is set to
client in the Compare Response. In the event that the attribute or undefinedAttributeType. Note that errors and the result of comparison
subtype is not present in the entry, the resultCode field is set to are all returned in the same construct.
noSuchAttribute. If the attribute is unknown, the resultCode is set
to undefinedAttributeType. Note that errors and the result of
comparison are all returned in the same construct.
Note that some directory systems may establish access controls which Note that some directory systems may establish access controls which
permit the values of certain attributes (such as userPassword) to be permit the values of certain attributes (such as userPassword) to be
compared but not interrogated by other means. compared but not interrogated by other means.
4.11. Abandon Operation 4.11. Abandon Operation
The function of the Abandon Operation is to allow a client to request The function of the Abandon Operation is to allow a client to request
that the server abandon an outstanding operation. The Abandon Request that the server abandon an outstanding operation. The Abandon Request
is defined as follows: is defined as follows:
skipping to change at line 1602 skipping to change at line 1595
AbandonRequest ::= [APPLICATION 16] MessageID AbandonRequest ::= [APPLICATION 16] MessageID
The MessageID MUST be that of an operation which was requested The MessageID MUST be that of an operation which was requested
earlier in this LDAP association. The abandon request itself has its earlier in this LDAP association. The abandon request itself has its
own message id. This is distinct from the id of the earlier operation own message id. This is distinct from the id of the earlier operation
being abandoned. being abandoned.
There is no response defined in the Abandon operation. Upon receipt There is no response defined in the Abandon operation. Upon receipt
of an AbandonRequest, the server MAY abandon the operation identified of an AbandonRequest, the server MAY abandon the operation identified
by the MessageID. Operation responses are not sent for successfully by the MessageID. Operation responses are not sent for successfully
abandoned operations, thus a client SHOULD NOT use the Abandon abandoned operations, thus the application of the Abandon operation
operation when it needs an indication of whether the operation was is limited to uses where the client does not require an indication of
abandoned. For example, if a client performs an update operation its outcome.
(Add, Modify, or ModifyDN), and it needs to know whether the
directory has changed due to the operation, it should not use the
Abandon operation to cancel the update operation.
Abandon and Unbind operations cannot be abandoned. The ability to Abandon and Unbind operations cannot be abandoned. The ability to
abandon other (particularly update) operations is at the discretion abandon other (particularly update) operations is at the discretion
of the server. of the server.
In the event that a server receives an Abandon Request on a Search In the event that a server receives an Abandon Request on a Search
Operation in the midst of transmitting responses to the search, that Operation in the midst of transmitting responses to the search, that
server MUST cease transmitting entry responses to the abandoned server MUST cease transmitting entry responses to the abandoned
request immediately, and MUST NOT send the SearchResponseDone. Of request immediately, and MUST NOT send the SearchResponseDone. Of
course, the server MUST ensure that only properly encoded LDAPMessage course, the server MUST ensure that only properly encoded LDAPMessage
PDUs are transmitted. PDUs are transmitted.
Clients MUST NOT send abandon requests for the same operation Clients MUST NOT send abandon requests for the same operation
multiple times, and MUST also be prepared to receive results from multiple times, and MUST also be prepared to receive results from
operations it has abandoned (since these may have been in transit operations it has abandoned (since these may have been in transit
when the abandon was requested, or are not able to be abandoned). when the abandon was requested, or are not able to be abandoned).
Sermersheim Internet-Draft - Expires Mar 2004 Page 29
Lightweight Directory Access Protocol Version 3
Servers MUST discard abandon requests for message IDs they do not Servers MUST discard abandon requests for message IDs they do not
recognize, for operations which cannot be abandoned, and for recognize, for operations which cannot be abandoned, and for
operations which have already been abandoned. operations which have already been abandoned.
4.12. Extended Operation 4.12. Extended Operation
Sermersheim Internet-Draft - Expires Apr 2004 Page 29
Lightweight Directory Access Protocol Version 3
An extension mechanism has been added in this version of LDAP, in An extension mechanism has been added in this version of LDAP, in
order to allow additional operations to be defined for services not order to allow additional operations to be defined for services not
available elsewhere in this protocol, for instance digitally signed available elsewhere in this protocol, for instance digitally signed
operations and results. operations and results.
The extended operation allows clients to make requests and receive The extended operation allows clients to make requests and receive
responses with predefined syntaxes and semantics. These may be responses with predefined syntaxes and semantics. These may be
defined in RFCs or be private to particular implementations. Each defined in RFCs or be private to particular implementations. Each
request MUST have a unique OBJECT IDENTIFIER assigned to it. request MUST have a unique OBJECT IDENTIFIER assigned to it.
skipping to change at line 1682 skipping to change at line 1672
Extended operations may be specified in other documents. The Extended operations may be specified in other documents. The
specification of an extended operation consists of: specification of an extended operation consists of:
- the OBJECT IDENTIFIER assigned to the ExtendedRequest.requestName - the OBJECT IDENTIFIER assigned to the ExtendedRequest.requestName
(and possibly ExtendedResponse.responseName), (and possibly ExtendedResponse.responseName),
- the format of the contents of the requestValue and responseValue - the format of the contents of the requestValue and responseValue
(if any), (if any),
Sermersheim Internet-Draft - Expires Mar 2004 Page 30
Lightweight Directory Access Protocol Version 3
- the semantics of the operation, - the semantics of the operation,
Servers list the requestName of all ExtendedRequests they recognize It is RECOMMENDED that servers list the requestName of
in the supportedExtension attribute [Models] in the root DSE. ExtendedRequests they support in the supportedExtension attribute
[Models] in the root DSE.
requestValues and responseValues that are defined in terms of ASN.1 Sermersheim Internet-Draft - Expires Apr 2004 Page 30
and BER encoded according to Section 5.1, also follow the Lightweight Directory Access Protocol Version 3
extensibility rules in Section 4.
4.13. Start TLS Operation 4.13. Start TLS Operation
The Start Transport Layer Security (StartTLS) operation provides the The Start Transport Layer Security (StartTLS) operation provides the
ability to establish Transport Layer Security [RFC2246] on an LDAP ability to establish Transport Layer Security [RFC2246] on an LDAP
connection. connection.
4.13.1. Start TLS Request 4.13.1. Start TLS Request
A client requests TLS establishment by transmitting a Start TLS A client requests TLS establishment by transmitting a Start TLS
skipping to change at line 1736 skipping to change at line 1723
4.13.2.2. Response other than "success" 4.13.2.2. Response other than "success"
If the ExtendedResponse contains a result code other than success, If the ExtendedResponse contains a result code other than success,
this indicates that the server is unwilling or unable to negotiate this indicates that the server is unwilling or unable to negotiate
TLS. The following result codes have these meanings for this TLS. The following result codes have these meanings for this
operation: operation:
- operationsError: operations sequencing incorrect; e.g. TLS already - operationsError: operations sequencing incorrect; e.g. TLS already
established) established)
Sermersheim Internet-Draft - Expires Mar 2004 Page 31
Lightweight Directory Access Protocol Version 3
- protocolError: (TLS not supported or incorrect PDU structure) - protocolError: (TLS not supported or incorrect PDU structure)
- unavailable: (e.g. some major problem with TLS, or server is - unavailable: (e.g. some major problem with TLS, or server is
shutting down) shutting down)
The server MUST return operationsError if the client violates any of The server MUST return operationsError if the client violates any of
the Start TLS extended operation sequencing requirements described in the Start TLS extended operation sequencing requirements described in
section 5.3 of [AuthMeth]. section 5.3 of [AuthMeth].
Sermersheim Internet-Draft - Expires Apr 2004 Page 31
Lightweight Directory Access Protocol Version 3
If the server does not support TLS (whether by design or by current If the server does not support TLS (whether by design or by current
configuration), it MUST set the resultCode field to protocolError. configuration), it MUST set the resultCode field to protocolError.
The client's current association is unaffected if the server does not The client's current association is unaffected if the server does not
support TLS. The client MAY proceed with any LDAP operation, or it support TLS. The client may proceed with any LDAP operation, or it
MAY close the connection. may close the connection.
The server MUST return unavailable if it supports TLS but cannot The server MUST return unavailable if it supports TLS but cannot
establish a TLS connection for some reason, e.g. the certificate establish a TLS connection for some reason, e.g. the certificate
server not responding, it cannot contact its TLS implementation, or server not responding, it cannot contact its TLS implementation, or
if the server is in process of shutting down. The client MAY retry if the server is in process of shutting down. The client may retry
the StartTLS operation, or it MAY proceed with any other LDAP the StartTLS operation, or it may proceed with any other LDAP
operation, or it MAY close the LDAP connection. operation, or it may close the LDAP connection.
4.13.3. Closing a TLS Connection 4.13.3. Closing a TLS Connection
Two forms of TLS connection closure--graceful and abrupt--are Two forms of TLS connection closure--graceful and abrupt--are
supported. supported.
4.13.3.1. Graceful Closure 4.13.3.1. Graceful Closure
Either the client or server MAY terminate the TLS connection and Either the client or server MAY terminate the TLS connection and
leave the LDAP connection intact by sending a TLS closure alert. leave the LDAP connection intact by sending and receiving a TLS
closure alert.
Before sending a TLS closure alert, the client MUST either wait for The initiating protocol peer sends the TLS closure alert. If it
any outstanding LDAP operations to complete, or explicitly abandon wishes to leave the LDAP connection intact, it then MUST cease to
them. send further PDUs and MUST ignore any received PDUs until it receives
a TLS closure alert from the other peer.
After the initiator of a close has sent a TLS closure alert, it MUST Once the initiating protocol peer receives a TLS closure alert from
discard any TLS messages until it has received a TLS closure alert the other peer it MAY send and receive LDAP PDUs.
from the other party. It will cease to send TLS Record Protocol
PDUs, and following the receipt of the alert, MAY send and receive
LDAP PDUs.
The other party, if it receives a TLS closure alert, MUST immediately When a protocol peer receives the initial TLS closure alert, it may
transmit a TLS closure alert. It will subsequently cease to send TLS choose to allow the underlying LDAP connection intact. In this case,
Record Protocol PDUs, and MAY send and receive LDAP PDUs. it MUST immediately transmit a TLS closure alert. Following this, it
MAY send and receive LDAP PDUs.
Protocol peers MAY drop the underlying LDAP connection after sending
or receiving a TLS closure alert.
After the TLS connection has been closed, the server MUST NOT send After the TLS connection has been closed, the server MUST NOT send
responses to any request message received before the TLS closure. responses to any request message received before the TLS closure.
Thus, clients wishing to receive responses to messages sent while the
TLS connection is intact MUST wait for those message responses before
sending the TLS closure alert.
4.13.3.2. Abrupt Closure 4.13.3.2. Abrupt Closure
Sermersheim Internet-Draft - Expires Mar 2004 Page 32
Lightweight Directory Access Protocol Version 3
Either the client or server MAY abruptly close the TLS connection by Either the client or server MAY abruptly close the TLS connection by
dropping the underlying transfer protocol connection. In this dropping the underlying transfer protocol connection. In this
circumstance, a server MAY send the client a Notice of Disconnection circumstance, a server MAY send the client a Notice of Disconnection
before dropping the underlying LDAP connection. before dropping the underlying LDAP connection.
Sermersheim Internet-Draft - Expires Apr 2004 Page 32
Lightweight Directory Access Protocol Version 3
5. Protocol Element Encodings and Transfer 5. Protocol Element Encodings and Transfer
One underlying service is defined here. Clients and servers SHOULD One underlying service is defined here. Clients and servers SHOULD
implement the mapping of LDAP over [TCP] described in 5.2.1. implement the mapping of LDAP over [TCP] described in 5.2.1.
5.1. Protocol Encoding 5.1. Protocol Encoding
The protocol elements of LDAP are encoded for exchange using the 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 Basic Encoding Rules [BER] of [ASN.1]. However, due to the high
the high overhead involved in using certain elements of the BER, the overhead involved in using certain elements of the BER, the following
following additional restrictions are placed on BER-encodings of LDAP additional restrictions are placed on BER-encodings of LDAP protocol
protocol elements: elements:
(1) Only the definite form of length encoding will be used. (1) Only the definite form of length encoding will be used.
(2) OCTET STRING values will be encoded in the primitive form only. (2) OCTET STRING values will be encoded in the primitive form only.
(3) If the value of a BOOLEAN type is true, the encoding MUST have (3) If the value of a BOOLEAN type is true, the encoding MUST have
its contents octets set to hex "FF". its contents octets set to hex "FF".
(4) If a value of a type is its default value, it MUST be absent. (4) If a value of a type is its default value, it MUST be absent.
Only some BOOLEAN and INTEGER types have default values in this Only some BOOLEAN and INTEGER types have default values in this
skipping to change at line 1843 skipping to change at line 1836
The encoded LDAPMessage PDUs are mapped directly onto the [TCP] The encoded LDAPMessage PDUs are mapped directly onto the [TCP]
bytestream using the BER-based encoding described in section 5.1. It bytestream using the BER-based encoding described in section 5.1. It
is recommended that server implementations running over the TCP is recommended that server implementations running over the TCP
provide a protocol listener on the assigned port, 389. Servers may provide a protocol listener on the assigned port, 389. Servers may
instead provide a listener on a different port number. Clients MUST instead provide a listener on a different port number. Clients MUST
support contacting servers on any valid TCP port. support contacting servers on any valid TCP port.
6. Implementation Guidelines 6. Implementation Guidelines
Sermersheim Internet-Draft - Expires Mar 2004 Page 33
Lightweight Directory Access Protocol Version 3
6.1. Server Implementations 6.1. Server Implementations
Sermersheim Internet-Draft - Expires Apr 2004 Page 33
Lightweight Directory Access Protocol Version 3
The server MUST be capable of recognizing all the mandatory attribute The server MUST be capable of recognizing all the mandatory attribute
types specified in [Models], and implement the syntaxes used by those types specified in [Models], and implement the syntaxes used by those
attributes specified in [Syntaxes]. Servers MAY also recognize attributes specified in [Syntaxes]. Servers MAY also recognize
additional attribute type names. additional attribute type names.
6.2. Client Implementations 6.2. Client Implementations
Clients that follow referrals or search continuation references MUST Clients that follow referrals or search continuation references MUST
ensure that they do not loop between servers. They MUST NOT ensure that they do not loop between servers. They MUST NOT
repeatedly contact the same server for the same request with the same repeatedly contact the same server for the same request with the same
skipping to change at line 1873 skipping to change at line 1866
In the absence of prior agreements with servers, clients SHOULD NOT In the absence of prior agreements with servers, clients SHOULD NOT
assume that servers support any particular schemas beyond those assume that servers support any particular schemas beyond those
referenced in section 6.1. Different schemas can have different referenced in section 6.1. Different schemas can have different
attribute types with the same names. The client can retrieve the attribute types with the same names. The client can retrieve the
subschema entries referenced by the subschemaSubentry attribute in subschema entries referenced by the subschemaSubentry attribute in
the entries held by the server. the entries held by the server.
7. Security Considerations 7. Security Considerations
This version of the protocol provides facilities for simple This version of the protocol provides facilities for simple
authentication using a cleartext password, as well as any SASL authentication using a cleartext password, as well as any [SASL]
mechanism [RFC2222]. SASL allows for integrity and privacy services mechanism. SASL allows for integrity and privacy services to be
to be negotiated. negotiated.
It is also permitted that the server can return its credentials to It is also permitted that the server can return its credentials to
the client, if it chooses to do so. the client, if it chooses to do so.
Use of cleartext password is strongly discouraged where the Use of cleartext password is strongly discouraged where the
underlying transport service cannot guarantee confidentiality and may underlying transport service cannot guarantee confidentiality and may
result in disclosure of the password to unauthorized parties. result in disclosure of the password to unauthorized parties.
Requirements of authentication methods, SASL mechanisms, and TLS are Requirements of authentication methods, SASL mechanisms, and TLS are
described in [AUTHMETH]. described in [AUTHMETH].
When used with SASL, it should be noted that the name field of the When used with SASL, it should be noted that the name field of the
BindRequest is not protected against modification. Thus if the BindRequest is not protected against modification. Thus if the
distinguished name of the client (an LDAPDN) is agreed through the distinguished name of the client (an LDAPDN) is agreed through the
negotiation of the credentials, it takes precedence over any value in negotiation of the credentials, it takes precedence over any value in
the unprotected name field. the unprotected name field.
Server implementors should plan for the possibility of an identity or Server implementors should plan for the possibility of an identity
associated with an LDAP connection being deleted, renamed, or associated with an LDAP connection being deleted, renamed, or
modified, and take appropriate actions to prevent insecure side modified, and take appropriate actions to prevent insecure side
Sermersheim Internet-Draft - Expires Mar 2004 Page 34
Lightweight Directory Access Protocol Version 3
effects. The way in which this is dealt with is implementation effects. The way in which this is dealt with is implementation
specific. Likewise, server implementors should plan for the specific. Likewise, server implementors should plan for the
possibility of an associated identities credentials becoming invalid. possibility of an associated identity's credentials becoming invalid.
Sermersheim Internet-Draft - Expires Apr 2004 Page 34
Lightweight Directory Access Protocol Version 3
Implementations which cache attributes and entries obtained via LDAP Implementations which cache attributes and entries obtained via LDAP
MUST ensure that access controls are maintained if that information MUST ensure that access controls are maintained if that information
is to be provided to multiple clients, since servers may have access is to be provided to multiple clients, since servers may have access
control policies which prevent the return of entries or attributes in control policies which prevent the return of entries or attributes in
search results except to particular authenticated clients. For search results except to particular authenticated clients. For
example, caches could serve result information only to the client example, caches could serve result information only to the client
whose request caused it to be in the cache. whose request caused it to be in the cache.
Protocol servers may return referrals which redirect protocol clients Protocol servers may return referrals which redirect protocol clients
to peer servers. It is possible for a rogue application to inject to peer servers. It is possible for a rogue application to inject
such referrals into the data stream in an attempt to redirect a such referrals into the data stream in an attempt to redirect a
client to a rogue server. Protocol clients are advised to be aware of client to a rogue server. Protocol clients are advised to be aware of
this, and possibly reject referrals when confidentiality measures are this, and possibly reject referrals when confidentiality measures are
in place. Protocol clients are advised to ignore referrals from the not in place. Protocol clients are advised to ignore referrals from
Start TLS operation. the Start TLS operation.
Protocol peers MUST be prepared to handle invalid and arbitrary Protocol peers MUST be prepared to handle invalid and arbitrary
length protocol encodings. A number of LDAP security advisories are length protocol encodings. A number of LDAP security advisories are
available through [CERT]. available through [CERT].
8. Acknowledgements 8. Acknowledgements
This document is an update to RFC 2251, by Mark Wahl, Tim Howes, and This document is an update to RFC 2251, by Mark Wahl, Tim Howes, and
Steve Kille. Their work along with the input of individuals of the Steve Kille. Their work along with the input of individuals of the
IETF LDAPEXT, LDUP, LDAPBIS, and other Working Groups is gratefully IETF LDAPEXT, LDUP, LDAPBIS, and other Working Groups is gratefully
acknowledged. acknowledged.
9. Normative References 9. Normative References
[X.500] ITU-T Rec. X.500, "The Directory: Overview of Concepts, [X.500] ITU-T Rec. X.500, "The Directory: Overview of Concepts,
Models and Service", 1993. Models and Service", 1993.
[Roadmap] K. Zeilenga (editor), "LDAP: Technical Specification Road [Roadmap] Zeilenga, K., "LDAP: Technical Specification Road Map",
Map", draft-ietf-ldapbis-roadmap-xx.txt (a work in draft-ietf-ldapbis-roadmap-xx.txt (a work in progress).
progress).
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [Keyword] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", RFC 2119, March 1997. Requirement Levels", RFC 2119, March 1997.
[X.680] ITU-T Recommendation X.680 (07/2002) | ISO/IEC 8824-1:2002 [ASN.1] ITU-T Recommendation X.680 (07/2002) | ISO/IEC 8824-1:2002
"Information Technology - Abstract Syntax Notation One "Information Technology - Abstract Syntax Notation One
(ASN.1): Specification of basic notation" (ASN.1): Specification of basic notation"
[X.690] ITU-T Rec. X.690 (07/2002) | ISO/IEC 8825-1:2002, [BER] ITU-T Rec. X.690 (07/2002) | ISO/IEC 8825-1:2002,
"Information technology - ASN.1 encoding rules: "Information technology - ASN.1 encoding rules:
Specification of Basic Encoding Rules (BER), Canonical Specification of Basic Encoding Rules (BER), Canonical
Encoding Rules (CER) and Distinguished Encoding Rules Encoding Rules (CER) and Distinguished Encoding Rules
(DER)", 2002. (DER)", 2002.
Sermersheim Internet-Draft - Expires Mar 2004 Page 35 [LDAPIANA] Zeilenga, K., "IANA Considerations for LDAP", draft-ietf-
Lightweight Directory Access Protocol Version 3 ldapbis-bcp64-00.txt, (a work in progress).
[LDAPIANA] K. Zeilenga, "IANA Considerations for LDAP", draft-ietf- Sermersheim Internet-Draft - Expires Apr 2004 Page 35
ldapbis-xx.txt (a work in progress). Lightweight Directory Access Protocol Version 3
[ISO10646] Universal Multiple-Octet Coded Character Set (UCS) - [ISO10646] Universal Multiple-Octet Coded Character Set (UCS) -
Architecture and Basic Multilingual Plane, ISO/IEC 10646-1 Architecture and Basic Multilingual Plane, ISO/IEC 10646-1
: 1993. : 1993.
[RFC2279] Yergeau, F., "UTF-8, a transformation format of Unicode [UTF-8] Yergeau, F., "UTF-8, a transformation format of Unicode
and ISO 10646", RFC 2279, January 1998. and ISO 10646", draft-yergeau-rfc2279bis-xx.txt, (a work
in progress).
[Models] K. Zeilenga, "LDAP: The Models", draft-ietf-ldapbis- [Models] Zeilenga, K., "LDAP: Directory Information Models", draft-
models-xx.txt (a work in progress). ietf-ldapbis-models-xx.txt (a work in progress).
[LDAPDN] K. Zeilenga (editor), "LDAP: String Representation of [LDAPDN] Zeilenga, K., "LDAP: String Representation of
Distinguished Names", draft-ietf-ldapbis-dn-xx.txt, (a Distinguished Names", draft-ietf-ldapbis-dn-xx.txt, (a
work in progress). work in progress).
[Syntaxes] K. Dally (editor), "LDAP: Syntaxes", draft-ietf-ldapbis- [Syntaxes] Legg, S., and K. Dally, "LDAP: Syntaxes and Matching
syntaxes-xx.txt, (a work in progress). Rules", draft-ietf-ldapbis-syntaxes-xx.txt, (a work in
progress).
[X.501] ITU-T Rec. X.501, "The Directory: Models", 1993. [X.501] ITU-T Rec. X.501, "The Directory: Models", 1993.
[X.511] ITU-T Rec. X.511, "The Directory: Abstract Service [X.511] ITU-T Rec. X.511, "The Directory: Abstract Service
Definition", 1993. Definition", 1993.
[RFC2396] Berners-Lee, T., Fielding, R., and L. Masinter Uniform [URI] Berners-Lee, T., Fielding, R., and L. Masinter Uniform
Resource Identifiers (URI): Generic Syntax", RFC 2396, Resource Identifiers (URI): Generic Syntax", RFC 2396,
August 1998. August 1998.
[AuthMeth] R. Harrison (editor), "LDAP: Authentication Methods", [AuthMeth] Harrison, R., "LDAP: Authentication Methods and Connection
draft-ietf-ldapbis-authmeth-xx.txt, (a work in progress). Level Security Mechanisms ", draft-ietf-ldapbis-authmeth-
xx.txt, (a work in progress).
[RFC2222] Meyers, J., "Simple Authentication and Security Layer", [SASL] Meyers, J., "Simple Authentication and Security Layer",
RFC 2222, October 1997. RFC 2222, October 1997.
[SASLPrep] Zeilenga, K., "Stringprep profile for user names and [SASLPrep] Zeilenga, K., "Stringprep profile for user names and
passwords", draft-ietf-sasl-saslprep-xx.txt, (a work in passwords", draft-ietf-sasl-saslprep-xx.txt, (a work in
progress). progress).
[Unicode] The Unicode Consortium, "The Unicode Standard, Version [Unicode] The Unicode Consortium, "The Unicode Standard, Version
3.2.0" is defined by "The Unicode Standard, Version 3.0" 3.2.0" is defined by "The Unicode Standard, Version 3.0"
(Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5), (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5),
as amended by the "Unicode Standard Annex #27: Unicode as amended by the "Unicode Standard Annex #27: Unicode
3.1" (http://www.unicode.org/reports/tr27/) and by the 3.1" (http://www.unicode.org/reports/tr27/) and by the
"Unicode Standard Annex #28: Unicode 3.2" "Unicode Standard Annex #28: Unicode 3.2"
(http://www.unicode.org/reports/tr28/). (http://www.unicode.org/reports/tr28/).
[TCP] Postel, J., "Transmission Control Protocol", STD7, [TCP] Postel, J., "Transmission Control Protocol", STD7 and RFC
September 1981 793, September 1981
[IP] Postel, J., "Internet Protocol", STD5, September 1981 [IP] Postel, J., "Internet Protocol", STD5 and RFC 791,
September 1981
Sermersheim Internet-Draft - Expires Mar 2004 Page 36 Sermersheim Internet-Draft - Expires Apr 2004 Page 36
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
10. Informative References 10. Informative References
[CERT] the CERT(R) Center, (http://www.cert.org) [CERT] the CERT(R) Center, (http://www.cert.org)
11. IANA Considerations 11. IANA Considerations
It is requested that the Internet Assigned Numbers Authority (IANA) It is requested that the Internet Assigned Numbers Authority (IANA)
update the occurrence of "RFC XXXX" Appendix B with this RFC number update the occurrence of "RFC XXXX" in Appendix B with this RFC
at publication. number at publication.
12. Editor's Address 12. Editor's Address
Jim Sermersheim Jim Sermersheim
Novell, Inc. Novell, Inc.
1800 South Novell Place 1800 South Novell Place
Provo, Utah 84606, USA Provo, Utah 84606, USA
jimse@novell.com jimse@novell.com
+1 801 861-3088 +1 801 861-3088
Sermersheim Internet-Draft - Expires Mar 2004 Page 37 Sermersheim Internet-Draft - Expires Apr 2004 Page 37
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
Appendix A - LDAP Result Codes Appendix A - LDAP Result Codes
This normative appendix details additional considerations regarding This normative appendix details additional considerations regarding
LDAP result codes and provides a brief, general description of each LDAP result codes and provides a brief, general description of each
LDAP result code enumerated in Section 4.1.10. LDAP result code enumerated in Section 4.1.10.
Additional result codes MAY be defined for use with extensions. Additional result codes MAY be defined for use with extensions
Client implementations SHALL treat any result code which they do not [LDAPIANA]. Client implementations SHALL treat any result code which
recognize as an unknown error condition. they do not recognize as an unknown error condition.
A.1 Non-Error Result Codes A.1 Non-Error Result Codes
These result codes (called "non-error" result codes) do not indicate These result codes (called "non-error" result codes) do not indicate
an error condition: an error condition:
success (0), success (0),
compareTrue (6), compareTrue (6),
compareFalse (7), compareFalse (7),
referral (10), and referral (10), and
saslBindInProgress (14). saslBindInProgress (14).
The success, compareTrue, and compare result codes indicate The success, compareTrue, and compare result codes indicate
successful completion (and, hence, are called to as "successful" successful completion (and, hence, are referred to as "successful"
result codes). result codes).
The referral and saslBindInProgress result codes indicate the client The referral and saslBindInProgress result codes indicate the client
is required to take additional action to complete the operation is required to take additional action to complete the operation
A.2 Result Codes A.2 Result Codes
Existing LDAP result codes are described as follows: Existing LDAP result codes are described as follows:
success (0) success (0)
Indicates the successful completion of an operation.
Indicates successful completion of an operation.
This result code is normally not returned by the compare
operation, see compareFalse and compareTrue. It is possible
that a future extension mechanism would allow this to be
returned by a compare operation.
operationsError (1) operationsError (1)
Indicates that the operation is not properly sequenced with Indicates that the operation is not properly sequenced with
relation to other operations (of same or different type). relation to other operations (of same or different type).
For example, this code is returned if the client attempts to For example, this code is returned if the client attempts to
Start TLS [RFC2246] while there are other operations Start TLS [RFC2246] while there are other operations
outstanding or if TLS was already established. outstanding or if TLS was already established.
protocolError (2) protocolError (2)
Sermersheim Internet-Draft - Expires Mar 2004 Page 38
Lightweight Directory Access Protocol Version 3
Indicates the server received data which has incorrect Indicates the server received data which has incorrect
structure. structure.
For bind operation only, the code may be resulted to indicate For bind operation only, the code may be returned to indicate
the server does not support the requested protocol version. the server does not support the requested protocol version.
timeLimitExceeded (3) timeLimitExceeded (3)
Indicates that the time limit specified by the client was Indicates that the time limit specified by the client was
exceeded before the operation could be completed. exceeded before the operation could be completed.
sizeLimitExceeded (4) sizeLimitExceeded (4)
Sermersheim Internet-Draft - Expires Apr 2004 Page 38
Lightweight Directory Access Protocol Version 3
Indicates that the size limit specified by the client was Indicates that the size limit specified by the client was
exceeded before the operation could be completed. exceeded before the operation could be completed.
compareFalse (5) compareFalse (5)
Indicates that the compare operation has successfully
Indicates that the operation successfully completes and the completed and the assertion has evaluated to FALSE.
assertion has evaluated to FALSE.
This result code is normally only returned by the compare
operation.
compareTrue (6) compareTrue (6)
Indicates that the compare operation has successfully
Indicates that the operation successfully completes and the completed and the assertion has evaluated to TRUE.
assertion has evaluated to TRUE.
This result code is normally only returned by the compare
operation.
authMethodNotSupported (7) authMethodNotSupported (7)
Indicates that the authentication method or mechanism is not Indicates that the authentication method or mechanism is not
supported. supported.
strongAuthRequired (8) strongAuthRequired (8)
Indicates that the server has detected that an established Indicates that the server has detected that an established
security association between the client and server has security association between the client and server has
unexpectedly failed or been compromised, or that the server unexpectedly failed or been compromised, or that the server
now requires the client to authenticate using a strong(er) now requires the client to authenticate using a strong(er)
mechanism. mechanism.
referral (10) referral (10)
Sermersheim Internet-Draft - Expires Mar 2004 Page 39
Lightweight Directory Access Protocol Version 3
Indicates that a referral needs to be chased to complete the Indicates that a referral needs to be chased to complete the
operation (see section 4.1.11). operation (see section 4.1.11).
adminLimitExceeded (11) adminLimitExceeded (11)
Indicates that an administrative limit has been exceeded. Indicates that an administrative limit has been exceeded.
unavailableCriticalExtension (12) unavailableCriticalExtension (12)
Indicates that server cannot perform a critical extension Indicates that server cannot perform a critical extension
(see section 4.1.12). (see section 4.1.12).
confidentialityRequired (13) confidentialityRequired (13)
Indicates that data confidentiality protections are required. Indicates that data confidentiality protections are required.
saslBindInProgress (14) saslBindInProgress (14)
Indicates the server requires the client to send a new bind Indicates the server requires the client to send a new bind
request, with the same SASL mechanism, to continue the request, with the same SASL mechanism, to continue the
authentication process (see section 4.2). authentication process (see section 4.2).
noSuchAttribute (16) noSuchAttribute (16)
Indicates that the named entry does not contain the specified Indicates that the named entry does not contain the specified
attribute or attribute value. attribute or attribute value.
undefinedAttributeType (17) undefinedAttributeType (17)
Indicates that a request field contains an undefined Indicates that a request field contains an undefined
attribute type. attribute type.
inappropriateMatching (18) inappropriateMatching (18)
Indicates that an attempt was made, e.g. in a filter, to use
Indicates that a request cannot be completed due to an a matching rule not defined for the attribute type concerned.
inappropriate matching.
constraintViolation (19) constraintViolation (19)
Indicates that the client supplied an attribute value which Sermersheim Internet-Draft - Expires Apr 2004 Page 39
does not conform to constraints placed upon it by the data Lightweight Directory Access Protocol Version 3
model.
For example, this code is returned when the multiple values Indicates that the client supplied an attribute value which
are supplied to an attribute which has a SINGLE-VALUE does not conform to the constraints placed upon it by the
constraint. data model.
Sermersheim Internet-Draft - Expires Mar 2004 Page 40 For example, this code is returned when multiple values are
Lightweight Directory Access Protocol Version 3 supplied to an attribute which has a SINGLE-VALUE constraint.
attributeOrValueExists (20) attributeOrValueExists (20)
Indicates that the client supplied an attribute or value to Indicates that the client supplied an attribute or value to
be added to an entry already exists. be added to an entry, but the attribute or value already
exists.
invalidAttributeSyntax (21) invalidAttributeSyntax (21)
Indicates that a purported attribute value does not conform Indicates that a purported attribute value does not conform
to the syntax of the attribute. to the syntax of the attribute.
noSuchObject (32) noSuchObject (32)
Indicates that the object does not exist in the DIT. Indicates that the object does not exist in the DIT.
aliasProblem (33) aliasProblem (33)
Indicates that an alias problem has occurred. Typically an Indicates that an alias problem has occurred. Typically an
alias has been dereferenced which names no object. alias has been dereferenced which names no object.
invalidDNSyntax (34) invalidDNSyntax (34)
Indicates that an LDAPDN or RelativeLDAPDN field (e.g. search
Indicates that a LDAPDN or RelativeLDAPDN field (e.g. search
base, target entry, ModifyDN newrdn, etc.) of a request does base, target entry, ModifyDN newrdn, etc.) of a request does
not conform to the required syntax or contains attribute not conform to the required syntax or contains attribute
values which do not conform to the syntax of the attribute's values which do not conform to the syntax of the attribute's
type. type.
aliasDereferencingProblem (36) aliasDereferencingProblem (36)
Indicates that a problem occurred while dereferencing an Indicates that a problem occurred while dereferencing an
alias. Typically an alias was encountered in a situation alias. Typically an alias was encountered in a situation
where it was not allowed or where access was denied. where it was not allowed or where access was denied.
inappropriateAuthentication (48) inappropriateAuthentication (48)
Indicates the server requires the client which had attempted Indicates the server requires the client which had attempted
to bind anonymously or without supplying credentials to to bind anonymously or without supplying credentials to
provide some form of credentials, provide some form of credentials.
invalidCredentials (49) invalidCredentials (49)
Indicates the supplied password or SASL credentials are Indicates the supplied password or SASL credentials are
invalid. invalid.
Sermersheim Internet-Draft - Expires Mar 2004 Page 41
Lightweight Directory Access Protocol Version 3
insufficientAccessRights (50) insufficientAccessRights (50)
Indicates that the client does not have sufficient access Indicates that the client does not have sufficient access
rights to perform the operation. rights to perform the operation.
busy (51) busy (51)
Indicates that the server is busy. Indicates that the server is busy.
unavailable (52) unavailable (52)
Indicates that the server is shutting down or a subsystem Indicates that the server is shutting down or a subsystem
necessary to complete the operation is offline. necessary to complete the operation is offline.
unwillingToPerform (53) Sermersheim Internet-Draft - Expires Apr 2004 Page 40
Lightweight Directory Access Protocol Version 3
unwillingToPerform (53)
Indicates that the server is unwilling to perform the Indicates that the server is unwilling to perform the
operation. operation.
loopDetect (54) loopDetect (54)
Indicates that the server has detected an internal loop. Indicates that the server has detected an internal loop.
namingViolation (64) namingViolation (64)
Indicates that the entry name violates naming restrictions. Indicates that the entry name violates naming restrictions.
objectClassViolation (65) objectClassViolation (65)
Indicates that the entry violates object class restrictions. Indicates that the entry violates object class restrictions.
notAllowedOnNonLeaf (66) notAllowedOnNonLeaf (66)
Indicates that the operation is inappropriately acting upon a
Indicates that operation is inappropriately acting upon a
non-leaf entry. non-leaf entry.
notAllowedOnRDN (67) notAllowedOnRDN (67)
Indicates that the operation is inappropriately attempting to Indicates that the operation is inappropriately attempting to
remove a value which forms the entry's relative distinguished remove a value which forms the entry's relative distinguished
name. name.
entryAlreadyExists (68) entryAlreadyExists (68)
Indicates that the request cannot be fulfilled (added, moved,
Indicates that the request cannot be added fulfilled as the or renamed) as the target entry already exists.
entry already exists.
Sermersheim Internet-Draft - Expires Mar 2004 Page 42
Lightweight Directory Access Protocol Version 3
objectClassModsProhibited (69) objectClassModsProhibited (69)
Indicates that the attempt to modify the object class(es) of Indicates that the attempt to modify the object class(es) of
an entry objectClass attribute is prohibited. an entry's objectClass attribute is prohibited.
For example, this code is returned when a when a client For example, this code is returned when a client attempts to
attempts to modify the structural object class of an entry. modify the structural object class of an entry.
affectsMultipleDSAs (71) affectsMultipleDSAs (71)
Indicates that the operation cannot be completed as it Indicates that the operation cannot be completed as it
affects multiple servers (DSAs). affects multiple servers (DSAs).
other (80) other (80)
Indicates the server has encountered an internal error. Indicates the server has encountered an internal error.
Sermersheim Internet-Draft - Expires Mar 2004 Page 43 Sermersheim Internet-Draft - Expires Apr 2004 Page 41
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
Appendix B - Complete ASN.1 Definition Appendix B - Complete ASN.1 Definition
This appendix is normative. This appendix is normative.
Lightweight-Directory-Access-Protocol-V3 Lightweight-Directory-Access-Protocol-V3
-- Copyright (C) The Internet Society (2003). This version of -- Copyright (C) The Internet Society (2003). This version of
-- this ASN.1 module is part of RFC XXXX; see the RFC itself -- this ASN.1 module is part of RFC XXXX; see the RFC itself
-- for full legal notices. -- for full legal notices.
skipping to change at line 2348 skipping to change at line 2289
... }, ... },
controls [0] Controls OPTIONAL } controls [0] Controls OPTIONAL }
MessageID ::= INTEGER (0 .. maxInt) MessageID ::= INTEGER (0 .. maxInt)
maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) --
LDAPString ::= OCTET STRING -- UTF-8 encoded, LDAPString ::= OCTET STRING -- UTF-8 encoded,
-- [ISO10646] characters -- [ISO10646] characters
LDAPOID ::= OCTET STRING -- Constrained to numericoid [Models] LDAPOID ::= OCTET STRING -- Constrained to <numericoid> [Models]
LDAPDN ::= LDAPString LDAPDN ::= LDAPString
RelativeLDAPDN ::= LDAPString RelativeLDAPDN ::= LDAPString
AttributeDescription ::= LDAPString AttributeDescription ::= LDAPString
Sermersheim Internet-Draft - Expires Mar 2004 Page 44 Sermersheim Internet-Draft - Expires Apr 2004 Page 42
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
-- Constrained to attributedescription -- Constrained to <attributedescription>
-- [Models] -- [Models]
AttributeSelection ::= SEQUENCE OF
LDAPString
AttributeValue ::= OCTET STRING AttributeValue ::= OCTET STRING
AttributeValueAssertion ::= SEQUENCE { AttributeValueAssertion ::= SEQUENCE {
attributeDesc AttributeDescription, attributeDesc AttributeDescription,
assertionValue AssertionValue } assertionValue AssertionValue }
AssertionValue ::= OCTET STRING AssertionValue ::= OCTET STRING
Attribute ::= SEQUENCE { Attribute ::= SEQUENCE {
type AttributeDescription, type AttributeDescription,
vals SET OF AttributeValue } vals SET SIZE (1..MAX) OF value AttributeValue }
MatchingRuleId ::= LDAPString MatchingRuleId ::= LDAPString
LDAPResult ::= SEQUENCE { LDAPResult ::= SEQUENCE {
resultCode ENUMERATED { resultCode ENUMERATED {
success (0), success (0),
operationsError (1), operationsError (1),
protocolError (2), protocolError (2),
timeLimitExceeded (3), timeLimitExceeded (3),
sizeLimitExceeded (4), sizeLimitExceeded (4),
skipping to change at line 2413 skipping to change at line 2351
noSuchObject (32), noSuchObject (32),
aliasProblem (33), aliasProblem (33),
invalidDNSyntax (34), invalidDNSyntax (34),
-- 35 reserved for undefined isLeaf -- -- 35 reserved for undefined isLeaf --
aliasDereferencingProblem (36), aliasDereferencingProblem (36),
-- 37-47 unused -- -- 37-47 unused --
inappropriateAuthentication (48), inappropriateAuthentication (48),
invalidCredentials (49), invalidCredentials (49),
insufficientAccessRights (50), insufficientAccessRights (50),
busy (51), busy (51),
Sermersheim Internet-Draft - Expires Mar 2004 Page 45
Lightweight Directory Access Protocol Version 3
unavailable (52), unavailable (52),
unwillingToPerform (53), unwillingToPerform (53),
loopDetect (54), loopDetect (54),
Sermersheim Internet-Draft - Expires Apr 2004 Page 43
Lightweight Directory Access Protocol Version 3
-- 55-63 unused -- -- 55-63 unused --
namingViolation (64), namingViolation (64),
objectClassViolation (65), objectClassViolation (65),
notAllowedOnNonLeaf (66), notAllowedOnNonLeaf (66),
notAllowedOnRDN (67), notAllowedOnRDN (67),
entryAlreadyExists (68), entryAlreadyExists (68),
objectClassModsProhibited (69), objectClassModsProhibited (69),
-- 70 reserved for CLDAP -- -- 70 reserved for CLDAP --
affectsMultipleDSAs (71), affectsMultipleDSAs (71),
-- 72-79 unused -- -- 72-79 unused --
other (80), other (80),
... }, ... },
-- 81-90 reserved for APIs -- -- 81-90 reserved for APIs --
matchedDN LDAPDN, matchedDN LDAPDN,
diagnosticMessage LDAPString, diagnosticMessage LDAPString,
referral [3] Referral OPTIONAL } referral [3] Referral OPTIONAL }
Referral ::= SEQUENCE OF URL Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI
URL ::= LDAPString -- limited to characters permitted in URI ::= LDAPString -- limited to characters permitted in
-- URLs -- URIs
Controls ::= SEQUENCE OF Control Controls ::= SEQUENCE OF control Control
Control ::= SEQUENCE { Control ::= SEQUENCE {
controlType LDAPOID, controlType LDAPOID,
criticality BOOLEAN DEFAULT FALSE, criticality BOOLEAN DEFAULT FALSE,
controlValue OCTET STRING OPTIONAL } controlValue OCTET STRING OPTIONAL }
BindRequest ::= [APPLICATION 0] SEQUENCE { BindRequest ::= [APPLICATION 0] SEQUENCE {
version INTEGER (1 .. 127), version INTEGER (1 .. 127),
name LDAPDN, name LDAPDN,
authentication AuthenticationChoice } authentication AuthenticationChoice }
skipping to change at line 2471 skipping to change at line 2409
mechanism LDAPString, mechanism LDAPString,
credentials OCTET STRING OPTIONAL } credentials OCTET STRING OPTIONAL }
BindResponse ::= [APPLICATION 1] SEQUENCE { BindResponse ::= [APPLICATION 1] SEQUENCE {
COMPONENTS OF LDAPResult, COMPONENTS OF LDAPResult,
serverSaslCreds [7] OCTET STRING OPTIONAL } serverSaslCreds [7] OCTET STRING OPTIONAL }
UnbindRequest ::= [APPLICATION 2] NULL UnbindRequest ::= [APPLICATION 2] NULL
SearchRequest ::= [APPLICATION 3] SEQUENCE { SearchRequest ::= [APPLICATION 3] SEQUENCE {
Sermersheim Internet-Draft - Expires Mar 2004 Page 46
Lightweight Directory Access Protocol Version 3
baseObject LDAPDN, baseObject LDAPDN,
scope ENUMERATED { scope ENUMERATED {
baseObject (0), baseObject (0),
Sermersheim Internet-Draft - Expires Apr 2004 Page 44
Lightweight Directory Access Protocol Version 3
singleLevel (1), singleLevel (1),
wholeSubtree (2) }, wholeSubtree (2) },
derefAliases ENUMERATED { derefAliases ENUMERATED {
neverDerefAliases (0), neverDerefAliases (0),
derefInSearching (1), derefInSearching (1),
derefFindingBaseObj (2), derefFindingBaseObj (2),
derefAlways (3) }, derefAlways (3) },
sizeLimit INTEGER (0 .. maxInt), sizeLimit INTEGER (0 .. maxInt),
timeLimit INTEGER (0 .. maxInt), timeLimit INTEGER (0 .. maxInt),
typesOnly BOOLEAN, typesOnly BOOLEAN,
filter Filter, filter Filter,
attributes AttributeSelection } attributes AttributeSelection }
AttributeSelection ::= SEQUENCE OF selection LDAPString
Filter ::= CHOICE { Filter ::= CHOICE {
and [0] SET SIZE (1..MAX) OF Filter, and [0] SET SIZE (1..MAX) OF filter Filter,
or [1] SET SIZE (1..MAX) OF Filter, or [1] SET SIZE (1..MAX) OF filter Filter,
not [2] Filter, not [2] Filter,
equalityMatch [3] AttributeValueAssertion, equalityMatch [3] AttributeValueAssertion,
substrings [4] SubstringFilter, substrings [4] SubstringFilter,
greaterOrEqual [5] AttributeValueAssertion, greaterOrEqual [5] AttributeValueAssertion,
lessOrEqual [6] AttributeValueAssertion, lessOrEqual [6] AttributeValueAssertion,
present [7] AttributeDescription, present [7] AttributeDescription,
approxMatch [8] AttributeValueAssertion, approxMatch [8] AttributeValueAssertion,
extensibleMatch [9] MatchingRuleAssertion } extensibleMatch [9] MatchingRuleAssertion }
SubstringFilter ::= SEQUENCE { SubstringFilter ::= SEQUENCE {
type AttributeDescription, type AttributeDescription,
-- at least one must be present, -- at least one must be present,
-- initial and final can occur at most once -- initial and final can occur at most once
substrings SEQUENCE OF CHOICE { substrings SEQUENCE SIZE (1..MAX) OF substring CHOICE {
initial [0] AssertionValue, initial [0] AssertionValue,
any [1] AssertionValue, any [1] AssertionValue,
final [2] AssertionValue } } final [2] AssertionValue } }
MatchingRuleAssertion ::= SEQUENCE { MatchingRuleAssertion ::= SEQUENCE {
matchingRule [1] MatchingRuleId OPTIONAL, matchingRule [1] MatchingRuleId OPTIONAL,
type [2] AttributeDescription OPTIONAL, type [2] AttributeDescription OPTIONAL,
matchValue [3] AssertionValue, matchValue [3] AssertionValue,
dnAttributes [4] BOOLEAN DEFAULT FALSE } dnAttributes [4] BOOLEAN DEFAULT FALSE }
SearchResultEntry ::= [APPLICATION 4] SEQUENCE { SearchResultEntry ::= [APPLICATION 4] SEQUENCE {
objectName LDAPDN, objectName LDAPDN,
attributes PartialAttributeList } attributes PartialAttributeList }
PartialAttributeList ::= SEQUENCE OF SEQUENCE { PartialAttributeList ::= SEQUENCE OF
type AttributeDescription, attribute PartialAttribute
vals SET OF AttributeValue }
SearchResultReference ::= [APPLICATION 19] SEQUENCE OF URL PartialAttribute ::= SEQUENCE {
type AttributeDescription,
vals SET OF value AttributeValue }
SearchResultDone ::= [APPLICATION 5] LDAPResult SearchResultReference ::= [APPLICATION 19] SEQUENCE
Sermersheim Internet-Draft - Expires Mar 2004 Page 47 Sermersheim Internet-Draft - Expires Apr 2004 Page 45
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
SIZE (1..MAX) OF uri URI
SearchResultDone ::= [APPLICATION 5] LDAPResult
ModifyRequest ::= [APPLICATION 6] SEQUENCE { ModifyRequest ::= [APPLICATION 6] SEQUENCE {
object LDAPDN, object LDAPDN,
changes SEQUENCE OF SEQUENCE { changes SEQUENCE OF change SEQUENCE {
operation ENUMERATED { operation ENUMERATED {
add (0), add (0),
delete (1), delete (1),
replace (2) }, replace (2) },
modification Attribute } } modification PartialAttribute } }
ModifyResponse ::= [APPLICATION 7] LDAPResult ModifyResponse ::= [APPLICATION 7] LDAPResult
AddRequest ::= [APPLICATION 8] SEQUENCE { AddRequest ::= [APPLICATION 8] SEQUENCE {
entry LDAPDN, entry LDAPDN,
attributes AttributeList } attributes AttributeList }
AttributeList ::= SEQUENCE OF SEQUENCE { AttributeList ::= SEQUENCE OF attribute Attribute
type AttributeDescription,
vals SET OF AttributeValue }
AddResponse ::= [APPLICATION 9] LDAPResult AddResponse ::= [APPLICATION 9] LDAPResult
DelRequest ::= [APPLICATION 10] LDAPDN DelRequest ::= [APPLICATION 10] LDAPDN
DelResponse ::= [APPLICATION 11] LDAPResult DelResponse ::= [APPLICATION 11] LDAPResult
ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { ModifyDNRequest ::= [APPLICATION 12] SEQUENCE {
entry LDAPDN, entry LDAPDN,
newrdn RelativeLDAPDN, newrdn RelativeLDAPDN,
skipping to change at line 2585 skipping to change at line 2528
requestName [0] LDAPOID, requestName [0] LDAPOID,
requestValue [1] OCTET STRING OPTIONAL } requestValue [1] OCTET STRING OPTIONAL }
ExtendedResponse ::= [APPLICATION 24] SEQUENCE { ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
COMPONENTS OF LDAPResult, COMPONENTS OF LDAPResult,
responseName [10] LDAPOID OPTIONAL, responseName [10] LDAPOID OPTIONAL,
responseValue [11] OCTET STRING OPTIONAL } responseValue [11] OCTET STRING OPTIONAL }
END END
Sermersheim Internet-Draft - Expires Mar 2004 Page 48 Sermersheim Internet-Draft - Expires Apr 2004 Page 46
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
Appendix C - Change History Appendix C - Change History
<Note to RFC editor: This section is to be removed prior to RFC <Note to RFC editor: This section is to be removed prior to RFC
publication> publication>
C.1 Changes made to RFC 2251: C.1 Changes made to RFC 2251:
C.1.1 Editorial C.1.1 Editorial
skipping to change at line 2642 skipping to change at line 2585
the transfer encoding is present in attributeDesc, the the transfer encoding is present in attributeDesc, the
AssertionValue is encoded as specified by the option...". AssertionValue is encoded as specified by the option...".
Previously, only the ;binary option was mentioned. Previously, only the ;binary option was mentioned.
C.2.3 Sections 4.2, 4.9, 4.10 C.2.3 Sections 4.2, 4.9, 4.10
- Added alias dereferencing specifications. In the case of modDN, - Added alias dereferencing specifications. In the case of modDN,
followed precedent set on other update operations (... alias is followed precedent set on other update operations (... alias is
not dereferenced...) In the case of bind and compare stated that not dereferenced...) In the case of bind and compare stated that
Sermersheim Internet-Draft - Expires Mar 2004 Page 49 Sermersheim Internet-Draft - Expires Apr 2004 Page 47
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
servers SHOULD NOT dereference aliases. Specifications were added servers SHOULD NOT dereference aliases. Specifications were added
because they were missing from the previous version and caused because they were missing from the previous version and caused
interoperability problems. Concessions were made for bind and interoperability problems. Concessions were made for bind and
compare (neither should have ever allowed alias dereferencing) by compare (neither should have ever allowed alias dereferencing) by
using SHOULD NOT language, due to the behavior of some existing using SHOULD NOT language, due to the behavior of some existing
implementations. implementations.
C.2.4 Sections 4.5 and Appendix A C.2.4 Sections 4.5 and Appendix A
skipping to change at line 2698 skipping to change at line 2641
by a lower layer" to "the underlying transport service cannot by a lower layer" to "the underlying transport service cannot
guarantee confidentiality" guarantee confidentiality"
C.3.6 Section 4.5.2 C.3.6 Section 4.5.2
- Removed all mention of ExtendedResponse due to lack of - Removed all mention of ExtendedResponse due to lack of
implementation. implementation.
C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt: C.4 Changes made to draft-ietf-ldapbis-protocol-02.txt:
Sermersheim Internet-Draft - Expires Mar 2004 Page 50 Sermersheim Internet-Draft - Expires Apr 2004 Page 48
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
C.4.1 Section 4 C.4.1 Section 4
- Removed "typically" from "and is typically transferred" in the - Removed "typically" from "and is typically transferred" in the
first paragraph. We know of no (and can conceive of no) case where first paragraph. We know of no (and can conceive of no) case where
this isn't true. this isn't true.
- Added "Section 5.1 specifies how the LDAP protocol is encoded." To - Added "Section 5.1 specifies how the LDAP protocol is encoded." To
the first paragraph. Added this cross reference for readability. the first paragraph. Added this cross reference for readability.
- Changed "version 3 " to "version 3 or later" in the second - Changed "version 3 " to "version 3 or later" in the second
skipping to change at line 2754 skipping to change at line 2697
controls). controls).
C.4.6 Section 4.4 C.4.6 Section 4.4
- Changed "One unsolicited notification is defined" to "One - Changed "One unsolicited notification is defined" to "One
unsolicited notification (Notice of Disconnection) is defined" in unsolicited notification (Notice of Disconnection) is defined" in
the third paragraph. For clarity and readability. the third paragraph. For clarity and readability.
C.4.7 Section 4.5.1 C.4.7 Section 4.5.1
Sermersheim Internet-Draft - Expires Mar 2004 Page 51 Sermersheim Internet-Draft - Expires Apr 2004 Page 49
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
- Changed "checking for the existence of the objectClass attribute" - Changed "checking for the existence of the objectClass attribute"
to "checking for the presence of the objectClass attribute" in the to "checking for the presence of the objectClass attribute" in the
last paragraph. This was done as a measure of consistency (we use last paragraph. This was done as a measure of consistency (we use
the terms present and presence rather than exists and existence in the terms present and presence rather than exists and existence in
search filters). search filters).
C.4.8 Section 4.5.3 C.4.8 Section 4.5.3
skipping to change at line 2810 skipping to change at line 2753
whether there can be more than one value of an attribute of that whether there can be more than one value of an attribute of that
type in an entry, the syntax to which the values must conform, the type in an entry, the syntax to which the values must conform, the
kinds of matching which can be performed on values of that kinds of matching which can be performed on values of that
attribute, and other functions." to " An attribute is a attribute, and other functions." to " An attribute is a
description (a type and zero or more options) with one or more description (a type and zero or more options) with one or more
associated values. The attribute type governs whether the associated values. The attribute type governs whether the
attribute can have multiple values, the syntax and matching rules attribute can have multiple values, the syntax and matching rules
used to construct and compare values of that attribute, and other used to construct and compare values of that attribute, and other
functions. Options indicate modes of transfer and other functions. Options indicate modes of transfer and other
Sermersheim Internet-Draft - Expires Mar 2004 Page 52 Sermersheim Internet-Draft - Expires Apr 2004 Page 50
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
functions.". This points out that an attribute consists of both functions.". This points out that an attribute consists of both
the type and options. the type and options.
C.5.2 Section 4 C.5.2 Section 4
- Changed "Section 5.1 specifies the encoding rules for the LDAP - Changed "Section 5.1 specifies the encoding rules for the LDAP
protocol" to "Section 5.1 specifies how the protocol is encoded protocol" to "Section 5.1 specifies how the protocol is encoded
and transferred." and transferred."
skipping to change at line 2867 skipping to change at line 2810
- Changed the wording regarding 'equally capable' referrals to "If - Changed the wording regarding 'equally capable' referrals to "If
multiple URLs are present, the client assumes that any URL may be multiple URLs are present, the client assumes that any URL may be
used to progress the operation.". The previous language implied used to progress the operation.". The previous language implied
that the server MUST enforce rules that it was practically that the server MUST enforce rules that it was practically
incapable of. The new language highlights the original intent-- incapable of. The new language highlights the original intent--
that is, that any of the referrals may be used to progress the that is, that any of the referrals may be used to progress the
operation, there is no inherent 'weighting' mechanism. operation, there is no inherent 'weighting' mechanism.
C.5.7 Section 4.5.1 and Appendix A C.5.7 Section 4.5.1 and Appendix A
Sermersheim Internet-Draft - Expires Mar 2004 Page 53 Sermersheim Internet-Draft - Expires Apr 2004 Page 51
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
- Added the comment "-- initial and final can occur at most once", - Added the comment "-- initial and final can occur at most once",
to clarify this restriction. to clarify this restriction.
C.5.8 Section 5.1 C.5.8 Section 5.1
- Changed heading from "Mapping Onto BER-based Transport Services" - Changed heading from "Mapping Onto BER-based Transport Services"
to "Protocol Encoding". to "Protocol Encoding".
skipping to change at line 2923 skipping to change at line 2866
doc now specifies a difference between transfer and tagging doc now specifies a difference between transfer and tagging
options and describes the semantics of each, and how and when options and describes the semantics of each, and how and when
subtyping rules apply. Now allow options to be transmitted in any subtyping rules apply. Now allow options to be transmitted in any
order but disallow any ordering semantics to be implied. These order but disallow any ordering semantics to be implied. These
changes are the result of ongoing input from an engineering team changes are the result of ongoing input from an engineering team
designed to deal with ambiguity issues surrounding attribute designed to deal with ambiguity issues surrounding attribute
options. options.
C.7.3 Sections 4.1.5.1 and 4.1.6 C.7.3 Sections 4.1.5.1 and 4.1.6
Sermersheim Internet-Draft - Expires Mar 2004 Page 54 Sermersheim Internet-Draft - Expires Apr 2004 Page 52
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
- Refer to non "binary" transfer encodings as "native encoding" - Refer to non "binary" transfer encodings as "native encoding"
rather than "string" encoding to clarify and avoid confusion. rather than "string" encoding to clarify and avoid confusion.
C.8 Changes made to draft-ietf-ldapbis-protocol-06.txt: C.8 Changes made to draft-ietf-ldapbis-protocol-06.txt:
C.8.1 Title C.8.1 Title
- Changed to "LDAP: The Protocol" to be consisted with other working - Changed to "LDAP: The Protocol" to be consisted with other working
skipping to change at line 2979 skipping to change at line 2922
C.8.7 Relationship to X.500 C.8.7 Relationship to X.500
- Removed section. It has been moved to [Roadmap] - Removed section. It has been moved to [Roadmap]
C.8.8 Server Specific Data Requirements C.8.8 Server Specific Data Requirements
- Removed section. It has been moved to [Models] - Removed section. It has been moved to [Models]
C.8.9 Elements of Protocol C.8.9 Elements of Protocol
Sermersheim Internet-Draft - Expires Mar 2004 Page 55 Sermersheim Internet-Draft - Expires Apr 2004 Page 53
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
- Added "Section 5.1 specifies how the protocol is encoded and - Added "Section 5.1 specifies how the protocol is encoded and
transferred." to the end of the first paragraph for reference. transferred." to the end of the first paragraph for reference.
- Reworded notes about extensibility, and now talk about implied - Reworded notes about extensibility, and now talk about implied
extensibility and the use of ellipses in the ASN.1 extensibility and the use of ellipses in the ASN.1
- Removed references to LDAPv2 in third and fourth paragraphs. - Removed references to LDAPv2 in third and fourth paragraphs.
skipping to change at line 3036 skipping to change at line 2979
- Clarified intent regarding exactly what is to be BER encoded. - Clarified intent regarding exactly what is to be BER encoded.
- Clarified that clients must not expect ;binary when not asking for - Clarified that clients must not expect ;binary when not asking for
it (;binary, as opposed to ber encoded data). it (;binary, as opposed to ber encoded data).
C.8.17 Attribute C.8.17 Attribute
- Use the term "attribute description" in lieu of "type" - Use the term "attribute description" in lieu of "type"
Sermersheim Internet-Draft - Expires Mar 2004 Page 56 Sermersheim Internet-Draft - Expires Apr 2004 Page 54
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
- Clarified the fact that clients cannot rely on any apparent - Clarified the fact that clients cannot rely on any apparent
ordering of attribute values. ordering of attribute values.
C.8.18 LDAPResult C.8.18 LDAPResult
- To resultCode, added ellipses "..." to the enumeration to indicate - To resultCode, added ellipses "..." to the enumeration to indicate
extensibility. and added a note, pointing to [LDAPIANA] extensibility. and added a note, pointing to [LDAPIANA]
skipping to change at line 3093 skipping to change at line 3036
- Added as normative appendix A - Added as normative appendix A
C.8.25 ASN.1 C.8.25 ASN.1
- Added EXTENSIBILITY IMPLIED - Added EXTENSIBILITY IMPLIED
- Added a number of comments holding referenced to [Models] and - Added a number of comments holding referenced to [Models] and
[ISO10646]. [ISO10646].
Sermersheim Internet-Draft - Expires Mar 2004 Page 57 Sermersheim Internet-Draft - Expires Apr 2004 Page 55
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
- Removed AttributeType. It is not used. - Removed AttributeType. It is not used.
C.9 Changes made to draft-ietf-ldapbis-protocol-07.txt: C.9 Changes made to draft-ietf-ldapbis-protocol-07.txt:
- Removed all mention of transfer encodings and the binary attribute - Removed all mention of transfer encodings and the binary attribute
option. Please refer to draft-legg-ldap-binary-00.txt and draft- option. Please refer to draft-legg-ldap-binary-00.txt and draft-
legg-ldap-transfer-00.txt legg-ldap-transfer-00.txt
skipping to change at line 3147 skipping to change at line 3090
C.11 Changes made to draft-ietf-ldapbis-protocol-09.txt: C.11 Changes made to draft-ietf-ldapbis-protocol-09.txt:
- Fixed formatting - Fixed formatting
C.12 Changes made to draft-ietf-ldapbis-protocol-10.txt: C.12 Changes made to draft-ietf-ldapbis-protocol-10.txt:
C.12.1 Section 4.1.4: C.12.1 Section 4.1.4:
- Removed second paragraph as this language exists in MODELS - Removed second paragraph as this language exists in MODELS
Sermersheim Internet-Draft - Expires Mar 2004 Page 58 Sermersheim Internet-Draft - Expires Apr 2004 Page 56
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
C.12.2 Section 4.2.1: C.12.2 Section 4.2.1:
- Replaced fourth paragraph. It was accidentally removed in an - Replaced fourth paragraph. It was accidentally removed in an
earlier edit. earlier edit.
C.12.2 Section 4.13: C.12.2 Section 4.13:
- Added section describing the StartTLS operation (moved from - Added section describing the StartTLS operation (moved from
skipping to change at line 3202 skipping to change at line 3145
C.15 Changes made to draft-ietf-ldapbis-protocol-13.txt C.15 Changes made to draft-ietf-ldapbis-protocol-13.txt
C.15.1 Section 2 & various C.15.1 Section 2 & various
- Added definitions for LDAP connection, TLS connection, and LDAP - Added definitions for LDAP connection, TLS connection, and LDAP
association, and updated appropriate fields to use proper terms. association, and updated appropriate fields to use proper terms.
C.15.2 Section 4.2 C.15.2 Section 4.2
- Added text to authentication, specifying the way in which textual - Added text to authentication, specifying the way in which textual
strings used as passwords are to be prepared. strings used as passwords are to be prepared.
Sermersheim Internet-Draft - Expires Mar 2004 Page 59 Sermersheim Internet-Draft - Expires Apr 2004 Page 57
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
C.15.3 Section 4.5.1 C.15.3 Section 4.5.1
- Clarified derefInSearching. Specifically how it works in terms of - Clarified derefInSearching. Specifically how it works in terms of
subtree and one level searches subtree and one level searches
C.15.4 Section 4.5.2 C.15.4 Section 4.5.2
- Changed MUST to SHOULD for returning textual attribute name, The - Changed MUST to SHOULD for returning textual attribute name, The
MUST is unreasonable. There are likely cases (such as when the MUST is unreasonable. There are likely cases (such as when the
skipping to change at line 3259 skipping to change at line 3202
negotiations of a particular mechanism, the mechanism technical negotiations of a particular mechanism, the mechanism technical
specification should detail how applications are to deal with specification should detail how applications are to deal with
them. LDAP should not require any special handling. And if an LDAP them. LDAP should not require any special handling. And if an LDAP
client had used such a mechanism, it would have the option of client had used such a mechanism, it would have the option of
using another mechanism. using another mechanism.
C.16.3 Section 4.5.2 and Section 7 C.16.3 Section 4.5.2 and Section 7
- Removed: "If the LDAP association is operating over a connection- - Removed: "If the LDAP association is operating over a connection-
oriented transport such as TCP" oriented transport such as TCP"
Sermersheim Internet-Draft - Expires Mar 2004 Page 60 Sermersheim Internet-Draft - Expires Apr 2004 Page 58
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
This is always true. This is always true.
C.16.4 Section 4.11 C.16.4 Section 4.11
- Added: thus a client SHOULD NOT use the Abandon operation when it - Added: thus a client SHOULD NOT use the Abandon operation when it
needs an indication of whether the operation was abandoned. For needs an indication of whether the operation was abandoned. For
example, if a client performs an update operation (Add, Modify, or example, if a client performs an update operation (Add, Modify, or
ModifyDN), and it needs to know whether the directory has changed ModifyDN), and it needs to know whether the directory has changed
due to the operation, it should not use the Abandon operation to due to the operation, it should not use the Abandon operation to
skipping to change at line 3316 skipping to change at line 3259
C.16.6 Section 4.13.3.1 C.16.6 Section 4.13.3.1
- Added: After the TLS connection has been closed, the server MUST - Added: After the TLS connection has been closed, the server MUST
NOT send responses to any request message received before the TLS NOT send responses to any request message received before the TLS
closure. closure.
C.16.7 Section A2 C.16.7 Section A2
- Removed precedence rules - Removed precedence rules
Sermersheim Internet-Draft - Expires Mar 2004 Page 61 Sermersheim Internet-Draft - Expires Apr 2004 Page 59
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
C.17 Changes made to draft-ietf-ldapbis-protocol-15.txt C.17 Changes made to draft-ietf-ldapbis-protocol-15.txt
C.17.1 Section 4.1.8 C.17.1 Section 4.1.8
- Removed: "Servers which support matching rules for use in the - Removed: "Servers which support matching rules for use in the
extensibleMatch search filter MUST list the matching rules they extensibleMatch search filter MUST list the matching rules they
implement in subschema entries, using the matchingRules implement in subschema entries, using the matchingRules
attributes. The server SHOULD also list there, using the attributes. The server SHOULD also list there, using the
matchingRuleUse attribute, the attribute types with which each matchingRuleUse attribute, the attribute types with which each
skipping to change at line 3373 skipping to change at line 3316
C.18.3 Section 4.2.1 C.18.3 Section 4.2.1
- Further clarified the authentication state of an abandoned bind - Further clarified the authentication state of an abandoned bind
C.18.4 Section 4.5.1 C.18.4 Section 4.5.1
- Added: "Note that the AssertionValue in a substrings filter item - Added: "Note that the AssertionValue in a substrings filter item
MUST conform to the assertion syntax of the EQUALITY matching rule MUST conform to the assertion syntax of the EQUALITY matching rule
for the attribute type rather than the assertion syntax of the for the attribute type rather than the assertion syntax of the
SUBSTR matching rule for the attribute type. The entire SUBSTR matching rule for the attribute type. The entire
Sermersheim Internet-Draft - Expires Mar 2004 Page 62 Sermersheim Internet-Draft - Expires Apr 2004 Page 60
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
SubstringFilter is converted into an assertion value of the SubstringFilter is converted into an assertion value of the
substrings matching rule prior to applying the rule." substrings matching rule prior to applying the rule."
C.18.5 Section 4.6 C.18.5 Section 4.6
- Replaced AttributeTypeAndValues with Attribute as they are - Replaced AttributeTypeAndValues with Attribute as they are
equivalent. equivalent.
- Reformatted documentation of the various fields. - Reformatted documentation of the various fields.
skipping to change at line 3410 skipping to change at line 3353
C.18.8 Section 11 C.18.8 Section 11
- Added IANA considerations - Added IANA considerations
C.18.9 Section A.2 C.18.9 Section A.2
- Clarified that strongAuthRequired could be sent any time - Clarified that strongAuthRequired could be sent any time
(including when credentials have been weakened or compromised. (including when credentials have been weakened or compromised.
C.18.10 Appendix B C.18.10 Appendix B
- Added copyright to ASN.1 definition - Added copyright to ASN.1 definition
Appendix D - Outstanding Work Items C.19 Changes made to draft-ietf-ldapbis-protocol-17.txt
D.1 General C.19.1 Section 4.1.1
- Reconcile problems with [Models]. Section 3.2 was wholly removed. - Changed MAY to SHOULD when stating when a Notice of Disconnect is
There were some protocol semantics in that section that need to be to be returned.
brought back. Specifically, there was the notion of the server
implicitly adding objectClass superclasses when a value is added.
D.2 Verify references. C.19.2 Sections 4.1.10 and 4.5.3
- Changed occurrences of URL to URI for format of referrals.
- Many referenced documents have changed. Ensure references and C.19.3 Section 4.1.11
section numbers are correct. - Dropped MUST imperative in paragraph 2, and added a SHOULD in
paragraph 3 to align with [Keywords].
D.3 Review 2119 usage C.19.4 Section 4.2
- Reworded section on string prep for simple passwords for clarity.
D.4 Reconcile with I-D Nits C.19.5 Section 4.2.1
- Dropped MUST imperative in paragraph 3 to align with [Keywords].
Sermersheim Internet-Draft - Expires Mar 2004 Page 63 Sermersheim Internet-Draft - Expires Apr 2004 Page 61
Lightweight Directory Access Protocol Version 3
C.19.6 Section 4.2.2
- Added SHALL NOT imperative to last paragraph to align with
[Keywords].
C.19.7 Section 4.5.1
- Added correct approxMatch semantics.
C.19.8 Various
- Added SHALL NOT imperative in regards to dereferencing aliases of
base objects.
C.19.9 Section 4.9
- Allow modDN to fail when moving between naming contexts.
C.19.10 Section 4.12
- Added RECOMMENDED imperative to paragraph that talks about
advertising supported extended operations.
C.19.11 Section 4.1.11
- Dropped all MAY imperative to align with [Keywords].
C.19.12 Various
- Made it more obvious that Attribute contains at least one value,
while PartialAttribute now allows zero values. Added appropriate
references back to Attribute and PartialAttribute.
Sermersheim Internet-Draft - Expires Apr 2004 Page 62
Lightweight Directory Access Protocol Version 3 Lightweight Directory Access Protocol Version 3
Full Copyright Statement Full Copyright Statement
Copyright (C) The Internet Society (2003). All Rights Reserved. Copyright (C) The Internet Society (2003). All Rights Reserved.
This document and translations of it may be copied and furnished to This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any and distributed, in whole or in part, without restriction of any
skipping to change at line 3458 skipping to change at line 3432
The limited permissions granted above are perpetual and will not be The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns. revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an This document and the information contained herein is provided on an
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Sermersheim Internet-Draft - Expires Mar 2004 Page 64 Sermersheim Internet-Draft - Expires Apr 2004 Page 63
 End of changes. 

This html diff was produced by rfcdiff 1.23, available from http://www.levkowetz.com/ietf/tools/rfcdiff/