]> git.sur5r.net Git - openldap/blob - doc/drafts/draft-rharrison-ldap-extpartresp-xx.txt
76a1a47c8c9992e5e77707858fcfd48bf335791d
[openldap] / doc / drafts / draft-rharrison-ldap-extpartresp-xx.txt
1
2 Individual Submission to LDAPExt Working Group              R. Harrison
3 Internet Draft                                             Novell, Inc.
4 Document: draft-rharrison-ldap-extpartresp-01.txt            June, 2000
5 Category: Proposed Standard
6
7
8                        Extended Partial Response
9                     Protocol Enhancement to LDAP v3
10
11
12 Status of this Memo
13
14    This document is an Internet-Draft and is in full conformance with
15    all provisions of Section 10 of RFC2026 [1].
16
17    Internet-Drafts are working documents of the Internet Engineering
18    Task Force (IETF), its areas, and its working groups. Note that
19    other groups may also distribute working documents as Internet-
20    Drafts. Internet-Drafts are draft documents valid for a maximum of
21    six months and may be updated, replaced, or obsoleted by other
22    documents at any time. It is inappropriate to use Internet- Drafts
23    as reference material or to cite them other than as "work in
24    progress."
25    The list of current Internet-Drafts can be accessed at
26    http://www.ietf.org/ietf/1id-abstracts.txt
27    The list of Internet-Draft Shadow Directories can be accessed at
28    http://www.ietf.org/shadow.html.
29
30
31 1. Abstract
32
33    This document describes the ExtendedPartialResponse, an element of
34    LDAP v3 protocol which allows multiple responses to LDAP v3 extended
35    requests.  Extended partial responses are backward compatible with
36    the existing LDAP v3 Extended Operation defined in [LDAPv3].
37
38 2. Conventions used in this document
39
40    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
41    "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in
42    this document are to be interpreted as described in [RFC2119].
43
44
45 3. Motivation for the Extended Partial Response
46
47    The Extended Operation ([LDAPv3] Section 4.12) was defined in LDAP
48    v3 to allow additional operations to be defined as part of the
49    protocol without requiring a new revision of the protocol.
50
51    The LDAP v3 Extended Operation allows for a single extended response
52    to each extended request, but this paradigm may not be sufficient
53    for some directory operations.  For instance, the LDAP search
54    operation is a directory operation that is much more efficient when
55    multiple partial responses are used to service a single request. The
56 \f
57                   LDAP v3 Extended Partial Response         June, 2000
58
59
60    extended partial response generalizes the current extended operation
61    definition to give LDAP server implementers the ability to make use
62    of a single-request-multiple-response paradigm for extended LDAP
63    operations that require it or that would benefit from it.
64
65 4. Element of Protocol
66
67    The ExtendedPartialResponse is defined as
68
69    ExtendedPartialResponse ::= [APPLICATION 25] SEQUENCE {
70            responseName     [0] LDAPOID OPTIONAL,
71            response         [1] OCTET STRING OPTIONAL }
72
73    An LDAP server responds to an LDAP v3 ExtendedRequest with zero or
74    more ExtendedPartialResponses followed by one ExtendedResponse. This
75    ensures backward compatibility with existing LDAP extensions which
76    do not make use of the ExtendedPartialResponse.  As with all LDAP
77    extensions, LDAP extensions that make use of the
78    ExtendedPartialResponse have predefined syntax and semantics that
79    are defined in RFCs or are private to a particular implementation.
80
81 5. Security Considerations
82
83    This draft describes an enhancement to the LDAP v3 protocol
84    [LDAPv3].  All security considerations of [LDAPv3] apply to this
85    draft, however it does not introduce any new security considerations
86    to the LDAP v3 protocol.
87
88 6. References
89
90     [LDAPv3]
91         Wahl, M., Howes, T., and S. Kille, "Lightweight Directory
92         Access Protocol (v3)", RFC 2251, December 1997.
93
94    [ReqsKeywords]
95         Scott Bradner. "Key Words for use in RFCs to Indicate
96         Requirement Levels". RFC 2119.
97
98
99 7. Acknowledgments
100
101    The author would like to acknowledge the readers of the LDAP
102    Extensions working group mail list who responded to the suggestion
103    that a multiple-response paradigm might be useful for LDAP extended
104    requests.  Special thanks go to two individuals: David Wilbur who
105    first introduced the idea on the working group list, and Thomas
106    Salter, who succinctly summarized the discussion and suggested the
107    name ExtendedPartialResponse in his summary.
108
109 8. Author's Addresses
110
111    Roger Harrison
112    Novell, Inc.
113 \f
114                   LDAP v3 Extended Partial Response         June, 2000
115
116
117    1800 S. Novell Place
118    Provo, UT 84606
119    +1 801 861 2642
120    roger_harrison@novell.com
121
122
123 Appendix A - Document Revision History
124
125 A.1 draft-rharrison-ldap-extPartResp-00.doc
126
127    Initial revision of draft.
128
129 A.2 draft-rharrison-ldap-extPartResp-01.doc
130
131    Changed responseName to be optional to align with [LDAPv3]
132    definition of ExtendedResponse.
133
134 Full Copyright Statement
135
136    "Copyright (C) The Internet Society (date). All Rights Reserved.
137    This document and translations of it may be copied and furnished to
138    others, and derivative works that comment on or otherwise explain it
139    or assist in its implmentation may be prepared, copied, published
140    and distributed, in whole or in part, without restriction of any
141    kind, provided that the above copyright notice and this paragraph
142    are included on all such copies and derivative works. However, this
143    document itself may not be modified in any way, such as by removing
144    the copyright notice or references to the Internet Society or other
145    Internet organizations, except as needed for the purpose of
146    developing Internet standards in which case the procedures for
147    copyrights defined in the Internet Standards process must be
148    followed, or as required to translate it into languages other than
149    English.
150
151    The limited permissions granted above are perpetual and will not be
152    revoked by the Internet Society or its successors or assigns.
153
154    This document and the information contained herein is provided on an
155    "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
156    TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
157    BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
158    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
159    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.