openldap/doc/drafts/draft-zeilenga-ldap-uuid-xx.txt

452 lines
14 KiB
Plaintext
Raw Normal View History

2003-06-01 06:47:07 +08:00
INTERNET-DRAFT Kurt D. Zeilenga
Intended Category: Standard Track OpenLDAP Foundation
2005-11-26 03:23:13 +08:00
Expires in six months 18 July 2005
2003-06-01 06:47:07 +08:00
The LDAP entryUUID operational attribute
2005-11-26 03:23:13 +08:00
<draft-zeilenga-ldap-uuid-06.txt>
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
Status of this Memo
2003-06-01 06:47:07 +08:00
This document is intended to be, after appropriate review and
revision, submitted to the RFC Editor as an Standard Track document.
Distribution of this memo is unlimited. Technical discussion of this
2003-12-07 15:50:23 +08:00
document will take place on the IETF LDAP Extensions mailing list
<ldapext@ietf.org>. Please send editorial comments directly to the
author <Kurt@OpenLDAP.org>.
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
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.
2003-06-01 06:47:07 +08:00
Internet-Drafts are working documents of the Internet Engineering Task
2005-11-26 03:23:13 +08:00
Force (IETF), its areas, and its working groups. Note that other
2003-06-01 06:47:07 +08:00
groups may also distribute working documents as Internet-Drafts.
2005-11-26 03:23:13 +08:00
2003-06-01 06:47:07 +08:00
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
2005-11-26 03:23:13 +08:00
time. It is inappropriate to use Internet-Drafts as reference material
or to cite them other than as "work in progress."
2003-06-01 06:47:07 +08:00
The list of current Internet-Drafts can be accessed at
2005-11-26 03:23:13 +08:00
http://www.ietf.org/1id-abstracts.html
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
Copyright (C) The Internet Society (2005). All Rights Reserved.
2003-06-01 06:47:07 +08:00
Please see the Full Copyright section near the end of this document
for more information.
Abstract
2005-11-26 03:23:13 +08:00
Zeilenga draft-zeilenga-ldap-uuid-06 [Page 1]
INTERNET-DRAFT LDAP entryUUID 18 July 2005
2003-06-01 06:47:07 +08:00
This document describes the LDAP/X.500 'entryUUID' operational
attribute and associated matching rules and syntax. The attribute
holds a server-assigned Universally Unique Identifier (UUID) for the
object. Directory clients may use this attribute to distinguish
objects identified by a distinguished name or to locate an object
after renaming.
1. Background and Intended Use
In X.500 Directory Services [X.501], such as those accessible using
2005-11-26 03:23:13 +08:00
the Lightweight Directory Access Protocol (LDAP) [Roadmap], an object
is identified by its distinguished name (DN). However, DNs are not
stable identifiers. That is, a new object may be identified by a DN
which previously identified another (now renamed or deleted) object.
A Universally Unique Identifier (UUID) is "an identifier unique across
both space and time, with respect to the space of all UUIDs"
[UUIDURN]. UUIDs are used in a wide range of systems.
2003-06-01 06:47:07 +08:00
2003-12-07 15:50:23 +08:00
This document describes the 'entryUUID' operational attribute which
2005-11-26 03:23:13 +08:00
holds the UUID assigned to the object by the server. Clients may use
this attribute to distinguish objects identified by a particular
distinguished name or to locate a particular object after renaming.
2003-06-01 06:47:07 +08:00
This document defines the UUID syntax, the 'uuidMatch' and
2005-11-26 03:23:13 +08:00
'uuidOrderingMatch' matching rules, and the 'entryUUID' attribute
type.
Schema definitions are provided using LDAP description formats
[Models]. Definitions provided here are formatted (line wrapped) for
readability.
2003-06-01 06:47:07 +08:00
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in BCP 14 [RFC2119].
2. UUID Schema Elements
2.1 UUID Syntax
2005-11-26 03:23:13 +08:00
A Universally Unique Identifier (UUID) [UUIDURN] is a 16-octet
(128-bit) value which identifies an object. The ASN.1 [X.680] type
UUID is defined to represent UUIDs as follows:
2003-06-01 06:47:07 +08:00
2003-12-07 15:50:23 +08:00
UUID ::= OCTET STRING (SIZE(16))
2005-11-26 03:23:13 +08:00
-- constrained to an UUID [UUIDURN]
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
Zeilenga draft-zeilenga-ldap-uuid-06 [Page 2]
INTERNET-DRAFT LDAP entryUUID 18 July 2005
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
In LDAP, UUID values are encoded using the [ASCII] character string
representation described in [UUIDURN]. For example,
"597ae2f6-16a6-1027-98f4-d28b5365dc14".
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
The following is a LDAP syntax description suitable for publication in
subschema subentries.
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
( IANA-ASSIGNED-OID.1 DESC 'UUID' )
2003-06-01 06:47:07 +08:00
2003-12-07 15:50:23 +08:00
2.2 'uuidMatch' Matching Rule
The 'uuidMatch' matching rule compares an asserted UUID with a stored
2005-11-26 03:23:13 +08:00
UUID for equality. Its semantics are same as the 'octetStringMatch'
[X.520][Syntaxes] matching rule. The rule differs from
'octetStringMatch' in that the assertion value is encoded using the
UUID string representation instead of the normal OCTET STRING string
2003-12-07 15:50:23 +08:00
representation.
2005-11-26 03:23:13 +08:00
The following is a LDAP matching rule description suitable for
publication in subschema subentries.
2003-06-01 06:47:07 +08:00
( IANA-ASSIGNED-OID.2 NAME 'uuidMatch'
SYNTAX IANA-ASSIGNED-OID.1 )
2.3 'uuidOrderingMatch' Matching Rule
The 'uuidOrderingMatch' matching rule compares an asserted UUID
2003-12-07 15:50:23 +08:00
with a stored UUID for ordering. Its semantics are the same as the
2005-11-26 03:23:13 +08:00
'octetStringOrderingMatch' [X.520][Syntaxes] matching rule. The
rule differs from 'octetStringOrderingMatch' in that the assertion
value is encoded using the UUID string representation instead of
the normal OCTET STRING string representation.
2003-12-07 15:50:23 +08:00
2005-11-26 03:23:13 +08:00
The following is a LDAP matching rule description suitable for
publication in subschema subentries.
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
( IANA-ASSIGNED-OID.3 NAME 'uuidOrderingMatch'
2003-06-01 06:47:07 +08:00
SYNTAX IANA-ASSIGNED-OID.1 )
2003-12-07 15:50:23 +08:00
It is noted that not all UUID variants have a defined ordering and,
even where so, servers are not obligated to assign UUIDs in any
particular order. This matching rule is provided for completeness.
2003-06-01 06:47:07 +08:00
2.4. 'entryUUID' attribute
2003-12-07 15:50:23 +08:00
2005-11-26 03:23:13 +08:00
Zeilenga draft-zeilenga-ldap-uuid-06 [Page 3]
INTERNET-DRAFT LDAP entryUUID 18 July 2005
2003-12-07 15:50:23 +08:00
2005-11-26 03:23:13 +08:00
The 'entryUUID' operational attribute provides the Universally Unique
Identifier (UUID) assigned to the entry.
2003-12-07 15:50:23 +08:00
2005-11-26 03:23:13 +08:00
The following is a LDAP attribute type description suitable for
publication in subschema subentries.
2003-12-07 15:50:23 +08:00
2005-11-26 03:23:13 +08:00
( IANA-ASSIGNED-OID.4 NAME 'entryUUID'
DESC 'UUID of the entry'
EQUALITY uuidMatch
ORDERING uuidOrderingMatch
2003-06-01 06:47:07 +08:00
SYNTAX IANA-ASSIGNED-OID.1
SINGLE-VALUE
NO-USER-MODIFICATION
USAGE directoryOperation )
2005-11-26 03:23:13 +08:00
Servers SHALL generate and assign a new UUID to each entry upon its
addition to the directory and provide that UUID as the value of the
2003-06-01 06:47:07 +08:00
'entryUUID' operational attribute. An entry's UUID is immutable.
2005-11-26 03:23:13 +08:00
UUID are to be generated in accordance with Section 4 of [UUIDURN].
In particular, servers MUST ensure that each generated UUID is unique
in space and time.
2003-06-01 06:47:07 +08:00
3. Security Considerations
2005-11-26 03:23:13 +08:00
An entry's relative distinguish name (RDN) is composed from attribute
values of the entry, values which are commonly descriptive of the
object the entry represents. While deployers are encouraged to use
naming attributes whose values are widely disclosable [LDAPDN],
entries are often named using information which cannot be disclosed to
all parties. As UUIDs do not contain any descriptive information of
the object they identify, UUIDs may be used to identify a particular
entry without disclosure of its contents.
General UUID security considerations [UUIDURN] apply.
2003-06-01 06:47:07 +08:00
General LDAP security considerations [RFC3377] apply.
4. IANA Considerations
2005-11-26 03:23:13 +08:00
It is requested that IANA register upon Standards Action the LDAP
values specified in this document.
2003-06-01 06:47:07 +08:00
4.1. Object Identifier Registration
2005-11-26 03:23:13 +08:00
Zeilenga draft-zeilenga-ldap-uuid-06 [Page 4]
INTERNET-DRAFT LDAP entryUUID 18 July 2005
2003-06-01 06:47:07 +08:00
Subject: Request for LDAP OID Registration
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Specification: RFC XXXX
Author/Change Controller: IESG
Comments:
Identifies the UUID schema elements
2005-11-26 03:23:13 +08:00
4.2. UUID Syntax Registration
Subject: Request for LDAP Syntax Registration
Object Identifier: IANA-ASSIGNED-OID.1
Description: UUID
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Specification: RFC XXXX
Author/Change Controller: IESG
Comments:
Identifies the UUID syntax
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
4.3. 'uuidMatch' Descriptor Registration
2003-06-01 06:47:07 +08:00
Subject: Request for LDAP Descriptor Registration
Descriptor (short name): uuidMatch
Object Identifier: IANA-ASSIGNED-OID.2
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Usage: Matching Rule
Specification: RFC XXXX
Author/Change Controller: IESG
2005-11-26 03:23:13 +08:00
4.3. 'uuidOrderingMatch' Descriptor Registration
2003-06-01 06:47:07 +08:00
Subject: Request for LDAP Descriptor Registration
Descriptor (short name): uuidOrderingMatch
Object Identifier: IANA-ASSIGNED-OID.3
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Usage: Matching Rule
Specification: RFC XXXX
Author/Change Controller: IESG
2005-11-26 03:23:13 +08:00
5.4. 'entryUUID' Descriptor Registration
Zeilenga draft-zeilenga-ldap-uuid-06 [Page 5]
INTERNET-DRAFT LDAP entryUUID 18 July 2005
2003-06-01 06:47:07 +08:00
It is requested that IANA register upon Standards Action the LDAP
'entryUUID' descriptor.
Subject: Request for LDAP Descriptor Registration
Descriptor (short name): entryUUID
Object Identifier: IANA-ASSIGNED-OID.4
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Usage: Attribute Type
Specification: RFC XXXX
Author/Change Controller: IESG
2005-11-26 03:23:13 +08:00
6. Acknowledgments
2003-06-01 06:47:07 +08:00
This document is based upon discussions in the LDAP Update and
2005-11-26 03:23:13 +08:00
Duplication Protocols (LDUP) WG. Members of the LDAP Directorate
provided review.
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
7. Author's Address
2003-06-01 06:47:07 +08:00
Kurt D. Zeilenga
OpenLDAP Foundation
2005-11-26 03:23:13 +08:00
Email: Kurt@OpenLDAP.org
8. References
[[Note to the RFC Editor: please replace the citation tags used in
referencing Internet-Drafts with tags of the form RFCnnnn where
possible.]]
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
8.1. Normative References
2003-06-01 06:47:07 +08:00
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14 (also RFC 2119), March 1997.
2005-11-26 03:23:13 +08:00
[Roadmap] Zeilenga, K. (editor), "LDAP: Technical Specification
Road Map", draft-ietf-ldapbis-roadmap-xx.txt, a work in
progress.
[UUIDURN] Leach, P, M. Mealling, R. Salz, "A UUID URN Namespace",
a work in progress.
[Models] Zeilenga, K. (editor), "LDAP: Directory Information
2003-12-07 15:50:23 +08:00
2005-11-26 03:23:13 +08:00
Zeilenga draft-zeilenga-ldap-uuid-06 [Page 6]
INTERNET-DRAFT LDAP entryUUID 18 July 2005
2003-12-07 15:50:23 +08:00
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
Models", draft-ietf-ldapbis-models-xx.txt, a work in
progress.
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
[Syntaxes] Legg, S. (editor), "LDAP: Syntaxes and Matching Rules",
draft-ietf-ldapbis-syntaxes-xx.txt, a work in progress.
2003-06-01 06:47:07 +08:00
2003-12-07 15:50:23 +08:00
[ASCII] Coded Character Set--7-bit American Standard Code for
Information Interchange, ANSI X3.4-1986.
2003-06-01 06:47:07 +08:00
[X.501] International Telecommunication Union -
Telecommunication Standardization Sector, "The Directory
-- Models," X.501(1993) (also ISO/IEC 9594-2:1994).
[X.520] International Telecommunication Union -
Telecommunication Standardization Sector, "The
Directory: Selected Attribute Types", X.520(1993) (also
ISO/IEC 9594-6:1994).
[X.680] International Telecommunication Union -
Telecommunication Standardization Sector, "Abstract
Syntax Notation One (ASN.1) - Specification of Basic
2005-11-26 03:23:13 +08:00
Notation", X.680(2002) (also ISO/IEC 8824-1:2002).
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
8.2. Informative References
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
[LDAPDN] Zeilenga, K. (editor), "LDAP: String Representation of
Distinguished Names", draft-ietf-ldapbis-dn-xx.txt, a
work in progress.
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
[BCP64bis] Zeilenga, K., "IANA Considerations for LDAP",
draft-ietf-ldapbis-bcp64-xx.txt, a work in progress.
2003-06-01 06:47:07 +08:00
Intellectual Property Rights
The IETF takes no position regarding the validity or scope of any
2005-11-26 03:23:13 +08:00
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 BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
2003-12-07 15:50:23 +08:00
2005-11-26 03:23:13 +08:00
Zeilenga draft-zeilenga-ldap-uuid-06 [Page 7]
2003-12-07 15:50:23 +08:00
2005-11-26 03:23:13 +08:00
INTERNET-DRAFT LDAP entryUUID 18 July 2005
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
http://www.ietf.org/ipr.
2003-06-01 06:47:07 +08:00
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
2005-11-26 03:23:13 +08:00
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
ietf-ipr@ietf.org.
2003-06-01 06:47:07 +08:00
Full Copyright
2005-11-26 03:23:13 +08:00
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.
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.
2003-06-01 06:47:07 +08:00
2005-11-26 03:23:13 +08:00
Zeilenga draft-zeilenga-ldap-uuid-06 [Page 8]
2003-06-01 06:47:07 +08:00