From 569a17d5e29f0ee576f8282cd8093e2b284c2da7 Mon Sep 17 00:00:00 2001 From: Pierangelo Masarati Date: Mon, 27 Oct 2008 20:21:40 +0000 Subject: [PATCH] add Dereference Control I.D. (needs xml2rfc) --- doc/drafts/draft-masarati-ldap-deref-xx.txt | 728 ++++++++++++++++++++ doc/drafts/draft-masarati-ldap-deref.xml | 337 +++++++++ 2 files changed, 1065 insertions(+) create mode 100644 doc/drafts/draft-masarati-ldap-deref-xx.txt create mode 100644 doc/drafts/draft-masarati-ldap-deref.xml diff --git a/doc/drafts/draft-masarati-ldap-deref-xx.txt b/doc/drafts/draft-masarati-ldap-deref-xx.txt new file mode 100644 index 0000000000..77c8ee6a0c --- /dev/null +++ b/doc/drafts/draft-masarati-ldap-deref-xx.txt @@ -0,0 +1,728 @@ + + + +Network Working Group P. Masarati +Internet-Draft Politecnico di Milano +Intended status: Standards Track H. Chu +Expires: April 30, 2009 Symas Corp. + October 27, 2008 + + + LDAP Dereference Control + draft-masarati-ldap-deref.txt + +Status of this Memo + + 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. + + Internet-Drafts are working documents of the Internet Engineering + Task Force (IETF), its areas, and its working groups. Note that + other groups may also distribute working documents as Internet- + Drafts. + + Internet-Drafts are draft documents valid for a maximum of six months + and may be updated, replaced, or obsoleted by other documents at any + time. It is inappropriate to use Internet-Drafts as reference + material or to cite them other than as "work in progress." + + The list of current Internet-Drafts can be accessed at + http://www.ietf.org/ietf/1id-abstracts.txt. + + The list of Internet-Draft Shadow Directories can be accessed at + http://www.ietf.org/shadow.html. + + This Internet-Draft will expire on April 30, 2009. + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 1] + +Internet-Draft LDAP Deref October 2008 + + +Abstract + + This document describes the Dereference Control for LDAP. This + control is intended to provide a concise means to collect extra + information related to cross-links present in entries returned as + part of search responses. + + +Table of Contents + + 1. Background and Intended Use . . . . . . . . . . . . . . . . . 3 + 2. The LDAP Dereference Control . . . . . . . . . . . . . . . . . 4 + 2.1. Control Semantics . . . . . . . . . . . . . . . . . . . . 4 + 2.2. Control Request . . . . . . . . . . . . . . . . . . . . . 5 + 2.3. Control Response . . . . . . . . . . . . . . . . . . . . . 5 + 3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 + 4. Implementation Notes . . . . . . . . . . . . . . . . . . . . . 7 + 5. Security Considerations . . . . . . . . . . . . . . . . . . . 8 + 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9 + 6.1. Object Identifier Registration . . . . . . . . . . . . . . 9 + 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 10 + 8. Normative References . . . . . . . . . . . . . . . . . . . . . 11 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 12 + Intellectual Property and Copyright Statements . . . . . . . . . . 13 + + + + + + + + + + + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 2] + +Internet-Draft LDAP Deref October 2008 + + +1. Background and Intended Use + + Cross-links between entries are often used to describe relationships + between entries. To exploit the uniqueness of entries naming, these + links are usually represented by the distinguished name (DN) of the + linked entries. + + In many cases, DUAs need to collect information about linked entries. + This requires to explicitly dereference each linked entry in order to + collect the desired attributes, resulting in the need to perform a + specific sequence of search operations, using the links as search + base, with a SearchRequest.scope of baseObject [RFC4511]. + + This document describes a LDAP Control [RFC4511] that allows a DUA to + request the DSA to return specific attributes of linked entries along + with the link, under the assumption that this operation can be + performed by the DSA in a more efficient manner than the DUA would + itself by performing the complete sequence of required search + operations. + + 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 [RFC2119]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 3] + +Internet-Draft LDAP Deref October 2008 + + +2. The LDAP Dereference Control + +2.1. Control Semantics + + This control allows specifying a dereference attribute and a set of + attributes to be dereferenced, as illustrated in Section 2.2. The + dereference attribute's syntax MUST be 1.3.6.1.4.1.1466.115.121.1.12 + (DN) [RFC4517]. Each value of the dereference attribute in a + SearchResultEntry SHOULD result in dereferencing the corresponding + entry, collecting the values of the attributes to be dereferenced, + and returning them as part of the control value in the + SearchResultEntry response, in the format detailed in Section 2.3. + + The control value may contain dereference attribute values without + any dereferenced attribute values, as detailed in Section 2.3. The + control semantics does not specify whether this is a consequence of a + dangling link or of the application of access restrictions on the + values of the attributes to be dereferenced. + + Attribute description hierarchy [RFC4512] SHALL NOT be exploited when + collecting the values of the attributes to be dereferenced. On the + contrary, all of the attribute descriptions in an attribute hierarchy + SHOULD be treated as distinct and unrelated descriptions. + + This control is only appropriate for the search operation [RFC4511]. + This control MUST be ignored if the Search was requested with + SearchRequest.typesOnly specified as TRUE. The dereference attribute + MUST be part of the search result set. + + The semantics of the criticality field are specified in [RFC4511]. + In detail, the criticality of the control determines whether the + control will or will not be used, and if it will not be used, whether + the operation will continue without the control, or fail returning + unavailableCriticalExtension. If the control is appropriate for an + operation and, for any reason, it cannot be applied in its entirety + to a single SearchResultEntry response, it MUST NOT be applied to + that specific SearchResultEntry response, without affecting its + application to any subsequent SearchResultEntry response. + + This control is totally unrelated to alias dereferencing [RFC4511]. + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 4] + +Internet-Draft LDAP Deref October 2008 + + +2.2. Control Request + + The specification of the Dereference Control request is: + + controlValue ::= SEQUENCE OF derefSpec DerefSpec + + DerefSpec ::= SEQUENCE { + derefAttr attributeDescription, ; with DN syntax + attributes AttributeList } + + AttributeList ::= SEQUENCE OF attr AttributeDescription + + Each derefSpec.derefAttr MUST be unique within controlValue. + +2.3. Control Response + + The specification of the Dereference Control response is: + + controlValue ::= SEQUENCE OF derefRes DerefRes + + DerefRes ::= SEQUENCE { + derefAttr AttributeDescription, + derefVal LDAPDN, + attrVals [0] PartialAttributeList OPTIONAL } + + PartialAttributeList ::= SEQUENCE OF + partialAttribute PartialAttribute + + PartialAttribute is defined in [RFC4511]; the definition is reported + here for clarity: + + PartialAttribute ::= SEQUENCE { + type AttributeDescription, + vals SET OF value AttributeValue } + + If partialAttribute.vals is empty, the corresponding partialAttribute + is omitted. If all partialAttribute.vals in attrVals are empty, that + derefRes.attrVals is omitted. + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 5] + +Internet-Draft LDAP Deref October 2008 + + +3. Examples + + Given these entries: + + dn: cn=Howard Chu,ou=people,dc=OpenLDAP,dc=org + objectClass: inetOrgPerson + cn: Howard Chu + sn: Chu + uid: hyc + + dn: Pierangelo Masarati,ou=people,dc=OpenLDAP,dc=org + objectClass: inetOrgPerson + cn: Pierangelo Masarati + sn: Masarati + uid: ando + + dn: cn=Test Group,ou=groups,dc=OpenLDAP,dc=org + objectClass: groupOfNames + cn: test Group + member: cn=Howard Chu,ou=people,dc=OpenLDAP,dc=org + member: cn=Pierangelo,Masarati,ou=people,dc=OpenLDAP,dc=org + + A search could be performed with a Dereference request control value + specified as + + { member, uid } + + and the "cn=Test Group" entry would be returned with the response + control value + + { { member, cn=Howard Chu,ou=people,dc=OpenLDAP,dc=org, + { { uid, [hyc] } } }, + { member, cn=Pierangelo Masarati,ou=people,dc=OpenLDAP,dc=org, + { { uid, [ando] } } } } + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 6] + +Internet-Draft LDAP Deref October 2008 + + +4. Implementation Notes + + This LDAP extension is currently implemented in OpenLDAP software. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 7] + +Internet-Draft LDAP Deref October 2008 + + +5. Security Considerations + + The control result MUST NOT disclose information the client's + identity could not have accessed by performing the related search + operations. The presence of a derefRes.derefVal in the response + control, with no derefRes.attrVals, does not imply neither the + existence of nor any access privilege to the corresponding entry. It + is merely a consequence of the read access the client's identity has + on the corresponding value of the derefRes.derefAttr that would be + returned as part of the attributes of a SearchResultEntry [RFC4511]. + + Security considerations described in documents listed in [RFC4510] + apply. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 8] + +Internet-Draft LDAP Deref October 2008 + + +6. IANA Considerations + +6.1. Object Identifier Registration + + It is requested that IANA register upon Standards Action an LDAP + Object Identifier for use in this technical specification. + + Subject: Request for LDAP OID Registration + Person & email address to contact for further information: + Pierangelo Masarati + Specification: (I-D) + Author/Change Controller: IESG + Comments: + Identifies the LDAP Dereference Control request + and response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 9] + +Internet-Draft LDAP Deref October 2008 + + +7. Acknowledgments + + TBD + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 10] + +Internet-Draft LDAP Deref October 2008 + + +8. Normative References + + [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate + Requirement Levels", BCP 14, RFC 2119, March 1997. + + [RFC4510] Zeilenga, K., "Lightweight Directory Access Protocol + (LDAP): Technical Specification Road Map", RFC 4510, + June 2006. + + [RFC4511] Sermersheim, J., "Lightweight Directory Access Protocol + (LDAP): The Protocol", RFC 4511, June 2006. + + [RFC4512] Zeilenga, K., "Lightweight Directory Access Protocol + (LDAP): Directory Information Models", RFC 4512, + June 2006. + + [RFC4517] Legg, S., "Lightweight Directory Access Protocol (LDAP): + Syntaxes and Matching Rules", RFC 4517, June 2006. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 11] + +Internet-Draft LDAP Deref October 2008 + + +Authors' Addresses + + Pierangelo Masarati + Politecnico di Milano + Dipartimento di Ingegneria Aerospaziale + via La Masa 34 + Milano 20156 + IT + + Phone: +39 02 2399 8309 + Fax: +39 02 2399 8334 + Email: ando@OpenLDAP.org + URI: http://www.aero.polimi.it/masarati/ + + + Howard Y. Chu + Symas Corporation + 18740 Oxnard St., Suite 313A + Tarzana, California 91356 + USA + + Phone: +1 818 757-7087 + Email: hyc@symas.com + URI: http://www.symas.com/ + + + + + + + + + + + + + + + + + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 12] + +Internet-Draft LDAP Deref October 2008 + + +Full Copyright Statement + + Copyright (C) The IETF Trust (2008). + + 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, THE IETF TRUST 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 + ietf-ipr@ietf.org. + + + + + + + + + + + +Masarati & Chu Expires April 30, 2009 [Page 13] + diff --git a/doc/drafts/draft-masarati-ldap-deref.xml b/doc/drafts/draft-masarati-ldap-deref.xml new file mode 100644 index 0000000000..dd7eb06888 --- /dev/null +++ b/doc/drafts/draft-masarati-ldap-deref.xml @@ -0,0 +1,337 @@ + + + + + + + +]> + + + + + + + + + + + + + + + LDAP Dereference Control + + + Politecnico di Milano + +
+ + Dipartimento di Ingegneria Aerospaziale + via La Masa 34 + Milano + 20156 + IT + + +39 02 2399 8309 + +39 02 2399 8334 + ando@OpenLDAP.org + http://www.aero.polimi.it/masarati/ +
+
+ + + Symas Corporation + +
+ + 18740 Oxnard St., Suite 313A + Tarzana + California + 91356 + USA + + +1 818 757-7087 + hyc@symas.com + http://www.symas.com/ +
+
+ + + + +This document describes the Dereference Control for LDAP. +This control is intended to provide a concise means to collect +extra information related to cross-links present in entries +returned as part of search responses. + + +
+ + +
+ +Cross-links between entries are often used to describe relationships +between entries. +To exploit the uniqueness of entries naming, these links are usually +represented by the distinguished name (DN) of the linked entries. + + + +In many cases, DUAs need to collect information about linked entries. +This requires to explicitly dereference each linked entry in order to +collect the desired attributes, resulting in the need to perform a +specific sequence of search operations, using the links as search base, +with a SearchRequest.scope of baseObject . + + + +This document describes a LDAP Control +that allows a DUA to request the DSA to return specific attributes +of linked entries along with the link, under the assumption that +this operation can be performed by the DSA in a more efficient manner +than the DUA would itself by performing the complete sequence +of required search operations. + + + +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 . + +
+ +
+
+ +This control allows specifying a dereference attribute and a set +of attributes to be dereferenced, as illustrated +in . +The dereference attribute's syntax MUST be 1.3.6.1.4.1.1466.115.121.1.12 +(DN) . +Each value of the dereference attribute in a SearchResultEntry SHOULD +result in dereferencing the corresponding entry, collecting the values +of the attributes to be dereferenced, and returning them as part +of the control value in the SearchResultEntry response, in the format +detailed in . + + + +The control value may contain dereference attribute values without any +dereferenced attribute values, as detailed in +. +The control semantics does not specify whether this is a consequence +of a dangling link or of the application of access restrictions +on the values of the attributes to be dereferenced. + + + +Attribute description hierarchy SHALL NOT +be exploited when collecting the values of the attributes +to be dereferenced. +On the contrary, all of the attribute descriptions in an attribute +hierarchy SHOULD be treated as distinct and unrelated descriptions. + + + +This control is only appropriate for the search operation +. This control MUST be ignored if the +Search was requested with SearchRequest.typesOnly specified as TRUE. +The dereference attribute MUST be part of the search result set. + + + +The semantics of the criticality field are specified in +. +In detail, the criticality of the control determines whether the control +will or will not be used, and if it will not be used, whether the operation +will continue without the control, or fail returning +unavailableCriticalExtension. +If the control is appropriate for an operation and, for any reason, +it cannot be applied in its entirety to a single SearchResultEntry response, +it MUST NOT be applied to that specific SearchResultEntry response, +without affecting its application to any subsequent SearchResultEntry +response. + + + +This control is totally unrelated to alias dereferencing +. + +
+ +
+
+ +The specification of the Dereference Control request is: + + + controlValue ::= SEQUENCE OF derefSpec DerefSpec + + DerefSpec ::= SEQUENCE { + derefAttr attributeDescription, ; with DN syntax + attributes AttributeList } + + AttributeList ::= SEQUENCE OF attr AttributeDescription + + +Each derefSpec.derefAttr MUST be unique within controlValue. + +
+
+ +
+
+ +The specification of the Dereference Control response is: + + + controlValue ::= SEQUENCE OF derefRes DerefRes + + DerefRes ::= SEQUENCE { + derefAttr AttributeDescription, + derefVal LDAPDN, + attrVals [0] PartialAttributeList OPTIONAL } + + PartialAttributeList ::= SEQUENCE OF + partialAttribute PartialAttribute + +
+
+ +PartialAttribute is defined in ; +the definition is reported here for clarity: + + + PartialAttribute ::= SEQUENCE { + type AttributeDescription, + vals SET OF value AttributeValue } + + +If partialAttribute.vals is empty, the corresponding partialAttribute +is omitted. +If all partialAttribute.vals in attrVals are empty, that derefRes.attrVals +is omitted. + +
+
+
+ +
+
+ +Given these entries: + + + dn: cn=Howard Chu,ou=people,dc=OpenLDAP,dc=org + objectClass: inetOrgPerson + cn: Howard Chu + sn: Chu + uid: hyc + + dn: Pierangelo Masarati,ou=people,dc=OpenLDAP,dc=org + objectClass: inetOrgPerson + cn: Pierangelo Masarati + sn: Masarati + uid: ando + + dn: cn=Test Group,ou=groups,dc=OpenLDAP,dc=org + objectClass: groupOfNames + cn: test Group + member: cn=Howard Chu,ou=people,dc=OpenLDAP,dc=org + member: cn=Pierangelo,Masarati,ou=people,dc=OpenLDAP,dc=org + +
+
+ +A search could be performed with a Dereference request control value +specified as + + + { member, uid } + +
+
+ +and the "cn=Test Group" entry would be returned with the response control +value + + + { { member, cn=Howard Chu,ou=people,dc=OpenLDAP,dc=org, + { { uid, [hyc] } } }, + { member, cn=Pierangelo Masarati,ou=people,dc=OpenLDAP,dc=org, + { { uid, [ando] } } } } + +
+
+ +
+ +This LDAP extension is currently implemented in OpenLDAP software. + +
+ +
+ +The control result MUST NOT disclose information the client's identity +could not have accessed by performing the related search operations. +The presence of a derefRes.derefVal in the response control, with +no derefRes.attrVals, does not imply neither the existence of nor any +access privilege to the corresponding entry. +It is merely a consequence of the read access the client's identity has +on the corresponding value of the derefRes.derefAttr that would be returned +as part of the attributes of a SearchResultEntry . + + +Security considerations described in documents listed in + apply. + +
+ +
+
+
+ +It is requested that IANA register upon Standards Action an LDAP +Object Identifier for use in this technical specification. + + + Subject: Request for LDAP OID Registration + Person & email address to contact for further information: + Pierangelo Masarati <ando@OpenLDAP.org> + Specification: (I-D) + Author/Change Controller: IESG + Comments: + Identifies the LDAP Dereference Control request + and response + +
+
+
+ +
+ +TBD + +
+
+ + + + &rfc2119; + &rfc4510; + &rfc4511; + &rfc4512; + &rfc4517; + + + + +
-- 2.39.5