4529
INFORMATIONAL
Requesting Attributes by Object Class in the Lightweight Directory Access Protocol
Authors: K. Zeilenga
Date: June 2006
Working Group: NON WORKING GROUP
Stream: IETF
Abstract
The Lightweight Directory Access Protocol (LDAP) search operation provides mechanisms for clients to request all user application attributes, all operational attributes, and/or attributes selected by their description. This document extends LDAP to support a mechanism that LDAP clients may use to request the return of all attributes of an object class. This memo provides information for the Internet community.
RFC 4529
INFORMATIONAL
Errata Exist
Network Working Group K. Zeilenga
Request for Comments: 4529 OpenLDAP Foundation
Category: Informational June 2006
<span class="h1">Requesting Attributes by Object Class in the</span>
<span class="h1">Lightweight Directory Access Protocol (LDAP)</span>
Status of This Memo
This memo provides information for the Internet community. It does
not specify an Internet standard of any kind. Distribution of this
memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2006).
Abstract
The Lightweight Directory Access Protocol (LDAP) search operation
provides mechanisms for clients to request all user application
attributes, all operational attributes, and/or attributes selected by
their description. This document extends LDAP to support a mechanism
that LDAP clients may use to request the return of all attributes of
an object class.
Table of Contents
<a href="#section-1">1</a>. Background and Intended Use .....................................<a href="#page-1">1</a>
<a href="#section-2">2</a>. Terminology .....................................................<a href="#page-2">2</a>
<a href="#section-3">3</a>. Return of all Attributes of an Object Class .....................<a href="#page-2">2</a>
<a href="#section-4">4</a>. Security Considerations .........................................<a href="#page-3">3</a>
<a href="#section-5">5</a>. IANA Considerations .............................................<a href="#page-3">3</a>
<a href="#section-6">6</a>. References ......................................................<a href="#page-4">4</a>
<a href="#section-6.1">6.1</a>. Normative References .......................................<a href="#page-4">4</a>
<a href="#section-6.2">6.2</a>. Informative References .....................................<a href="#page-4">4</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Background and Intended Use</span>
In the Lightweight Directory Access Protocol (LDAP) [<a href="./rfc4510" title=""Lightweight Directory Access Protocol (LDAP): Technical Specification Road Map"">RFC4510</a>], the
search operation [<a href="./rfc4511" title=""Lightweight Directory Access Protocol (LDAP): The Protocol"">RFC4511</a>] supports requesting the return of a set of
attributes. This set is determined by a list of attribute
descriptions. Two special descriptors are defined to request all
user attributes ("*") [<a href="./rfc4511" title=""Lightweight Directory Access Protocol (LDAP): The Protocol"">RFC4511</a>] and all operational attributes ("+")
[<a href="./rfc3673" title=""Lightweight Directory Access Protocol version 3 (LDAPv3): All Operational Attributes"">RFC3673</a>]. However, there is no convenient mechanism for requesting
pre-defined sets of attributes such as the set of attributes used to
represent a particular class of object.
<span class="grey">Zeilenga Informational [Page 1]</span><span id="page-2" ></span>
<span class="grey"><a href="./rfc4529">RFC 4529</a> Requesting Attributes by Object Class June 2006</span>
This document extends LDAP to allow an object class identifier to be
specified in attributes lists, such as in Search requests, to request
the return of all attributes belonging to an object class. The
COMMERCIAL AT ("@", U+0040) character is used to distinguish an
object class identifier from an attribute descriptions.
For example, the attribute list of "@country" is equivalent to the
attribute list of 'c', 'searchGuide', 'description', and
'objectClass'. This object class is described in [<a href="./rfc4519" title=""Lightweight Directory Access Protocol (LDAP): Schema for User Applications"">RFC4519</a>].
This extension is intended primarily to be used where the user is in
direct control of the parameters of the LDAP search operation, for
instance when entering an LDAP URL [<a href="./rfc4516" title=""Lightweight Directory Access Protocol (LDAP): Uniform Resource Locator"">RFC4516</a>] into a web browser, such
as <ldap:///dc=example,dc=com?@organization?base>.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Terminology</span>
In this document, the key words "MUST", "MUST NOT", "REQUIRED",
"SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
and "OPTIONAL" are to be interpreted as described in <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>
[<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
DSA stands for Directory System Agent (or server).
DSE stands for DSA-specific Entry.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Return of All Attributes of an Object Class</span>
This extension allows object class identifiers to be provided in the
attributes field of the LDAP SearchRequest [<a href="./rfc4511" title=""Lightweight Directory Access Protocol (LDAP): The Protocol"">RFC4511</a>] or other request
values of the AttributeSelection data type (e.g., attributes field in
pre/post read controls [<a href="#ref-ReadEntry" title=""Lightweight Directory Access Protocol (LDAP) Read Entry Controls"">ReadEntry</a>]) and/or <attributeSelector>
production (e.g., attributes of an LDAP URL [<a href="./rfc4516" title=""Lightweight Directory Access Protocol (LDAP): Uniform Resource Locator"">RFC4516</a>]). For each
object class identified in the attributes field, the request is to be
treated as if each attribute allowed by that class (by "MUST" or
"MAY", directly or by "SUP"erior) [<a href="./rfc4512" title=""Lightweight Directory Access Protocol (LDAP): Directory Information Models"">RFC4512</a>] were itself listed.
This extension extends the <attributeSelector> [<a href="./rfc4511" title=""Lightweight Directory Access Protocol (LDAP): The Protocol"">RFC4511</a>] production
as indicated by the following ABNF [<a href="./rfc4234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC4234</a>]:
attributeSelector =/ objectclassdescription
objectclassdescription = ATSIGN oid options
ATSIGN = %x40 ; COMMERCIAL AT ("@" U+0040)
where <oid> and <options> productions are as defined in [<a href="./rfc4512" title=""Lightweight Directory Access Protocol (LDAP): Directory Information Models"">RFC4512</a>].
<span class="grey">Zeilenga Informational [Page 2]</span><span id="page-3" ></span>
<span class="grey"><a href="./rfc4529">RFC 4529</a> Requesting Attributes by Object Class June 2006</span>
The <oid> component of an <objectclassdescription> production
identifies the object class by short name (descr) or object
identifier (numericoid). If the value of the <oid> component is
unrecognized or does not refer to an object class, the object class
description is to be treated as an unrecognized attribute
description.
The <options> production is included in the grammar for extensibility
purposes. An object class description with an unrecognized or
inappropriate option is to be treated as unrecognized.
Although object class description options and attribute description
options share the same syntax, they are not semantically related.
This document does not define any object description option.
Servers supporting this feature SHOULD publish the object identifier
(OID) 1.3.6.1.4.1.4203.1.5.2 as a value of the 'supportedFeatures'
[<a href="./rfc4512" title=""Lightweight Directory Access Protocol (LDAP): Directory Information Models"">RFC4512</a>] attribute in the root DSE. Clients supporting this feature
SHOULD NOT use the feature unless they know that the server supports
it.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Security Considerations</span>
This extension provides a shorthand for requesting all attributes of
an object class. Because these attributes could have been listed
individually, introduction of this shorthand is not believed to raise
additional security considerations.
Implementors of this LDAP extension should be familiar with security
considerations applicable to the LDAP search operation [<a href="./rfc4511" title=""Lightweight Directory Access Protocol (LDAP): The Protocol"">RFC4511</a>], as
well as with general LDAP security considerations [<a href="./rfc4510" title=""Lightweight Directory Access Protocol (LDAP): Technical Specification Road Map"">RFC4510</a>].
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. IANA Considerations</span>
Registration of the LDAP Protocol Mechanism [<a href="./rfc4520" title=""Internet Assigned Numbers Authority (IANA) Considerations for the Lightweight Directory Access Protocol (LDAP)"">RFC4520</a>] defined in this
document has been completed.
Subject: Request for LDAP Protocol Mechanism Registration
Object Identifier: 1.3.6.1.4.1.4203.1.5.2
Description: OC AD Lists
Person & email address to contact for further information:
Kurt Zeilenga <kurt@openldap.org>
Usage: Feature
Specification: <a href="./rfc4529">RFC 4529</a>
Author/Change Controller: Kurt Zeilenga <kurt@openldap.org>
Comments: none
<span class="grey">Zeilenga Informational [Page 3]</span><span id="page-4" ></span>
<span class="grey"><a href="./rfc4529">RFC 4529</a> Requesting Attributes by Object Class June 2006</span>
This OID was assigned [<a href="#ref-ASSIGN" title=""OpenLDAP OID Delegations"">ASSIGN</a>] by OpenLDAP Foundation, under its
IANA-assigned private enterprise allocation [<a href="#ref-PRIVATE" title=""Private Enterprise Numbers"">PRIVATE</a>], for use in
this specification.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. References</span>
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
[<a id="ref-RFC4234">RFC4234</a>] Crocker, D., Ed. and P. Overell, "Augmented BNF for
Syntax Specifications: ABNF", <a href="./rfc4234">RFC 4234</a>, October 2005.
[<a id="ref-RFC4510">RFC4510</a>] Zeilenga, K., Ed., "Lightweight Directory Access
Protocol (LDAP): Technical Specification Road Map", <a href="./rfc4510">RFC</a>
<a href="./rfc4510">4510</a>, June 2006.
[<a id="ref-RFC4511">RFC4511</a>] Sermersheim, J., Ed., "Lightweight Directory Access
Protocol (LDAP): The Protocol", <a href="./rfc4511">RFC 4511</a>, June 2006.
[<a id="ref-RFC4512">RFC4512</a>] Zeilenga, K., "Lightweight Directory Access Protocol
(LDAP): Directory Information Models", <a href="./rfc4512">RFC 4512</a>, June
2006.
[<a id="ref-RFC4516">RFC4516</a>] Smith, M., Ed. and T. Howes, "Lightweight Directory
Access Protocol (LDAP): Uniform Resource Locator", <a href="./rfc4516">RFC</a>
<a href="./rfc4516">4516</a>, June 2006.
[<a id="ref-X.680">X.680</a>] International Telecommunication Union -
Telecommunication Standardization Sector, "Abstract
Syntax Notation One (ASN.1) - Specification of Basic
Notation", X.680(2002) (also ISO/IEC 8824-1:2002).
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Informative References</span>
[<a id="ref-RFC3673">RFC3673</a>] Zeilenga, K., "Lightweight Directory Access Protocol
version 3 (LDAPv3): All Operational Attributes", <a href="./rfc3673">RFC</a>
<a href="./rfc3673">3673</a>, December 2003.
[<a id="ref-RFC4519">RFC4519</a>] Sciberras, A., Ed., "Lightweight Directory Access
Protocol (LDAP): Schema for User Applications", <a href="./rfc4519">RFC</a>
<a href="./rfc4519">4519</a>, June 2006.
[<a id="ref-RFC4520">RFC4520</a>] Zeilenga, K., "Internet Assigned Numbers Authority
(IANA) Considerations for the Lightweight Directory
Access Protocol (LDAP)", <a href="https://www.rfc-editor.org/bcp/bcp64">BCP 64</a>, <a href="./rfc4520">RFC 4520</a>, June 2006.
<span class="grey">Zeilenga Informational [Page 4]</span><span id="page-5" ></span>
<span class="grey"><a href="./rfc4529">RFC 4529</a> Requesting Attributes by Object Class June 2006</span>
[<a id="ref-ReadEntry">ReadEntry</a>] Zeilenga, K., "Lightweight Directory Access Protocol
(LDAP) Read Entry Controls", <a href="./rfc4527">RFC 4527</a>, June 2006.
[<a id="ref-ASSIGN">ASSIGN</a>] OpenLDAP Foundation, "OpenLDAP OID Delegations",
<a href="http://www.openldap.org/foundation/oid-delegate.txt">http://www.openldap.org/foundation/oid-delegate.txt</a>.
[<a id="ref-PRIVATE">PRIVATE</a>] IANA, "Private Enterprise Numbers",
<a href="http://www.iana.org/assignments/enterprise-numbers">http://www.iana.org/assignments/enterprise-numbers</a>.
Author's Address
Kurt D. Zeilenga
OpenLDAP Foundation
EMail: [email protected]
<span class="grey">Zeilenga Informational [Page 5]</span><span id="page-6" ></span>
<span class="grey"><a href="./rfc4529">RFC 4529</a> Requesting Attributes by Object Class June 2006</span>
Full Copyright Statement
Copyright (C) The Internet Society (2006).
This document is subject to the rights, licenses and restrictions
contained in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>, 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
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
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
made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be
found in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>.
Copies of IPR disclosures made to the IETF Secretariat and any
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
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
<a href="http://www.ietf.org/ipr">http://www.ietf.org/ipr</a>.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
[email protected].
Acknowledgement
Funding for the RFC Editor function is provided by the IETF
Administrative Support Activity (IASA).
Zeilenga Informational [Page 6]
Annotations
Select text to annotate