Difference between revisions of "RFC4530"
Line 6: | Line 6: | ||
entryUUID Operational Attribute | entryUUID Operational Attribute | ||
− | Status of This Memo | + | '''Status of This Memo''' |
This document specifies an Internet standards track protocol for the | This document specifies an Internet standards track protocol for the | ||
Internet community, and requests discussion and suggestions for | Internet community, and requests discussion and suggestions for | ||
improvements. Please refer to the current edition of the "Internet | improvements. Please refer to the current edition of the "Internet | ||
− | Official Protocol Standards" (STD 1) for the standardization state | + | Official Protocol Standards" ([[STD1|STD 1]]) for the standardization state |
and status of this protocol. Distribution of this memo is unlimited. | and status of this protocol. Distribution of this memo is unlimited. | ||
− | Copyright Notice | + | '''Copyright Notice''' |
Copyright (C) The Internet Society (2006). | Copyright (C) The Internet Society (2006). | ||
− | Abstract | + | '''Abstract''' |
This document describes the LDAP/X.500 'entryUUID' operational | This document describes the LDAP/X.500 'entryUUID' operational | ||
Line 26: | Line 26: | ||
objects identified by a distinguished name or to locate an object | objects identified by a distinguished name or to locate an object | ||
after renaming. | after renaming. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Background and Intended Use == | == Background and Intended Use == | ||
In X.500 Directory Services [X.501], such as those accessible using | In X.500 Directory Services [X.501], such as those accessible using | ||
− | the Lightweight Directory Access Protocol (LDAP) [RFC4510], an object | + | the Lightweight Directory Access Protocol (LDAP) [[RFC4510]], an object |
is identified by its distinguished name (DN). However, DNs are not | is identified by its distinguished name (DN). However, DNs are not | ||
stable identifiers. That is, a new object may be identified by a DN | stable identifiers. That is, a new object may be identified by a DN | ||
Line 57: | Line 37: | ||
A Universally Unique Identifier (UUID) is "an identifier unique | A Universally Unique Identifier (UUID) is "an identifier unique | ||
across both space and time, with respect to the space of all UUIDs" | across both space and time, with respect to the space of all UUIDs" | ||
− | [RFC4122]. UUIDs are used in a wide range of systems. | + | [[RFC4122]]. UUIDs are used in a wide range of systems. |
This document describes the 'entryUUID' operational attribute, which | This document describes the 'entryUUID' operational attribute, which | ||
Line 69: | Line 49: | ||
Schema definitions are provided using LDAP description formats | Schema definitions are provided using LDAP description formats | ||
− | [RFC4512]. Definitions provided here are formatted (line wrapped) | + | [[RFC4512]]. Definitions provided here are formatted (line wrapped) |
for readability. | for readability. | ||
In this document, the key words "MUST", "MUST NOT", "REQUIRED", | In this document, the key words "MUST", "MUST NOT", "REQUIRED", | ||
"SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", | "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", | ||
− | and "OPTIONAL" are to be interpreted as described in BCP 14 | + | and "OPTIONAL" are to be interpreted as described in [[BCP14|BCP 14]] |
− | [RFC2119]. | + | [[RFC2119]]. |
== UUID Schema Elements == | == UUID Schema Elements == | ||
Line 81: | Line 61: | ||
=== UUID Syntax === | === UUID Syntax === | ||
− | A Universally Unique Identifier (UUID) [RFC4122] is a 16-octet (128- | + | A Universally Unique Identifier (UUID) [[RFC4122]] is a 16-octet (128- |
bit) value that identifies an object. The ASN.1 [X.680] type UUID is | bit) value that identifies an object. The ASN.1 [X.680] type UUID is | ||
defined to represent UUIDs as follows: | defined to represent UUIDs as follows: | ||
UUID ::= OCTET STRING (SIZE(16)) | UUID ::= OCTET STRING (SIZE(16)) | ||
− | -- constrained to an UUID [RFC4122] | + | -- constrained to an UUID [[RFC4122]] |
In LDAP, UUID values are encoded using the [ASCII] character string | In LDAP, UUID values are encoded using the [ASCII] character string | ||
− | representation described in [RFC4122]. For example, | + | representation described in [[RFC4122]]. For example, |
"597ae2f6-16a6-1027-98f4-d28b5365dc14". | "597ae2f6-16a6-1027-98f4-d28b5365dc14". | ||
Line 101: | Line 81: | ||
The 'uuidMatch' matching rule compares an asserted UUID with a stored | The 'uuidMatch' matching rule compares an asserted UUID with a stored | ||
UUID for equality. Its semantics are the same as the | UUID for equality. Its semantics are the same as the | ||
− | 'octetStringMatch' [X.520][RFC4517] matching rule. The rule differs | + | 'octetStringMatch' [X.520][[RFC4517]] matching rule. The rule differs |
from 'octetStringMatch' in that the assertion value is encoded using | from 'octetStringMatch' in that the assertion value is encoded using | ||
the UUID string representation instead of the normal OCTET STRING | the UUID string representation instead of the normal OCTET STRING | ||
Line 116: | Line 96: | ||
The 'uuidOrderingMatch' matching rule compares an asserted UUID with | The 'uuidOrderingMatch' matching rule compares an asserted UUID with | ||
a stored UUID for ordering. Its semantics are the same as the | a stored UUID for ordering. Its semantics are the same as the | ||
− | 'octetStringOrderingMatch' [X.520][RFC4517] matching rule. The rule | + | 'octetStringOrderingMatch' [X.520][[RFC4517]] matching rule. The rule |
differs from 'octetStringOrderingMatch' in that the assertion value | differs from 'octetStringOrderingMatch' in that the assertion value | ||
is encoded using the UUID string representation instead of the normal | is encoded using the UUID string representation instead of the normal | ||
Line 152: | Line 132: | ||
'entryUUID' operational attribute. An entry's UUID is immutable. | 'entryUUID' operational attribute. An entry's UUID is immutable. | ||
− | UUID are to be generated in accordance with Section 4 of [RFC4122]. | + | UUID are to be generated in accordance with Section 4 of [[RFC4122]]. |
In particular, servers MUST ensure that each generated UUID is unique | In particular, servers MUST ensure that each generated UUID is unique | ||
in space and time. | in space and time. | ||
Line 161: | Line 141: | ||
values of the entry, which are commonly descriptive of the object the | values of the entry, which are commonly descriptive of the object the | ||
entry represents. Although deployers are encouraged to use naming | entry represents. Although deployers are encouraged to use naming | ||
− | attributes whose values are widely disclosable [RFC4514], entries are | + | attributes whose values are widely disclosable [[RFC4514]], entries are |
often named using information that cannot be disclosed to all | often named using information that cannot be disclosed to all | ||
parties. As UUIDs do not contain any descriptive information of the | parties. As UUIDs do not contain any descriptive information of the | ||
Line 167: | Line 147: | ||
entry without disclosure of its contents. | entry without disclosure of its contents. | ||
− | General UUID security considerations [RFC4122] apply. | + | General UUID security considerations [[RFC4122]] apply. |
− | General LDAP security considerations [RFC4510] apply. | + | General LDAP security considerations [[RFC4510]] apply. |
== IANA Considerations == | == IANA Considerations == | ||
− | The IANA has registered the LDAP values [RFC4520] specified in this | + | The IANA has registered the LDAP values [[RFC4520]] specified in this |
document. | document. | ||
Line 181: | Line 161: | ||
Person & email address to contact for further information: | Person & email address to contact for further information: | ||
Kurt Zeilenga <[email protected]> | Kurt Zeilenga <[email protected]> | ||
− | Specification: RFC 4530 | + | Specification: [[RFC4530|RFC 4530]] |
Author/Change Controller: IESG | Author/Change Controller: IESG | ||
Comments: | Comments: | ||
Line 193: | Line 173: | ||
Person & email address to contact for further information: | Person & email address to contact for further information: | ||
Kurt Zeilenga <[email protected]> | Kurt Zeilenga <[email protected]> | ||
− | Specification: RFC 4530 | + | Specification: [[RFC4530|RFC 4530]] |
Author/Change Controller: IESG | Author/Change Controller: IESG | ||
Comments: | Comments: | ||
Line 206: | Line 186: | ||
Kurt Zeilenga <[email protected]> | Kurt Zeilenga <[email protected]> | ||
Usage: Matching Rule | Usage: Matching Rule | ||
− | Specification: RFC 4530 | + | Specification: [[RFC4530|RFC 4530]] |
Author/Change Controller: IESG | Author/Change Controller: IESG | ||
Line 218: | Line 198: | ||
Usage: Matching Rule | Usage: Matching Rule | ||
− | Specification: RFC 4530 | + | Specification: [[RFC4530|RFC 4530]] |
Author/Change Controller: IESG | Author/Change Controller: IESG | ||
Line 231: | Line 211: | ||
Kurt Zeilenga <[email protected]> | Kurt Zeilenga <[email protected]> | ||
Usage: Attribute Type | Usage: Attribute Type | ||
− | Specification: RFC 4530 | + | Specification: [[RFC4530|RFC 4530]] |
Author/Change Controller: IESG | Author/Change Controller: IESG | ||
Line 244: | Line 224: | ||
=== Normative References === | === Normative References === | ||
− | [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate | + | [[RFC2119]] Bradner, S., "Key words for use in RFCs to Indicate |
− | Requirement Levels", BCP 14, RFC 2119, March 1997. | + | Requirement Levels", [[BCP14|BCP 14]], [[RFC2119|RFC 2119]], March 1997. |
− | [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally | + | [[RFC4122]] Leach, P., Mealling, M., and R. Salz, "A Universally |
− | Unique IDentifier (UUID) URN Namespace", RFC 4122, July | + | Unique IDentifier (UUID) URN Namespace", [[RFC4122|RFC 4122]], July |
2005. | 2005. | ||
− | [RFC4510] Zeilenga, K., Ed., "Lightweight Directory Access | + | [[RFC4510]] Zeilenga, K., Ed., "Lightweight Directory Access |
Protocol (LDAP): Technical Specification Road Map", RFC | Protocol (LDAP): Technical Specification Road Map", RFC | ||
4510, June 2006. | 4510, June 2006. | ||
− | [RFC4512] Zeilenga, K., "Lightweight Directory Access Protocol | + | [[RFC4512]] Zeilenga, K., "Lightweight Directory Access Protocol |
− | (LDAP): Directory Information Models", RFC 4512, June | + | (LDAP): Directory Information Models", [[RFC4512|RFC 4512]], June |
2006. | 2006. | ||
− | [RFC4517] Legg, S., Ed., "Lightweight Directory Access Protocol | + | [[RFC4517]] Legg, S., Ed., "Lightweight Directory Access Protocol |
− | (LDAP): Syntaxes and Matching Rules", RFC 4517, June | + | (LDAP): Syntaxes and Matching Rules", [[RFC4517|RFC 4517]], June |
2006. | 2006. | ||
Line 283: | Line 263: | ||
=== Informative References === | === Informative References === | ||
− | [RFC4514] Zeilenga, K., Ed., "Lightweight Directory Access | + | [[RFC4514]] Zeilenga, K., Ed., "Lightweight Directory Access |
Protocol (LDAP): String Representation of Distinguished | Protocol (LDAP): String Representation of Distinguished | ||
− | Names", RFC 4514, June 2006. | + | Names", [[RFC4514|RFC 4514]], June 2006. |
− | [RFC4520] Zeilenga, K., "Internet Assigned Numbers Authority | + | [[RFC4520]] Zeilenga, K., "Internet Assigned Numbers Authority |
(IANA) Considerations for the Lightweight Directory | (IANA) Considerations for the Lightweight Directory | ||
− | Access Protocol (LDAP)", BCP 64, RFC 4520, June 2006. | + | Access Protocol (LDAP)", [[BCP64|BCP 64]], [[RFC4520|RFC 4520]], June 2006. |
Author's Address | Author's Address | ||
Line 303: | Line 283: | ||
This document is subject to the rights, licenses and restrictions | This document is subject to the rights, licenses and restrictions | ||
− | contained in BCP 78, and except as set forth therein, the authors | + | contained in [[BCP78|BCP 78]], and except as set forth therein, the authors |
retain all their rights. | retain all their rights. | ||
Line 323: | Line 303: | ||
made any independent effort to identify any such rights. Information | made any independent effort to identify any such rights. Information | ||
on the procedures with respect to rights in RFC documents can be | on the procedures with respect to rights in RFC documents can be | ||
− | found in BCP 78 and BCP 79. | + | found in [[BCP78|BCP 78]] and [[BCP79|BCP 79]]. |
Copies of IPR disclosures made to the IETF Secretariat and any | Copies of IPR disclosures made to the IETF Secretariat and any | ||
Line 342: | Line 322: | ||
Funding for the RFC Editor function is provided by the IETF | Funding for the RFC Editor function is provided by the IETF | ||
Administrative Support Activity (IASA). | Administrative Support Activity (IASA). | ||
+ | |||
+ | [[Category:Standards Track]] |
Latest revision as of 11:47, 5 October 2020
Network Working Group K. Zeilenga Request for Comments: 4530 OpenLDAP Foundation Category: Standards Track June 2006
Lightweight Directory Access Protocol (LDAP) entryUUID Operational Attribute
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.
Contents
Background and Intended Use
In X.500 Directory Services [X.501], such as those accessible using the Lightweight Directory Access Protocol (LDAP) RFC4510, 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" RFC4122. 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 RFC4512. Definitions provided here are formatted (line wrapped) for readability.
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 BCP 14 RFC2119.
UUID Schema Elements
UUID Syntax
A Universally Unique Identifier (UUID) RFC4122 is a 16-octet (128- bit) value that identifies an object. The ASN.1 [X.680] type UUID is defined to represent UUIDs as follows:
UUID ::= OCTET STRING (SIZE(16)) -- constrained to an UUID RFC4122
In LDAP, UUID values are encoded using the [ASCII] character string representation described in RFC4122. 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' )
'uuidMatch' Matching Rule
The 'uuidMatch' matching rule compares an asserted UUID with a stored UUID for equality. Its semantics are the same as the 'octetStringMatch' [X.520]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 )
'uuidOrderingMatch' Matching Rule
The 'uuidOrderingMatch' matching rule compares an asserted UUID with a stored UUID for ordering. Its semantics are the same as the 'octetStringOrderingMatch' [X.520]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.
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.
'entryUUID' Attribute
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 Section 4 of RFC4122. In particular, servers MUST ensure that each generated UUID is unique in space and time.
Security Considerations
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 RFC4514, 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 RFC4122 apply.
General LDAP security considerations RFC4510 apply.
IANA Considerations
The IANA has registered the LDAP values RFC4520 specified in this document.
Object Identifier Registration
Subject: Request for LDAP OID Registration Person & email address to contact for further information: Kurt Zeilenga <[email protected]> Specification: RFC 4530 Author/Change Controller: IESG Comments: Identifies the UUID schema elements
UUID Syntax Registration
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 <[email protected]> Specification: RFC 4530 Author/Change Controller: IESG Comments: Identifies the UUID syntax
'uuidMatch' Descriptor Registration
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 <[email protected]> Usage: Matching Rule Specification: RFC 4530 Author/Change Controller: IESG
'uuidOrderingMatch' Descriptor Registration
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 <[email protected]> Usage: Matching Rule
Specification: RFC 4530 Author/Change Controller: IESG
'entryUUID' Descriptor Registration
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 <[email protected]> Usage: Attribute Type Specification: RFC 4530 Author/Change Controller: IESG
Acknowledgements
This document is based upon discussions in the LDAP Update and Duplication Protocols (LDUP) WG. Members of the LDAP Directorate provided review.
References
Normative References
RFC2119 Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
RFC4122 Leach, P., Mealling, M., and R. Salz, "A Universally
Unique IDentifier (UUID) URN Namespace", RFC 4122, July 2005.
RFC4510 Zeilenga, K., Ed., "Lightweight Directory Access
Protocol (LDAP): Technical Specification Road Map", RFC 4510, June 2006.
RFC4512 Zeilenga, K., "Lightweight Directory Access Protocol
(LDAP): Directory Information Models", RFC 4512, June 2006.
RFC4517 Legg, S., Ed., "Lightweight Directory Access Protocol
(LDAP): Syntaxes and Matching Rules", RFC 4517, June 2006.
[ASCII] Coded Character Set--7-bit American Standard Code for
Information Interchange, ANSI X3.4-1986.
[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 Notation", X.680(2002) (also ISO/IEC 8824-1:2002).
Informative References
RFC4514 Zeilenga, K., Ed., "Lightweight Directory Access
Protocol (LDAP): String Representation of Distinguished Names", RFC 4514, June 2006.
RFC4520 Zeilenga, K., "Internet Assigned Numbers Authority
(IANA) Considerations for the Lightweight Directory Access Protocol (LDAP)", BCP 64, RFC 4520, June 2006.
Author's Address
Kurt D. Zeilenga OpenLDAP Foundation
EMail: [email protected]
Full Copyright Statement
Copyright (C) The Internet Society (2006).
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.
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 BCP 78 and BCP 79.
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 http://www.ietf.org/ipr.
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).