Commit cc7a8ecd authored by Quanah Gibson-Mount's avatar Quanah Gibson-Mount
Browse files

Update to rev -11

parent 32b46347
......@@ -5,12 +5,13 @@
INTERNET-DRAFT Kurt D. Zeilenga
Intended Category: Standard Track OpenLDAP Foundation
Expires in six months 5 March 2006
Intended Category: Standard Track Isode Limited
Expires in six months 18 November 2007
LDAP Transactions
<draft-zeilenga-ldap-txn-07.txt>
<draft-zeilenga-ldap-txn-11.txt>
Status of Memo
......@@ -20,7 +21,7 @@ Status of Memo
Standard. Distribution of this memo is unlimited. Technical
discussion of this 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>.
comments directly to the author <Kurt.Zeilenga@Isode.COM>.
By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware have
......@@ -37,56 +38,58 @@ Status of Memo
or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/1id-abstracts.html
http://www.ietf.org/1id-abstracts.html.
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html
http://www.ietf.org/shadow.html.
Copyright (C) The Internet Society (2006). All Rights Reserved.
Copyright (C) The IETF Trust (2007).
Please see the Full Copyright section near the end of this document
for more information.
Abstract
Lightweight Directory Access Protocol (LDAP) update operations, such
Zeilenga LDAP Transactions [Page 1]
INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
Abstract
Lightweight Directory Access Protocol (LDAP) update operations, such
as Add, Delete, and Modify operations, have atomic, consistency,
isolation, durability (ACID) properties. Each of these update
operations act upon an entry. However, It is often desirable to
update two or more entries in a single unit of interaction, a
transaction. Transactions are necessary to support a number of
applications including resource provisioning and information
replication. This document defines an LDAP extension to support
transactions.
operations act upon an entry. It is often desirable to update two or
more entries in a single unit of interaction, a transaction.
Transactions are necessary to support a number of applications
including resource provisioning. This document extends LDAP to
support transactions.
1. Overview
This document extends the Lightweight Directory Access Protocol (LDAP)
[Roadmap] to allow clients to group a number of related update
operations [Protocol] and have them preformed as one unit of
interaction, a transaction. As with distinct update operations, each
transaction has atomic, consistency, isolation, and durability
([ACID]) properties.
[RFC4510] to allow clients to relate a number of update operations
[RFC4511] and have them performed as one unit of interaction, a
transaction. As with distinct update operations, each transaction has
atomic, consistency, isolation, and durability (ACID) properties
[ACID].
This extension consists of two extended operations, one control, and
one unsolicited notification message. The Start Transaction operation
is used to obtain a transaction identifier. This identifier is then
attached to multiple update operations to indicate that they belong to
transaction using the Transaction Specification control. The End
the transaction using the Transaction Specification control. The End
Transaction is used to settle (commit or abort) the transaction. The
Aborted Tranaction Notice is used notify the client the server is no
longer willing or able to process an outstanding transaction.
Aborted Transaction Notice is provided by the server to notify the
client that the server is no longer willing or able to process an
outstanding transaction.
1.1. Conventions and Terminology
......@@ -98,7 +101,7 @@ INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
Protocol elements are described using ASN.1 [X.680] with implicit
tags. The term "BER-encoded" means the element is to be encoded using
the Basic Encoding Rules [X.690] under the restrictions detailed in
Section 5.2 of [Protocol].
Section 5.1 of [RFC4511].
DSA stands for "Directory System Agent" (a server). DSE stands for
"DSA-specific entry".
......@@ -106,42 +109,47 @@ INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
2. Elements of an LDAP Transaction
2.1. Start Transaction Request and Response
Zeilenga LDAP Transactions [Page 2]
INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
2.1. Start Transaction Request and Response
A Start Transaction Request is an LDAPMessage of CHOICE extendedReq
where the requestName is IANA-ASSIGNED-OID.1 and the requestValue is
absent.
A Start Transaction Response is an LDAPMessage of CHOICE extendedRes
sent in response to a Start Transaction Request. Its responesName is
absent. When the resultCode is success, responseValue is present and
contains a transaction identifier. Otherwise, the responseValue is
absent.
sent in response to a Start Transaction Request. Its responseName is
absent. When the resultCode is success (0), responseValue is present
and contains a transaction identifier. Otherwise, the responseValue
is absent.
2.2. Transaction Specification Control
A Transaction Specification Control is an LDAPControl where the
A Transaction Specification control is an LDAPControl where the
controlType is IANA-ASSIGNED-OID.2, the criticality is TRUE, and the
controlValue is a transaction identifer. The control is appropriate
controlValue is a transaction identifier. The control is appropriate
for update requests including Add, Delete, Modify, and ModifyDN
requests [Protocol].
(Rename) requests [RFC4511], as well as the Password Modify requests
[RFC3062].
As discussed in Section 4, the Transaction Specification control can
be used in conjunction with request controls appropriate for the
update request.
2.3. End Transactions Request and Response
An End Transaction Request is an LDAPMessage of CHOICE extendedReq
where the requestName is IANA-ASSIGNED-OID.3 and the requestValue is
present and contains a BER-encoded settlementValue.
present and contains a BER-encoded txnEndReq.
settlementValue ::= SEQUENCE {
txnEndReq ::= SEQUENCE {
commit BOOLEAN DEFAULT TRUE,
identifier OCTET STRING }
......@@ -151,10 +159,45 @@ INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
An End Transaction Response is an LDAPMessage sent in response to a
End Transaction Request. Its response name is absent. The
responseValue when present contains a BER-encoded MessageID.
responseValue when present contains a BER-encoded txnEndRes.
txnEndRes ::= SEQUENCE {
messageID MessageID OPTIONAL,
-- msgid associated with non-success resultCode
Zeilenga LDAP Transactions [Page 3]
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
updatesControls SEQUENCE OF updateControls SEQUENCE {
messageID MessageID,
-- msgid associated with controls
controls Controls
} OPTIONAL
}
-- where MessageID and Controls are as specified in RFC 4511
The txnEndRes.messageID provides the message id of the update request
associated with a non-success response. txnEndRes.messageID is absent
when resultCode of the End Transaction Response is success (0).
The txnEndRes.updatesControls provides a facility for returning
response controls that normally (i.e., in absence of transactions)
would be returned in an update response. The updateControls.messageID
provides the message id of the update request associated with the
response controls provided in updateControls.controls.
2.5. Aborted Transaction Notice
The txnEndRes.updatesControls is absent when there are no update
response controls to return.
If both txnEndRes.messageID and txnEndRes.updatesControl are absent,
the responseValue of the End Transaction Response is absent.
2.4. Aborted Transaction Notice
The Aborted Transaction Notice is an Unsolicited Notification message
where the responseName is IANA-ASSIGNED-OID.4 and responseValue is
......@@ -165,51 +208,51 @@ INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
3.1. Extension Discovery
Zeilenga LDAP Transactions [Page 3]
INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
To allow clients to discover support for this extension, servers
implementing this specification SHOULD publish IANA-ASSIGNED-OID.1 and
IANA-ASSIGNED-OID.3 as values of the 'supportedExtension' attribute
[Models] within the Root DSE, and publish the IANA-ASSIGNED-OID.2 as a
value of the 'supportedControl' attribute [Models] of the Root DSE.
[RFC4512] within the Root DSE, and publish the IANA-ASSIGNED-OID.2 as
a value of the 'supportedControl' attribute [RFC4512] of the Root DSE.
A server MAY choose to advertise this extension only when the client
is authorized to use it.
3.2. Starting an Transactions
3.2. Starting a Transaction
A client wishing to preform a sequence of directory updates as an
Zeilenga LDAP Transactions [Page 4]
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
A client wishing to perform a sequence of directory updates as an
transaction issues a Start Transaction Request. A server which is
willing and able to support transactions responds to this request with
a Start Transaction Response providing a transaction identifier and
with a resultCode of success. Otherwise, the server responds with a
Start Transaction Response wth a result code other than success
with a resultCode of success (0). Otherwise, the server responds with
a Start Transaction Response with a result code other than success
indicating the nature of the failure.
The transaction identifier provided upon successful start of a
transaction is used in subseqent protocol messages to identify this
transaction is used in subsequent protocol messages to identify this
transaction.
3.3. Specification of a Transaction
The client then may issue may issue one or more update (add, delete,
modify, modifyDN) requests, each with a Transaction Specification
control containing the transaction identifier indicating the updates
are to processed as part of the transaction. Each of these update
request MUST have a different MessageId value. If the server is
unwilling or unable to attempt to process the requested update
operation as part of the transaction, the server immediately returns
the approrpiate response to the request with a resultCode indicating
the nature of the failure. Otherwise, the server immediately returns
success and the defers further processing of the operation is then
deferred until settlement.
The client then can issue one or more update requests, each with a
Transaction Specification control containing the transaction
identifier indicating the updates are to processed as part of the
transaction. Each of these update request MUST have a different
MessageID value. If the server is unwilling or unable to attempt to
process the requested update operation as part of the transaction, the
server immediately returns the appropriate response to the request
with a resultCode indicating the nature of the failure. Otherwise,
the server immediately returns success (0) and the defers further
processing of the operation is then deferred until settlement.
If the server becomes unwilling or unable to continue the
specification of a transaction, the server issues an Aborted
......@@ -222,12 +265,6 @@ INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
containing a non-success resultCode.
Zeilenga LDAP Transactions [Page 4]
INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
3.4. Transaction Settlement
A client requests settlement of transaction by issuing an End
......@@ -237,20 +274,29 @@ INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
Upon receipt of a request to abort the transaction, the server is to
abort the identified transaction (abandoning all operations which are
part of the transaction) and indicate that it has done so by returning
an End Transaction response with a resultCode of success.
an End Transaction Response with a resultCode of success (0).
Zeilenga LDAP Transactions [Page 5]
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
Upon receipt of a request to commit the transaction, the server
processes all update operations of the transaction as one atomic,
isolated action with each requested update being processed in turn.
Either all of the requested updates are to be successfully applied or
none of the requested are to be applied. The server returns an End
Transaction Response with a resultCode of success and no responseValue
to indicate all the requested updates were applied. Otherwise, the
server returns an End Transaction with an non-success resultCode
indicating the nature of the failure. If the failure is associated
with a particular update request, a responseValue containing its
MessageID is returned. If the failure was not associated with any
particular update request, no responseValue is returned.
durable, isolated, and consistent action with each requested update
being processed in turn. Either all of the requested updates are to
be successfully applied or none of the requested are to be applied.
The server returns an End Transaction Response with a resultCode of
success (0) and no responseValue to indicate all the requested updates
were applied. Otherwise, the server returns an End Transaction with
an non-success resultCode indicating the nature of the failure. If
the failure is associated with a particular update request, the
txnEndRes.messageID in the responseValue is the messageID of this
update request. If the failure was not associated with any particular
update request, no txnEnd.messageID is provided.
There is no requirement that a server serialize transactions, or
updates requested outside of a transaction. That is, a server MAY
......@@ -259,13 +305,130 @@ INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
deadlock.
4. Distributed Directory Considerations
3.5. Miscellaneous Issues
Transactions cannot be nested.
Each LDAP transaction should be initiated, specified, and settled
within a stable security context. Between the Start request and the
End response, the peers SHOULD avoid negotiating new security
associations and/or layers.
Upon receipt of a Bind or Unbind request, the server SHALL abort any
and all outstanding transactions without notice and nullify their
identifiers.
4. Interaction with Other Extensions
The LDAP Transaction extension may be used with many but not all LDAP
control extensions designed to extend Update (and possibly other)
operations. The remainder of this subsection discusses interaction
with a number of control extensions. Interaction with other control
extensions may be discussed in other documents, in particular in
control extension specifications.
4.1. Assertion Control
The Assertion [RFC4528] control is appropriate for use with update
Zeilenga LDAP Transactions [Page 6]
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
requests specified as part of a transaction. The evaluation of the
assertion is performed as part of the transaction.
The Assertion control is inappropriate for use with either the
Transaction Start or End extended operations.
4.2. ManageDsaIT Control
The ManageDsaIT [RFC3296] control is appropriate for use with update
requests specified as part of a transaction.
The ManageDsaIT control is inappropriate for use with either the
Transaction Start or End extended operations.
4.3. No-Op Control
The LDAP/X.500 models provide for distributed directory operations
including server-side chaining and client-side chasing of operations.
The No-Op [NO-OP] control is appropriate for use with the Transaction
Start or End extended operations.
The No-Op control is not appropriate for update requests specified as
part of a transaction. A server supporting both the No-Op control
extension and this extension SHALL regard a request containing both
controls as a protocol violation. As both of the No-Op and
Transaction Specification request controls are required to be marked
as critical, a server implementing one of these request controls, or
neither, is expected to return unavailableCriticalExtension as
prescribed by [RFC4511].
4.4. Proxied Authorization Control
The Proxied Authorization [RFC4370] control is appropriate for use
with the Transaction Start extended operation, but not the Transaction
End extended operation or any update request specified as part of a
transaction.
To request that a transaction be performed under a different
authorization, the client provides a Proxied Authorization control
with the Transaction Start request. If the client is not authorized
to assume the requested authorization identity, the server is to
return the authorizationDenied (123) resultCode in its response.
Otherwise, further processing of the request and transaction is
performed under the requested authorization identity.
Any proxied authorization request attached to an update request
specified as part of a transaction, or attached to a Transaction end
Zeilenga LDAP Transactions [Page 7]
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
request, is to be regarded as a protocol error.
4.5. Read Entry Controls
The Pre- and Post-Read Entry [RFC4527] request control are appropriate
for use with update requests specified as part of a transaction.
The response control produced in response to a Pre- or Post-Read Entry
request control is returned in the txnEndRes.updatesControls field of
responseValue of the End Transaction Response.
The Pre- and Post-Read Entry controls are inappropriate for use in the
LDAPMessage.controls field of the Transaction Start and End request
and response messages.
4.6. Relax Rules Control
The Relax Rules [RELAX] control is appropriate for use with update
requests specified as part of a transaction.
The Relax Rules control is inappropriate for use with either the
Transaction Start or End extended operations.
5. Distributed Directory Considerations
The LDAP/X.500 models provide for distributed directory operations,
including server-side chaining and client-side chasing of referrals.
This document does not preclude servers from chaining operations which
are part of a transaction. However, if a server does allow such
are part of a transaction. However, if a server does attempt such
chaining, it MUST ensure that transaction semantics are provided.
This mechanism defined by this document does not support client-side
......@@ -273,128 +436,145 @@ INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
specific to a particular client/server session.
The LDAP/X.500 models provide for a single-master/multiple-shadow
replication architecture. This document states no requirement that
changes made to the directory based upon processing a transaction be
replicated as one atomic action. That is, the client SHOULD NOT
replication architecture. There is no requirement that changes made
to the directory based upon processing a transaction be replicated as
one atomic action. Hence, clients SHOULD NOT assume tight data
consistency nor fast data convergence of shadow copies unless they
have prior knowledge that these properties are provided. Note that
DontUseCopy control [DONTUSECOPY] control may be used in conjunction
with the LDAP search request to ask for the return of the
authoritative copy of the entry.
Zeilenga LDAP Transactions [Page 5]
Zeilenga LDAP Transactions [Page 8]
INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
assume tight data consistency nor fast data convergence at shadow
servers unless they have prior knowledge that such service is
provided. Though this mechanism could be used to support replication,
use in replication is not described in this document.
The LDAP/X.500 models do not currently support a multi-master
replication architecture and, hence, not considered by this
specification.
6. Security Considerations
Transactions mechanisms may be the target of denial-of-service
attacks, especially where implementation lock shared resources for the
duration of a transaction.
5. Security Considerations
General security considerations [RFC4510], especially those associated
with update operations [RFC4511], apply to this extension.
Transactions mechanisms may be the target of denial of service
attacks. Implementors should provide safeguards to ensure these
mechanisms are not abused.
General security considerations [Roadmap], especially associated with
update operations [Protocol], apply to this extension.
7. IANA Considerations
It is requested that Internet Assigned Numbers Authority (IANA) make
the following assignments.
6. IANA Considerations
In accordance with [BCP64bis], it is requested that Internet Assigned
Numbers Authority (IANA) make the following assignments.
7.1. Object Identifier
6.1. Object Identifier
Assignment of an LDAP Object Identifier to identify the protocol
elements specified in this document this document is requested.
Assignment of an LDAP Object Identifier [RFC4520] to identify the
protocol elements specified in this document this document is
requested.
Subject: Request for LDAP Object Identifier Registration
Person & email address to contact for further information:
Kurt Zeilenga <kurt@OpenLDAP.org>
Kurt Zeilenga <Kurt.Zeilenga@Isode.COM>
Specification: RFC XXXX
Author/Change Controller: IESG
Comments: Identifies protocol elements for LDAP Transactions
6.2. LDAP Protocol Mechanism
7.2. LDAP Protocol Mechanism
Registration of the protocol mechanisms specified in this document is
requested.
Registration of the protocol mechanisms [RFC4520] specified in this
document is requested.
Subject: Request for LDAP Protocol Mechanism Registration
Object Identifier: see table
Description: see table
Person & email address to contact for further information:
Subject: Request for LDAP Protocol Mechanism Registration
Object Identifier: see table
Description: see table
Person & email address to contact for further information:
Kurt Zeilenga <Kurt.Zeilenga@Isode.COM>
Specification: RFC XXXX
Author/Change Controller: IESG
Comments:
Object Identifier Type Description
------------------- ---- ----------------------------------
IANA-ASSIGNED-OID.1 E Start Transaction Extended Request
IANA-ASSIGNED-OID.2 C Transaction Specification Control
Zeilenga LDAP Transactions [Page 6]
Zeilenga LDAP Transactions [Page 9]
INTERNET-DRAFT draft-zeilenga-ldap-txn-07 5 March 2006
INTERNET-DRAFT draft-zeilenga-ldap-txn-11 18 November 2007
Kurt Zeilenga <kurt@openldap.org>
Specification: RFC XXXX
Author/Change Controller: IESG
Comments:
IANA-ASSIGNED-OID.3 E End Transaction Extended Request
IANA-ASSIGNED-OID.4 N Aborted Transaction Notice
Object Identifier Type Description
------------------- ---- -----------------------------------------
IANA-ASSIGNED-OID.1 E Start Transaction Extended Request
IANA-ASSIGNED-OID.2 C Transaction Specification Control
IANA-ASSIGNED-OID.3 E End Transaction Extended Request
Legend
------------------------
C => supportedControl
E => supportedExtension
N => Unsolicited Notice
7. Acknowledgments
8. Acknowledgments
The author gratefully acknowledges the contributions made by members
of the Internet Engineering Task Force.
The author gratefully acknowledges the contributions made by Internet
Engineering Task Force participants.
8. Author's Address
9. Author's Address
Kurt D. Zeilenga
OpenLDAP Foundation
Isode Limited
Email: Kurt@OpenLDAP.org
Email: Kurt.Zeilenga@Isode.COM
9. References
10. References