git.sur5r.net Git - openldap/blob - doc/drafts/draft-zeilenga-ldap-adlist-xx.txt

   1
   2
   3
   4
   5
   6
   7 INTERNET-DRAFT                                      Kurt D. Zeilenga
   8 Intended Category: Informational                    OpenLDAP Foundation
   9 Expires in six months                               17 May 2002
  10
  11
  12               LDAPv3: Requesting Attributes by Object Class
  13                    <draft-zeilenga-ldap-adlist-01.txt>
  14
  15
  16 Status of this Memo
  17
  18   This document is an Internet-Draft and is in full conformance with all
  19   provisions of Section 10 of RFC2026.
  20
  21   This document is intended to be, after appropriate review and
  22   revision, submitted to the RFC Editor as an Informational document.
  23   Distribution of this memo is unlimited.  Technical discussion of this
  24   document will take place on the IETF LDAP Extensions Working Group
  25   mailing list <ietf-ldapext@netscape.com>.  Please send editorial
  26   comments directly to the author <Kurt@OpenLDAP.org>.
  27
  28   Internet-Drafts are working documents of the Internet Engineering Task
  29   Force (IETF), its areas, and its working groups.  Note that other
  30   groups may also distribute working documents as Internet-Drafts.
  31   Internet-Drafts are draft documents valid for a maximum of six months
  32   and may be updated, replaced, or obsoleted by other documents at any
  33   time.  It is inappropriate to use Internet-Drafts as reference
  34   material or to cite them other than as ``work in progress.''
  35
  36   The list of current Internet-Drafts can be accessed at
  37   <http://www.ietf.org/ietf/1id-abstracts.txt>. The list of
  38   Internet-Draft Shadow Directories can be accessed at
  39   <http://www.ietf.org/shadow.html>.
  40
  41   Copyright 2002, The Internet Society.  All Rights Reserved.
  42
  43   Please see the Copyright section near the end of this document for
  44   more information.
  45
  46
  47 Abstract
  48
  49   The Lightweight Directory Access Protocol (LDAP) search operation
  50   provides mechanisms for clients to request all user application
  51   attributes, all operational attributes, or attributes selected by
  52   their description.  This document extends LDAP to provide a mechanism
  53   for LDAP clients to request the return of all attributes of an object
  54   class.
  55
  56
  57
  58 Zeilenga          Requesting Attributes by Object Class         [Page 1]
  59 \f
  60 INTERNET-DRAFT        draft-zeilenga-ldap-adlist-01          17 May 2002
  61
  62
  63 1.  Overview
  64
  65   LDAP [RFC2251] search operations support mechanisms for requesting
  66   sets of attributes.  This set is determined by a list of attribute
  67   descriptions.  Two special descriptors are defined to request all user
  68   attributes ("*") and all operational attributes ("+").  However, there
  69   is no convenient mechanism for requesting pre-defined sets of
  70   attributes.  This document extends LDAP to allow an object class
  71   identifier to be specified in search request attributes list to
  72   request the return all attributes allowed by object class.
  73
  74   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
  75   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
  76   document are to be interpreted as described in BCP 14 [RFC2119].
  77
  78
  79 2.  Return of all Attributes of an Object Class
  80
  81   This extension allows object class identifiers is to be provided in
  82   the attributes field of the LDAP SearchRequest [RFC2251].  For each
  83   object class identified in the attributes field, the request is to be
  84   treated as if each attribute allowed by that class (by "MUST" or
  85   "MAY", directly or by SUPerior) was itself listed.  For example, a
  86   request for "country" [RFC2256] is treated as if "c", "searchGuide",
  87   "description", and "objectClass" were requested.
  88
  89   As a special case, requesting extensibleObject [RFC2252] is treated as
  90   if "objectClass,*,+" was requested [RFC2251][OPATTRS].
  91
  92   If the object class identifier is unrecognized, it is be treated an an
  93   unrecognized attribute description.
  94
  95   This extension redefines the attributes field of the SearchRequest to
  96   be a DescriptionList described by the following [ASN.1]:
  97
  98        DescriptionList ::= SEQUENCE OF Description
  99        Description ::= LDAPString
 100
 101   The Description is string conforming to the [ABNF]:
 102
 103        Description ::= AttributeDescription | ObjectClassDescription.
 104        ObjectDescription ::= ObjectClass *( ";" options )
 105
 106   where AttributeDescription and options productions are as defined in
 107   Section 4.1.5 of [RFC2251] and an ObjectClass is an objectIdentifier,
 108   in either numericoid or descr form [RFC 2252], of an object class.
 109
 110   ObjectDescription options are provided for extensibility.  This
 111
 112
 113
 114 Zeilenga          Requesting Attributes by Object Class         [Page 2]
 115 \f
 116 INTERNET-DRAFT        draft-zeilenga-ldap-adlist-01          17 May 2002
 117
 118
 119   document only defines semantics of ObjectDescriptions with zero
 120   options in the attributes field of a SearchRequest.  Other uses may be
 121   defined in future specifications.
 122
 123   Servers supporting this feature SHOULD publish the Object Identifier
 124   1.3.6.1.4.1.4203.1.5.2 as a value of the supportedFeatures [FEATURES]
 125   attribute in the root DSE.
 126
 127
 128 3.  Security Considerations
 129
 130   This extension provides a shorthand for requesting all attributes of
 131   an object class.  As these attributes which could have been listed
 132   individually, this short hand is not believed to raises additional
 133   security considerations.
 134
 135   Implementors of this (or any) LDAP extension should be familiar with
 136   general LDAP general security considerations [LDAPTS].
 137
 138
 139 4.  IANA Considerations
 140
 141   No IANA assignments are requested.
 142
 143   This document uses the OID 1.3.6.1.4.1.4203.1.5.2 to identify the LDAP
 144   feature it details.  This OID was assigned [ASSIGN] by OpenLDAP
 145   Foundation under its IANA assigned private enterprise allocation
 146   [PRIVATE] for use in this specification.
 147
 148
 149 5.  Author's Address
 150
 151   Kurt D. Zeilenga
 152   OpenLDAP Foundation
 153   <Kurt@OpenLDAP.org>
 154
 155
 156 6. Normative References
 157
 158   [RFC2119]  S. Bradner, "Key words for use in RFCs to Indicate
 159              Requirement Levels", BCP 14 (also RFC 2119), March 1997.
 160
 161   [RFC2251]  M. Wahl, T. Howes, S. Kille, "Lightweight Directory Access
 162              Protocol (v3)", RFC 2251, December 1997.
 163
 164   [RFC2252]  M. Wahl, A. Coulbeck, T. Howes, S. Kille, "Lightweight
 165              Directory Access Protocol (v3):  Attribute Syntax
 166              Definitions", RFC 2252, December 1997.
 167
 168
 169
 170 Zeilenga          Requesting Attributes by Object Class         [Page 3]
 171 \f
 172 INTERNET-DRAFT        draft-zeilenga-ldap-adlist-01          17 May 2002
 173
 174
 175   [LDAPTS]   J. Hodges, R. Morgan, "Lightweight Directory Access
 176              Protocol (v3): Technical Specification",
 177              draft-ietf-ldapbis-ldapv3-ts-xx.txt (a work in progress).
 178
 179   [FEATURES] K. Zeilenga, "Feature Discovery in LDAP",
 180              draft-zeilenga-ldap-features-xx.txt (a work in progress).
 181
 182   [OPATTRS]  K. Zeilenga, "LDAPv3: All Operational Attributes",
 183              draft-zeilenga-ldap-opattrs-xx.txt (a work in progress).
 184
 185
 186 7. Informative References
 187
 188   [RFC2256]  Wahl, M., "A Summary of the X.500(96) User Schema for use
 189              with LDAPv3", RFC 2256, December 1997.
 190
 191   [X.500]    ITU-T Rec. X.500, "The Directory: Overview of Concepts,
 192              Models and Service", 1993.
 193
 194   [X.511]    ITU-T Rec. X.511, "The Directory: Abstract Service
 195              Definition", 1993.
 196
 197   [ASSIGN]   OpenLDAP Foundation, "OpenLDAP OID Delegations",
 198              http://www.openldap.org/foundation/oid-delegate.txt.
 199
 200   [PRIVATE]  IANA, "Private Enterprise Numbers",
 201              http://www.iana.org/assignments/enterprise-numbers.
 202
 203
 204
 205 Copyright 2002, The Internet Society.  All Rights Reserved.
 206
 207   This document and translations of it may be copied and furnished to
 208   others, and derivative works that comment on or otherwise explain it
 209   or assist in its implementation may be prepared, copied, published and
 210   distributed, in whole or in part, without restriction of any kind,
 211   provided that the above copyright notice and this paragraph are
 212   included on all such copies and derivative works.  However, this
 213   document itself may not be modified in any way, such as by removing
 214   the copyright notice or references to the Internet Society or other
 215   Internet organizations, except as needed for the  purpose of
 216   developing Internet standards in which case the procedures for
 217   copyrights defined in the Internet Standards process must be followed,
 218   or as required to translate it into languages other than English.
 219
 220   The limited permissions granted above are perpetual and will not be
 221   revoked by the Internet Society or its successors or assigns.
 222
 223
 224
 225
 226 Zeilenga          Requesting Attributes by Object Class         [Page 4]
 227 \f
 228 INTERNET-DRAFT        draft-zeilenga-ldap-adlist-01          17 May 2002
 229
 230
 231   This document and the information contained herein is provided on an
 232   "AS IS" basis and THE AUTHORS, THE INTERNET SOCIETY, AND THE INTERNET
 233   ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
 234   INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
 235   INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
 236   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282 Zeilenga          Requesting Attributes by Object Class         [Page 5]
 283 \f