draft-ietf-ldapbis-protocol-32.txt   rfc4511.txt 
Internet-Draft Editor: J. Sermersheim Network Working Group J. Sermersheim, Ed.
Intended Category: Standard Track Novell, Inc Request for Comments: 4511 Novell, Inc.
Document: draft-ietf-ldapbis-protocol-32.txt Oct 2005 Obsoletes: 2251, 2830, 3771 June 2006
Obsoletes: RFCs 2251, 2830, 3771 Category: Standards Track
LDAP: The Protocol
Status of this Memo
By submitting this Internet-Draft, each
author represents that any applicable patent or other IPR claims of
which he or she is aware have been or will be disclosed, and any of
which he or she becomes aware will be disclosed, in accordance with
Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that other
groups may also distribute working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Lightweight Directory Access Protocol (LDAP): The Protocol
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress".
The list of current Internet-Drafts can be accessed at Status of This Memo
http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at This document specifies an Internet standards track protocol for the
http://www.ietf.org/shadow.html. Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
This Internet-Draft will expire in February 2005. Copyright Notice
Technical discussion of this document will take place on the IETF Copyright (C) The Internet Society (2006).
LDAP Revision Working Group (LDAPbis) mailing list <ietf-
ldapbis@openldap.org>. Please send 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, of the Lightweight Directory Access Protocol semantics and encodings, of the Lightweight Directory Access Protocol
(LDAP). LDAP provides access to distributed directory services that (LDAP). LDAP provides access to distributed directory services that
act in accordance with X.500 data and service models. These protocol act in accordance with X.500 data and service models. These protocol
elements are based on those described in the X.500 Directory Access elements are based on those described in the X.500 Directory Access
Protocol (DAP). Protocol (DAP).
Table of Contents Table of Contents
Lightweight Directory Access Protocol Version 3
1. Introduction....................................................3 1. Introduction ....................................................3
1.1. Relationship to Other LDAP Specifications.....................3 1.1. Relationship to Other LDAP Specifications ..................3
2. Conventions.....................................................3 2. Conventions .....................................................3
3. Protocol Model..................................................4 3. Protocol Model ..................................................4
3.1 Operation and LDAP Message Layer Relationship..................5 3.1. Operation and LDAP Message Layer Relationship ..............5
4. Elements of Protocol............................................5 4. Elements of Protocol ............................................5
4.1. Common Elements...............................................5 4.1. Common Elements ............................................5
4.1.1. Message Envelope............................................5 4.1.1. Message Envelope ....................................6
4.1.2. String Types................................................7 4.1.2. String Types ........................................7
4.1.3. Distinguished Name and Relative Distinguished Name..........7 4.1.3. Distinguished Name and Relative Distinguished Name ..8
4.1.4. Attribute Descriptions......................................8 4.1.4. Attribute Descriptions ..............................8
4.1.5. Attribute Value.............................................8 4.1.5. Attribute Value .....................................8
4.1.6. Attribute Value Assertion...................................8 4.1.6. Attribute Value Assertion ...........................9
4.1.7. Attribute and PartialAttribute..............................9 4.1.7. Attribute and PartialAttribute ......................9
4.1.8. Matching Rule Identifier....................................9 4.1.8. Matching Rule Identifier ...........................10
4.1.9. Result Message..............................................9 4.1.9. Result Message .....................................10
4.1.10. Referral..................................................11 4.1.10. Referral ..........................................12
4.1.11. Controls..................................................13 4.1.11. Controls ..........................................14
4.2. Bind Operation...............................................14 4.2. Bind Operation ............................................16
4.3. Unbind Operation.............................................17 4.2.1. Processing of the Bind Request .....................17
4.4. Unsolicited Notification.....................................17 4.2.2. Bind Response ......................................18
4.5. Search Operation.............................................18 4.3. Unbind Operation ..........................................18
4.6. Modify Operation.............................................29 4.4. Unsolicited Notification ..................................19
4.7. Add Operation................................................31 4.4.1. Notice of Disconnection ............................19
4.8. Delete Operation.............................................31 4.5. Search Operation ..........................................20
4.9. Modify DN Operation..........................................32 4.5.1. Search Request .....................................20
4.10. Compare Operation...........................................33 4.5.2. Search Result ......................................27
4.11. Abandon Operation...........................................34 4.5.3. Continuation References in the Search Result .......28
4.12. Extended Operation..........................................35 4.6. Modify Operation ..........................................31
4.13. IntermediateResponse Message................................36 4.7. Add Operation .............................................33
4.14. StartTLS Operation..........................................37 4.8. Delete Operation ..........................................34
5. Protocol Encoding, Connection, and Transfer....................39 4.9. Modify DN Operation .......................................34
5.1. Protocol Encoding............................................39 4.10. Compare Operation ........................................36
5.2. Transmission Control Protocol (TCP)..........................40 4.11. Abandon Operation ........................................36
5.3. Termination of the LDAP session..............................40 4.12. Extended Operation .......................................37
6. Security Considerations........................................40 4.13. IntermediateResponse Message .............................39
7. Acknowledgements...............................................42 4.13.1. Usage with LDAP ExtendedRequest and
8. Normative References...........................................42 ExtendedResponse ..................................40
9. Informative References.........................................44 4.13.2. Usage with LDAP Request Controls ..................40
10. IANA Considerations...........................................44 4.14. StartTLS Operation .......................................40
11. Editor's Address..............................................45 4.14.1. StartTLS Request ..................................40
Appendix A - LDAP Result Codes....................................46 4.14.2. StartTLS Response .................................41
A.1 Non-Error Result Codes........................................46 4.14.3. Removal of the TLS Layer ..........................41
A.2 Result Codes..................................................46 5. Protocol Encoding, Connection, and Transfer ....................42
Appendix B - Complete ASN.1 Definition............................51 5.1. Protocol Encoding .........................................42
Appendix C - Changes..............................................57 5.2. Transmission Control Protocol (TCP) .......................43
C.1 Changes made to RFC 2251:.....................................57 5.3. Termination of the LDAP session ...........................43
C.2 Changes made to RFC 2830:.....................................62 6. Security Considerations ........................................43
C.3 Changes made to RFC 3771:.....................................63 7. Acknowledgements ...............................................45
Lightweight Directory Access Protocol Version 3 8. Normative References ...........................................46
9. Informative References .........................................48
10. IANA Considerations ...........................................48
Appendix A. LDAP Result Codes .....................................49
A.1. Non-Error Result Codes ....................................49
A.2. Result Codes ..............................................49
Appendix B. Complete ASN.1 Definition .............................54
Appendix C. Changes ...............................................60
C.1. Changes Made to RFC 2251 ..................................60
C.2. Changes Made to RFC 2830 ..................................66
C.3. Changes Made to RFC 3771 ..................................66
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 the Lightweight This document details the protocol elements of the Lightweight
Directory Access Protocol (LDAP), along with their semantics. Directory Access Protocol (LDAP), along with their semantics.
Following the description of protocol elements, it describes the way Following the description of protocol elements, it describes the way
in which the protocol elements are encoded and transferred. in which the protocol elements are encoded and transferred.
1.1. Relationship to Other LDAP Specifications 1.1. Relationship to Other LDAP Specifications
This document is an integral part of the LDAP Technical Specification This document is an integral part of the LDAP Technical Specification
[Roadmap] which obsoletes the previously defined LDAP technical [RFC4510], which obsoletes the previously defined LDAP technical
specification, RFC 3377, in its entirety. specification, RFC 3377, in its entirety.
This document, together with [Roadmap], [AuthMeth], and [Models], This document, together with [RFC4510], [RFC4513], and [RFC4512],
obsoletes RFC 2251 in its entirety. Section 3.3 is obsoleted by obsoletes RFC 2251 in its entirety. Section 3.3 is obsoleted by
[Roadmap]. Sections 4.2.1 (portions), and 4.2.2 are obsoleted by [RFC4510]. Sections 4.2.1 (portions) and 4.2.2 are obsoleted by
[AuthMeth]. Sections 3.2, 3.4, 4.1.3 (last paragraph), 4.1.4, 4.1.5, [RFC4513]. Sections 3.2, 3.4, 4.1.3 (last paragraph), 4.1.4, 4.1.5,
4.1.5.1, 4.1.9 (last paragraph), 5.1, 6.1, and 6.2 (last paragraph) 4.1.5.1, 4.1.9 (last paragraph), 5.1, 6.1, and 6.2 (last paragraph)
are obsoleted by [Models]. The remainder of RFC 2251 is obsoleted by are obsoleted by [RFC4512]. The remainder of RFC 2251 is obsoleted
this document. Appendix C.1 summarizes substantive changes in the by this document. Appendix C.1 summarizes substantive changes in the
remainder. remainder.
This document obsoletes RFC 2830, Sections 2 and 4. The remainder of This document obsoletes RFC 2830, Sections 2 and 4. The remainder of
RFC 2830 is obsoleted by [AuthMeth]. Appendix C.2 summarizes RFC 2830 is obsoleted by [RFC4513]. Appendix C.2 summarizes
substantive changes to the remaining sections. substantive changes to the remaining sections.
This document also obsoletes RFC 3771 in entirety. This document also obsoletes RFC 3771 in entirety.
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 [Keyword]. to be interpreted as described in [RFC2119].
Character names in this document use the notation for code points and Character names in this document use the notation for code points and
names from the Unicode Standard [Unicode]. For example, the letter names from the Unicode Standard [Unicode]. For example, the letter
"a" may be represented as either <U+0061> or <LATIN SMALL LETTER A>. "a" may be represented as either <U+0061> or <LATIN SMALL LETTER A>.
Note: a glossary of terms used in Unicode can be found in [Glossary]. Note: a glossary of terms used in Unicode can be found in [Glossary].
Information on the Unicode character encoding model can be found in Information on the Unicode character encoding model can be found in
[CharModel]. [CharModel].
Lightweight Directory Access Protocol Version 3
The term "transport connection" refers to the underlying transport The term "transport connection" refers to the underlying transport
services used to carry the protocol exchange, as well as associations services used to carry the protocol exchange, as well as associations
established by these services. established by these services.
The term "TLS layer" refers to TLS services used in providing The term "TLS layer" refers to Transport Layer Security (TLS)
security services, as well as associations established by these services used in providing security services, as well as associations
services. established by these services.
The term "SASL layer" refers to SASL services used in providing The term "SASL layer" refers to Simply Authentication and Security
security services, as well as associations established by these Layer (SASL) services used in providing security services, as well as
services. associations established by these services.
The term "LDAP message layer" refers to the LDAP Message Protocol The term "LDAP message layer" refers to the LDAP Message Protocol
Data Unit (PDU) services used in providing directory services, as Data Unit (PDU) services used in providing directory services, as
well as associations established by these services. well as associations established by these services.
The term "LDAP session" refers to combined services (transport The term "LDAP session" refers to combined services (transport
connection, TLS layer, SASL layer, LDAP message layer) and their connection, TLS layer, SASL layer, LDAP message layer) and their
associations. associations.
See the table in Section 5 for an illustration of these four terms. See the table in Section 5 for an illustration of these four terms.
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 an the necessary operation(s) in the Directory. Upon completion of an
operation, the server typically returns a response containing operation, the server typically returns a response containing
appropriate data to the requesting client. appropriate data to the requesting client.
Protocol operations are generally independent of one another. Each Protocol operations are generally independent of one another. Each
operation is processed as an atomic action, leaving the directory in operation is processed as an atomic action, leaving the directory in
a consistent state. a consistent state.
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 generally may be Requests and responses for multiple operations generally may be
exchanged between a client and server in any order. If required, exchanged between a client and server in any order. If required,
synchronous behavior may be controlled by client applications. synchronous behavior may be controlled by client applications.
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 (1993) Directory Abstract Service [X.511]. to a subset of the X.500 (1993) Directory Abstract Service [X.511].
However there is not a one-to-one mapping between LDAP operations and However, there is not a one-to-one mapping between LDAP operations
X.500 Directory Access Protocol (DAP) operations. Server and X.500 Directory Access Protocol (DAP) operations. Server
implementations acting as a gateway to X.500 directories may need to implementations acting as a gateway to X.500 directories may need to
make multiple DAP requests to service a single LDAP request. make multiple DAP requests to service a single LDAP request.
Lightweight Directory Access Protocol Version 3 3.1. Operation and LDAP Message Layer Relationship
3.1. Operation and LDAP Message Layer Relationship
Protocol operations are exchanged at the LDAP message layer. When the Protocol operations are exchanged at the LDAP message layer. When
transport connection is closed, any uncompleted operations at the the transport connection is closed, any uncompleted operations at the
LDAP message layer, when possible, are abandoned, and when not LDAP message layer are abandoned (when possible) or are completed
possible, are completed without transmission of the response. Also, without transmission of the response (when abandoning them is not
when the transport connection is closed, the client MUST NOT assume possible). Also, when the transport connection is closed, the client
that any uncompleted update operations have succeeded or failed. MUST NOT assume that any uncompleted update operations have succeeded
or failed.
4. Elements of Protocol 4. Elements of Protocol
The protocol is described using Abstract Syntax Notation One The protocol is described using Abstract Syntax Notation One
([ASN.1]), and is transferred using a subset of ASN.1 Basic Encoding ([ASN.1]) and is transferred using a subset of ASN.1 Basic Encoding
Rules ([BER]). Section 5 specifies how the protocol elements are Rules ([BER]). Section 5 specifies how the protocol elements are
encoded and transferred. encoded and transferred.
In order to support future extensions to this protocol, extensibility In order to support future extensions to this protocol, extensibility
is implied where it is allowed per ASN.1 (i.e. sequence, set, choice, is implied where it is allowed per ASN.1 (i.e., sequence, set,
and enumerated types are extensible). In addition, ellipses (...) choice, and enumerated types are extensible). In addition, ellipses
have been supplied in ASN.1 types that are explicitly extensible as (...) have been supplied in ASN.1 types that are explicitly
discussed in [LDAPIANA]. Because of the implied extensibility, extensible as discussed in [RFC4520]. Because of the implied
clients and servers MUST (unless otherwise specified) ignore trailing extensibility, clients and servers MUST (unless otherwise specified)
SEQUENCE components whose tags they do not recognize. ignore trailing SEQUENCE components whose tags they do not recognize.
Changes to the protocol other than through the extension mechanisms Changes to the protocol other than through the extension mechanisms
described here require a different version number. A client indicates described here require a different version number. A client
the version it is using as part of the BindRequest, described in indicates the version it is using as part of the BindRequest,
Section 4.2. If a client has not sent a Bind, the server MUST assume described in Section 4.2. If a client has not sent a Bind, the
the client is using version 3 or later. server MUST assume the client is using version 3 or later.
Clients may attempt to determine the protocol versions a server Clients may attempt to determine the protocol versions a server
supports by reading the 'supportedLDAPVersion' attribute from the supports by reading the 'supportedLDAPVersion' attribute from the
root DSE (DSA-Specific Entry) [Models]. root DSE (DSA-Specific Entry) [RFC4512].
4.1. Common Elements 4.1. Common Elements
This section describes the LDAPMessage envelope Protocol Data Unit This section describes the LDAPMessage envelope Protocol Data Unit
(PDU) format, as well as data type definitions, which are used in the (PDU) 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:
Lightweight Directory Access Protocol Version 3
LDAPMessage ::= SEQUENCE { LDAPMessage ::= SEQUENCE {
messageID MessageID, messageID MessageID,
protocolOp CHOICE { protocolOp CHOICE {
bindRequest BindRequest, bindRequest BindRequest,
bindResponse BindResponse, bindResponse BindResponse,
unbindRequest UnbindRequest, unbindRequest UnbindRequest,
searchRequest SearchRequest, searchRequest SearchRequest,
searchResEntry SearchResultEntry, searchResEntry SearchResultEntry,
searchResDone SearchResultDone, searchResDone SearchResultDone,
searchResRef SearchResultReference, searchResRef SearchResultReference,
skipping to change at page 6, line 34 skipping to change at page 6, line 38
modDNResponse ModifyDNResponse, modDNResponse ModifyDNResponse,
compareRequest CompareRequest, compareRequest CompareRequest,
compareResponse CompareResponse, compareResponse CompareResponse,
abandonRequest AbandonRequest, abandonRequest AbandonRequest,
extendedReq ExtendedRequest, extendedReq ExtendedRequest,
extendedResp ExtendedResponse, extendedResp ExtendedResponse,
..., ...,
intermediateResponse IntermediateResponse }, intermediateResponse IntermediateResponse },
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) --
The ASN.1 type Controls is defined in Section 4.1.11. The ASN.1 type Controls is defined in Section 4.1.11.
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 messageID and the controls. only common fields are the messageID and the controls.
If the server receives an LDAPMessage from the client in which the If the server receives an LDAPMessage from the client in which the
LDAPMessage SEQUENCE tag cannot be recognized, the messageID cannot LDAPMessage SEQUENCE tag cannot be recognized, the messageID cannot
be parsed, the tag of the protocolOp is not recognized as a request, be parsed, the tag of the protocolOp is not recognized as a request,
or the encoding structures or lengths of data fields are found to be or the encoding structures or lengths of data fields are found to be
incorrect, then the server SHOULD 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 terminate the LDAP session as described in and MUST immediately terminate the LDAP session as described in
Section 5.3. Section 5.3.
In other cases where the client or server cannot parse an LDAP PDU, In other cases where the client or server cannot parse an LDAP PDU,
it SHOULD abruptly terminate the LDAP session (Section 5.3) where it SHOULD abruptly terminate the LDAP session (Section 5.3) where
further communication (including providing notice) would be further communication (including providing notice) would be
pernicious. Otherwise, server implementations MUST return an pernicious. Otherwise, server implementations MUST return an
appropriate response to the request, with the resultCode set to appropriate response to the request, with the resultCode set to
protocolError. protocolError.
Lightweight Directory Access Protocol Version 3 4.1.1.1. MessageID
4.1.1.1. Message ID
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 messageID of a request MUST have a non-zero value different from
the messageID of any other request in progress in the same LDAP the messageID of any other request in progress in the same LDAP
session. The zero value is reserved for the unsolicited notification session. The zero value is reserved for the unsolicited notification
message. 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 messageID as an
earlier request in the same LDAP session unless it can be determined earlier request in the same LDAP session unless it can be determined
that the server is no longer servicing the earlier request (e.g. that the server is no longer servicing the earlier request (e.g.,
after the final response is received, or a subsequent Bind after the final response is received, or a subsequent Bind
completes). Otherwise the behavior is undefined. For this purpose, completes). Otherwise, the behavior is undefined. For this purpose,
note that Abandon and successfully abandoned operations do not send note that Abandon and successfully abandoned operations do not send
responses. responses.
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 ASN.1 OCTET STRING types, the strings of LDAPString type encode as ASN.1 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. Note that Unicode characters U+0000 following the UTF-8 [RFC3629] algorithm. Note that Unicode
through U+007F are the same as ASCII 0 through 127, respectively, and characters U+0000 through U+007F are the same as ASCII 0 through 127,
have the same single octet UTF-8 encoding. Other Unicode characters respectively, and have the same single octet UTF-8 encoding. Other
have a multiple octet UTF-8 encoding. Unicode characters have a multiple octet UTF-8 encoding.
LDAPString ::= OCTET STRING -- UTF-8 encoded, LDAPString ::= OCTET STRING -- UTF-8 encoded,
-- [ISO10646] 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.4 of [Models]. <numericoid> given in Section 1.4 of [RFC4512].
LDAPOID ::= OCTET STRING -- Constrained to <numericoid> [Models] LDAPOID ::= OCTET STRING -- Constrained to <numericoid>
-- [RFC4512]
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 is defined to be the representation of a Distinguished Name An LDAPDN is defined to be the representation of a Distinguished Name
(DN) after encoding according to the specification in [LDAPDN]. (DN) after encoding according to the specification in [RFC4514].
LDAPDN ::= LDAPString LDAPDN ::= LDAPString
-- Constrained to <distinguishedName> [LDAPDN] -- Constrained to <distinguishedName> [RFC4514]
Lightweight Directory Access Protocol Version 3
A RelativeLDAPDN is defined to be the representation of a Relative A RelativeLDAPDN is defined to be the representation of a Relative
Distinguished Name (RDN) after encoding according to the Distinguished Name (RDN) after encoding according to the
specification in [LDAPDN]. specification in [RFC4514].
RelativeLDAPDN ::= LDAPString RelativeLDAPDN ::= LDAPString
-- Constrained to <name-component> [LDAPDN] -- Constrained to <name-component> [RFC4514]
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 [RFC4512]. Briefly, an attribute
is an attribute type and zero or more options. description is an attribute type and zero or more options.
AttributeDescription ::= LDAPString AttributeDescription ::= LDAPString
-- Constrained to <attributedescription> -- Constrained to <attributedescription>
-- [Models] -- [RFC4512]
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. The attribute value is encoded according to encoded attribute value. The attribute value is encoded according to
the LDAP-specific encoding definition of its corresponding syntax. the LDAP-specific encoding definition of its corresponding syntax.
The LDAP-specific encoding definitions for different syntaxes and The LDAP-specific encoding definitions for different syntaxes and
attribute types may be found in other documents and in particular attribute types may be found in other documents and in particular
[Syntaxes]. [RFC4517].
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 attribute values thus, protocol values may include multi-megabyte attribute values
(e.g. photographs). (e.g., photographs).
Attribute values may be defined which have arbitrary and non- Attribute values may be defined that have arbitrary and non-printable
printable syntax. Implementations MUST NOT display nor attempt to syntax. Implementations MUST NOT display or attempt to decode an
decode an attribute value if its syntax is not known. The attribute value if its syntax is not known. The implementation may
implementation may attempt to discover the subschema of the source attempt to discover the subschema of the source entry and to retrieve
entry, and retrieve the descriptions of 'attributeTypes' from it the descriptions of 'attributeTypes' from it [RFC4512].
[Models].
Clients MUST only send attribute values in a request that are valid Clients MUST only send attribute values in a request that are valid
according to the syntax defined for the attributes. according to the syntax defined for the attributes.
4.1.6. Attribute Value Assertion 4.1.6. Attribute Value Assertion
The AttributeValueAssertion (AVA) type definition is similar to the The AttributeValueAssertion (AVA) type definition is similar to the
one in the X.500 Directory standards. It contains an attribute one in the X.500 Directory standards. It contains an attribute
description and a matching rule ([Models] Section 4.1.3) assertion description and a matching rule ([RFC4512], Section 4.1.3) assertion
value suitable for that type. Elements of this type are typically value suitable for that type. Elements of this type are typically
used to assert that the value in assertionValue matches a value of an used to assert that the value in assertionValue matches a value of an
attribute. attribute.
Lightweight Directory Access Protocol Version 3
AttributeValueAssertion ::= SEQUENCE { AttributeValueAssertion ::= SEQUENCE {
attributeDesc AttributeDescription, attributeDesc AttributeDescription,
assertionValue AssertionValue } assertionValue AssertionValue }
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. [RFC4517] for an example.
4.1.7. Attribute and PartialAttribute 4.1.7. Attribute and PartialAttribute
Attributes and partial attributes consist of an attribute description Attributes and partial attributes consist of an attribute description
and attribute values. A PartialAttribute allows zero values, while and attribute values. A PartialAttribute allows zero values, while
Attribute requires at least one value. Attribute requires at least one value.
PartialAttribute ::= SEQUENCE { PartialAttribute ::= SEQUENCE {
type AttributeDescription, type AttributeDescription,
vals SET OF value AttributeValue } vals SET OF value AttributeValue }
Attribute ::= PartialAttribute(WITH COMPONENTS { Attribute ::= PartialAttribute(WITH COMPONENTS {
..., ...,
vals (SIZE(1..MAX))}) vals (SIZE(1..MAX))})
No two of the attribute values may be equivalent as described by No two of the attribute values may be equivalent as described by
Section 2.3 of [Models]. The set of attribute values is unordered. Section 2.2 of [RFC4512]. The set of attribute values is unordered.
Implementations MUST NOT rely upon the ordering being repeatable. Implementations MUST NOT rely upon the ordering being repeatable.
4.1.8. Matching Rule Identifier 4.1.8. Matching Rule Identifier
Matching rules are defined in Section 4.1.3 of [Models]. A matching Matching rules are defined in Section 4.1.3 of [RFC4512]. A matching
rule is identified in the protocol by the printable representation of rule is identified in the protocol by the printable representation of
either its <numericoid>, or one of its short name descriptors either its <numericoid> or one of its short name descriptors
[Models], e.g. 'caseIgnoreMatch' or '2.5.13.2'. [RFC4512], e.g., 'caseIgnoreMatch' or '2.5.13.2'.
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 containing the elements found requests, servers will return responses containing the elements found
in LDAPResult to indicate the final status of the protocol operation in LDAPResult to indicate the final status of the protocol operation
request. request.
Lightweight Directory Access Protocol Version 3
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),
compareFalse (5), compareFalse (5),
compareTrue (6), compareTrue (6),
authMethodNotSupported (7), authMethodNotSupported (7),
skipping to change at page 10, line 55 skipping to change at page 11, line 29
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),
... }, ... },
matchedDN LDAPDN, matchedDN LDAPDN,
diagnosticMessage LDAPString, diagnosticMessage LDAPString,
referral [3] Referral OPTIONAL } referral [3] Referral OPTIONAL }
Lightweight Directory Access Protocol Version 3
The resultCode enumeration is extensible as defined in Section 3.6 of The resultCode enumeration is extensible as defined in Section 3.8 of
[LDAPIANA]. The meanings of the listed result codes are given in [RFC4520]. The meanings of the listed result codes are given in
Appendix A. If a server detects multiple errors for an operation, Appendix A. If a server detects multiple errors for an operation,
only one result code is returned. The server should return the result only one result code is returned. The server should return the
code that best indicates the nature of the error encountered. Servers result code that best indicates the nature of the error encountered.
may return substituted result codes to prevent unauthorized Servers may return substituted result codes to prevent unauthorized
disclosures. disclosures.
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 diagnostic message (terminal control and page formatting
avoided) diagnostic message. As this diagnostic message is not characters should be avoided). As this diagnostic message is not
standardized, implementations MUST NOT rely on the values returned. standardized, implementations MUST NOT rely on the values returned.
Diagnostic messages typically supplement the resultCode with Diagnostic messages typically supplement the resultCode with
additional information. If the server chooses not to return a textual additional information. If the server chooses not to return a
diagnostic, the diagnosticMessage field MUST be empty. 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 (subject to aliasDereferencingProblem), the matchedDN field is set (subject to
access controls) to the name of the last entry (object or alias) used access controls) to the name of the last entry (object or alias) used
in finding the target (or base) object. This will be a truncated form in finding the target (or base) object. This will be a truncated
of the provided name or, if an alias was dereferenced while form of the provided name or, if an alias was dereferenced while
attempting to locate the entry, of the resulting name. Otherwise the attempting to locate the entry, of the resulting name. Otherwise,
matchedDN field is empty. the matchedDN field is empty.
4.1.10. Referral 4.1.10. Referral
The referral result code indicates that the contacted server cannot The referral result code indicates that the contacted server cannot
or will not perform the operation and that one or more other servers or will not perform the operation and that one or more other servers
may be able to. Reasons for this include: may be able to. Reasons for this include:
- The target entry of the request is not held locally, but the - The target entry of the request is not held locally, but the server
server has knowledge of its possible existence elsewhere. has knowledge of its possible existence elsewhere.
- The operation is restricted on this server -- perhaps due to a - The operation is restricted on this server -- perhaps due to a
read-only copy of an entry to be modified. read-only copy of an entry to be modified.
The referral field is present in an LDAPResult if the resultCode is The referral field is present in an LDAPResult if the resultCode is
set to referral, and absent with all other result codes. It contains set to referral, and it is absent with all other result codes. It
one or more references to one or more servers or services that may be contains one or more references to one or more servers or services
accessed via LDAP or other protocols. Referrals can be returned in that may be accessed via LDAP or other protocols. Referrals can be
response to any operation request (except Unbind and Abandon which do returned in response to any operation request (except Unbind and
not have responses). At least one URI MUST be present in the Abandon, which do not have responses). At least one URI MUST be
Referral. 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 other servers would need to be contacted to complete the when other servers would need to be contacted to complete the
operation. operation.
Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI
Lightweight Directory Access Protocol Version 3
URI ::= LDAPString -- limited to characters permitted in URI ::= LDAPString -- limited to characters permitted in
-- URIs -- URIs
If the client wishes to progress the operation, it contacts one of If the client wishes to progress the operation, it contacts one of
the supported services found in the referral. If multiple URIs are the supported services found in the referral. If multiple URIs are
present, the client assumes that any supported URI may be used to present, the client assumes that any supported URI may be used to
progress the operation. progress the operation.
Clients that follow referrals MUST ensure that they do not loop Clients that follow referrals MUST ensure that they do not loop
between servers. They MUST NOT repeatedly contact the same server for between servers. They MUST NOT repeatedly contact the same server
the same request with the same parameters. Some clients use a counter for the same request with the same parameters. Some clients use a
that is incremented each time referral handling occurs for an counter that is incremented each time referral handling occurs for an
operation, and these kinds of clients MUST be able to handle at least operation, and these kinds of clients MUST be able to handle at least
ten nested referrals while progressing the operation. ten nested referrals while progressing the operation.
A URI for a server implementing LDAP and accessible via [TCP]/[IP] A URI for a server implementing LDAP and accessible via TCP/IP (v4 or
(v4 or v6) is written as an LDAP URL according to [LDAPURL]. v6) [RFC793][RFC791] is written as an LDAP URL according to
[RFC4516].
Referral values which are LDAP URLs follow these rules: Referral values that are LDAP URLs follow these rules:
- If an alias was dereferenced, the <dn> part of the LDAP URL MUST - If an alias was dereferenced, the <dn> part of the LDAP URL MUST be
be present, with the new target object name. present, with the new target object name.
- It is RECOMMENDED that the <dn> part be present to avoid - It is RECOMMENDED that the <dn> part be present to avoid ambiguity.
ambiguity.
- If the <dn> part is present, the client uses this name in its next - If the <dn> part is present, the client uses this name in its next
request to progress the operation, and if it is not present the request to progress the operation, and if it is not present the
client uses the same name as in the original request. client uses the same name as in the original request.
- 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 uses - If the <filter> part of the LDAP URL is present, the client uses
this filter in its next request to progress this Search, and if it this filter in its next request to progress this Search, and if it
is not present the client uses the same filter as it used for that is not present the client uses the same filter as it used for that
Search. Search.
- For Search, it is RECOMMENDED that the <scope> part be present to - For Search, it is RECOMMENDED that the <scope> part be present to
avoid ambiguity. avoid ambiguity.
- If the <scope> part is missing, the scope of the original Search - If the <scope> part is missing, the scope of the original Search is
is used by the client to progress the operation. used by the client to progress the operation.
- Other aspects of the new request may be the same as or different - Other aspects of the new request may be the same as or different
from the request which generated the referral. from the request that generated the referral.
Other kinds of URIs may be returned. The syntax and semantics of such
URIs is left to future specifications. Clients may ignore URIs that
they do not support.
Lightweight Directory Access Protocol Version 3 Other kinds of URIs may be returned. The syntax and semantics of
such URIs is left to future specifications. Clients may ignore URIs
that they do not support.
UTF-8 encoded characters appearing in the string representation of a UTF-8 encoded characters appearing in the string representation of a
DN, search filter, or other fields of the referral value may not be DN, search filter, or other fields of the referral value may not be
legal for URIs (e.g. spaces) and MUST be escaped using the % method legal for URIs (e.g., spaces) and MUST be escaped using the % method
in [URI]. in [RFC3986].
4.1.11. Controls 4.1.11. Controls
Controls provide a mechanism whereby the semantics and arguments of Controls provide a mechanism whereby the semantics and arguments of
existing LDAP operations may be extended. One or more controls may be existing LDAP operations may be extended. One or more controls may
attached to a single LDAP message. A control only affects the be attached to a single LDAP message. A control only affects the
semantics of the message it is attached to. semantics of the message it is attached to.
Controls sent by clients are termed 'request controls' and those sent Controls sent by clients are termed 'request controls', and those
by servers are termed 'response controls'. sent by servers are termed 'response controls'.
Controls ::= SEQUENCE OF control 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 is the dotted-decimal representation of an The controlType field is the dotted-decimal representation of an
OBJECT IDENTIFIER which uniquely identifies the control. This OBJECT IDENTIFIER that uniquely identifies the control. This
provides unambiguous naming of controls. Often, response control(s) provides unambiguous naming of controls. Often, response control(s)
solicited by a request control share controlType values with the solicited by a request control share controlType values with the
request control. request control.
The criticality field only has meaning in controls attached to The criticality field only has meaning in controls attached to
request messages (except UnbindRequest). For controls attached to request messages (except UnbindRequest). For controls attached to
response messages and the UnbindRequest, the criticality field SHOULD response messages and the UnbindRequest, the criticality field SHOULD
be FALSE, and MUST be ignored by the receiving protocol peer. A value be FALSE, and MUST be ignored by the receiving protocol peer. A
of TRUE indicates that it is unacceptable to perform the operation value of TRUE indicates that it is unacceptable to perform the
without applying the semantics of the control. Specifically, the operation without applying the semantics of the control.
criticality field is applied as follows: Specifically, the criticality field is applied as follows:
- If the server does not recognize the control type, determines that - If the server does not recognize the control type, determines that
it is not appropriate for the operation, or is otherwise unwilling it is not appropriate for the operation, or is otherwise unwilling
to perform the operation with the control, and the criticality to perform the operation with the control, and if the criticality
field is TRUE, the server MUST NOT perform the operation, and for field is TRUE, the server MUST NOT perform the operation, and for
operations that have a response message, MUST return with the operations that have a response message, it MUST return with the
resultCode set to unavailableCriticalExtension. resultCode set to unavailableCriticalExtension.
- If the server does not recognize the control type, determines that - If the server does not recognize the control type, determines that
it is not appropriate for the operation, or is otherwise unwilling it is not appropriate for the operation, or is otherwise unwilling
to perform the operation with the control, and the criticality to perform the operation with the control, and if the criticality
field is FALSE, the server MUST ignore the control. field is FALSE, the server MUST ignore the control.
- Regardless of criticality, if a control is applied to an - Regardless of criticality, if a control is applied to an
operation, it is applied consistently and impartially to the operation, it is applied consistently and impartially to the
entire operation. entire operation.
Lightweight Directory Access Protocol Version 3
The controlValue may contain information associated with the The controlValue may contain information associated with the
controlType. Its format is defined by the specification of the controlType. Its format is defined by the specification of the
control. Implementations MUST be prepared to handle arbitrary control. Implementations MUST be prepared to handle arbitrary
contents of the controlValue octet string, including zero bytes. It contents of the controlValue octet string, including zero bytes. It
is absent only if there is no value information which is associated is absent only if there is no value information that is associated
with a control of its type. When a controlValue is defined in terms with a control of its type. When a controlValue is defined in terms
of ASN.1, and BER encoded according to Section 5.1, it also follows of ASN.1, and BER-encoded according to Section 5.1, it also follows
the extensibility rules in Section 4. the extensibility rules in Section 4.
Servers list the controlType of request controls they recognize in Servers list the controlType of request controls they recognize in
the 'supportedControl' attribute in the root DSE (Section 5.1 of the 'supportedControl' attribute in the root DSE (Section 5.1 of
[Models]). [RFC4512]).
Controls SHOULD NOT be combined unless the semantics of the Controls SHOULD NOT be combined unless the semantics of the
combination has been specified. The semantics of control combination has been specified. The semantics of control
combinations, if specified, are generally found in the control combinations, if specified, are generally found in the control
specification most recently published. When a combination of controls specification most recently published. When a combination of
is encountered whose semantics are invalid, not specified (or not controls is encountered whose semantics are invalid, not specified
known), the message is considered to be not well-formed, thus the (or not known), the message is considered not well-formed; thus, the
operation fails with protocolError. Controls with a criticality of operation fails with protocolError. Controls with a criticality of
FALSE may be ignored in order to arrive at a valid combination. FALSE may be ignored in order to arrive at a valid combination.
Additionally, unless order-dependent semantics are given in a Additionally, unless order-dependent semantics are given in a
specification, the order of a combination of controls in the SEQUENCE specification, the order of a combination of controls in the SEQUENCE
is ignored. Where the order is to be ignored but cannot be ignored by is ignored. Where the order is to be ignored but cannot be ignored
the server, the message is considered not well-formed and the by the server, the message is considered not well-formed, and the
operation fails with protocolError. Again, controls with a operation fails with protocolError. Again, controls with a
criticality of FALSE may be ignored in order to arrive at a valid criticality of FALSE may be ignored in order to arrive at a valid
combination. combination.
This document does not specify any controls. Controls may be This document does not specify any controls. Controls may be
specified in other documents. Documents detailing control extensions specified in other documents. Documents detailing control extensions
are to provide for each control: are to provide for each control:
- the OBJECT IDENTIFIER assigned to the control, - the OBJECT IDENTIFIER assigned to the control,
- direction as to what value the sender should provide for the - direction as to what value the sender should provide for the
criticality field (note: the semantics of the criticality field criticality field (note: the semantics of the criticality field are
are defined above should not be altered by the control's defined above should not be altered by the control's
specification), specification),
- whether the controlValue field is present, and if so, the format - whether the controlValue field is present, and if so, the format of
of its contents, its contents,
- the semantics of the control, and - the semantics of the control, and
- optionally, semantics regarding the combination of the control - optionally, semantics regarding the combination of the control with
with other controls. other controls.
4.2. Bind Operation 4.2. Bind Operation
Lightweight Directory Access Protocol Version 3
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. The Bind information to be exchanged between the client and server. The Bind
operation should be thought of as the "authenticate" operation. operation should be thought of as the "authenticate" operation.
Operational, authentication, and security-related semantics of this Operational, authentication, and security-related semantics of this
operation are given in [AuthMeth]. operation are given in [RFC4513].
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,
... } ... }
SaslCredentials ::= SEQUENCE { SaslCredentials ::= SEQUENCE {
mechanism LDAPString, mechanism LDAPString,
credentials OCTET STRING OPTIONAL } credentials OCTET STRING OPTIONAL }
Fields of the BindRequest are: Fields of the BindRequest are:
- version: A version number indicating the version of the protocol - version: A version number indicating the version of the protocol to
to be used at the LDAP message layer. This document describes be used at the LDAP message layer. This document describes version
version 3 of the protocol. There is no version negotiation. The 3 of the protocol. There is no version negotiation. The client
client sets this field to the version it desires. If the server sets this field to the version it desires. If the server does not
does not support the specified version, it MUST respond with a support the specified version, it MUST respond with a BindResponse
BindResponse where the resultCode is set to protocolError. where the resultCode is set to protocolError.
- name: If not empty, the name of the Directory object that the - name: If not empty, the name of the Directory object that the
client wishes to bind as. This field may take on a null value (a client wishes to bind as. This field may take on a null value (a
zero length string) for the purposes of anonymous binds zero-length string) for the purposes of anonymous binds ([RFC4513],
([AuthMeth] Section 5.1) or when using Simple Authentication and Section 5.1) or when using SASL [RFC4422] authentication
Security Layer [SASL] authentication ([AuthMeth] Section 5.2). ([RFC4513], Section 5.2). Where the server attempts to locate the
Where the server attempts to locate the named object, it SHALL NOT named object, it SHALL NOT perform alias dereferencing.
perform alias dereferencing.
- authentication: information used in authentication. This type is - authentication: Information used in authentication. This type is
extensible as defined in Section 3.7 of [LDAPIANA]. Servers that extensible as defined in Section 3.7 of [RFC4520]. Servers that do
do not support a choice supplied by a client return a BindResponse not support a choice supplied by a client return a BindResponse
with the resultCode set to authMethodNotSupported. with the resultCode set to authMethodNotSupported.
Textual passwords (consisting of a character sequence with a known Textual passwords (consisting of a character sequence with a known
character set and encoding) transferred to the server using the character set and encoding) transferred to the server using the
simple AuthenticationChoice SHALL be transferred as [UTF-8] simple AuthenticationChoice SHALL be transferred as UTF-8 [RFC3629]
encoded [Unicode]. Prior to transfer, clients SHOULD prepare text encoded [Unicode]. Prior to transfer, clients SHOULD prepare text
passwords as "query" strings by applying the [SASLprep] profile of passwords as "query" strings by applying the SASLprep [RFC4013]
the [Stringprep] algorithm. Passwords consisting of other data profile of the stringprep [RFC3454] algorithm. Passwords
(such as random octets) MUST NOT be altered. The determination of consisting of other data (such as random octets) MUST NOT be
whether a password is textual is a local client matter. altered. The determination of whether a password is textual is a
local client matter.
Lightweight Directory Access Protocol Version 3
4.2.1. Processing of the Bind Request 4.2.1. Processing of the Bind Request
Before processing a BindRequest, all uncompleted operations MUST Before processing a BindRequest, all uncompleted operations MUST
either complete or be abandoned. The server may either wait for the either complete or be abandoned. The server may either wait for the
uncompleted operations to complete, or abandon them. The server then uncompleted operations to complete, or abandon them. The server then
proceeds to authenticate the client in either a single-step, or proceeds to authenticate the client in either a single-step or
multi-step Bind process. Each step requires the server to return a multi-step Bind process. Each step requires the server to return a
BindResponse to indicate the status of authentication. BindResponse to indicate the status of authentication.
After sending a BindRequest, clients MUST NOT send further LDAP PDUs After sending a BindRequest, clients MUST NOT send further LDAP PDUs
until receiving the BindResponse. Similarly, servers SHOULD NOT until receiving the BindResponse. Similarly, servers SHOULD NOT
process or respond to requests received while processing a process or respond to requests received while processing a
BindRequest. BindRequest.
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 to that request, it may then send a BindRequest. If operationsError to that request, it may then send a BindRequest. If
this also fails or the client chooses not to bind on the existing this also fails or the client chooses not to bind on the existing
LDAP session, it may terminate the LDAP session, re-establish it and LDAP session, it may terminate the LDAP session, re-establish it, and
begin again by first sending a BindRequest. This will aid in begin again by first sending a BindRequest. This will aid in
interoperating with servers implementing other versions of LDAP. interoperating with servers implementing other versions of LDAP.
Clients may send multiple Bind requests to change the authentication Clients may send multiple Bind requests to change the authentication
and/or security associations or to complete a multi-stage Bind and/or security associations or to complete a multi-stage Bind
process. Authentication from earlier binds is subsequently ignored. process. Authentication from earlier binds is subsequently 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 ([AuthMeth] Section client to invoke the BindRequest multiple times ([RFC4513], Section
5.2). Clients MUST NOT invoke operations between two Bind requests 5.2). Clients MUST NOT invoke operations between two Bind requests
made as part of a multi-stage Bind. made as part of a multi-stage Bind.
A client may abort a SASL bind negotiation by sending a BindRequest A client may abort a SASL bind negotiation by sending a BindRequest
with a different value in the mechanism field of SaslCredentials, or with a different value in the mechanism field of SaslCredentials, or
an AuthenticationChoice other than sasl. an AuthenticationChoice other than sasl.
If the client sends a BindRequest with the sasl mechanism field as an If the client sends a BindRequest with the sasl mechanism field as an
empty string, the server MUST return a BindResponse with the empty string, the server MUST return a BindResponse with the
resultCode set to authMethodNotSupported. This will allow clients to resultCode set to authMethodNotSupported. This will allow the client
abort a negotiation if it wishes to try again with the same SASL to abort a negotiation if it wishes to try again with the same SASL
mechanism. mechanism.
4.2.2. Bind Response 4.2.2. Bind Response
The Bind response is defined as follows. The Bind response is defined as follows.
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.
Lightweight Directory Access Protocol Version 3
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 BindResponse, the protocolError result set in the BindResponse. For BindResponse, the protocolError result
code may be used to indicate that the version number supplied by the code may be used to indicate that the version number supplied by the
client is unsupported. client is unsupported.
If the client receives a BindResponse where the resultCode is set to If the client receives a BindResponse where the resultCode is set to
protocolError, it is to assume that the server does not support this protocolError, it is to assume that the server does not support this
version of LDAP. While the client may be able proceed with another version of LDAP. While the client may be able proceed with another
version of this protocol (this may or may not require closing and re- version of this protocol (which may or may not require closing and
establishing the transport connection), how to proceed with another re-establishing the transport connection), how to proceed with
version of this protocol is beyond the scope of this document. another version of this protocol is beyond the scope of this
Clients which are unable or unwilling to proceed SHOULD terminate the document. Clients that are unable or unwilling to proceed SHOULD
LDAP session. terminate the LDAP session.
The serverSaslCreds field is used as part of a SASL-defined bind The serverSaslCreds field is used as part of a SASL-defined bind
mechanism to allow the client to authenticate the server to which it mechanism to allow the client to authenticate the server to which it
is communicating, or to perform "challenge-response" authentication. is communicating, or to perform "challenge-response" authentication.
If the client bound with the simple choice, or the SASL mechanism If the client bound with the simple choice, or the SASL mechanism
does not require the server to return information to the client, then does not require the server to return information to the client, then
this field SHALL NOT be included in the BindResponse. this 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 session. The function of the Unbind operation is to terminate an LDAP session.
The Unbind operation is not the antithesis of the Bind operation as The Unbind operation is not the antithesis of the Bind operation as
the name implies. The naming of these operations are historical. The the name implies. The naming of these operations are historical.
Unbind operation should be thought of as the "quit" operation. The Unbind operation should be thought of as the "quit" operation.
The Unbind operation is defined as follows: The Unbind operation is defined as follows:
UnbindRequest ::= [APPLICATION 2] NULL UnbindRequest ::= [APPLICATION 2] NULL
The client, upon transmission of the UnbindRequest, and the server, The client, upon transmission of the UnbindRequest, and the server,
upon receipt of the UnbindRequest are to gracefully terminate the upon receipt of the UnbindRequest, are to gracefully terminate the
LDAP session as described in Section 5.3. LDAP session as described in Section 5.3. Uncompleted operations are
handled as specified in Section 3.1.
Uncompleted operations are handled as specified in Section 3.1.
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 that is not in response to any LDAPMessage received by the
the server. It is used to signal an extraordinary condition in the server. It is used to signal an extraordinary condition in the
server or in the LDAP session between the client and the server. The server or in the LDAP session 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.
Lightweight Directory Access Protocol Version 3
The unsolicited notification is structured as an LDAPMessage in which The unsolicited notification is structured as an LDAPMessage in which
the messageID is zero and protocolOp is set to the extendedResp the messageID is zero and protocolOp is set to the extendedResp
choice using the ExtendedResponse type (See Section 4.12). The choice using the ExtendedResponse type (See Section 4.12). The
responseName field of the ExtendedResponse always contains an LDAPOID responseName field of the ExtendedResponse always contains an LDAPOID
which is unique for this notification. that is unique for this notification.
One unsolicited notification (Notice of Disconnection) is defined in One unsolicited notification (Notice of Disconnection) is defined in
this document. The specification of an unsolicited notification this document. The specification of an unsolicited notification
consists of: consists of:
- the OBJECT IDENTIFIER assigned to the notification (to be - the OBJECT IDENTIFIER assigned to the notification (to be specified
specified in the responseName, in the responseName,
- the format of the contents of the responseValue (if any), - the format of the contents of the responseValue (if any),
- the circumstances which will cause the notification to be sent, - the circumstances which will cause the notification to be sent, and
and
- the semantics of the message. - the semantics of the message.
4.4.1. Notice of Disconnection 4.4.1. Notice of Disconnection
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 terminate the LDAP session on its own the server is about to terminate the LDAP session on its own
initiative. This notification is intended to assist clients in initiative. This notification is intended to assist clients in
distinguishing between an exceptional server condition and a distinguishing between an exceptional server condition and a
transient network failure. Note that this notification is not a transient network failure. Note that this notification is not a
response to an Unbind requested by the client. Uncompleted operations response to an Unbind requested by the client. Uncompleted
are handled as specified in Section 3.1. operations are handled as specified in Section 3.1.
The responseName is 1.3.6.1.4.1.1466.20036, the responseValue field The responseName is 1.3.6.1.4.1.1466.20036, the responseValue field
is absent, and the resultCode is used to indicate the reason for the is absent, and the resultCode is used to indicate the reason for the
disconnection. When the strongerAuthRequired resultCode is returned disconnection. When the strongerAuthRequired resultCode is returned
with this message, it indicates that the server has detected that an with this message, it indicates that the server has detected that an
established security association between the client and server has established security association between the client and server has
unexpectedly failed or been compromised. unexpectedly failed or been compromised.
Upon transmission of the Notice of Disconnection, the server Upon transmission of the Notice of Disconnection, the server
gracefully terminates the LDAP session as described in Section 5.3. gracefully terminates the LDAP session as described in Section 5.3.
4.5. Search Operation 4.5. Search Operation
The Search operation is used to request a server to return, subject The Search operation is used to request a server to return, subject
to access controls and other restrictions, a set of entries matching to access controls and other restrictions, a set of entries matching
a complex search criterion. This can be used to read attributes from a complex search criterion. This can be used to read attributes from
a single entry, from entries immediately subordinate to a particular a single entry, from entries immediately subordinate to a particular
entry, or a whole subtree of entries. entry, or from 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:
Lightweight Directory Access Protocol Version 3
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 { 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 selector LDAPString AttributeSelection ::= SEQUENCE OF selector LDAPString
-- The LDAPString is constrained to -- The LDAPString is constrained to
-- <attributeSelector> in Section 4.5.1.7 -- <attributeSelector> in Section 4.5.1.8
Filter ::= CHOICE { Filter ::= CHOICE {
and [0] SET SIZE (1..MAX) OF filter Filter, and [0] SET SIZE (1..MAX) OF filter Filter,
or [1] SET SIZE (1..MAX) OF filter 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,
substrings SEQUENCE SIZE (1..MAX) OF substring CHOICE { substrings SEQUENCE SIZE (1..MAX) OF substring CHOICE {
initial [0] AssertionValue, -- can occur at most once initial [0] AssertionValue, -- can occur at most once
any [1] AssertionValue, any [1] AssertionValue,
final [2] AssertionValue } -- can occur at most once final [2] AssertionValue } -- can occur at most once
} }
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 }
Lightweight Directory Access Protocol Version 3
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 singleLevel Search operation with a filter client requesting a singleLevel 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 baseObject Search X.500 "read"-like operation can be emulated by a baseObject Search
operation with the same filter. A server which provides a gateway to operation with the same filter. A server that provides a gateway to
X.500 is not required to use the Read or List operations, although it 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 same may choose to do so, and if it does, it must provide the same
semantics as the X.500 Search operation. semantics as the X.500 Search operation.
4.5.1.1. SearchRequest.baseObject 4.5.1.1. SearchRequest.baseObject
The name of the base object entry (or possibly the root) relative to The name of the base object entry (or possibly the root) relative to
which the Search is to be performed. which the Search is to be performed.
4.5.1.2. SearchRequest.scope 4.5.1.2. SearchRequest.scope
Specifies the scope of the Search to be performed. The semantics (as Specifies the scope of the Search to be performed. The semantics (as
described in [X.511]) of the defined values of this field are: described in [X.511]) of the defined values of this field are:
baseObject: The scope is constrained to the entry named by baseObject: The scope is constrained to the entry named by
baseObject. baseObject.
singleLevel: The scope is constrained to the immediate singleLevel: The scope is constrained to the immediate
subordinates of the entry named by baseObject. subordinates of the entry named by baseObject.
wholeSubtree: the scope is constrained to the entry named by the wholeSubtree: The scope is constrained to the entry named by
baseObject, and all its subordinates. baseObject and to all its subordinates.
4.5.1.3. SearchRequest.derefAliases 4.5.1.3. SearchRequest.derefAliases
An indicator as to whether or not alias entries (as defined in An indicator as to whether or not alias entries (as defined in
[Models]) are to be dereferenced during stages of the Search [RFC4512]) are to be dereferenced during stages of the Search
operation. operation.
The act of dereferencing an alias includes recursively dereferencing The act of dereferencing an alias includes recursively dereferencing
aliases which refer to aliases. aliases that refer to aliases.
Servers MUST detect looping while dereferencing aliases in order to Servers MUST detect looping while dereferencing aliases in order to
prevent denial of service attacks of this nature. prevent denial-of-service attacks of this nature.
The semantics of the defined values of this field are: The semantics of the defined values of this field are:
neverDerefAliases: Do not dereference aliases in searching or in neverDerefAliases: Do not dereference aliases in searching or in
locating the base object of the Search. locating the base object of the Search.
Lightweight Directory Access Protocol Version 3
derefInSearching: While searching subordinates of the base object, derefInSearching: While searching subordinates of the base object,
dereference any alias within the search scope. Dereferenced dereference any alias within the search scope. Dereferenced
objects become the vertices of further search scopes where the objects become the vertices of further search scopes where the
Search operation is also applied. If the search scope is Search operation is also applied. If the search scope is
wholeSubtree, the Search continues in the subtree(s) of any wholeSubtree, the Search continues in the subtree(s) of any
dereferenced object. If the search scope is singleLevel, the dereferenced object. If the search scope is singleLevel, the
search is applied to any dereferenced objects, and is not applied search is applied to any dereferenced objects and is not applied
to their subordinates. Servers SHOULD eliminate duplicate entries to their subordinates. Servers SHOULD eliminate duplicate entries
that arise due to alias dereferencing while searching. that arise due to alias dereferencing while searching.
derefFindingBaseObj: Dereference aliases in locating the base derefFindingBaseObj: Dereference aliases in locating the base
object of the Search, but not when searching subordinates of the object of the Search, but not when searching subordinates of the
base object. base object.
derefAlways: Dereference aliases both in searching and in locating derefAlways: Dereference aliases both in searching and in locating
the base object of the Search. the base object of the Search.
4.5.1.4. SearchRequest.sizeLimit 4.5.1.4. SearchRequest.sizeLimit
A size limit that restricts the maximum number of entries to be A size limit that restricts the maximum number of entries to be
returned as a result of the Search. A value of zero in this field returned as a result of the Search. A value of zero in this field
indicates that no client-requested size limit restrictions are in indicates that no client-requested size limit restrictions are in
effect for the Search. Servers may also enforce a maximum number of effect for the Search. Servers may also enforce a maximum number of
entries to return. entries to return.
4.5.1.5. SearchRequest.timeLimit 4.5.1.5. SearchRequest.timeLimit
A time limit that restricts the maximum time (in seconds) allowed for A time limit that restricts the maximum time (in seconds) allowed for
a Search. A value of zero in this field indicates that no client- a Search. A value of zero in this field indicates that no client-
requested time limit restrictions are in effect for the Search. requested time limit restrictions are in effect for the Search.
Servers may also enforce a maximum time limit for the Search. Servers may also enforce a maximum time limit for the Search.
4.5.1.6. SearchRequest.typesOnly 4.5.1.6. SearchRequest.typesOnly
An indicator as to whether Search results are to contain both An indicator as to whether Search results are to contain both
attribute descriptions and values, or just attribute descriptions. attribute descriptions and values, or just attribute descriptions.
Setting this field to TRUE causes only attribute descriptions (no Setting this field to TRUE causes only attribute descriptions (and
values) to be returned. Setting this field to FALSE causes both not values) to be returned. Setting this field to FALSE causes both
attribute descriptions and values to be returned. attribute descriptions and values to be returned.
Lightweight Directory Access Protocol Version 3 4.5.1.7. SearchRequest.filter
4.5.1.7. SearchRequest.filter
A filter that defines the conditions that must be fulfilled in order A filter that defines the conditions that must be fulfilled in order
for the Search to match a given entry. for the Search to match a given entry.
The 'and', 'or' and 'not' choices can be used to form combinations of The 'and', 'or', and 'not' choices can be used to form combinations
filters. At least one filter element MUST be present in an 'and' or of filters. At least one filter element MUST be present in an 'and'
'or' choice. The others match against individual attribute values of or 'or' choice. The others match against individual attribute values
entries in the scope of the Search. (Implementor's note: the 'not' of entries in the scope of the Search. (Implementor's note: the
filter is an example of a tagged choice in an implicitly-tagged 'not' filter is an example of a tagged choice in an implicitly-tagged
module. In BER this is treated as if the tag was explicit.) module. In BER this is treated as if the tag were explicit.)
A server MUST evaluate filters according to the three-valued logic of A server MUST evaluate filters according to the three-valued logic of
[X.511] (1993) Clause 7.8.1. In summary, a filter is evaluated to [X.511] (1993), Clause 7.8.1. In summary, a filter is evaluated to
either "TRUE", "FALSE" or "Undefined". If the filter evaluates to "TRUE", "FALSE", or "Undefined". If the filter evaluates to TRUE for
TRUE for a particular entry, then the attributes of that entry are a particular entry, then the attributes of that entry are returned as
returned as part of the Search result (subject to any applicable part of the Search result (subject to any applicable access control
access control restrictions). If the filter evaluates to FALSE or restrictions). If the filter evaluates to FALSE or Undefined, then
Undefined, then the entry is ignored for the Search. the entry is ignored for the Search.
A filter of the "and" choice is TRUE if all the filters in the SET OF 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 evaluate to TRUE, FALSE if at least one filter is FALSE, and
otherwise Undefined. A filter of the "or" choice is FALSE if all of Undefined otherwise. A filter of the "or" choice is FALSE if all the
the filters in the SET OF evaluate to FALSE, TRUE if at least one filters in the SET OF evaluate to FALSE, TRUE if at least one filter
filter is TRUE, and Undefined otherwise. A filter of the 'not' choice is TRUE, and Undefined otherwise. A filter of the 'not' choice is
is TRUE if the filter being negated is FALSE, FALSE if it is TRUE, TRUE if the filter being negated is FALSE, FALSE if it is TRUE, and
and Undefined if it is Undefined. Undefined if it is Undefined.
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. able to determine whether the assertion value matches an entry.
Examples include: Examples include:
- An attribute description in an equalityMatch, substrings, - An attribute description in an equalityMatch, substrings,
greaterOrEqual, lessOrEqual, approxMatch or extensibleMatch greaterOrEqual, lessOrEqual, approxMatch, or extensibleMatch filter
filter is not recognized by the server. is not recognized by the server.
- The attribute type does not define the appropriate matching - The attribute type does not define the appropriate matching rule.
rule.
- A MatchingRuleId in the extensibleMatch is not recognized by - A MatchingRuleId in the extensibleMatch is not recognized by the
the server or is not valid for the attribute type. server or is not valid for the attribute type.
- The type of filtering requested is not implemented. - The type of filtering requested is not implemented.
- The assertion value is invalid. - The assertion value is invalid.
For example, if a server did not recognize the attribute type For example, if a server did not recognize the attribute type
shoeSize, the filters (shoeSize=*), (shoeSize=12), (shoeSize>=12) and shoeSize, the filters (shoeSize=*), (shoeSize=12), (shoeSize>=12),
(shoeSize<=12) would each evaluate to Undefined. and (shoeSize<=12) would each evaluate to Undefined.
Servers MUST NOT return errors if attribute descriptions or matching Servers MUST NOT return errors if attribute descriptions or matching
rule ids are not recognized, assertion values are invalid, or the rule ids are not recognized, assertion values are invalid, or the
assertion syntax is not supported. More details of filter processing assertion syntax is not supported. More details of filter processing
are given in Clause 7.8 of [X.511]. are given in Clause 7.8 of [X.511].
Lightweight Directory Access Protocol Version 3 4.5.1.7.1. SearchRequest.filter.equalityMatch
4.5.1.7.1. SearchRequest.filter.equalityMatch
The matching rule for an equalityMatch filter is defined by the The matching rule for an equalityMatch filter is defined by the
EQUALITY matching rule for the attribute type or subtype. The filter EQUALITY matching rule for the attribute type or subtype. The filter
is TRUE when the EQUALITY rule returns TRUE as applied to the is TRUE when the EQUALITY rule returns TRUE as applied to the
attribute or subtype and the asserted value. attribute or subtype and the asserted value.
4.5.1.7.2. SearchRequest.filter.substrings 4.5.1.7.2. SearchRequest.filter.substrings
There SHALL be at most one 'initial', and at most one 'final' in the There SHALL be at most one 'initial' and at most one 'final' in the
'substrings' of a SubstringFilter. If 'initial' is present, it SHALL 'substrings' of a SubstringFilter. If 'initial' is present, it SHALL
be the first element of 'substrings'. If 'final' is present, it SHALL be the first element of 'substrings'. If 'final' is present, it
be the last element of 'substrings'. SHALL be the last element of 'substrings'.
The matching rule for an AssertionValue in a substrings filter item The matching rule for an AssertionValue in a substrings filter item
is defined by the SUBSTR matching rule for the attribute type or is defined by the SUBSTR matching rule for the attribute type or
subtype. The filter is TRUE when the SUBSTR rule returns TRUE as subtype. The filter is TRUE when the SUBSTR rule returns TRUE as
applied to the attribute or subtype and the asserted value. applied to the attribute or subtype and the asserted value.
Note that the AssertionValue in a substrings filter item conforms to Note that the AssertionValue in a substrings filter item conforms to
the assertion syntax of the EQUALITY matching rule for the attribute the assertion syntax of the EQUALITY matching rule for the attribute
type rather than the assertion syntax of the SUBSTR matching rule for type rather than to the assertion syntax of the SUBSTR matching rule
the attribute type. Conceptually, the entire SubstringFilter is for the attribute type. Conceptually, the entire SubstringFilter is
converted into an assertion value of the substrings matching rule converted into an assertion value of the substrings matching rule
prior to applying the rule. prior to applying the rule.
4.5.1.7.3. SearchRequest.filter.greaterOrEqual 4.5.1.7.3. SearchRequest.filter.greaterOrEqual
The matching rule for a greaterOrEqual filter is defined by the The matching rule for a greaterOrEqual filter is defined by the
ORDERING matching rule for the attribute type or subtype. The filter ORDERING matching rule for the attribute type or subtype. The filter
is TRUE when the ORDERING rule returns FALSE as applied to the is TRUE when the ORDERING rule returns FALSE as applied to the
attribute or subtype and the asserted value. attribute or subtype and the asserted value.
4.5.1.7.4. SearchRequest.filter.lessOrEqual 4.5.1.7.4. SearchRequest.filter.lessOrEqual
The matching rules for a lessOrEqual filter are defined by the The matching rules for a lessOrEqual filter are defined by the
ORDERING and EQUALITY matching rules for the attribute type or ORDERING and EQUALITY matching rules for the attribute type or
subtype. The filter is TRUE when either the ORDERING or EQUALITY rule subtype. The filter is TRUE when either the ORDERING or EQUALITY
returns TRUE as applied to the attribute or subtype and the asserted rule returns TRUE as applied to the attribute or subtype and the
value. asserted value.
4.5.1.7.5. SearchRequest.filter.present 4.5.1.7.5. SearchRequest.filter.present
A present filter is TRUE when there is an attribute or subtype of the A present filter is TRUE when there is an attribute or subtype of the
specified attribute description present in an entry, FALSE when no specified attribute description present in an entry, FALSE when no
attribute or subtype of the specified attribute description is attribute or subtype of the specified attribute description is
present in an entry, and Undefined otherwise. present in an entry, and Undefined otherwise.
Lightweight Directory Access Protocol Version 3 4.5.1.7.6. SearchRequest.filter.approxMatch
4.5.1.7.6. SearchRequest.filter.approxMatch
An approxMatch filter is TRUE when there is a value of the attribute An approxMatch filter is TRUE when there is a value of the attribute
type or subtype for which some locally-defined approximate matching type or subtype for which some locally-defined approximate matching
algorithm (e.g. spelling variations, phonetic match, etc.) returns algorithm (e.g., spelling variations, phonetic match, etc.) returns
TRUE. If a value matches for equality, it also satisfies an TRUE. If a value matches for equality, it also satisfies an
approximate match. If approximate matching is not supported for the approximate match. If approximate matching is not supported for the
attribute, this filter item should be treated as an equalityMatch. attribute, this filter item should be treated as an equalityMatch.
4.5.1.7.7. SearchRequest.filter.extensibleMatch 4.5.1.7.7. SearchRequest.filter.extensibleMatch
The fields of the extensibleMatch filter item are evaluated as The fields of the extensibleMatch filter item are evaluated as
follows: follows:
- If the matchingRule field is absent, the type field MUST be - If the matchingRule field is absent, the type field MUST be
present, and an equality match is performed for that type. present, and an equality match is performed for that type.
- If the type field is absent and the matchingRule is present, the - If the type field is absent and the matchingRule is present, the
matchValue is compared against all attributes in an entry which matchValue is compared against all attributes in an entry that
support that matchingRule. support that matchingRule.
- If the type field is present and the matchingRule is present, the - If the type field is present and the matchingRule is present, the
matchValue is compared against the specified attribute type and matchValue is compared against the specified attribute type and its
its subtypes. subtypes.
- If the dnAttributes field is set to TRUE, the match is - If the dnAttributes field is set to TRUE, the match is additionally
additionally applied against all the AttributeValueAssertions in applied against all the AttributeValueAssertions in an entry's
an entry's distinguished name, and evaluates to TRUE if there is distinguished name, and it evaluates to TRUE if there is at least
at least one attribute or subtype in the distinguished name for one attribute or subtype in the distinguished name for which the
which the filter item evaluates to TRUE. The dnAttributes field is filter item evaluates to TRUE. The dnAttributes field is present
present to alleviate the need for multiple versions of generic to alleviate the need for multiple versions of generic matching
matching rules (such as word matching), where one applies to rules (such as word matching), where one applies to entries and
entries and another applies to entries and DN attributes as well. another applies to entries and DN attributes as well.
The matchingRule used for evaluation determines the syntax for the The matchingRule used for evaluation determines the syntax for the
assertion value. Once the matchingRule and attribute(s) have been assertion value. Once the matchingRule and attribute(s) have been
determined, the filter item evaluates to TRUE if it matches at least determined, the filter item evaluates to TRUE if it matches at least
one attribute type or subtype in the entry, FALSE if it does not one attribute type or subtype in the entry, FALSE if it does not
match any attribute type or subtype in the entry, and Undefined if match any attribute type or subtype in the entry, and Undefined if
the matchingRule is not recognized, the matchingRule is unsuitable the matchingRule is not recognized, the matchingRule is unsuitable
for use with the specified type, or the assertionValue is invalid. for use with the specified type, or the assertionValue is invalid.
4.5.1.7. SearchRequest.attributes 4.5.1.8. SearchRequest.attributes
A selection list of the attributes to be returned from each entry A selection list of the attributes to be returned from each entry
which matches the search filter. Attributes which are subtypes of that matches the search filter. Attributes that are subtypes of
listed attributes are implicitly included. LDAPString values of this listed attributes are implicitly included. LDAPString values of this
field are constrained to the following Augmented Backus-Naur Form field are constrained to the following Augmented Backus-Naur Form
([ABNF]): (ABNF) [RFC4234]:
attributeSelector = attributedescription / selectorspecial
Lightweight Directory Access Protocol Version 3
selectorspecial = noattrs / alluserattrs
noattrs = %x31.2E.31 ; "1.1"
alluserattrs = %x2A ; asterisk ("*") attributeSelector = attributedescription / selectorspecial
The <attributedescription> production is defined in Section 2.5 of selectorspecial = noattrs / alluserattrs
[Models].
There are three special cases which may appear in the attributes noattrs = %x31.2E.31 ; "1.1"
selection list:
- an empty list with no attributes, alluserattrs = %x2A ; asterisk ("*")
- a list containing "*" (with zero or more attribute The <attributedescription> production is defined in Section 2.5 of
descriptions), and [RFC4512].
- a list containing only "1.1". There are three special cases that may appear in the attributes
selection list:
An empty list requests the return of all user attributes. 1. An empty list with no attributes requests the return of all
user attributes.
A list containing "*" requests the return of all user attributes 2. A list containing "*" (with zero or more attribute
in addition to other listed (operational) attributes. descriptions) requests the return of all user attributes in
addition to other listed (operational) attributes.
A list containing only the OID "1.1" indicates that no attributes 3. A list containing only the OID "1.1" indicates that no
are to be returned. If "1.1" is provided with other attributes are to be returned. If "1.1" is provided with other
attributeSelector values, the "1.1" attributeSelector is ignored. attributeSelector values, the "1.1" attributeSelector is
This OID was chosen because it does not (and can not) correspond ignored. This OID was chosen because it does not (and can not)
to any attribute in use. correspond to any attribute in use.
Client implementors should note that even if all user attributes are Client implementors should note that even if all user attributes are
requested, some attributes and/or attribute values of the entry may requested, some attributes and/or attribute values of the entry may
not be included in Search results due to access controls or other not be included in Search results due to access controls or other
restrictions. Furthermore, servers will not return operational restrictions. Furthermore, servers will not return operational
attributes, such as objectClasses or attributeTypes, unless they are attributes, such as objectClasses or attributeTypes, unless they are
listed by name. Operational attributes are described in [Models]. listed by name. Operational attributes are described in [RFC4512].
Attributes are returned at most once in an entry. If an attribute Attributes are returned at most once in an entry. If an attribute
description is named more than once in the list, the subsequent names description is named more than once in the list, the subsequent names
are ignored. If an attribute description in the list is not are ignored. If an attribute description in the list is not
recognized, it is ignored by the server. recognized, it is ignored by the server.
4.5.2. Search Result 4.5.2. Search Result
The results of the Search operation are returned as zero or more The results of the Search operation are returned as zero or more
SearchResultEntry and/or SearchResultReference messages, followed by SearchResultEntry and/or SearchResultReference messages, followed by
a single SearchResultDone message. a single SearchResultDone message.
SearchResultEntry ::= [APPLICATION 4] SEQUENCE { SearchResultEntry ::= [APPLICATION 4] SEQUENCE {
objectName LDAPDN, objectName LDAPDN,
attributes PartialAttributeList } attributes PartialAttributeList }
Lightweight Directory Access Protocol Version 3
PartialAttributeList ::= SEQUENCE OF PartialAttributeList ::= SEQUENCE OF
partialAttribute PartialAttribute partialAttribute PartialAttribute
SearchResultReference ::= [APPLICATION 19] SEQUENCE SearchResultReference ::= [APPLICATION 19] SEQUENCE
SIZE (1..MAX) OF uri URI SIZE (1..MAX) OF uri URI
SearchResultDone ::= [APPLICATION 5] LDAPResult SearchResultDone ::= [APPLICATION 5] LDAPResult
Each SearchResultEntry represents an entry found during the Search. Each SearchResultEntry represents an entry found during the Search.
Each SearchResultReference represents an area not yet explored during Each SearchResultReference represents an area not yet explored during
the Search. The SearchResultEntry and SearchResultReference messages the Search. The SearchResultEntry and SearchResultReference messages
may come in any order. Following all the SearchResultReference and may come in any order. Following all the SearchResultReference and
SearchResultEntry responses, the server returns a SearchResultDone SearchResultEntry responses, the server returns a SearchResultDone
response, which contains an indication of success, or detailing any response, which contains an indication of success or details any
errors that have occurred. 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, subject to access control and other administrative Search Request, subject to access control and other administrative
policy. Note that the PartialAttributeList may hold zero elements. policy. Note that the PartialAttributeList may hold zero elements.
This may happen when none of the attributes of an entry were This may happen when none of the attributes of an entry were
requested, or could be returned. Note also that the partialAttribute requested or could be returned. Note also that the partialAttribute
vals set may hold zero elements. This may happen when typesOnly is vals set may hold zero elements. This may happen when typesOnly is
requested, access controls prevent the return of values, or other requested, access controls prevent the return of values, or other
reasons. reasons.
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
can be modified, even if permitted by access control. attributes can be modified, even if this is permitted by access
control.
If the server's schema defines short names [Models] for an attribute If the server's schema defines short names [RFC4512] for an attribute
type then the server SHOULD use one of those names in attribute type, then the server SHOULD use one of those names in attribute
descriptions for that attribute type (in preference to using the descriptions for that attribute type (in preference to using the
<numericoid> [Models] format of the attribute type's object <numericoid> [RFC4512] format of the attribute type's object
identifier). The server SHOULD NOT use the short name if that name is identifier). The server SHOULD NOT use the short name if that name
known by the server to be ambiguous, or otherwise likely to cause is known by the server to be ambiguous, or if it is otherwise likely
interoperability problems. to cause interoperability problems.
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 or unwilling to search one or more non- baseObject but was unable or unwilling to search one or more non-
local entries, the server may return one or more local entries, the server may return one or more
SearchResultReference messages, each containing a reference to SearchResultReference messages, each containing a reference to
another set of servers for continuing the operation. A server MUST another set of servers for continuing the operation. A server MUST
NOT return any SearchResultReference messages if it has not located NOT return any SearchResultReference messages if it has not located
the baseObject and thus has not searched any entries; in this case it the baseObject and thus has not searched any entries. In this case,
would return a SearchResultDone containing either a referral or it would return a SearchResultDone containing either a referral or
noSuchObject result code (depending on the server's knowledge of the noSuchObject result code (depending on the server's knowledge of the
entry named in the baseObject). entry named in the baseObject).
Lightweight Directory Access Protocol Version 3
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 (Section 5 of [Models]), it may use the search filter to context (Section 5 of [RFC4512]), it may use the search filter to
determine whether or not to return a SearchResultReference response. determine whether or not to return a SearchResultReference response.
Otherwise SearchResultReference responses are always returned when in Otherwise, SearchResultReference responses are always returned when
scope. in scope.
The SearchResultReference is of the same data type as the Referral. The SearchResultReference is of the same data type as the Referral.
If the client wishes to progress the Search, it issues a new Search If the client wishes to progress the Search, it issues a new Search
operation for each SearchResultReference that is returned. If operation for each SearchResultReference that is returned. If
multiple URIs are present, the client assumes that any supported URI multiple URIs are present, the client assumes that any supported URI
may be used to progress the operation. may be used to progress the operation.
Clients that follow search continuation references MUST ensure that Clients that follow search continuation references MUST ensure that
they do not loop between servers. They MUST NOT repeatedly contact they do not loop between servers. They MUST NOT repeatedly contact
the same server for the same request with the same parameters. Some the same server for the same request with the same parameters. Some
clients use a counter that is incremented each time search result clients use a counter that is incremented each time search result
reference handling occurs for an operation, and these kinds of reference handling occurs for an operation, and these kinds of
clients MUST be able to handle at least ten nested referrals while clients MUST be able to handle at least ten nested referrals while
progressing the operation. progressing the operation.
Note that the Abandon operation described in Section 4.11 applies Note that the Abandon operation described in Section 4.11 applies
only to a particular operation sent at the LDAP message layer between only to a particular operation sent at the LDAP message layer between
a client and server. The client must abandon subsequent Search a client and server. The client must individually abandon subsequent
operations it wishes to individually. Search operations it wishes to.
A URI for a server implementing LDAP and accessible via [TCP]/[IP] A URI for a server implementing LDAP and accessible via TCP/IP (v4 or
(v4 or v6) is written as an LDAP URL according to [LDAPURL]. v6) [RFC793][RFC791] is written as an LDAP URL according to
[RFC4516].
SearchResultReference values which are LDAP URLs follow these rules: SearchResultReference values that are LDAP URLs follow these rules:
- The <dn> part of the LDAP URL MUST be present, with the new target - The <dn> part of the LDAP URL MUST be present, with the new target
object name. The client uses this name when following the object name. The client uses this name when following the
reference. reference.
- Some servers (e.g. participating in distributed indexing) may - Some servers (e.g., participating in distributed indexing) may
provide a different filter in the LDAP URL. provide a different filter in the LDAP URL.
- If the <filter> part of the LDAP URL is present, the client uses - If the <filter> part of the LDAP URL is present, the client uses
this filter in its next request to progress this Search, and if it this filter in its next request to progress this Search, and if it
is not present the client uses the same filter as it used for that is not present the client uses the same filter as it used for that
Search. Search.
- If the originating search scope was singleLevel, the <scope> part - If the originating search scope was singleLevel, the <scope> part
of the LDAP URL will be "base". of the LDAP URL will be "base".
- It is RECOMMENDED that the <scope> part be present to avoid - It is RECOMMENDED that the <scope> part be present to avoid
ambiguity. In the absence of a <scope> part, the scope of the ambiguity. In the absence of a <scope> part, the scope of the
original Search request is assumed. original Search request is assumed.
- Other aspects of the new Search request may be the same as or - Other aspects of the new Search request may be the same as or
different from the Search request which generated the different from the Search request that generated the
SearchResultReference. SearchResultReference.
Lightweight Directory Access Protocol Version 3
- The name of an unexplored subtree in a SearchResultReference need - The name of an unexplored subtree in a SearchResultReference need
not be subordinate to the base object. not be subordinate to the base object.
Other kinds of URIs may be returned. The syntax and semantics of such Other kinds of URIs may be returned. The syntax and semantics of
URIs is left to future specifications. Clients may ignore URIs that such URIs is left to future specifications. Clients may ignore URIs
they do not support. that they do not support.
UTF-8 encoded characters appearing in the string representation of a UTF-8-encoded characters appearing in the string representation of a
DN, search filter, or other fields of the referral value may not be DN, search filter, or other fields of the referral value may not be
legal for URIs (e.g. spaces) and MUST be escaped using the % method legal for URIs (e.g., spaces) and MUST be escaped using the % method
in [URI]. in [RFC3986].
4.5.3.1. Examples 4.5.3.1. Examples
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 both LDAP servers (hostb) and (hostc) hold knows that both LDAP servers (hostb) and (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 wholeSubtree Search of <OU=Roles,DC=Example,DC=NET>. If a wholeSubtree 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??sub ldap://hostb/OU=People,DC=Example,DC=NET??sub
ldap://hostc/OU=People,DC=Example,DC=NET??sub } ldap://hostc/OU=People,DC=Example,DC=NET??sub }
SearchResultReference { SearchResultReference {
ldap://hostd/OU=Roles,DC=Example,DC=NET??sub } ldap://hostd/OU=Roles,DC=Example,DC=NET??sub }
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
(hostb) and issued the Search request for the subtree server (hostb) and issued the Search request 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??sub } ldap://hoste/OU=Managers,OU=People,DC=Example,DC=NET??sub }
SearchResultReference { SearchResultReference {
ldap://hostf/OU=Consultants,OU=People,DC=Example,DC=NET??sub } ldap://hostf/OU=Consultants,OU=People,DC=Example,DC=NET??sub }
SearchResultDone (success) SearchResultDone (success)
Similarly, if a singleLevel Search of <DC=Example,DC=NET> is Similarly, if a singleLevel Search of <DC=Example,DC=NET> is
requested to the contacted server, it may return the following: requested to the contacted server, it may return the following:
Lightweight Directory Access Protocol Version 3
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??base ldap://hostb/OU=People,DC=Example,DC=NET??base
ldap://hostc/OU=People,DC=Example,DC=NET??base } ldap://hostc/OU=People,DC=Example,DC=NET??base }
SearchResultReference { SearchResultReference {
ldap://hostd/OU=Roles,DC=Example,DC=NET??base } ldap://hostd/OU=Roles,DC=Example,DC=NET??base }
SearchResultDone (success) SearchResultDone (success)
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,
but has knowledge of its possible location, then it may return a but has knowledge of its possible location, then it may return a
referral to the client. In this case, if the client requests a referral to the client. In this case, if the client requests a
subtree Search of <DC=Example,DC=ORG> to hosta, the server returns a subtree Search of <DC=Example,DC=ORG> to hosta, the server returns a
SearchResultDone containing a referral. 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 change SEQUENCE { changes SEQUENCE OF change SEQUENCE {
operation ENUMERATED { operation ENUMERATED {
add (0), add (0),
delete (1), delete (1),
replace (2), replace (2),
... }, ... },
modification PartialAttribute } } modification PartialAttribute } }
Fields of the Modify Request are: Fields of the Modify Request are:
- object: The value of this field contains the name of the entry to - object: The value of this field contains the name of the entry to
be modified. The server SHALL NOT perform any alias dereferencing be modified. The server SHALL NOT perform any alias dereferencing
in determining the object to be modified. in determining the 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 Directory Information Tree
resulting entry after the entire list of modifications is (DIT) content rule), the resulting entry after the entire list of
performed MUST conform to the requirements of the directory model modifications is performed MUST conform to the requirements of the
and controlling schema [Models]. directory model and controlling schema [RFC4512].
- 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:
Lightweight Directory Access Protocol Version 3
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 attribute. delete: delete values listed from the modification attribute.
If no values are listed, or if all current values of the If no values are listed, or if all current values of the
attribute are listed, the entire attribute is removed; attribute are listed, the entire attribute is removed.
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 attribute with the new values listed, creating the attribute
if it did not already exist. A replace with no value will if it did not already exist. A replace with no value will
delete the entire attribute if it exists, and is ignored if delete the entire attribute if it exists, and it is ignored
the attribute does not exist. if the attribute does not exist.
- modification: A PartialAttribute (which may have an empty SET - modification: A PartialAttribute (which may have an empty SET
of vals) used to hold the attribute type or attribute type and of vals) used to hold the attribute type or attribute type and
values being modified. values being modified.
Upon receipt of a Modify Request, the server attempts to perform the Upon receipt of a Modify Request, the server attempts to perform the
necessary modifications to the DIT and returns the result in a Modify necessary modifications to the DIT and returns the result in a Modify
Response, defined as follows: Response, defined as follows:
ModifyResponse ::= [APPLICATION 7] LDAPResult ModifyResponse ::= [APPLICATION 7] LDAPResult
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. Due to the requirement or the reason that the modification failed. Due to the requirement
for atomicity in applying the list of modifications in the Modify for atomicity in applying the list of modifications in the Modify
Request, the client may expect that no modifications of the DIT have Request, the client may expect that no modifications of the DIT have
been performed if the Modify Response received indicates any sort of been performed if the Modify Response received indicates any sort of
error, and that all requested modifications have been performed if error, and that all requested modifications have been performed if
the Modify Response indicates successful completion of the Modify the Modify Response indicates successful completion of the Modify
operation. Whether the modification was applied or not cannot be operation. Whether or not the modification was applied cannot be
determined by the client if the Modify Response was not received determined by the client if the Modify Response was not received
(e.g. the LDAP session was terminated or the Modify operation was (e.g., the LDAP session was terminated or the Modify operation was
abandoned). abandoned).
Servers MUST ensure that entries conform to user and system schema Servers MUST ensure that entries conform to user and system schema
rules or other data model constraints. The Modify operation cannot be rules or other data model constraints. The Modify operation cannot
used to remove from an entry any of its distinguished values, i.e. be used to remove from an entry any of its distinguished values,
those values which form the entry's relative distinguished name. An i.e., those values which form the entry's relative distinguished
attempt to do so will result in the server returning the name. An attempt to do so will result in the server returning the
notAllowedOnRDN result code. The Modify DN operation described in notAllowedOnRDN result code. The Modify DN operation described in
Section 4.9 is used to rename an entry. Section 4.9 is used to rename an entry.
For attribute types which specify no equality matching, the rules in For attribute types that specify no equality matching, the rules in
Section 2.5.1 of [Models] are followed. Section 2.5.1 of [RFC4512] are followed.
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.
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 attribute Attribute AttributeList ::= SEQUENCE OF attribute Attribute
Fields of the Add Request are: Fields of the Add Request are:
- entry: the name of the entry to be added. The server SHALL NOT - entry: the name of the entry to be added. The server SHALL NOT
dereference any aliases in locating the entry to be added. dereference any aliases in locating the entry to be added.
- attributes: the list of attributes that, along with those from the - attributes: the list of attributes that, along with those from the
RDN, make up the content of the entry being added. Clients MAY or RDN, make up the content of the entry being added. Clients MAY or
MAY NOT include the RDN attribute(s) in this list. Clients MUST MAY NOT include the RDN attribute(s) in this list. Clients MUST
NOT supply NO-USER-MODIFICATION attributes such as the NOT supply NO-USER-MODIFICATION attributes such as the
createTimestamp or creatorsName attributes, since the server createTimestamp or creatorsName attributes, since the server
maintains these automatically. maintains these automatically.
Servers MUST ensure that entries conform to user and system schema Servers MUST ensure that entries conform to user and system schema
rules or other data model constraints. For attribute types which rules or other data model constraints. For attribute types that
specify no equality matching, the rules in Section 2.5.1 of [Models] specify no equality matching, the rules in Section 2.5.1 of [RFC4512]
are followed (this applies to the naming attribute in addition to any are followed (this applies to the naming attribute in addition to any
multi-valued attributes being added). multi-valued attributes being added).
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 an for the AddRequest to succeed. The immediate superior (parent) of an
object or alias entry 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>. the matchedDN field containing <DC=NET>.
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 has been added to A response of success indicates that the new entry has been added to
the Directory. the Directory.
4.8. Delete Operation 4.8. Delete Operation
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
Lightweight Directory Access Protocol Version 3
The Delete Request consists of the name of the entry to be deleted. The Delete Request consists of the name of the entry to be deleted.
The server SHALL NOT dereference aliases while resolving the name of The server SHALL NOT dereference aliases while resolving the name of
the target entry to be removed. the target entry to be removed.
Only leaf entries (those with no subordinate entries) can be deleted Only leaf entries (those with no subordinate entries) can be deleted
with this operation. with this operation.
Upon receipt of a Delete Request, a server will attempt to perform Upon receipt of a Delete Request, a server will attempt to perform
the entry removal requested and return the result in the Delete the entry removal requested and return the result in the Delete
Response defined as follows: Response defined as follows:
DelResponse ::= [APPLICATION 11] LDAPResult DelResponse ::= [APPLICATION 11] LDAPResult
4.9. Modify DN Operation 4.9. Modify DN Operation
The Modify DN operation allows a client to change the Relative The Modify DN operation allows a client to change the Relative
Distinguished Name (RDN) of an entry in the Directory, and/or to move Distinguished Name (RDN) of an entry in the Directory and/or to move
a subtree of entries to a new location in the Directory. The Modify a subtree of entries to a new location in the 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 }
Fields of the Modify DN Request are: Fields of the Modify DN Request are:
- entry: the name of the entry to be changed. This entry may or may - entry: the name of the entry to be changed. This entry may or may
not have subordinate entries. not have subordinate entries.
- newrdn: the new RDN of the entry. The value of the old RDN is - newrdn: the new RDN of the entry. The value of the old RDN is
supplied when moving the entry to a new superior without changing supplied when moving the entry to a new superior without changing
its RDN. Attribute values of the new RDN not matching any its RDN. Attribute values of the new RDN not matching any
attribute value of the entry are added to the entry and an attribute value of the entry are added to the entry, and an
appropriate error is returned if this fails. appropriate error is returned if this fails.
- deleteoldrdn: a boolean field that controls whether the old RDN - deleteoldrdn: a boolean field that controls whether the old RDN
attribute values are to be retained as attributes of the entry, or attribute values are to be retained as attributes of the entry or
deleted from the entry. deleted from the entry.
- newSuperior: if present, this is the name of an existing object - newSuperior: if present, this is the name of an existing object
entry which becomes the immediate superior (parent) of the entry that becomes the immediate superior (parent) of the
existing entry. existing entry.
The server SHALL NOT dereference any aliases in locating the objects The server SHALL NOT dereference any aliases in locating the objects
named in entry or newSuperior. named in entry or newSuperior.
Upon receipt of a ModifyDNRequest, a server will attempt to perform Upon receipt of a ModifyDNRequest, a server will attempt to perform
the name change and return the result in the Modify DN Response, the name change and return the result in the Modify DN Response,
defined as follows: defined as follows:
Lightweight Directory Access Protocol Version 3
ModifyDNResponse ::= [APPLICATION 13] LDAPResult ModifyDNResponse ::= [APPLICATION 13] LDAPResult
For example, if the entry named in the entry field was <cn=John For example, if the entry named in the entry field was <cn=John
Smith,c=US>, the newrdn field was <cn=John Cougar Smith>, and the Smith,c=US>, the newrdn field was <cn=John Cougar Smith>, and the
newSuperior field was absent, then this operation would attempt to newSuperior field was absent, then this operation would attempt to
rename the entry to be <cn=John Cougar Smith,c=US>. If there was rename the entry as <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.
Servers MUST ensure that entries conform to user and system schema Servers MUST ensure that entries conform to user and system schema
rules or other data model constraints. For attribute types which rules or other data model constraints. For attribute types that
specify no equality matching, the rules in Section 2.5.1 of [Models] specify no equality matching, the rules in Section 2.5.1 of [RFC4512]
are followed (this pertains to newrdn and deleteoldrdn). are followed (this pertains to newrdn and deleteoldrdn).
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 field is TRUE, the attribute values forming the If the deleteoldrdn field is TRUE, the attribute values forming the
old RDN but not the new RDN are deleted from the entry. If the old RDN (but not the new RDN) are deleted from the entry. If the
deleteoldrdn field is FALSE, the attribute values forming the old RDN deleteoldrdn field is FALSE, the attribute values forming the old RDN
will be retained as non-distinguished attribute values of the entry. will be retained as non-distinguished attribute values of the entry.
Note that X.500 restricts the ModifyDN operation to only affect Note that X.500 restricts the ModifyDN operation to affect only
entries that are contained within a single server. If the LDAP server entries that are contained within a single server. If the LDAP
is mapped onto DAP, then this restriction will apply, and the server 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 or arbitrary movements of entries and subtrees between servers or
between naming contexts. between naming contexts.
4.10. Compare Operation 4.10. Compare Operation
The Compare operation allows a client to compare an assertion value The Compare operation allows a client to compare an assertion value
with the values of a particular attribute in a particular entry in with the values of a particular attribute in a particular entry in
the Directory. The Compare Request is defined as follows: the Directory. The Compare Request is defined as follows:
CompareRequest ::= [APPLICATION 14] SEQUENCE { CompareRequest ::= [APPLICATION 14] SEQUENCE {
entry LDAPDN, entry LDAPDN,
ava AttributeValueAssertion } ava AttributeValueAssertion }
Fields of the Compare Request are: Fields of the Compare Request are:
- entry: the name of the entry to be compared. The server SHALL NOT - entry: the name of the entry to be compared. The server SHALL NOT
dereference any aliases in locating the entry to be compared. dereference any aliases in locating the entry to be compared.
- ava: holds the attribute value assertion to be compared. - ava: holds the attribute value assertion to be compared.
Upon receipt of a Compare Request, a server will attempt to perform Upon receipt of a Compare Request, a server will attempt to perform
the requested comparison and return the result in the Compare the requested comparison and return the result in the Compare
Response, defined as follows: Response, defined as follows:
Lightweight Directory Access Protocol Version 3
CompareResponse ::= [APPLICATION 15] LDAPResult CompareResponse ::= [APPLICATION 15] LDAPResult
The resultCode is set to compareTrue, compareFalse, or an appropriate The resultCode is set to compareTrue, compareFalse, or an appropriate
error. compareTrue indicates that the assertion value in the ava error. compareTrue indicates that the assertion value in the ava
field matches a value of the attribute or subtype according to the field matches a value of the attribute or subtype according to the
attribute's EQUALITY matching rule. compareFalse indicates that the attribute's EQUALITY matching rule. compareFalse indicates that the
assertion value in the ava field and the values of the attribute or assertion value in the ava field and the values of the attribute or
subtype did not match. Other result codes indicate either that the subtype did not match. Other result codes indicate either that the
result of the comparison was Undefined (Section 4.5.1), or that some result of the comparison was Undefined (Section 4.5.1.7), or that
error occurred. some error occurred.
Note that some directory systems may establish access controls which Note that some directory systems may establish access controls that
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 uncompleted operation. The Abandon Request that the server abandon an uncompleted operation. The Abandon
is defined as follows: Request is defined as follows:
AbandonRequest ::= [APPLICATION 16] MessageID AbandonRequest ::= [APPLICATION 16] MessageID
The MessageID is that of an operation which was requested earlier at The MessageID is that of an operation that was requested earlier at
this LDAP message layer. The Abandon request itself has its own this LDAP message layer. The Abandon request itself has its own
MessageID. This is distinct from the MessageID of the earlier MessageID. This is distinct from the MessageID of the earlier
operation being abandoned. operation 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. Since the client cannot tell the difference between by the MessageID. Since the client cannot tell the difference
a successfully abandoned operation and an uncompleted operation, the between a successfully abandoned operation and an uncompleted
application of the Abandon operation is limited to uses where the operation, the application of the Abandon operation is limited to
client does not require an indication of its outcome. uses where the client does not require an indication of its outcome.
Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned. Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.
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 SearchResultDone. Of request immediately, and it MUST NOT send the SearchResultDone. 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.
The ability to abandon other (particularly update) operations is at The ability to abandon other (particularly update) operations is at
the discretion of the server. the discretion of the server.
Clients should not send Abandon requests for the same operation Clients should not send Abandon requests for the same operation
multiple times, and MUST also be prepared to receive results from multiple times, and they MUST also be prepared to receive results
operations it has abandoned (since these may have been in transit from operations they have abandoned (since these might have been in
when the Abandon was requested, or are not able to be abandoned). transit when the Abandon was requested or might not be able to be
abandoned).
Lightweight Directory Access Protocol Version 3
Servers MUST discard Abandon requests for message IDs they do not Servers MUST discard Abandon requests for messageIDs they do not
recognize, for operations which cannot be abandoned, and for recognize, for operations that cannot be abandoned, and for
operations which have already been abandoned. operations that have already been abandoned.
4.12. Extended Operation 4.12. Extended Operation
The Extended operation allows additional operations to be defined for The Extended operation allows additional operations to be defined for
services not already available in the protocol. For example, to Add services not already available in the protocol; for example, to Add
operations to install transport layer security (see Section 4.14). operations to install transport layer security (see Section 4.14).
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. defined in RFCs or be private to particular implementations.
Each Extended operation consists of an Extended request and an Each Extended operation consists of an Extended request and an
Extended response. Extended response.
ExtendedRequest ::= [APPLICATION 23] SEQUENCE { ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
requestName [0] LDAPOID, requestName [0] LDAPOID,
requestValue [1] OCTET STRING OPTIONAL } requestValue [1] OCTET STRING OPTIONAL }
The requestName is a dotted-decimal representation of the unique The requestName is a dotted-decimal representation of the unique
OBJECT IDENTIFIER corresponding to the request. The requestValue is OBJECT IDENTIFIER corresponding to the request. The requestValue is
information in a form defined by that request, encapsulated inside an information in a form defined by that request, encapsulated inside an
OCTET STRING. OCTET STRING.
The server will respond to this with an LDAPMessage containing an The server will respond to this with an LDAPMessage containing an
ExtendedResponse. ExtendedResponse.
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 }
The responseName field, when present, contains an LDAPOID which is The responseName field, when present, contains an LDAPOID that is
unique for this extended operation or response. This field is unique for this extended operation or response. This field is
optional (even when the extension specification specifies an LDAPOID optional (even when the extension specification defines an LDAPOID
to be returned in the field). The field will be absent whenever the for use in this field). The field will be absent whenever the server
server is unable or unwilling to determine the appropriate LDAPOID to is unable or unwilling to determine the appropriate LDAPOID to
return, for instance when the requestName cannot be parsed or its return, for instance, when the requestName cannot be parsed or its
value is not recognized. value is not recognized.
Where the requestName is not recognized, the server returns Where the requestName is not recognized, the server returns
protocolError (The server may return protocolError in other cases). protocolError. (The server may return protocolError in other cases.)
The requestValue and responseValue fields contain information The requestValue and responseValue fields contain information
associated with the operation. The format of these fields is defined associated with the operation. The format of these fields is defined
by the specification of the Extended operation. Implementations MUST by the specification of the Extended operation. Implementations MUST
be prepared to handle arbitrary contents of these fields, including be prepared to handle arbitrary contents of these fields, including
zero bytes. Values that are defined in terms of ASN.1 and BER encoded zero bytes. Values that are defined in terms of ASN.1 and BER-
according to Section 5.1, also follow the extensibility rules in encoded according to Section 5.1 also follow the extensibility rules
Section 4. in Section 4.
Lightweight Directory Access Protocol Version 3
Servers list the requestName of Extended Requests they recognize in Servers list the requestName of Extended Requests they recognize in
the 'supportedExtension' attribute in the root DSE (Section 5.1 of the 'supportedExtension' attribute in the root DSE (Section 5.1 of
[Models]). [RFC4512]).
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 requestName, - the OBJECT IDENTIFIER assigned to the requestName,
- the OBJECT IDENTIFIER (if any) assigned to the responseName (note - the OBJECT IDENTIFIER (if any) assigned to the responseName (note
that the same OBJECT IDENTIFIER may be used for both the that the same OBJECT IDENTIFIER may be used for both the
requestName and responseName), requestName and responseName),
- the format of the contents of the requestValue and responseValue - the format of the contents of the requestValue and responseValue
(if any), and (if any), and
- the semantics of the operation. - the semantics of the operation.
4.13. IntermediateResponse Message 4.13. IntermediateResponse Message
While the Search operation provides a mechanism to return multiple While the Search operation provides a mechanism to return multiple
response messages for a single Search request, other operations, by response messages for a single Search request, other operations, by
nature, do not provide for multiple response messages. nature, do not provide for multiple response messages.
The IntermediateResponse message provides a general mechanism for The IntermediateResponse message provides a general mechanism for
defining single-request/multiple-response operations in LDAP. This defining single-request/multiple-response operations in LDAP. This
message is intended to be used in conjunction with the Extended message is intended to be used in conjunction with the Extended
operation to define new single-request/multiple-response operations operation to define new single-request/multiple-response operations
or in conjunction with a control when extending existing LDAP or in conjunction with a control when extending existing LDAP
operations in a way that requires them to return Intermediate operations in a way that requires them to return Intermediate
response information. response information.
It is intended that the definitions and descriptions of Extended It is intended that the definitions and descriptions of Extended
operations and controls that make use of the IntermediateResponse operations and controls that make use of the IntermediateResponse
message will define the circumstances when an IntermediateResponse message will define the circumstances when an IntermediateResponse
message can be sent by a server and the associated meaning of an message can be sent by a server and the associated meaning of an
IntermediateResponse message sent in a particular circumstance. IntermediateResponse message sent in a particular circumstance.
IntermediateResponse ::= [APPLICATION 25] SEQUENCE { IntermediateResponse ::= [APPLICATION 25] SEQUENCE {
responseName [0] LDAPOID OPTIONAL, responseName [0] LDAPOID OPTIONAL,
responseValue [1] OCTET STRING OPTIONAL } responseValue [1] OCTET STRING OPTIONAL }
IntermediateResponse messages SHALL NOT be returned to the client IntermediateResponse messages SHALL NOT be returned to the client
unless the client issues a request that specifically solicits their unless the client issues a request that specifically solicits their
return. This document defines two forms of solicitation: Extended return. This document defines two forms of solicitation: Extended
operation and request control. IntermediateResponse messages are operation and request control. IntermediateResponse messages are
specified in documents describing the manner in which they are specified in documents describing the manner in which they are
solicited (i.e. in the Extended operation or request control solicited (i.e., in the Extended operation or request control
specification that uses them). These specifications include: specification that uses them). These specifications include:
- the OBJECT IDENTIFIER (if any) assigned to the responseName, - the OBJECT IDENTIFIER (if any) assigned to the responseName,
- the format of the contents of the responseValue (if any), and - the format of the contents of the responseValue (if any), and
Lightweight Directory Access Protocol Version 3
- the semantics associated with the IntermediateResponse message. - the semantics associated with the IntermediateResponse message.
Extensions that allow the return of multiple types of Extensions that allow the return of multiple types of
IntermediateResponse messages SHALL identify those types using unique IntermediateResponse messages SHALL identify those types using unique
responseName values (note that one of these may specify no value). responseName values (note that one of these may specify no value).
Sections 4.13.1 and 4.13.2 describe additional requirements on the Sections 4.13.1 and 4.13.2 describe additional requirements on the
inclusion of responseName and responseValue in IntermediateResponse inclusion of responseName and responseValue in IntermediateResponse
messages. messages.
4.13.1. Usage with LDAP ExtendedRequest and ExtendedResponse 4.13.1. Usage with LDAP ExtendedRequest and ExtendedResponse
A single-request/multiple-response operation may be defined using a A single-request/multiple-response operation may be defined using a
single ExtendedRequest message to solicit zero or more single ExtendedRequest message to solicit zero or more
IntermediateResponse messages of one or more kinds followed by an IntermediateResponse messages of one or more kinds, followed by an
ExtendedResponse message. ExtendedResponse message.
4.13.2. Usage with LDAP Request Controls 4.13.2. Usage with LDAP Request Controls
A control's semantics may include the return of zero or more A control's semantics may include the return of zero or more
IntermediateResponse messages prior to returning the final result IntermediateResponse messages prior to returning the final result
code for the operation. One or more kinds of IntermediateResponse code for the operation. One or more kinds of IntermediateResponse
messages may be sent in response to a request control. messages may be sent in response to a request control.
All IntermediateResponse messages associated with request controls All IntermediateResponse messages associated with request controls
SHALL include a responseName. This requirement ensures that the SHALL include a responseName. This requirement ensures that the
client can correctly identify the source of IntermediateResponse client can correctly identify the source of IntermediateResponse
messages when: messages when:
- two or more controls using IntermediateResponse messages are - two or more controls using IntermediateResponse messages are
included in a request for any LDAP operation or included in a request for any LDAP operation or
- one or more controls using IntermediateResponse messages are - one or more controls using IntermediateResponse messages are
included in a request with an LDAP Extended operation that uses included in a request with an LDAP Extended operation that uses
IntermediateResponse messages. IntermediateResponse messages.
4.14. StartTLS Operation 4.14. StartTLS Operation
The Start Transport Layer Security (StartTLS) operation's purpose is The Start Transport Layer Security (StartTLS) operation's purpose is
to initiate installation of a TLS layer. The StartTLS operation is to initiate installation of a TLS layer. The StartTLS operation is
defined using the Extended operation mechanism described in Section defined using the Extended operation mechanism described in Section
4.12. 4.12.
Lightweight Directory Access Protocol Version 3 4.14.1. StartTLS Request
4.14.1. StartTLS Request
A client requests TLS establishment by transmitting a StartTLS A client requests TLS establishment by transmitting a StartTLS
request message to the server. The StartTLS request is defined in request message to the server. The StartTLS request is defined in
terms of an ExtendedRequest. The requestName is terms of an ExtendedRequest. The requestName is
"1.3.6.1.4.1.1466.20037", and the requestValue field is always "1.3.6.1.4.1.1466.20037", and the requestValue field is always
absent. absent.
The client MUST NOT send any LDAP PDUs at this LDAP message layer The client MUST NOT send any LDAP PDUs at this LDAP message layer
following this request until it receives a StartTLS Extended response following this request until it receives a StartTLS Extended response
and, in the case of a successful response, completes TLS and, in the case of a successful response, completes TLS
negotiations. negotiations.
Detected sequencing problems (particularly those detailed in Section Detected sequencing problems (particularly those detailed in Section
3.1.1 of [AuthMeth]) result in the resultCode being set to 3.1.1 of [RFC4513]) result in the resultCode being set to
operationsError. operationsError.
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 returns with the resultCode set to protocolError configuration), it returns with the resultCode set to protocolError
as described in Section 4.12. as described in Section 4.12.
4.14.2. StartTLS Response 4.14.2. StartTLS Response
When a StartTLS request is received, servers supporting the operation When a StartTLS request is received, servers supporting the operation
MUST return a StartTLS response message to the requestor. The MUST return a StartTLS response message to the requestor. The
responseName is "1.3.6.1.4.1.1466.20037" when provided (See 4.12). responseName is "1.3.6.1.4.1.1466.20037" when provided (see Section
The responseValue is always absent. 4.12). The responseValue is always absent.
If the server is willing and able to negotiate TLS, it returns the If the server is willing and able to negotiate TLS, it returns the
StartTLS response with the resultCode set to success. Upon client StartTLS response with the resultCode set to success. Upon client
receipt of a successful StartTLS response, protocol peers may receipt of a successful StartTLS response, protocol peers may
commence with TLS negotiation as discussed in Section 3 of commence with TLS negotiation as discussed in Section 3 of [RFC4513].
[AuthMeth].
If the server is otherwise unwilling or unable to perform this If the server is otherwise unwilling or unable to perform this
operation, the server is to return an appropriate result code operation, the server is to return an appropriate result code
indicating the nature of the problem. For example, if the TLS indicating the nature of the problem. For example, if the TLS
subsystem is not presently available, the server may indicate so by subsystem is not presently available, the server may indicate this by
returning with the resultCode set to unavailable. In cases where a returning with the resultCode set to unavailable. In cases where a
non-success result code is returned, the LDAP session is left without non-success result code is returned, the LDAP session is left without
a TLS layer. a TLS layer.
4.14.3. Removal of the TLS Layer 4.14.3. Removal of the TLS Layer
Either the client or server MAY remove the TLS layer and leave the Either the client or server MAY remove the TLS layer and leave the
LDAP message layer intact by sending and receiving a TLS closure LDAP message layer intact by sending and receiving a TLS closure
alert. alert.
Lightweight Directory Access Protocol Version 3
The initiating protocol peer sends the TLS closure alert and MUST The initiating protocol peer sends the TLS closure alert and MUST
wait until it receives a TLS closure alert from the other peer before wait until it receives a TLS closure alert from the other peer before
sending further LDAP PDUs. sending further LDAP PDUs.
When a protocol peer receives the initial TLS closure alert, it may When a protocol peer receives the initial TLS closure alert, it may
choose to allow the LDAP message layer to remain intact. In this choose to allow the LDAP message layer to remain intact. In this
case, it MUST immediately transmit a TLS closure alert. Following case, it MUST immediately transmit a TLS closure alert. Following
this, it MAY send and receive LDAP PDUs. this, it MAY send and receive LDAP PDUs.
Protocol peers MAY terminate the LDAP session after sending or Protocol peers MAY terminate the LDAP session after sending or
receiving a TLS closure alert. receiving a TLS closure alert.
5. Protocol Encoding, Connection, and Transfer 5. Protocol Encoding, Connection, and Transfer
This protocol is designed to run over connection-oriented, reliable This protocol is designed to run over connection-oriented, reliable
transports, where the data stream is divided into octets (8-bit transports, where the data stream is divided into octets (8-bit
units), with each octet and each bit being significant. units), with each octet and each bit being significant.
One underlying service, LDAP over TCP, is defined in Section One underlying service, LDAP over TCP, is defined in Section 5.2.
5.2. This service is generally applicable to applications providing This service is generally applicable to applications providing or
or consuming X.500-based directory services on the Internet. This consuming X.500-based directory services on the Internet. This
specification was generally written with the TCP mapping in mind. specification was generally written with the TCP mapping in mind.
Specifications detailing other mappings may encounter various Specifications detailing other mappings may encounter various
obstacles. obstacles.
Implementations of LDAP over TCP MUST implement the mapping as Implementations of LDAP over TCP MUST implement the mapping as
described in Section 5.2. described in Section 5.2.
This table illustrates the relationship between the different layers This table illustrates the relationship among the different layers
involved in an exchange between two protocol peers: involved in an exchange between two protocol peers:
+----------------------+ +----------------------+
| LDAP message layer | | LDAP message layer |
+----------------------+ > LDAP PDUs +----------------------+ > LDAP PDUs
+----------------------+ < data +----------------------+ < data
| SASL layer | | SASL layer |
+----------------------+ > SASL-protected data +----------------------+ > SASL-protected data
+----------------------+ < data +----------------------+ < data
| TLS layer | | TLS layer |
Application +----------------------+ > TLS-protected data Application +----------------------+ > TLS-protected data
------------+----------------------+ < data ------------+----------------------+ < data
Transport | transport connection | Transport | transport connection |
+----------------------+ +----------------------+
5.1. Protocol Encoding 5.1. Protocol Encoding
The protocol elements of LDAP SHALL be encoded for exchange using the The protocol elements of LDAP SHALL be encoded for exchange using the
Basic Encoding Rules [BER] of [ASN.1] with the following Basic Encoding Rules [BER] of [ASN.1] with the following
restrictions: restrictions:
- Only the definite form of length encoding is used. - Only the definite form of length encoding is used.
Lightweight Directory Access Protocol Version 3
- OCTET STRING values are encoded in the primitive form only. - OCTET STRING values are encoded in the primitive form only.
- If the value of a BOOLEAN type is true, the encoding of the value - If the value of a BOOLEAN type is true, the encoding of the value
octet is set to hex "FF". octet is set to hex "FF".
- If a value of a type is its default value, it is absent. Only some - If a value of a type is its default value, it is absent. Only some
BOOLEAN and INTEGER types have default values in this protocol BOOLEAN and INTEGER types have default values in this protocol
definition. definition.
These restrictions are meant to ease the overhead of encoding and These restrictions are meant to ease the overhead of encoding and
decoding certain elements in BER. decoding certain elements in BER.
These restrictions do not apply to ASN.1 types encapsulated inside of These restrictions do not apply to ASN.1 types encapsulated inside of
OCTET STRING values, such as attribute values, unless otherwise OCTET STRING values, such as attribute values, unless otherwise
stated. stated.
5.2. Transmission Control Protocol (TCP) 5.2. Transmission Control Protocol (TCP)
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 [RFC793] bytestream using the BER-based encoding described in Section
is recommended that server implementations running over the TCP 5.1. It is recommended that server implementations running over the
provide a protocol listener on the Internet Assigned Numbers TCP provide a protocol listener on the Internet Assigned Numbers
Authority (IANA)-assigned LDAP port, 389 [PortReg]. Servers may Authority (IANA)-assigned LDAP port, 389 [PortReg]. 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.
5.3. Termination of the LDAP session 5.3. Termination of the LDAP session
Termination of the LDAP session is typically initiated by the client Termination of the LDAP session is typically initiated by the client
sending an UnbindRequest (Section 4.3), or by the server sending a sending an UnbindRequest (Section 4.3), or by the server sending a
Notice of Disconnection (Section 4.4.1). In these cases each protocol Notice of Disconnection (Section 4.4.1). In these cases, each
peer gracefully terminates the LDAP session by ceasing exchanges at protocol peer gracefully terminates the LDAP session by ceasing
the LDAP message layer, tearing down any SASL layer, tearing down any exchanges at the LDAP message layer, tearing down any SASL layer,
TLS layer, and closing the transport connection. tearing down any TLS layer, and closing the transport connection.
A protocol peer may determine that the continuation of any A protocol peer may determine that the continuation of any
communication would be pernicious, and in this case may abruptly communication would be pernicious, and in this case, it may abruptly
terminate the session by ceasing communication and closing the terminate the session by ceasing communication and closing the
transport connection. transport connection.
In either case, when the LDAP session is terminated, uncompleted In either case, when the LDAP session is terminated, uncompleted
operations are handled as specified in Section 3.1. operations are handled as specified in Section 3.1.
6. Security Considerations 6. 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. Installing SASL and/or TLS layers can provide integrity [RFC4422] mechanism. Installing SASL and/or TLS layers can provide
and other data security services. integrity and other data security services.
Lightweight Directory Access Protocol Version 3
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.
Servers are encouraged to prevent directory modifications by clients Servers are encouraged to prevent directory modifications by clients
that have authenticated anonymously [AuthMeth]. that have authenticated anonymously [RFC4513].
Security considerations for authentication methods, SASL mechanisms, Security considerations for authentication methods, SASL mechanisms,
and TLS are described in [AuthMeth]. and TLS are described in [RFC4513].
It should be noted that SASL authentication exchanges do not provide Note that SASL authentication exchanges do not provide data
data confidentiality nor integrity protection for the version or name confidentiality or integrity protection for the version or name
fields of the BindRequest nor the resultCode, diagnosticMessage, or fields of the BindRequest or the resultCode, diagnosticMessage, or
referral fields of the BindResponse nor of any information contained referral fields of the BindResponse, nor for any information
in controls attached to Bind requests or responses. Thus information contained in controls attached to Bind requests or responses. Thus,
contained in these fields SHOULD NOT be relied on unless otherwise information contained in these fields SHOULD NOT be relied on unless
protected (such as by establishing protections at the transport it is otherwise protected (such as by establishing protections at the
layer). transport layer).
Implementors should note that various security factors, including Implementors should note that various security factors (including
authentication and authorization information and data security authentication and authorization information and data security
services may change during the course of the LDAP session, or even services) may change during the course of the LDAP session or even
during the performance of a particular operation. For instance, during the performance of a particular operation. For instance,
credentials could expire, authorization identities or access controls credentials could expire, authorization identities or access controls
could change, or the underlying security layer(s) could be replaced could change, or the underlying security layer(s) could be replaced
or terminated. Implementations should be robust in the handling of or terminated. Implementations should be robust in the handling of
changing security factors. changing security factors.
In some cases, it may be appropriate to continue the operation even In some cases, it may be appropriate to continue the operation even
in light of security factor changes. For instance, it may be in light of security factor changes. For instance, it may be
appropriate to continue an Abandon operation regardless of the appropriate to continue an Abandon operation regardless of the
change, or to continue an operation when the change upgraded (or change, or to continue an operation when the change upgraded (or
maintained) the security factor. In other cases, it may be maintained) the security factor. In other cases, it may be
appropriate to fail, or alter the processing of the operation. For appropriate to fail or alter the processing of the operation. For
instance, if confidential protections were removed, it would be instance, if confidential protections were removed, it would be
appropriate to either fail a request to return sensitive data, or appropriate either to fail a request to return sensitive data or,
minimally, to exclude the return of sensitive data. minimally, to exclude the return of sensitive data.
Implementations which cache attributes and entries obtained via LDAP Implementations that 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 that 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.
Lightweight Directory Access Protocol Version 3 Servers may return referrals or Search result references that
redirect clients to peer servers. It is possible for a rogue
Servers may return referrals or Search result references which
redirect clients to peer servers. It is possible for a rogue
application to inject such referrals into the data stream in an application to inject such referrals into the data stream in an
attempt to redirect a client to a rogue server. Clients are advised attempt to redirect a client to a rogue server. Clients are advised
to be aware of this, and possibly reject referrals when to be aware of this and possibly reject referrals when
confidentiality measures are not in place. Clients are advised to confidentiality measures are not in place. Clients are advised to
reject referrals from the StartTLS operation. reject referrals from the StartTLS operation.
The matchedDN and diagnosticMessage fields, as well as some The matchedDN and diagnosticMessage fields, as well as some
resultCode values (e.g., attributeOrValueExists and resultCode values (e.g., attributeOrValueExists and
entryAlreadyExists), could disclose the presence or absence of entryAlreadyExists), could disclose the presence or absence of
specific data in the directory which is subject to access and other specific data in the directory that is subject to access and other
administrative controls. Server implementations should restrict administrative controls. Server implementations should restrict
access to protected information equally under both normal and error access to protected information equally under both normal and error
conditions. conditions.
Protocol peers MUST be prepared to handle invalid and arbitrary Protocol peers MUST be prepared to handle invalid and arbitrary-
length protocol encodings. Invalid protocol encodings include: BER length protocol encodings. Invalid protocol encodings include: BER
encoding exceptions, format string and UTF-8 encoding exceptions, encoding exceptions, format string and UTF-8 encoding exceptions,
overflow exceptions, integer value exceptions, and binary mode on/off overflow exceptions, integer value exceptions, and binary mode on/off
flag exceptions. The LDAPv3 PROTOS [PROTOS-LDAP] test suite provides flag exceptions. The LDAPv3 PROTOS [PROTOS-LDAP] test suite provides
excellent examples of these exceptions and test cases used to excellent examples of these exceptions and test cases used to
discover flaws. discover flaws.
In the event that a protocol peer senses an attack which in its In the event that a protocol peer senses an attack that in its nature
nature could cause damage due to further communication at any layer could cause damage due to further communication at any layer in the
in the LDAP session, the protocol peer should abruptly terminate the LDAP session, the protocol peer should abruptly terminate the LDAP
LDAP session as described in Section 5.3. session as described in Section 5.3.
7. Acknowledgements 7. Acknowledgements
This document is based on RFC 2251 by Mark Wahl, Tim Howes, and Steve This document is based on RFC 2251 by Mark Wahl, Tim Howes, and Steve
Kille. RFC 2251 was a product of the IETF ASID Working Group. Kille. RFC 2251 was a product of the IETF ASID Working Group.
It is also based on RFC 2830 by Jeff Hodges, RL "Bob" Morgan, and It is also based on RFC 2830 by Jeff Hodges, RL "Bob" Morgan, and
Mark Wahl. RFC 2830 was a product of the IETF LDAPEXT Working Group. Mark Wahl. RFC 2830 was a product of the IETF LDAPEXT Working Group.
It is also based on RFC 3771 by Roger Harrison, and Kurt Zeilenga. It is also based on RFC 3771 by Roger Harrison and Kurt Zeilenga.
RFC 3771 was an individual submission to the IETF. RFC 3771 was an individual submission to the IETF.
This document is a product of the IETF LDAPBIS Working Group. This document is a product of the IETF LDAPBIS Working Group.
Significant contributors of technical review and content include Kurt Significant contributors of technical review and content include Kurt
Zeilenga, Steven Legg, and Hallvard Furuseth. Zeilenga, Steven Legg, and Hallvard Furuseth.
8. Normative References 8. Normative References
[ABNF] Crocker, D. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", draft-crocker-abnf-rfc2234bis-
xx.txt, (a work in progress).
Lightweight Directory Access Protocol Version 3
[ASN.1] ITU-T Recommendation X.680 (07/2002) | ISO/IEC 8824-1:2002 [ASN.1] ITU-T Recommendation X.680 (07/2002) | ISO/IEC 8824-
"Information Technology - Abstract Syntax Notation One 1:2002 "Information Technology - Abstract Syntax
(ASN.1): Specification of basic notation" Notation One (ASN.1): Specification of basic notation".
[AuthMeth] Harrison, R., "LDAP: Authentication Methods and Connection [BER] ITU-T Rec. X.690 (07/2002) | ISO/IEC 8825-1:2002,
Level Security Mechanisms", draft-ietf-ldapbis-authmeth- "Information technology - ASN.1 encoding rules:
xx.txt, (a work in progress). Specification of Basic Encoding Rules (BER), Canonical
Encoding Rules (CER) and Distinguished Encoding Rules
(DER)", 2002.
[BER] ITU-T Rec. X.690 (07/2002) | ISO/IEC 8825-1:2002, [ISO10646] Universal Multiple-Octet Coded Character Set (UCS) -
"Information technology - ASN.1 encoding rules: Architecture and Basic Multilingual Plane, ISO/IEC
Specification of Basic Encoding Rules (BER), Canonical 10646-1 : 1993.
Encoding Rules (CER) and Distinguished Encoding Rules
(DER)", 2002.
[IP] Postel, J., "Internet Protocol", STD5 and RFC 791, [RFC791] Postel, J., "Internet Protocol", STD 5, RFC 791,
September 1981 September 1981.
[ISO10646] Universal Multiple-Octet Coded Character Set (UCS) - [RFC793] Postel, J., "Transmission Control Protocol", STD 7, RFC
Architecture and Basic Multilingual Plane, ISO/IEC 10646-1 793, September 1981.
: 1993.
[Keyword] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[LDAPDN] Zeilenga, K., "LDAP: String Representation of [RFC3454] Hoffman P. and M. Blanchet, "Preparation of
Distinguished Names", draft-ietf-ldapbis-dn-xx.txt, (a Internationalized Strings ('stringprep')", RFC 3454,
work in progress). December 2002.
[LDAPIANA] Zeilenga, K., "IANA Considerations for LDAP", draft-ietf- [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
ldapbis-bcp64-xx.txt, (a work in progress). 10646", STD 63, RFC 3629, November 2003.
[LDAPURL] Smith, M., "LDAP: Uniform Resource Locator", draft-ietf- [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter,
ldapbis-url-xx.txt, (a work in progress). "Uniform Resource Identifier (URI): Generic Syntax",
STD 66, RFC 3986, January 2005.
[Models] Zeilenga, K., "LDAP: Directory Information Models", draft- [RFC4013] Zeilenga, K., "SASLprep: Stringprep Profile for User
ietf-ldapbis-models-xx.txt (a work in progress). Names and Passwords", RFC 4013, February 2005.
[Roadmap] Zeilenga, K., "LDAP: Technical Specification Road Map", [RFC4234] Crocker, D. and P. Overell, "Augmented BNF for Syntax
draft-ietf-ldapbis-roadmap-xx.txt (a work in progress). Specifications: ABNF", RFC 4234, October 2005.
[SASL] Melnikov, A., "Simple Authentication and Security Layer", [RFC4346] Dierks, T. and E. Rescorla, "The TLS Protocol Version
draft-ietf-sasl-rfc2222bis-xx.txt (a work in progress). 1.1", RFC 4346, March 2006.
[SASLPrep] Zeilenga, K., "Stringprep profile for user names and [RFC4422] Melnikov, A., Ed. and K. Zeilenga, Ed., "Simple
passwords", draft-ietf-sasl-saslprep-xx.txt, (a work in Authentication and Security Layer (SASL)", RFC 4422,
progress). June 2006.
[StringPrep] Hoffman P. and M. Blanchet, "Preparation of [RFC4510] Zeilenga, K., Ed., "Lightweight Directory Access
Internationalized Strings ('stringprep')", draft-hoffman- Protocol (LDAP): Technical Specification Road Map", RFC
rfc3454bis-xx.txt, a work in progress. 4510, June 2006.
[Syntaxes] Legg, S., and K. Dally, "LDAP: Syntaxes and Matching [RFC4512] Zeilenga, K., Lightweight Directory Access Protocol
Rules", draft-ietf-ldapbis-syntaxes-xx.txt, (a work in (LDAP): Directory Information Models", RFC 4512, June
progress). 2006.
Lightweight Directory Access Protocol Version 3 [RFC4513] Harrison, R., Ed., "Lightweight Directory Access
Protocol (LDAP): Authentication Methods and Security
Mechanisms", RFC 4513, June 2006.
[TCP] Postel, J., "Transmission Control Protocol", STD7 and RFC [RFC4514] Zeilenga, K., Ed., "Lightweight Directory Access
793, September 1981 Protocol (LDAP): String Representation of Distinguished
Names", RFC 4514, June 2006.
[TLS] Dierks, T. and C. Allen. "The TLS Protocol Version 1.1", [RFC4516] Smith, M., Ed. and T. Howes, "Lightweight Directory
draft-ietf-tls-rfc2246-bis-xx.txt, a work in progress. Access Protocol (LDAP): Uniform Resource Locator", RFC
4516, June 2006.
[Unicode] The Unicode Consortium, "The Unicode Standard, Version [RFC4517] Legg, S., Ed., "Lightweight Directory Access Protocol
3.2.0" is defined by "The Unicode Standard, Version 3.0" (LDAP): Syntaxes and Matching Rules", RFC 4517, June
(Reading, MA, Addison-Wesley, 2000. ISBN 0-201-61633-5), 2006.
as amended by the "Unicode Standard Annex #27: Unicode
3.1" (http://www.unicode.org/reports/tr27/) and by the
"Unicode Standard Annex #28: Unicode 3.2"
(http://www.unicode.org/reports/tr28/).
[URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform [RFC4520] Zeilenga, K., "Internet Assigned Numbers Authority
Resource Identifiers (URI): Generic Syntax", RFC 2396, (IANA) Considerations for the Lightweight Directory
August 1998. Access Protocol (LDAP)", BCP 64, RFC 4520, June 2006.
[UTF-8] Yergeau, F., "UTF-8, a transformation format of ISO [Unicode] The Unicode Consortium, "The Unicode Standard, Version
10646", STD63 and RFC3629, November 2003. 3.2.0" is defined by "The Unicode Standard, Version
3.0" (Reading, MA, Addison-Wesley, 2000. ISBN 0-201-
61633-5), as amended by the "Unicode Standard Annex
#27: Unicode 3.1"
(http://www.unicode.org/reports/tr27/) and by the
"Unicode Standard Annex #28: Unicode 3.2"
(http://www.unicode.org/reports/tr28/).
[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.
[X.501] ITU-T Rec. X.501, "The Directory: Models", 1993. [X.511] ITU-T Rec. X.511, "The Directory: Abstract Service
Definition", 1993.
[X.511] ITU-T Rec. X.511, "The Directory: Abstract Service 9. Informative References
Definition", 1993.
9. Informative References [CharModel] Whistler, K. and M. Davis, "Unicode Technical Report
#17, Character Encoding Model", UTR17,
<http://www.unicode.org/unicode/reports/tr17/>, August
2000.
[Glossary] The Unicode Consortium, "Unicode Glossary", [Glossary] The Unicode Consortium, "Unicode Glossary",
<http://www.unicode.org/glossary/>. <http://www.unicode.org/glossary/>.
[CharModel] Whistler, K. and M. Davis, "Unicode Technical Report [PortReg] IANA, "Port Numbers",
#17, Character Encoding Model", UTR17, <http://www.iana.org/assignments/port-numbers>.
<http://www.unicode.org/unicode/reports/tr17/>, August
2000.
[PROTOS-LDAP] University of Oulu, "PROTOS Test-Suite: c06-ldapv3" [PROTOS-LDAP] University of Oulu, "PROTOS Test-Suite: c06-ldapv3"
<http://www.ee.oulu.fi/research/ouspg/protos/testing/c06/l <http://www.ee.oulu.fi/research/ouspg/protos/testing/
dapv3/> c06/ldapv3/>.
[PortReg] IANA, "Port Numbers",
http://www.iana.org/assignments/port-numbers
10. IANA Considerations 10. IANA Considerations
Lightweight Directory Access Protocol Version 3
It is requested that the Internet Assigned Numbers Authority (IANA) The Internet Assigned Numbers Authority (IANA) has updated the LDAP
update the LDAP result code registry to indicate that this document result code registry to indicate that this document provides the
provides the definitive technical specification for result codes 0- definitive technical specification for result codes 0-36, 48-54, 64-
36, 48-54, 64-70, 80-90. It is also noted that one resultCode value 70, 80-90. It is also noted that one resultCode value
(strongAuthRequired) has been renamed (to strongerAuthRequired). (strongAuthRequired) has been renamed (to strongerAuthRequired).
It is requested that the IANA update the LDAP Protocol Mechanism The IANA has also updated the LDAP Protocol Mechanism registry to
registry to indicate that this document and [AuthMeth] provides the indicate that this document and [RFC4513] provides the definitive
definitive technical specification for the StartTLS technical specification for the StartTLS (1.3.6.1.4.1.1466.20037)
(1.3.6.1.4.1.1466.20037) Extended operation. Extended operation.
It is requested that the IANA update the occurrence of "RFC XXXX" in
this section and Appendix B with this RFC number at publication.
It is requested that IANA assign upon Standards Action an LDAP Object IANA has assigned LDAP Object Identifier 18 [RFC4520] to identify the
Identifier [LDAPIANA] to identify the ASN.1 module defined in this ASN.1 module defined in this document.
document.
Subject: Request for LDAP Object Identifier Registration Subject: Request for LDAP Object Identifier Registration
Person & email address to contact for further information: Person & email address to contact for further information:
Jim Sermersheim <jimse@novell.com> Jim Sermersheim <jimse@novell.com>
Specification: RFC XXXX Specification: RFC 4511
Author/Change Controller: IESG Author/Change Controller: IESG
Comments: Comments:
Identifies the LDAP ASN.1 module Identifies the LDAP ASN.1 module
[[Note to RFC Editor: please replace the occurrence of <IANA- Appendix A. LDAP Result Codes
ASSIGNED-DIRECTORY-NUMBER> in Appendix B with the IANA assigned
OID.]]
11. Editor's Address
Jim Sermersheim
Novell, Inc.
1800 South Novell Place
Provo, Utah 84606, USA
jimse@novell.com
+1 801 861-3088
Lightweight Directory Access Protocol Version 3
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.9. LDAP result code enumerated in Section 4.1.9.
Additional result codes MAY be defined for use with extensions Additional result codes MAY be defined for use with extensions
[LDAPIANA]. Client implementations SHALL treat any result code which [RFC4520]. Client implementations SHALL treat any result code that
they do not recognize as an unknown error condition. they do not recognize as an unknown error condition.
The descriptions provided here do not fully account for result code The descriptions provided here do not fully account for result code
substitutions used to prevent unauthorized disclosures (such as substitutions used to prevent unauthorized disclosures (such as
substitution of noSuchObject for insufficientAccessRights, or substitution of noSuchObject for insufficientAccessRights, or
invalidCredentials for insufficientAccessRights). invalidCredentials for insufficientAccessRights).
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),
compareFalse (5), compareFalse (5),
compareTrue (6), compareTrue (6),
referral (10), and referral (10), and
saslBindInProgress (14). saslBindInProgress (14).
The success, compareTrue, and compareFalse result codes indicate The success, compareTrue, and compareFalse result codes indicate
successful completion (and, hence, are referred to as "successful" successful completion (and, hence, are referred to as "successful"
result codes). result codes).
skipping to change at page 46, line 38 skipping to change at page 49, line 38
referral (10), and referral (10), and
saslBindInProgress (14). saslBindInProgress (14).
The success, compareTrue, and compareFalse result codes indicate The success, compareTrue, and compareFalse result codes indicate
successful completion (and, hence, are referred 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
needs to take additional action to complete the operation. needs 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. Note: Indicates the successful completion of an operation. Note:
this code is not used with the Compare operation. See this code is not used with the Compare operation. See
compareFalse (5) and compareTrue (6). compareFalse (5) and compareTrue (6).
operationsError (1)
Indicates that the operation is not properly sequenced with
relation to other operations (of same or different type).
For example, this code is returned if the client attempts to
StartTLS [TLS] while there are other uncompleted operations
or if a TLS layer was already installed.
protocolError (2)
Indicates the server received data which is not well-formed.
Lightweight Directory Access Protocol Version 3
For Bind operation only, this code is also used to indicate
that the server does not support the requested protocol
version.
For Extended operations only, this code is also used to operationsError (1)
indicate that the server does not support (by design or Indicates that the operation is not properly sequenced with
configuration) the Extended operation associated with the relation to other operations (of same or different type).
requestName.
For request operations specifying multiple controls, this may For example, this code is returned if the client attempts to
be used to indicate that the server cannot ignore the order StartTLS [RFC4346] while there are other uncompleted operations
of the controls as specified, or that the combination of the or if a TLS layer was already installed.
specified controls is invalid or unspecified.
timeLimitExceeded (3) protocolError (2)
Indicates that the time limit specified by the client was Indicates the server received data that is not well-formed.
exceeded before the operation could be completed.
sizeLimitExceeded (4) For Bind operation only, this code is also used to indicate
Indicates that the size limit specified by the client was that the server does not support the requested protocol
exceeded before the operation could be completed. version.
compareFalse (5) For Extended operations only, this code is also used to
Indicates that the Compare operation has successfully indicate that the server does not support (by design or
completed and the assertion has evaluated to FALSE or configuration) the Extended operation associated with the
Undefined. requestName.
compareTrue (6) For request operations specifying multiple controls, this may
Indicates that the Compare operation has successfully be used to indicate that the server cannot ignore the order
completed and the assertion has evaluated to TRUE. of the controls as specified, or that the combination of the
specified controls is invalid or unspecified.
authMethodNotSupported (7) timeLimitExceeded (3)
Indicates that the authentication method or mechanism is not Indicates that the time limit specified by the client was
supported. exceeded before the operation could be completed.
strongerAuthRequired (8) sizeLimitExceeded (4)
Indicates the server requires strong(er) authentication in Indicates that the size limit specified by the client was
order to complete the operation. exceeded before the operation could be completed.
When used with the Notice of Disconnection operation, this compareFalse (5)
code indicates that the server has detected that an Indicates that the Compare operation has successfully
established security association between the client and completed and the assertion has evaluated to FALSE or
server has unexpectedly failed or been compromised. Undefined.
referral (10) compareTrue (6)
Indicates that a referral needs to be chased to complete the Indicates that the Compare operation has successfully
operation (see Section 4.1.10). completed and the assertion has evaluated to TRUE.
adminLimitExceeded (11) authMethodNotSupported (7)
Indicates that an administrative limit has been exceeded. Indicates that the authentication method or mechanism is not
supported.
unavailableCriticalExtension (12) strongerAuthRequired (8)
Indicates a critical control is unrecognized (see Section Indicates the server requires strong(er) authentication in
4.1.11). order to complete the operation.
Lightweight Directory Access Protocol Version 3 When used with the Notice of Disconnection operation, this
code indicates that the server has detected that an
established security association between the client and
server has unexpectedly failed or been compromised.
confidentialityRequired (13) referral (10)
Indicates that data confidentiality protections are required. Indicates that a referral needs to be chased to complete the
operation (see Section 4.1.10).
saslBindInProgress (14) adminLimitExceeded (11)
Indicates the server requires the client to send a new bind Indicates that an administrative limit has been exceeded.
request, with the same SASL mechanism, to continue the
authentication process (see Section 4.2).
noSuchAttribute (16) unavailableCriticalExtension (12)
Indicates that the named entry does not contain the specified Indicates a critical control is unrecognized (see Section
attribute or attribute value. 4.1.11).
undefinedAttributeType (17) confidentialityRequired (13)
Indicates that a request field contains an unrecognized Indicates that data confidentiality protections are required.
attribute description.
inappropriateMatching (18) saslBindInProgress (14)
Indicates that an attempt was made (e.g. in an assertion) to Indicates the server requires the client to send a new bind
use a matching rule not defined for the attribute type request, with the same SASL mechanism, to continue the
concerned. authentication process (see Section 4.2).
constraintViolation (19) noSuchAttribute (16)
Indicates that the client supplied an attribute value which Indicates that the named entry does not contain the specified
does not conform to the constraints placed upon it by the attribute or attribute value.
data model.
For example, this code is returned when multiple values are undefinedAttributeType (17)
supplied to an attribute which has a SINGLE-VALUE constraint. Indicates that a request field contains an unrecognized
attribute description.
attributeOrValueExists (20) inappropriateMatching (18)
Indicates that the client supplied an attribute or value to Indicates that an attempt was made (e.g., in an assertion) to
be added to an entry, but the attribute or value already use a matching rule not defined for the attribute type
exists. concerned.
invalidAttributeSyntax (21) constraintViolation (19)
Indicates that a purported attribute value does not conform Indicates that the client supplied an attribute value that
to the syntax of the attribute. does not conform to the constraints placed upon it by the
data model.
noSuchObject (32) For example, this code is returned when multiple values are
Indicates that the object does not exist in the DIT. supplied to an attribute that has a SINGLE-VALUE constraint.
aliasProblem (33) attributeOrValueExists (20)
Indicates that an alias problem has occurred. For example, Indicates that the client supplied an attribute or value to
the code may used to indicate an alias has been dereferenced be added to an entry, but the attribute or value already
which names no object. exists.
invalidDNSyntax (34) invalidAttributeSyntax (21)
Indicates that an LDAPDN or RelativeLDAPDN field (e.g. search Indicates that a purported attribute value does not conform
base, target entry, ModifyDN newrdn, etc.) of a request does to the syntax of the attribute.
not conform to the required syntax or contains attribute
values which do not conform to the syntax of the attribute's
type.
Lightweight Directory Access Protocol Version 3 noSuchObject (32)
Indicates that the object does not exist in the DIT.
aliasDereferencingProblem (36) aliasProblem (33)
Indicates that a problem occurred while dereferencing an Indicates that an alias problem has occurred. For example,
alias. Typically an alias was encountered in a situation the code may used to indicate an alias has been dereferenced
where it was not allowed or where access was denied. that names no object.
inappropriateAuthentication (48) invalidDNSyntax (34)
Indicates the server requires the client which had attempted Indicates that an LDAPDN or RelativeLDAPDN field (e.g., search
to bind anonymously or without supplying credentials to base, target entry, ModifyDN newrdn, etc.) of a request does
provide some form of credentials. not conform to the required syntax or contains attribute
values that do not conform to the syntax of the attribute's
type.
invalidCredentials (49) aliasDereferencingProblem (36)
Indicates that the provided credentials (e.g. the user's name Indicates that a problem occurred while dereferencing an
and password) are invalid. alias. Typically, an alias was encountered in a situation
where it was not allowed or where access was denied.
insufficientAccessRights (50) inappropriateAuthentication (48)
Indicates that the client does not have sufficient access Indicates the server requires the client that had attempted
rights to perform the operation. to bind anonymously or without supplying credentials to
provide some form of credentials.
busy (51) invalidCredentials (49)
Indicates that the server is too busy to service the Indicates that the provided credentials (e.g., the user's name
operation. and password) are invalid.
unavailable (52) insufficientAccessRights (50)
Indicates that the server is shutting down or a subsystem Indicates that the client does not have sufficient access
necessary to complete the operation is offline. rights to perform the operation.
unwillingToPerform (53) busy (51)
Indicates that the server is unwilling to perform the Indicates that the server is too busy to service the
operation. operation.
loopDetect (54) unavailable (52)
Indicates that the server has detected an internal loop (e.g. Indicates that the server is shutting down or a subsystem
while dereferencing aliases or chaining an operation). necessary to complete the operation is offline.
namingViolation (64) unwillingToPerform (53)
Indicates that the entry's name violates naming restrictions. Indicates that the server is unwilling to perform the
operation.
objectClassViolation (65) loopDetect (54)
Indicates that the entry violates object class restrictions. Indicates that the server has detected an internal loop (e.g.,
while dereferencing aliases or chaining an operation).
notAllowedOnNonLeaf (66) namingViolation (64)
Indicates that the operation is inappropriately acting upon a Indicates that the entry's name violates naming restrictions.
non-leaf entry.
notAllowedOnRDN (67) objectClassViolation (65)
Indicates that the operation is inappropriately attempting to Indicates that the entry violates object class restrictions.
remove a value which forms the entry's relative distinguished
name.
entryAlreadyExists (68) notAllowedOnNonLeaf (66)
Indicates that the request cannot be fulfilled (added, moved, Indicates that the operation is inappropriately acting upon a
or renamed) as the target entry already exists. non-leaf entry.
Lightweight Directory Access Protocol Version 3 notAllowedOnRDN (67)
Indicates that the operation is inappropriately attempting to
remove a value that forms the entry's relative distinguished
name.
objectClassModsProhibited (69) entryAlreadyExists (68)
Indicates that an attempt to modify the object class(es) of Indicates that the request cannot be fulfilled (added, moved,
an entry's 'objectClass' attribute is prohibited. or renamed) as the target entry already exists.
For example, this code is returned when a client attempts to objectClassModsProhibited (69)
modify the structural object class of an entry. Indicates that an attempt to modify the object class(es) of
an entry's 'objectClass' attribute is prohibited.
affectsMultipleDSAs (71) For example, this code is returned when a client attempts to
Indicates that the operation cannot be performed as it would modify the structural object class of an entry.
affect multiple servers (DSAs).
other (80) affectsMultipleDSAs (71)
Indicates the server has encountered an internal error. Indicates that the operation cannot be performed as it would
affect multiple servers (DSAs).
Lightweight Directory Access Protocol Version 3 other (80)
Indicates the server has encountered an internal error.
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 {1 3 6 1 1 <IANA- Lightweight-Directory-Access-Protocol-V3 {1 3 6 1 1 18}
ASSIGNED-DIRECTORY-NUMBER>} -- Copyright (C) The Internet Society (2006). This version of
-- Copyright (C) The Internet Society (2005). This version of -- this ASN.1 module is part of RFC 4511; 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.
DEFINITIONS DEFINITIONS
IMPLICIT TAGS IMPLICIT TAGS
EXTENSIBILITY IMPLIED ::= EXTENSIBILITY IMPLIED ::=
BEGIN BEGIN
LDAPMessage ::= SEQUENCE { LDAPMessage ::= SEQUENCE {
messageID MessageID, messageID MessageID,
protocolOp CHOICE { protocolOp CHOICE {
skipping to change at page 51, line 49 skipping to change at page 54, line 46
modDNResponse ModifyDNResponse, modDNResponse ModifyDNResponse,
compareRequest CompareRequest, compareRequest CompareRequest,
compareResponse CompareResponse, compareResponse CompareResponse,
abandonRequest AbandonRequest, abandonRequest AbandonRequest,
extendedReq ExtendedRequest, extendedReq ExtendedRequest,
extendedResp ExtendedResponse, extendedResp ExtendedResponse,
..., ...,
intermediateResponse IntermediateResponse }, intermediateResponse IntermediateResponse },
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>
-- [RFC4512]
LDAPDN ::= LDAPString -- Constrained to <distinguishedName> LDAPDN ::= LDAPString -- Constrained to <distinguishedName>
-- [LDAPDN] -- [RFC4514]
Lightweight Directory Access Protocol Version 3
RelativeLDAPDN ::= LDAPString -- Constrained to <name-component> RelativeLDAPDN ::= LDAPString -- Constrained to <name-component>
-- [LDAPDN] -- [RFC4514]
AttributeDescription ::= LDAPString AttributeDescription ::= LDAPString
-- Constrained to <attributedescription> -- Constrained to <attributedescription>
-- [Models] -- [RFC4512]
AttributeValue ::= OCTET STRING AttributeValue ::= OCTET STRING
AttributeValueAssertion ::= SEQUENCE { AttributeValueAssertion ::= SEQUENCE {
attributeDesc AttributeDescription, attributeDesc AttributeDescription,
assertionValue AssertionValue } assertionValue AssertionValue }
AssertionValue ::= OCTET STRING AssertionValue ::= OCTET STRING
PartialAttribute ::= SEQUENCE { PartialAttribute ::= SEQUENCE {
type AttributeDescription, type AttributeDescription,
vals SET OF value AttributeValue } vals SET OF value AttributeValue }
Attribute ::= PartialAttribute(WITH COMPONENTS { Attribute ::= PartialAttribute(WITH COMPONENTS {
..., ...,
vals (SIZE(1..MAX))}) vals (SIZE(1..MAX))})
MatchingRuleId ::= LDAPString MatchingRuleId ::= LDAPString
Lightweight Directory Access Protocol Version 3
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),
compareFalse (5), compareFalse (5),
compareTrue (6), compareTrue (6),
skipping to change at page 53, line 54 skipping to change at page 56, line 35
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),
... }, ... },
matchedDN LDAPDN, matchedDN LDAPDN,
diagnosticMessage LDAPString, diagnosticMessage LDAPString,
referral [3] Referral OPTIONAL } referral [3] Referral OPTIONAL }
Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI
Lightweight Directory Access Protocol Version 3
URI ::= LDAPString -- limited to characters permitted in URI ::= LDAPString -- limited to characters permitted in
-- URIs -- URIs
Controls ::= SEQUENCE OF control 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 }
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,
... } ... }
SaslCredentials ::= SEQUENCE { SaslCredentials ::= SEQUENCE {
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 {
baseObject LDAPDN, baseObject LDAPDN,
scope ENUMERATED { scope ENUMERATED {
baseObject (0), baseObject (0),
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 selector LDAPString AttributeSelection ::= SEQUENCE OF selector LDAPString
-- The LDAPString is constrained to -- The LDAPString is constrained to
-- <attributeSelector> in Section 4.5.1.7 -- <attributeSelector> in Section 4.5.1.8
Lightweight Directory Access Protocol Version 3
Filter ::= CHOICE { Filter ::= CHOICE {
and [0] SET SIZE (1..MAX) OF filter Filter, and [0] SET SIZE (1..MAX) OF filter Filter,
or [1] SET SIZE (1..MAX) OF filter 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,
substrings SEQUENCE SIZE (1..MAX) OF substring CHOICE { substrings SEQUENCE SIZE (1..MAX) OF substring CHOICE {
initial [0] AssertionValue, -- can occur at most once initial [0] AssertionValue, -- can occur at most once
any [1] AssertionValue, any [1] AssertionValue,
final [2] AssertionValue } -- can occur at most once final [2] AssertionValue } -- can occur at most once
} }
MatchingRuleAssertion ::= SEQUENCE { MatchingRuleAssertion ::= SEQUENCE {
skipping to change at page 55, line 52 skipping to change at page 58, line 45
SearchResultDone ::= [APPLICATION 5] LDAPResult SearchResultDone ::= [APPLICATION 5] LDAPResult
ModifyRequest ::= [APPLICATION 6] SEQUENCE { ModifyRequest ::= [APPLICATION 6] SEQUENCE {
object LDAPDN, object LDAPDN,
changes SEQUENCE OF change SEQUENCE { changes SEQUENCE OF change SEQUENCE {
operation ENUMERATED { operation ENUMERATED {
add (0), add (0),
delete (1), delete (1),
replace (2), replace (2),
... }, ... },
modification PartialAttribute } } 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 }
Lightweight Directory Access Protocol Version 3
AttributeList ::= SEQUENCE OF attribute Attribute AttributeList ::= SEQUENCE OF attribute Attribute
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 {
skipping to change at page 57, line 4 skipping to change at page 60, line 4
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 }
IntermediateResponse ::= [APPLICATION 25] SEQUENCE { IntermediateResponse ::= [APPLICATION 25] SEQUENCE {
responseName [0] LDAPOID OPTIONAL, responseName [0] LDAPOID OPTIONAL,
responseValue [1] OCTET STRING OPTIONAL } responseValue [1] OCTET STRING OPTIONAL }
END END
Lightweight Directory Access Protocol Version 3
Appendix C. Changes Appendix C. Changes
This appendix is non-normative. This appendix is non-normative.
This appendix summarizes substantive changes made to RFC 2251, RFC This appendix summarizes substantive changes made to RFC 2251, RFC
2830, and RFC 3771. 2830, and RFC 3771.
C.1. Changes made to RFC 2251: C.1. Changes Made to RFC 2251
This section summarizes the substantive changes made to Sections 1, This section summarizes the substantive changes made to Sections 1,
2, 3.1, and 4 through the remainder of RFC 2251. Readers should 2, 3.1, and 4, and the remainder of RFC 2251. Readers should
consult [Models] and [AuthMeth] for summaries of changes to other consult [RFC4512] and [RFC4513] for summaries of changes to other
sections. sections.
C.1.1. Section 1 (Status of this Memo) C.1.1. Section 1 (Status of this Memo)
- Removed IESG note. Post publication of RFC 2251, mandatory LDAP - Removed IESG note. Post publication of RFC 2251, mandatory LDAP
authentication mechanisms have been standardized which are authentication mechanisms have been standardized which are
sufficient to remove this note. See [AuthMeth] for authentication sufficient to remove this note. See [RFC4513] for authentication
mechanisms. mechanisms.
C.1.2. Section 3.1 (Protocol Model) and others C.1.2. Section 3.1 (Protocol Model) and others
- Removed notes giving history between LDAP v1, v2 and v3. Instead, - Removed notes giving history between LDAP v1, v2, and v3. Instead,
added sufficient language so that this document can stand on its added sufficient language so that this document can stand on its
own. own.
C.1.3. Section 4 (Elements of Protocol) C.1.3. Section 4 (Elements of Protocol)
- Clarified where the extensibility features of ASN.1 apply to the - Clarified where the extensibility features of ASN.1 apply to the
protocol. This change affected various ASN.1 types by the protocol. This change affected various ASN.1 types by the
inclusion of ellipses (...) to certain elements. inclusion of ellipses (...) to certain elements.
- Removed the requirement that servers which implement version 3 or - Removed the requirement that servers that implement version 3 or
later MUST provide the 'supportedLDAPVersion' attribute. This later MUST provide the 'supportedLDAPVersion' attribute. This
statement provided no interoperability advantages. statement provided no interoperability advantages.
C.1.4. Section 4.1.1 (Message Envelope) C.1.4. Section 4.1.1 (Message Envelope)
- There was a mandatory requirement for the server to return a - There was a mandatory requirement for the server to return a
Notice of Disconnection and drop the transport connection when a Notice of Disconnection and drop the transport connection when a
PDU is malformed in a certain way. This has been updated such that PDU is malformed in a certain way. This has been updated such that
the server SHOULD return the Notice of Disconnection, and MUST the server SHOULD return the Notice of Disconnection, and it MUST
terminate the LDAP Session. terminate the LDAP Session.
C.1.5. Section 4.1.1.1 (Message ID) C.1.5. Section 4.1.1.1 (Message ID)
- Required that the messageID of requests MUST be non-zero as the - Required that the messageID of requests MUST be non-zero as the
zero is reserved for Notice of Disconnection. zero is reserved for Notice of Disconnection.
Lightweight Directory Access Protocol Version 3
- Specified when it is and isn't appropriate to return an already - Specified when it is and isn't appropriate to return an already
used message id. RFC 2251 accidentally imposed synchronous server used messageID. RFC 2251 accidentally imposed synchronous server
behavior in its wording of this. behavior in its wording of this.
C.1.6. Section 4.1.2 (String Types) C.1.6. Section 4.1.2 (String Types)
- Stated that LDAPOID is constrained to <numericoid> from [Models]. - Stated that LDAPOID is constrained to <numericoid> from [RFC4512].
C.1.7. Section 4.1.5.1 (Binary Option) and others C.1.7. Section 4.1.5.1 (Binary Option) and others
- Removed the Binary Option from the specification. There are - Removed the Binary Option from the specification. There are
numerous interoperability problems associated with this method of numerous interoperability problems associated with this method of
alternate attribute type encoding. Work to specify a suitable alternate attribute type encoding. Work to specify a suitable
replacement is ongoing. replacement is ongoing.
C.1.8. Section 4.1.8 (Attribute) C.1.8. Section 4.1.8 (Attribute)
- Combined the definitions of PartialAttribute and Attribute here, - Combined the definitions of PartialAttribute and Attribute here,
and defined Attribute in terms of PartialAttribute. and defined Attribute in terms of PartialAttribute.
C.1.9. Section 4.1.10 (Result Message) C.1.9. Section 4.1.10 (Result Message)
- Renamed "errorMessage" to "diagnosticMessage" as it is allowed to - Renamed "errorMessage" to "diagnosticMessage" as it is allowed to
be sent for non-error results. be sent for non-error results.
- Moved some language into Appendix A, and refer the reader there. - Moved some language into Appendix A, and referred the reader there.
- Allowed matchedDN to be present for other result codes than those - Allowed matchedDN to be present for other result codes than those
listed in RFC 2251. listed in RFC 2251.
- renamed the code "strongAuthRequired" to "strongerAuthRequired" to - Renamed the code "strongAuthRequired" to "strongerAuthRequired" to
clarify that this code may often be returned to indicate that a clarify that this code may often be returned to indicate that a
stronger authentication is needed to perform a given operation. stronger authentication is needed to perform a given operation.
C.1.10. Section 4.1.11 (Referral) C.1.10. Section 4.1.11 (Referral)
- Defined referrals in terms of URIs rather than URLs. - Defined referrals in terms of URIs rather than URLs.
- Removed the requirement that all referral URIs MUST be equally - Removed the requirement that all referral URIs MUST be equally
capable of progressing the operation. The statement was ambiguous capable of progressing the operation. The statement was ambiguous
and provided no instructions on how to carry it out. and provided no instructions on how to carry it out.
- Added the requirement that clients MUST NOT loop between servers. - Added the requirement that clients MUST NOT loop between servers.
- Clarified the instructions for using LDAPURLs in referrals, and in - Clarified the instructions for using LDAPURLs in referrals, and in
doing so added a recommendation that the scope part be present. doing so added a recommendation that the scope part be present.
- Removed imperatives which required clients to use URLs in specific - Removed imperatives which required clients to use URLs in specific
ways to progress an operation. These did nothing for ways to progress an operation. These did nothing for
interoperability. interoperability.
C.1.11. Section 4.1.12 (Controls) C.1.11. Section 4.1.12 (Controls)
- Specified how control values defined in terms of ASN.1 are to be - Specified how control values defined in terms of ASN.1 are to be
encoded. encoded.
Lightweight Directory Access Protocol Version 3
- Noted that the criticality field is only applied to request - Noted that the criticality field is only applied to request
messages (except UnbindRequest), and must be ignored when present messages (except UnbindRequest), and must be ignored when present
on response messages and UnbindRequest. on response messages and UnbindRequest.
- Specified that non-critical controls may be ignored at the - Specified that non-critical controls may be ignored at the
server's discretion. There was confusion in the original wording server's discretion. There was confusion in the original wording
which led some to believe that recognized controls may not be which led some to believe that recognized controls may not be
ignored as long as they were associated with a proper request. ignored as long as they were associated with a proper request.
- Added language regarding combinations of controls and the ordering - Added language regarding combinations of controls and the ordering
of controls on a message. of controls on a message.
- Specified that when the semantics of the combination of controls - Specified that when the semantics of the combination of controls
is undefined or unknown, it results in a protocolError. is undefined or unknown, it results in a protocolError.
- Changed "The server MUST be prepared" to "Implementations MUST be - Changed "The server MUST be prepared" to "Implementations MUST be
prepared" in the eighth paragraph to reflect that both client and prepared" in paragraph 8 to reflect that both client and server
server implementations must be able to handle this (as both parse implementations must be able to handle this (as both parse
controls). controls).
C.1.12. Section 4.2 (Bind Operation) C.1.12. Section 4.2 (Bind Operation)
- Mandated that servers return protocolError when the version is not - Mandated that servers return protocolError when the version is not
supported. supported.
- Disambiguated behavior when the simple authentication is used, the - Disambiguated behavior when the simple authentication is used, the
name is empty and the password is non-empty. name is empty, and the password is non-empty.
- Required servers to not dereference aliases for Bind. This was - Required servers to not dereference aliases for Bind. This was
added for consistency with other operations and to help ensure added for consistency with other operations and to help ensure
data consistency. data consistency.
- Required that textual passwords be transferred as UTF-8 encoded - Required that textual passwords be transferred as UTF-8 encoded
Unicode, and added recommendations on string preparation. This was Unicode, and added recommendations on string preparation. This was
to help ensure interoperability of passwords being sent from to help ensure interoperability of passwords being sent from
different clients. different clients.
C.1.13. Section 4.2.1 (Sequencing of the Bind Request) C.1.13. Section 4.2.1 (Sequencing of the Bind Request)
- This section was largely reorganized for readability and language - This section was largely reorganized for readability, and language
was added to clarify the authentication state of failed and was added to clarify the authentication state of failed and
abandoned Bind operations. abandoned Bind operations.
- Removed: "If a SASL transfer encryption or integrity mechanism has - Removed: "If a SASL transfer encryption or integrity mechanism has
been negotiated, that mechanism does not support the changing of been negotiated, that mechanism does not support the changing of
credentials from one identity to another, then the client MUST credentials from one identity to another, then the client MUST
instead establish a new connection." instead establish a new connection."
If there are dependencies between multiple negotiations of a If there are dependencies between multiple negotiations of a
particular SASL mechanism, the technical specification for that particular SASL mechanism, the technical specification for that
SASL mechanism details how applications are to deal with them. SASL mechanism details how applications are to deal with them.
LDAP should not require any special handling. LDAP should not require any special handling.
- Dropped MUST imperative in paragraph 3 to align with [Keywords]. - Dropped MUST imperative in paragraph 3 to align with [RFC2119].
- Mandated that clients not send non-Bind operations while a Bind is - Mandated that clients not send non-Bind operations while a Bind is
in progress, and suggested that servers not process them if they in progress, and suggested that servers not process them if they
are received. This is needed to ensure proper sequencing of the are received. This is needed to ensure proper sequencing of the
Bind in relationship to other operations. Bind in relationship to other operations.
Lightweight Directory Access Protocol Version 3 C.1.14. Section 4.2.3 (Bind Response)
C.1.14. Section 4.2.3 (Bind Response)
- Moved most error-related text to Appendix A, and added text - Moved most error-related text to Appendix A, and added text
regarding certain errors used in conjunction with the Bind regarding certain errors used in conjunction with the Bind
operation. operation.
- Prohibited the server from specifying serverSaslCreds when not - Prohibited the server from specifying serverSaslCreds when not
appropriate. appropriate.
C.1.15. Section 4.3 (Unbind Operation) C.1.15. Section 4.3 (Unbind Operation)
- Specified that both peers are to cease transmission and terminate - Specified that both peers are to cease transmission and terminate
the LDAP session for the Unbind operation. the LDAP session for the Unbind operation.
C.1.16. Section 4.4 (Unsolicited Notification) C.1.16. Section 4.4 (Unsolicited Notification)
- Added instructions for future specifications of Unsolicited - Added instructions for future specifications of Unsolicited
Notifications. Notifications.
C.1.17. Section 4.5.1 (Search Request) C.1.17. Section 4.5.1 (Search Request)
- SearchRequest attributes is now defined as an AttributeSelection - SearchRequest attributes is now defined as an AttributeSelection
type rather than AttributeDescriptionList, and an ABNF is type rather than AttributeDescriptionList, and an ABNF is
provided. provided.
- SearchRequest attributes may contain duplicate attribute - SearchRequest attributes may contain duplicate attribute
descriptions. This was previously prohibited. Now servers are descriptions. This was previously prohibited. Now servers are
instructed to ignore subsequent names when they are duplicated. instructed to ignore subsequent names when they are duplicated.
This was relaxed in order to allow different short names and also This was relaxed in order to allow different short names and also
OIDs to be requested for an attribute. OIDs to be requested for an attribute.
- The present search filter now evaluates to Undefined when the - The present search filter now evaluates to Undefined when the
specified attribute is not known to the server. It used to specified attribute is not known to the server. It used to
evaluate to FALSE, which caused behavior inconsistent with what evaluate to FALSE, which caused behavior inconsistent with what
most would expect, especially when the not operator was used. most would expect, especially when the 'not' operator was used.
- The Filter choice SubstringFilter substrings type is now defined - The Filter choice SubstringFilter substrings type is now defined
with a lower bound of 1. with a lower bound of 1.
- The SubstringFilter substrings 'initial, 'any', and 'final' types - The SubstringFilter substrings 'initial, 'any', and 'final' types
are now AssertionValue rather than LDAPString. Also, added are now AssertionValue rather than LDAPString. Also, added
imperatives stating that 'initial' (if present) must be listed imperatives stating that 'initial' (if present) must be listed
first, and 'final' (if present) must be listed last. first, and 'final' (if present) must be listed last.
- Disambiguated the semantics of the derefAliases choices. There was - Disambiguated the semantics of the derefAliases choices. There was
question as to whether derefInSearching applied to the base object question as to whether derefInSearching applied to the base object
in a wholeSubtree Search. in a wholeSubtree Search.
- Added instructions for equalityMatch, substrings, greaterOrEqual, - Added instructions for equalityMatch, substrings, greaterOrEqual,
lessOrEqual, and approxMatch. lessOrEqual, and approxMatch.
C.1.18. Section 4.5.2 (Search Result) C.1.18. Section 4.5.2 (Search Result)
- Recommended that servers not use attribute short names when it - Recommended that servers not use attribute short names when it
knows they are ambiguous or may cause interoperability problems. knows they are ambiguous or may cause interoperability problems.
- Removed all mention of ExtendedResponse due to lack of - Removed all mention of ExtendedResponse due to lack of
implementation. implementation.
Lightweight Directory Access Protocol Version 3 C.1.19. Section 4.5.3 (Continuation References in the Search Result)
C.1.19. Section 4.5.3 (Continuation References in the Search Result)
- Made changes similar to those made to Section 4.1.11. - Made changes similar to those made to Section 4.1.11.
C.1.20. Section 4.5.3.1 (Example) C.1.20. Section 4.5.3.1 (Example)
- Fixed examples to adhere to changes made to Section 4.5.3. - Fixed examples to adhere to changes made to Section 4.5.3.
C.1.21. Section 4.6 (Modify Operation) C.1.21. Section 4.6 (Modify Operation)
- Replaced AttributeTypeAndValues with Attribute as they are - Replaced AttributeTypeAndValues with Attribute as they are
equivalent. equivalent.
- Specified the types of modification changes which might - Specified the types of modification changes that might
temporarily violate schema. Some readers were under the impression temporarily violate schema. Some readers were under the impression
that any temporary schema violation was allowed. that any temporary schema violation was allowed.
C.1.22. Section 4.7 (Add Operation) C.1.22. Section 4.7 (Add Operation)
- Aligned Add operation with X.511 in that the attributes of the RDN - Aligned Add operation with X.511 in that the attributes of the RDN
are used in conjunction with the listed attributes to create the are used in conjunction with the listed attributes to create the
entry. Previously, Add required that the distinguished values be entry. Previously, Add required that the distinguished values be
present in the listed attributes. present in the listed attributes.
- Removed requirement that the objectClass attribute MUST be - Removed requirement that the objectClass attribute MUST be
specified as some DSE types do not require this attribute. specified as some DSE types do not require this attribute.
Instead, generic wording was added, requiring the added entry to Instead, generic wording was added, requiring the added entry to
adhere to the data model. adhere to the data model.
- Removed recommendation regarding placement of objects. This is - Removed recommendation regarding placement of objects. This is
covered in the data model document. covered in the data model document.
C.1.23. Section 4.9 (Modify DN Operation) C.1.23. Section 4.9 (Modify DN Operation)
- Required servers to not dereference aliases for Modify DN. This - Required servers to not dereference aliases for Modify DN. This
was added for consistency with other operations and to help ensure was added for consistency with other operations and to help ensure
data consistency. data consistency.
- Allow Modify DN to fail when moving between naming contexts. - Allow Modify DN to fail when moving between naming contexts.
- Specified what happens when the attributes of the newrdn are not - Specified what happens when the attributes of the newrdn are not
present on the entry. present on the entry.
C.1.24. Section 4.10 (Compare Operation) C.1.24. Section 4.10 (Compare Operation)
- Specified that compareFalse means that the Compare took place and - Specified that compareFalse means that the Compare took place and
the result is false. There was confusion which lead people to the result is false. There was confusion that led people to
believe that an Undefined match resulted in compareFalse. believe that an Undefined match resulted in compareFalse.
- Required servers to not dereference aliases for Compare. This was - Required servers to not dereference aliases for Compare. This was
added for consistency with other operations and to help ensure added for consistency with other operations and to help ensure
data consistency. data consistency.
Lightweight Directory Access Protocol Version 3 C.1.25. Section 4.11 (Abandon Operation)
C.1.25. Section 4.11 (Abandon Operation)
- Explained that since Abandon returns no response, clients should - Explained that since Abandon returns no response, clients should
not use it if they need to know the outcome. not use it if they need to know the outcome.
- Specified that Abandon and Unbind cannot be abandoned. - Specified that Abandon and Unbind cannot be abandoned.
C.1.26. Section 4.12 (Extended Operation) C.1.26. Section 4.12 (Extended Operation)
- Specified how values of Extended operations defined in terms of - Specified how values of Extended operations defined in terms of
ASN.1 are to be encoded. ASN.1 are to be encoded.
- Added instructions on what Extended operation specifications - Added instructions on what Extended operation specifications
consist of. consist of.
- Added a recommendation that servers advertise supported Extended - Added a recommendation that servers advertise supported Extended
operations. operations.
C.1.27. Section 5.2 (Transfer Protocols) C.1.27. Section 5.2 (Transfer Protocols)
- Moved referral-specific instructions into referral-related - Moved referral-specific instructions into referral-related
sections. sections.
C.1.28. Section 7 (Security Considerations) C.1.28. Section 7 (Security Considerations)
- Reworded notes regarding SASL not protecting certain aspects of - Reworded notes regarding SASL not protecting certain aspects of
the LDAP Bind messages. the LDAP Bind messages.
- Noted that Servers are encouraged to prevent directory - Noted that Servers are encouraged to prevent directory
modifications by clients that have authenticated anonymously modifications by clients that have authenticated anonymously
[AuthMeth]. [RFC4513].
- Added a note regarding the possibility of changes to security - Added a note regarding the possibility of changes to security
factors (authentication, authorization, data confidentiality). factors (authentication, authorization, and data confidentiality).
- Warned against following referrals that may have been injected in - Warned against following referrals that may have been injected in
the data stream. the data stream.
- Noted that servers should protect information equally, whether in - Noted that servers should protect information equally, whether in
an error condition or not, and mentioned specifically; matchedDN, an error condition or not, and mentioned matchedDN,
diagnosticMessage, and resultCodes. diagnosticMessage, and resultCodes specifically.
- Added a note regarding malformed and long encodings. - Added a note regarding malformed and long encodings.
C.1.29. Appendix A (Complete ASN.1 Definition) C.1.29. Appendix A (Complete ASN.1 Definition)
- Added "EXTENSIBILITY IMPLIED" to ASN.1 definition. - Added "EXTENSIBILITY IMPLIED" to ASN.1 definition.
- Removed AttributeType. It is not used. - Removed AttributeType. It is not used.
C.2. Changes made to RFC 2830: C.2. Changes Made to RFC 2830
This section summarizes the substantive changes made to Sections of This section summarizes the substantive changes made to Sections of
RFC 2830. Readers should consult [AuthMeth] for summaries of changes RFC 2830. Readers should consult [RFC4513] for summaries of changes
to other sections. to other sections.
Lightweight Directory Access Protocol Version 3 C.2.1. Section 2.3 (Response other than "success")
C.2.1. Section 2.3 (Response other than "success")
- Removed wording indicating that referrals can be returned from - Removed wording indicating that referrals can be returned from
StartTLS. StartTLS.
- Removed requirement that only a narrow set of result codes can be - Removed requirement that only a narrow set of result codes can be
returned. Some result codes are required in certain scenarios, but returned. Some result codes are required in certain scenarios, but
any other may be returned if appropriate. any other may be returned if appropriate.
- Removed requirement that the ExtendedResponse.responseName MUST be - Removed requirement that the ExtendedResponse.responseName MUST be
present. There are circumstances where this is impossible, and present. There are circumstances where this is impossible, and
requiring this is at odds with language in Section 4.12. requiring this is at odds with language in Section 4.12.
C.2.1. Section 4 (Closing a TLS Connection) C.2.1. Section 4 (Closing a TLS Connection)
- Reworded most of this section to align with definitions of the - Reworded most of this section to align with definitions of the
LDAP protocol layers. LDAP protocol layers.
- Removed instructions on abrupt closure as this is covered in other - Removed instructions on abrupt closure as this is covered in other
areas of the document (specifically, Section 5.3) areas of the document (specifically, Section 5.3)
C.3. Changes made to RFC 3771: C.3. Changes Made to RFC 3771
- Rewrote to fit into this document. In general, semantics were - Rewrote to fit into this document. In general, semantics were
preserved. Supporting and background language seen as redundant preserved. Supporting and background language seen as redundant
due to its presence in this document was omitted. due to its presence in this document was omitted.
- Specified that Intermediate responses to a request may be of - Specified that Intermediate responses to a request may be of
different types, and one of the response types may be specified to different types, and one of the response types may be specified to
have no response value. have no response value.
Lightweight Directory Access Protocol Version 3 Editor's Address
Intellectual Property Statement Jim Sermersheim
Novell, Inc.
1800 South Novell Place
Provo, Utah 84606, USA
Phone: +1 801 861-3088
EMail: jimse@novell.com
Full Copyright Statement
Copyright (C) The Internet Society (2006).
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
retain all their rights.
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be on the procedures with respect to rights in RFC documents can be
found in BCP 78 and BCP 79. found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr. http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at ietf- this standard. Please address the information to the IETF at
ipr@ietf.org. ietf-ipr@ietf.org.
Disclaimer of Validity
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Copyright Statement
Copyright (C) The Internet Society (2005).
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
retain all their rights.
Acknowledgement Acknowledgement
Funding for the RFC Editor function is currently provided by the Funding for the RFC Editor function is provided by the IETF
Internet Society. Administrative Support Activity (IASA).
 End of changes. 581 change blocks. 
1211 lines changed or deleted 1088 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/