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

   1
   2
   3
   4
   5
   6
   7 INTERNET-DRAFT                           Editor:  Kurt D. Zeilenga
   8 Intended Category: Standard Track                 OpenLDAP Foundation
   9 Expires in six months                             17 May 2002
  10
  11
  12                       Collective Attributes in LDAP
  13                  <draft-zeilenga-ldap-collective-07.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 a Standard Track document.
  23   Distribution of this memo is unlimited.  Technical discussion of this
  24   document will take place on the IETF LDAP Extension 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   X.500 collective attributes allow common characteristics to be shared
  50   between collections of entries.  This document summarizes the X.500
  51   information model for collective attributes and describes use of
  52   collective attributes in LDAP (Lightweight Directory Access Protocol).
  53   This document provides schema definitions for collective attributes
  54   for use in LDAP.
  55
  56
  57
  58 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 1]
  59 \f
  60 INTERNET-DRAFT         LDAP Collective Attributes            17 May 2002
  61
  62
  63 Conventions
  64
  65   Schema definitions are provided using LDAPv3 description formats
  66   [RFC2252].  Definitions provided here are formatted (line wrapped) for
  67   readability.
  68
  69   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
  70   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
  71   document are to be interpreted as described in BCP 14 [RFC2119].
  72
  73
  74 1. Introduction
  75
  76   In X.500, a collective attribute is "a user attribute whose values are
  77   the same for each member of an entry collection" [X.501].  This
  78   document details their use in the Lightweight Directory Access
  79   Protocol (LDAP) [LDAPTS].
  80
  81
  82 1.1. Entry Collections
  83
  84   A collection of entries is a grouping of object and alias entries
  85   based upon common properties or shared relationship between the
  86   corresponding entries which share certain attributes.  An entry
  87   collection consists of all entries within scope of a collective
  88   attributes subentry [SUBENTRY].  An entry can belong to several entry
  89   collections.
  90
  91
  92 1.2. Collective Attributes
  93
  94   Attributes shared by the entries comprising an entry collection are
  95   called collective attributes.  Values of collective attributes are
  96   visible but not updateable to clients accessing entries within the
  97   collection.  Collective attributes are updated (i.e. modified) via
  98   their associated collective attributes subentry.
  99
 100   When an entry belongs to multiple entry collections, the entry's
 101   values of each collective attribute are combined such that independent
 102   sources of these values are not manifested to clients.
 103
 104   Entries can specifically exclude a particular collective attribute by
 105   listing the attribute as a value of the collectiveExclusions
 106   attribute.  Like other user attributes, collective attributes are
 107   subject to a variety of controls including access, administrative, and
 108   content controls.
 109
 110
 111
 112
 113
 114 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 2]
 115 \f
 116 INTERNET-DRAFT         LDAP Collective Attributes            17 May 2002
 117
 118
 119 2. System Schema for Collective Attributes
 120
 121   The following operational attributes are used to manage Collective
 122   Attributes.  LDAP servers [LDAPTS] MUST act in accordance with the
 123   X.500 Directory Models [X.501] when providing this service.
 124
 125
 126 2.1. collectiveAttributeSubentry
 127
 128   Subentries of this object class are used to administer collective
 129   attributes and are referred to as collective attribute subentries.
 130
 131       ( 2.5.20.2 NAME 'collectiveAttributeSubentry' AUXILIARY )
 132
 133   A collective attribute subentry SHOULD contain at least one collective
 134   attribute.  The collective attributes contained within a collective
 135   attribute subentry are available for finding, searching, and
 136   comparison at every entry within the scope of the subentry. The
 137   collective attributes, however, are administered (e.g. modified) via
 138   the subentry.
 139
 140   Implementations of this specification SHOULD support collective
 141   attribute subentries in both collectiveAttributeSpecificArea
 142   (2.5.23.5) and collectiveAttributeInnerArea (2.5.23.6) administrative
 143   areas [SUBENTRY][X.501].
 144
 145
 146 2.2. collectiveAttributeSubentries
 147
 148   The collectiveAttributeSubentries operational attribute identifies all
 149   collective attribute subentries that affect the entry.
 150
 151       ( 2.5.18.12 NAME 'collectiveAttributeSubentries'
 152         EQUALITY distinguishedNameMatch
 153         SYNTAX 1.3.6.1.4.1.1466.115.121.1.12
 154         USAGE directoryOperation NO-USER-MODIFICATION )
 155
 156
 157 2.3. collectiveExclusions
 158
 159   The collectiveExclusions operational attribute allows particular
 160   collective attributes to be excluded from an entry.  It MAY appear in
 161   any entry and MAY have multiple values.
 162
 163       ( 2.5.18.7 NAME 'collectiveExclusions'
 164         EQUALITY objectIdentifierMatch
 165         SYNTAX 1.3.6.1.4.1.1466.115.121.1.38
 166         USAGE directoryOperation )
 167
 168
 169
 170 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 3]
 171 \f
 172 INTERNET-DRAFT         LDAP Collective Attributes            17 May 2002
 173
 174
 175   The descriptor excludeAllCollectiveAttributes is associated with the
 176   OID 2.5.18.0.  When this descriptor or OID is present as a value of
 177   the collectiveExclusions attribute, all collective attributes are
 178   excluded from an entry.
 179
 180
 181 3. Collective Attribute Types
 182
 183   A userApplications attribute type can be defined to be COLLECTIVE
 184   [RFC2252].  This indicates that the same attribute values will appear
 185   in the entries of an entry collection subject to the use of the
 186   collectiveExclusions attribute and other administrative controls.
 187   These administrative controls MAY include DIT Content Rules, if
 188   implemented.
 189
 190   Collective attribute types are commonly defined as subtypes of non-
 191   collective attribute types.  By convention, collective attributes are
 192   named by prefixing the name of their non-collective supertype with
 193   "c-".  For example, the collective telephone attribute is named
 194   c-TelephoneNumber after its non-collective supertype telephoneNumber.
 195
 196   Non-collective attributes types SHALL NOT subtype collective
 197   attributes.
 198
 199   Collective attributes SHALL NOT be SINGLE-VALUED.  Collective
 200   attribute types SHALL NOT appear in the attribute types of an object
 201   class definition.
 202
 203   Operational attributes SHALL NOT be defined to be collective.
 204
 205   The remainder of section provides a summary of collective attributes
 206   derived from those defined in [X.520].  The SUPerior attribute types
 207   are described in [RFC 2256] for use with LDAP.
 208
 209   Implementations of this specification SHOULD support the following
 210   collective attributes and MAY support additional collective
 211   attributes.
 212
 213
 214 3.1. Collective Locality Name
 215
 216   The c-l attribute type specifies a locality name for a collection of
 217   entries.
 218
 219       ( 2.5.4.7.1 NAME 'c-l'
 220         SUP l COLLECTIVE )
 221
 222
 223
 224
 225
 226 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 4]
 227 \f
 228 INTERNET-DRAFT         LDAP Collective Attributes            17 May 2002
 229
 230
 231 3.2. Collective State or Province Name
 232
 233   The c-st attribute type specifies a state or province name for a
 234   collection of entries.
 235
 236       ( 2.5.4.8.1 NAME 'c-st'
 237         SUP st COLLECTIVE )
 238
 239
 240 3.3. Collective Street Address
 241
 242   The c-street attribute type specifies a street address for a
 243   collection of entries.
 244
 245       ( 2.5.4.9.1 NAME 'c-street'
 246         SUP street COLLECTIVE )
 247
 248
 249 3.4. Collective Organization Name
 250
 251   The c-o attribute type specifies an organization name for a collection
 252   of entries.
 253
 254       ( 2.5.4.10.1 NAME 'c-o'
 255         SUP o COLLECTIVE )
 256
 257
 258 3.5. Collective Organizational Unit Name
 259
 260   The c-ou attribute type specifies an organizational unit name for a
 261   collection of entries.
 262
 263       ( 2.5.4.11.1 NAME 'c-ou'
 264         SUP ou COLLECTIVE )
 265
 266
 267 3.6. Collective Postal Address
 268
 269   The c-PostalAddress attribute type specifies a postal address for a
 270   collection of entries.
 271
 272       ( 2.5.4.16.1 NAME 'c-PostalAddress'
 273         SUP postalAddress COLLECTIVE )
 274
 275
 276 3.7. Collective Postal Code
 277
 278   The c-PostalCode attribute type specifies a postal code for a
 279
 280
 281
 282 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 5]
 283 \f
 284 INTERNET-DRAFT         LDAP Collective Attributes            17 May 2002
 285
 286
 287   collection of entries.
 288
 289       ( 2.5.4.17.1 NAME 'c-PostalCode'
 290         SUP postalCode COLLECTIVE )
 291
 292
 293 3.8. Collective Post Office Box
 294
 295   The c-PostOfficeBox attribute type specifies a post office box for a
 296   collection of entries.
 297
 298       ( 2.5.4.18.1 NAME 'c-PostOfficeBox'
 299         SUP postOfficeBox COLLECTIVE )
 300
 301
 302 3.9. Collective Physical Delivery Office Name
 303
 304   The c-PhysicalDeliveryOfficeName attribute type specifies a physical
 305   delivery office name for a collection of entries.
 306
 307       ( 2.5.4.19.1 NAME 'c-PhysicalDeliveryOfficeName'
 308         SUP physicalDeliveryOfficeName COLLECTIVE )
 309
 310
 311 3.10. Collective Telephone Number
 312
 313   The c-TelephoneNumber attribute type specifies a telephone number for
 314   a collection of entries.
 315
 316       ( 2.5.4.20.1 NAME 'c-TelephoneNumber'
 317         SUP telephoneNumber COLLECTIVE )
 318
 319
 320 3.11. Collective Telex Number
 321
 322   The c-TelexNumber attribute type specifies a telex number for a
 323   collection of entries.
 324
 325       ( 2.5.4.21.1 NAME 'c-TelexNumber'
 326         SUP telexNumber COLLECTIVE )
 327
 328
 329 3.13. Collective Facsimile Telephone Number
 330
 331   The c-FacsimileTelephoneNumber attribute type specifies a facsimile
 332   telephone number for a collection of entries.
 333
 334       ( 2.5.4.23.1 NAME 'c-FacsimileTelephoneNumber'
 335
 336
 337
 338 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 6]
 339 \f
 340 INTERNET-DRAFT         LDAP Collective Attributes            17 May 2002
 341
 342
 343         SUP facsimileTelephoneNumber COLLECTIVE )
 344
 345
 346 3.14. Collective International ISDN Number
 347
 348   The c-InternationalISDNNumber attribute type specifies an
 349   international ISDN number for a collection of entries.
 350
 351       ( 2.5.4.25.1 NAME 'c-InternationalISDNNumber'
 352         SUP internationalISDNNumber COLLECTIVE )
 353
 354
 355 4. Security Considerations
 356
 357   Collective attributes are not believed to introduce any additional
 358   security considerations to LDAP [LDAPTS].
 359
 360
 361 5. IANA Considerations
 362
 363   It is requested that IANA register the LDAP descriptors used in this
 364   document per the following registration template:
 365
 366       Subject: Request for LDAP Descriptor Registration
 367       Descriptor (short name): see comment
 368       Object Identifier: see comment
 369       Person & email address to contact for further information:
 370            Kurt Zeilenga <kurt@OpenLDAP.org>
 371       Usage: see comment
 372       Specification: RFCXXXX
 373       Author/Change Controller: IESG
 374       Comments:
 375
 376         NAME                           Type OID
 377         ------------------------       ---- -----------------
 378         c-FacsimileTelephoneNumber     A    2.5.4.23.1
 379         c-InternationalISDNNumber      A    2.5.4.25.1
 380         c-PhysicalDeliveryOffice       A    2.5.4.19.1
 381         c-PostOfficeBox                A    2.5.4.18.1
 382         c-PostalAddress                A    2.5.4.16.1
 383         c-PostalCode                   A    2.5.4.17.1
 384         c-TelephoneNumber              A    2.5.4.20.1
 385         c-TelexNumber                  A    2.5.4.21.1
 386         c-l                            A    2.5.4.7.1
 387         c-o                            A    2.5.4.10.1
 388         c-ou                           A    2.5.4.11.1
 389         c-st                           A    2.5.4.8.1
 390         c-street                       A    2.5.4.9.1
 391
 392
 393
 394 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 7]
 395 \f
 396 INTERNET-DRAFT         LDAP Collective Attributes            17 May 2002
 397
 398
 399         collectiveAttributeSubentries  A    2.5.18.12
 400         collectiveAttributeSubentry    O    2.5.20.2
 401         collectiveExclusions           A    2.5.18.7
 402
 403       where Type A is Attribute and Type O is ObjectClass.
 404
 405
 406   This document uses in this document were assigned by the ISO/IEC Joint
 407   Technical Committee 1 - Subcommitte 6 to identify elements of X.500
 408   schema.  This document make no OID assignments, it only associates
 409   LDAP schema descriptions with existing elements of X.500 schema.
 410
 411
 412 6. Acknowledgments
 413
 414   This document is based upon the ITU Recommendations for the Directory
 415   [X.501][X.520].
 416
 417
 418 7. Author's Address
 419
 420   Kurt D. Zeilenga
 421   OpenLDAP Foundation
 422   <Kurt@OpenLDAP.org>
 423
 424
 425 8. Normative References
 426
 427   [RFC2119] S. Bradner, "Key words for use in RFCs to Indicate
 428             Requirement Levels", BCP 14 (also RFC 2119), March 1997.
 429
 430   [RFC2251] M. Wahl, T. Howes, S. Kille, "Lightweight Directory Access
 431             Protocol (v3)", RFC 2251, December 1997.
 432
 433   [RFC2252] M. Wahl, A. Coulbeck, T. Howes, S. Kille, "Lightweight
 434             Directory Access Protocol (v3):  Attribute Syntax
 435             Definitions", RFC 2252, December 1997.
 436
 437   [RFC2256] M. Wahl, "A Summary of the X.500(96) User Schema for use
 438             with LDAPv3", RFC 2256, December 1997.
 439
 440   [LDAPTS]  J. Hodges, R.L. Morgan, "Lightweight Directory Access
 441             Protocol (v3): Technical Specification",
 442             draft-ietf-ldapbis-ldapv3-ts-xx.txt.
 443
 444   [SUBENTRY] K. Zeilenga, S. Legg, "Subentries in LDAP",
 445             draft-zeilenga-ldap-subentry-xx.txt, a work in progress.
 446
 447
 448
 449
 450 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 8]
 451 \f
 452 INTERNET-DRAFT         LDAP Collective Attributes            17 May 2002
 453
 454
 455   [X.501]   "The Directory: Models", ITU-T Recommendation X.501, 1993.
 456
 457
 458 9. Informative References
 459
 460   [X.500]   "The Directory: Overview of Concepts, Models", ITU-T
 461             Recommendation X.500, 1993.
 462
 463   [X.520]   "The Directory: Selected Attribute Types", ITU-T
 464             Recommendation X.520, 1993.
 465
 466
 467 Copyright 2002, The Internet Society.  All Rights Reserved.
 468
 469   This document and translations of it may be copied and furnished to
 470   others, and derivative works that comment on or otherwise explain it
 471   or assist in its implementation may be prepared, copied, published and
 472   distributed, in whole or in part, without restriction of any kind,
 473   provided that the above copyright notice and this paragraph are
 474   included on all such copies and derivative works.  However, this
 475   document itself may not be modified in any way, such as by removing
 476   the copyright notice or references to the Internet Society or other
 477   Internet organizations, except as needed for the  purpose of
 478   developing Internet standards in which case the procedures for
 479   copyrights defined in the Internet Standards process must be followed,
 480   or as required to translate it into languages other than English.
 481
 482   The limited permissions granted above are perpetual and will not be
 483   revoked by the Internet Society or its successors or assigns.
 484
 485   This document and the information contained herein is provided on an
 486   "AS IS" basis and THE AUTHORS, THE INTERNET SOCIETY, AND THE INTERNET
 487   ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
 488   INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
 489   INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
 490   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506 Zeilenga            draft-zeilenga-ldap-collective-07           [Page 9]
 507 \f