4530
PROPOSED STANDARD
Lightweight Directory Access Protocol (LDAP) entryUUID Operational Attribute
Authors: K. Zeilenga
Date: June 2006
Working Group: NON WORKING GROUP
Stream: IETF
Abstract
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. [STANDARDS-TRACK]
RFC 4530
PROPOSED STANDARD
Network Working Group K. Zeilenga
Request for Comments: 4530 OpenLDAP Foundation
Category: Standards Track June 2006
<span class="h1">Lightweight Directory Access Protocol (LDAP)</span>
<span class="h1">entryUUID Operational Attribute</span>
Status of This Memo
This document specifies an Internet standards track protocol for the
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.
Copyright Notice
Copyright (C) The Internet Society (2006).
Abstract
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.
<span class="grey">Zeilenga Standards Track [Page 1]</span><span id="page-2" ></span>
<span class="grey"><a href="./rfc4530">RFC 4530</a> LDAP entryUUID June 2006</span>
Table of Contents
<a href="#section-1">1</a>. Background and Intended Use .....................................<a href="#page-2">2</a>
<a href="#section-2">2</a>. UUID Schema Elements ............................................<a href="#page-3">3</a>
<a href="#section-2.1">2.1</a>. UUID Syntax ................................................<a href="#page-3">3</a>
<a href="#section-2.2">2.2</a>. 'uuidMatch' Matching Rule ..................................<a href="#page-3">3</a>
<a href="#section-2.3">2.3</a>. 'uuidOrderingMatch' Matching Rule ..........................<a href="#page-3">3</a>
<a href="#section-2.4">2.4</a>. 'entryUUID' Attribute ......................................<a href="#page-4">4</a>
<a href="#section-3">3</a>. Security Considerations .........................................<a href="#page-4">4</a>
<a href="#section-4">4</a>. IANA Considerations .............................................<a href="#page-5">5</a>
<a href="#section-4.1">4.1</a>. Object Identifier Registration .............................<a href="#page-5">5</a>
<a href="#section-4.2">4.2</a>. UUID Syntax Registration ...................................<a href="#page-5">5</a>
<a href="#section-4.3">4.3</a>. 'uuidMatch' Descriptor Registration ........................<a href="#page-5">5</a>
<a href="#section-4.4">4.4</a>. 'uuidOrderingMatch' Descriptor Registration ................<a href="#page-5">5</a>
<a href="#section-4.5">4.5</a>. 'entryUUID' Descriptor Registration ........................<a href="#page-6">6</a>
<a href="#section-5">5</a>. Acknowledgements ................................................<a href="#page-6">6</a>
<a href="#section-6">6</a>. References ......................................................<a href="#page-6">6</a>
<a href="#section-6.1">6.1</a>. Normative References .......................................<a href="#page-6">6</a>
<a href="#section-6.2">6.2</a>. Informative References .....................................<a href="#page-7">7</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Background and Intended Use</span>
In X.500 Directory Services [<a href="#ref-X.501" title=""The Directory -- Models,"">X.501</a>], such as those accessible using
the Lightweight Directory Access Protocol (LDAP) [<a href="./rfc4510" title=""Lightweight Directory Access Protocol (LDAP): Technical Specification Road Map"">RFC4510</a>], 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
that 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"
[<a href="./rfc4122" title=""A Universally Unique IDentifier (UUID) URN Namespace"">RFC4122</a>]. UUIDs are used in a wide range of systems.
This document describes the 'entryUUID' operational attribute, which
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.
This document defines the UUID syntax, the 'uuidMatch' and
'uuidOrderingMatch' matching rules, and the 'entryUUID' attribute
type.
Schema definitions are provided using LDAP description formats
[<a href="./rfc4512" title=""Lightweight Directory Access Protocol (LDAP): Directory Information Models"">RFC4512</a>]. Definitions provided here are formatted (line wrapped)
for readability.
<span class="grey">Zeilenga Standards Track [Page 2]</span><span id="page-3" ></span>
<span class="grey"><a href="./rfc4530">RFC 4530</a> LDAP entryUUID June 2006</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>].
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. UUID Schema Elements</span>
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. UUID Syntax</span>
A Universally Unique Identifier (UUID) [<a href="./rfc4122" title=""A Universally Unique IDentifier (UUID) URN Namespace"">RFC4122</a>] is a 16-octet (128-
bit) value that identifies an object. The ASN.1 [<a href="#ref-X.680" title=""Abstract Syntax Notation One (ASN.1) - Specification of Basic Notation"">X.680</a>] type UUID is
defined to represent UUIDs as follows:
UUID ::= OCTET STRING (SIZE(16))
-- constrained to an UUID [<a href="./rfc4122" title=""A Universally Unique IDentifier (UUID) URN Namespace"">RFC4122</a>]
In LDAP, UUID values are encoded using the [<a href="#ref-ASCII">ASCII</a>] character string
representation described in [<a href="./rfc4122" title=""A Universally Unique IDentifier (UUID) URN Namespace"">RFC4122</a>]. For example,
"597ae2f6-16a6-1027-98f4-d28b5365dc14".
The following is an LDAP syntax description suitable for publication
in subschema subentries.
( 1.3.6.1.1.16.1 DESC 'UUID' )
<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. 'uuidMatch' Matching Rule</span>
The 'uuidMatch' matching rule compares an asserted UUID with a stored
UUID for equality. Its semantics are the same as the
'octetStringMatch' [<a href="#ref-X.520" title=""The Directory: Selected Attribute Types"">X.520</a>][RFC4517] 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 representation.
The following is an LDAP matching rule description suitable for
publication in subschema subentries.
( 1.3.6.1.1.16.2 NAME 'uuidMatch'
SYNTAX 1.3.6.1.1.16.1 )
<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. 'uuidOrderingMatch' Matching Rule</span>
The 'uuidOrderingMatch' matching rule compares an asserted UUID with
a stored UUID for ordering. Its semantics are the same as the
'octetStringOrderingMatch' [<a href="#ref-X.520" title=""The Directory: Selected Attribute Types"">X.520</a>][RFC4517] 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.
<span class="grey">Zeilenga Standards Track [Page 3]</span><span id="page-4" ></span>
<span class="grey"><a href="./rfc4530">RFC 4530</a> LDAP entryUUID June 2006</span>
The following is an LDAP matching rule description suitable for
publication in subschema subentries.
( 1.3.6.1.1.16.3 NAME 'uuidOrderingMatch'
SYNTAX 1.3.6.1.1.16.1 )
Note that not all UUID variants have a defined ordering; and even
where it does, servers are not obligated to assign UUIDs in any
particular order. This matching rule is provided for completeness.
<span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. 'entryUUID' Attribute</span>
The 'entryUUID' operational attribute provides the Universally Unique
Identifier (UUID) assigned to the entry.
The following is an LDAP attribute type description suitable for
publication in subschema subentries.
( 1.3.6.1.1.16.4 NAME 'entryUUID'
DESC 'UUID of the entry'
EQUALITY uuidMatch
ORDERING uuidOrderingMatch
SYNTAX 1.3.6.1.1.16.1
SINGLE-VALUE
NO-USER-MODIFICATION
USAGE directoryOperation )
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
'entryUUID' operational attribute. An entry's UUID is immutable.
UUID are to be generated in accordance with <a href="./rfc4122#section-4">Section 4 of [RFC4122]</a>.
In particular, servers MUST ensure that each generated UUID is unique
in space and time.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Security Considerations</span>
An entry's relative distinguish name (RDN) is composed from attribute
values of the entry, which are commonly descriptive of the object the
entry represents. Although deployers are encouraged to use naming
attributes whose values are widely disclosable [<a href="./rfc4514" title=""Lightweight Directory Access Protocol (LDAP): String Representation of Distinguished Names"">RFC4514</a>], entries are
often named using information that 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 [<a href="./rfc4122" title=""A Universally Unique IDentifier (UUID) URN Namespace"">RFC4122</a>] apply.
<span class="grey">Zeilenga Standards Track [Page 4]</span><span id="page-5" ></span>
<span class="grey"><a href="./rfc4530">RFC 4530</a> LDAP entryUUID June 2006</span>
General LDAP security considerations [<a href="./rfc4510" title=""Lightweight Directory Access Protocol (LDAP): Technical Specification Road Map"">RFC4510</a>] apply.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. IANA Considerations</span>
The IANA has registered the LDAP values [<a href="./rfc4520" title=""Internet Assigned Numbers Authority (IANA) Considerations for the Lightweight Directory Access Protocol (LDAP)"">RFC4520</a>] specified in this
document.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Object Identifier Registration</span>
Subject: Request for LDAP OID Registration
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Specification: <a href="./rfc4530">RFC 4530</a>
Author/Change Controller: IESG
Comments:
Identifies the UUID schema elements
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. UUID Syntax Registration</span>
Subject: Request for LDAP Syntax Registration
Object Identifier: 1.3.6.1.1.16.1
Description: UUID
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Specification: <a href="./rfc4530">RFC 4530</a>
Author/Change Controller: IESG
Comments:
Identifies the UUID syntax
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. 'uuidMatch' Descriptor Registration</span>
Subject: Request for LDAP Descriptor Registration
Descriptor (short name): uuidMatch
Object Identifier: 1.3.6.1.1.16.2
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Usage: Matching Rule
Specification: <a href="./rfc4530">RFC 4530</a>
Author/Change Controller: IESG
<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. 'uuidOrderingMatch' Descriptor Registration</span>
Subject: Request for LDAP Descriptor Registration
Descriptor (short name): uuidOrderingMatch
Object Identifier: 1.3.6.1.1.16.3
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Usage: Matching Rule
<span class="grey">Zeilenga Standards Track [Page 5]</span><span id="page-6" ></span>
<span class="grey"><a href="./rfc4530">RFC 4530</a> LDAP entryUUID June 2006</span>
Specification: <a href="./rfc4530">RFC 4530</a>
Author/Change Controller: IESG
<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>. 'entryUUID' Descriptor Registration</span>
The IANA has registered the LDAP 'entryUUID' descriptor.
Subject: Request for LDAP Descriptor Registration
Descriptor (short name): entryUUID
Object Identifier: 1.3.6.1.1.16.4
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Usage: Attribute Type
Specification: <a href="./rfc4530">RFC 4530</a>
Author/Change Controller: IESG
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Acknowledgements</span>
This document is based upon discussions in the LDAP Update and
Duplication Protocols (LDUP) WG. Members of the LDAP Directorate
provided review.
<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-RFC4122">RFC4122</a>] Leach, P., Mealling, M., and R. Salz, "A Universally
Unique IDentifier (UUID) URN Namespace", <a href="./rfc4122">RFC 4122</a>, July
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-RFC4512">RFC4512</a>] Zeilenga, K., "Lightweight Directory Access Protocol
(LDAP): Directory Information Models", <a href="./rfc4512">RFC 4512</a>, June
2006.
[<a id="ref-RFC4517">RFC4517</a>] Legg, S., Ed., "Lightweight Directory Access Protocol
(LDAP): Syntaxes and Matching Rules", <a href="./rfc4517">RFC 4517</a>, June
2006.
[<a id="ref-ASCII">ASCII</a>] Coded Character Set--7-bit American Standard Code for
Information Interchange, ANSI X3.4-1986.
<span class="grey">Zeilenga Standards Track [Page 6]</span><span id="page-7" ></span>
<span class="grey"><a href="./rfc4530">RFC 4530</a> LDAP entryUUID June 2006</span>
[<a id="ref-X.501">X.501</a>] International Telecommunication Union -
Telecommunication Standardization Sector, "The
Directory -- Models," X.501(1993) (also ISO/IEC 9594-
2:1994).
[<a id="ref-X.520">X.520</a>] International Telecommunication Union -
Telecommunication Standardization Sector, "The
Directory: Selected Attribute Types", X.520(1993) (also
ISO/IEC 9594-6:1994).
[<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-RFC4514">RFC4514</a>] Zeilenga, K., Ed., "Lightweight Directory Access
Protocol (LDAP): String Representation of Distinguished
Names", <a href="./rfc4514">RFC 4514</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.
Author's Address
Kurt D. Zeilenga
OpenLDAP Foundation
EMail: [email protected]
<span class="grey">Zeilenga Standards Track [Page 7]</span><span id="page-8" ></span>
<span class="grey"><a href="./rfc4530">RFC 4530</a> LDAP entryUUID 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 Standards Track [Page 8]
Annotations
Select text to annotate