git.sur5r.net Git - openldap/blob - doc/drafts/draft-masarati-ldap-whatfailed-xx.txt

   1
   2
   3
   4 Network Working Group                                        P. Masarati
   5 Internet-Draft                                     Politecnico di Milano
   6 Intended status: Standards Track                            October 2008
   7 Expires: April 4, 2009
   8
   9
  10                       LDAP "What Failed?" Control
  11                    draft-masarati-ldap-whatfailed.txt
  12
  13 Status of this Memo
  14
  15    By submitting this Internet-Draft, each author represents that any
  16    applicable patent or other IPR claims of which he or she is aware
  17    have been or will be disclosed, and any of which he or she becomes
  18    aware will be disclosed, in accordance with Section 6 of BCP 79.
  19
  20    Internet-Drafts are working documents of the Internet Engineering
  21    Task Force (IETF), its areas, and its working groups.  Note that
  22    other groups may also distribute working documents as Internet-
  23    Drafts.
  24
  25    Internet-Drafts are draft documents valid for a maximum of six months
  26    and may be updated, replaced, or obsoleted by other documents at any
  27    time.  It is inappropriate to use Internet-Drafts as reference
  28    material or to cite them other than as "work in progress."
  29
  30    The list of current Internet-Drafts can be accessed at
  31    http://www.ietf.org/ietf/1id-abstracts.txt.
  32
  33    The list of Internet-Draft Shadow Directories can be accessed at
  34    http://www.ietf.org/shadow.html.
  35
  36    This Internet-Draft will expire on April 4, 2009.
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55 Masarati                  Expires April 4, 2009                 [Page 1]
  56 \f
  57 Internet-Draft               LDAP WHATFAILED                October 2008
  58
  59
  60 Abstract
  61
  62    This document describes the LDAP "What Failed?" control.  This
  63    control allows DUAs to request, in response to a failed operation
  64    request, the object identifier of those extensions that caused the
  65    operation to fail.
  66
  67
  68 Table of Contents
  69
  70    1.  Background and Intended Use  . . . . . . . . . . . . . . . . .  3
  71    2.  LDAP "What Failed?" Control  . . . . . . . . . . . . . . . . .  4
  72      2.1.  Control Semantics  . . . . . . . . . . . . . . . . . . . .  4
  73      2.2.  Control Request  . . . . . . . . . . . . . . . . . . . . .  4
  74      2.3.  Control Response . . . . . . . . . . . . . . . . . . . . .  4
  75    3.  Implementation Notes . . . . . . . . . . . . . . . . . . . . .  5
  76    4.  Security Considerations  . . . . . . . . . . . . . . . . . . .  6
  77    5.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . .  7
  78      5.1.  Object Identifier Registration . . . . . . . . . . . . . .  7
  79    6.  Acknowledgments  . . . . . . . . . . . . . . . . . . . . . . .  8
  80    7.  References . . . . . . . . . . . . . . . . . . . . . . . . . .  9
  81      7.1.  Normative References . . . . . . . . . . . . . . . . . . .  9
  82      7.2.  Informative References . . . . . . . . . . . . . . . . . .  9
  83    Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 10
  84    Intellectual Property and Copyright Statements . . . . . . . . . . 11
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111 Masarati                  Expires April 4, 2009                 [Page 2]
 112 \f
 113 Internet-Draft               LDAP WHATFAILED                October 2008
 114
 115
 116 1.  Background and Intended Use
 117
 118    The LDAP Protocol [RFC4510] is extensible.  Extensions include
 119    controls, extended requests and extensions related to other aspects
 120    of the protocol, for example those described in [RFC4526], [RFC4529]
 121    and more.
 122
 123    Operations may fail for different reasons.  The resultCode may help
 124    in determining the reason of a failure.  The (optional)
 125    diagnosticsMessage fields of a LDAPResponse could also be of help.
 126    However, according to [RFC4511], implementations MUST NOT rely on the
 127    returned values, which are simply intended to be presented as are to
 128    human users.
 129
 130    In case of failure related to the inability to process a control
 131    marked as critical in a request, the specific resultCode
 132    unavailableCriticalExtension is returned.  In case of failure related
 133    to an unrecognized extendedReq, the generic resultCode protocolError
 134    is returned.  Failures related to handling other extensions may
 135    result in other generic resultCode values.
 136
 137    As a consequence, DUAs may be unable to exactly determine what
 138    extension, if any, caused a failure.  The "What Failed?" control
 139    represents a means for the DSA to inform DUAs about what specific
 140    extensions, if any, caused an error notified by the DSA.
 141
 142    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
 143    "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
 144    document are to be interpreted as described in [RFC2119].
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167 Masarati                  Expires April 4, 2009                 [Page 3]
 168 \f
 169 Internet-Draft               LDAP WHATFAILED                October 2008
 170
 171
 172 2.  LDAP "What Failed?" Control
 173
 174 2.1.  Control Semantics
 175
 176    The presence of the "What Failed?"  LDAP control in a LDAP request
 177    indicates that the DUA, in case of error, wishes to receive detailed
 178    information about what extension, if any, caused the error.
 179
 180    The criticality of the control in the request SHOULD be FALSE.
 181    According to the semantics of the criticality field as indicated in
 182    [RFC4511], this ensures that in case the control is not recognized by
 183    the DSA, it does not cause itself an error.
 184
 185    The presence of this control in a request does not guarantee that the
 186    DSA will return detailed information about what extensions caused an
 187    error.  Considering the requirement on the criticality of the
 188    control, the DSA MAY simply choose to ignore the control.  The DSA
 189    MAY hide information about failure in handling an extension to
 190    prevent disclosure of other information.  The DSA MAY choose to
 191    notify an error as soon as it is detected, instead of proceed
 192    checking its ability to handle any other extension present in a
 193    request.
 194
 195    Implementations may choose to check the validity of extensions,
 196    including controls, as soon as they are parsed.  As a consequence, a
 197    critical control might result in an error before thw "What Failed?"
 198    control request is parsed.  Implementations SHOULD check anyway the
 199    presence of this control, unless they detect that the remaining part
 200    of the request is malformed.  Clients SHOULD NOT rely on any specific
 201    ordering of controls handling when requesting the "What Failed?"
 202    control.
 203
 204 2.2.  Control Request
 205
 206    The controlType is whatFailed-oid; the controlValue MUST be absent;
 207    the criticality SHOULD be FALSE.
 208
 209 2.3.  Control Response
 210
 211    The controlType is whatFailed-oid; the controlValue is:
 212
 213        controlValue ::= SET OF oid LDAPOID
 214
 215    If the set of extension OID is empty, the control is omitted from the
 216    response.  The criticality SHOULD be FALSE.
 217
 218
 219
 220
 221
 222
 223 Masarati                  Expires April 4, 2009                 [Page 4]
 224 \f
 225 Internet-Draft               LDAP WHATFAILED                October 2008
 226
 227
 228 3.  Implementation Notes
 229
 230    The "What Failed?"  LDAP Control is implemented in OpenLDAP software
 231    using the temporary OID 1.3.6.1.4.1.4203.666.5.17 under OpenLDAP's
 232    experimental OID arc.
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279 Masarati                  Expires April 4, 2009                 [Page 5]
 280 \f
 281 Internet-Draft               LDAP WHATFAILED                October 2008
 282
 283
 284 4.  Security Considerations
 285
 286    Implementations MUST take measures to prevent the disclosure of
 287    sensible information whenever this may result from disclosing what
 288    extension caused an error.  This can consist in excluding the OID of
 289    specific extensions from the controlValue in the response, or in
 290    entirely omitting the control in the response.
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335 Masarati                  Expires April 4, 2009                 [Page 6]
 336 \f
 337 Internet-Draft               LDAP WHATFAILED                October 2008
 338
 339
 340 5.  IANA Considerations
 341
 342 5.1.  Object Identifier Registration
 343
 344    It is requested that IANA register upon Standards Action an LDAP
 345    Object Identifier for use in this technical specification.
 346
 347          Subject: Request for LDAP OID Registration
 348          Person & email address to contact for further information:
 349              Pierangelo Masarati <ando@OpenLDAP.org>
 350          Specification: (I-D)
 351          Author/Change Controller: IESG
 352          Comments:
 353              Identifies the LDAP "What Failed?" Control request
 354              and response
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391 Masarati                  Expires April 4, 2009                 [Page 7]
 392 \f
 393 Internet-Draft               LDAP WHATFAILED                October 2008
 394
 395
 396 6.  Acknowledgments
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447 Masarati                  Expires April 4, 2009                 [Page 8]
 448 \f
 449 Internet-Draft               LDAP WHATFAILED                October 2008
 450
 451
 452 7.  References
 453
 454 7.1.  Normative References
 455
 456    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
 457               Requirement Levels", BCP 14, RFC 2119, March 1997.
 458
 459    [RFC4510]  Zeilenga, K., "Lightweight Directory Access Protocol
 460               (LDAP): Technical Specification Road Map", RFC 4510,
 461               June 2006.
 462
 463    [RFC4511]  Sermersheim, J., "Lightweight Directory Access Protocol
 464               (LDAP): The Protocol", RFC 4511, June 2006.
 465
 466 7.2.  Informative References
 467
 468    [RFC4526]  Zeilenga, K., "Lightweight Directory Access Protocol
 469               (LDAP) Absolute True and False Filters", RFC 4526,
 470               June 2006.
 471
 472    [RFC4529]  Zeilenga, K., "Requesting Attributes by Object Class in
 473               the Lightweight Directory Access Protocol", RFC 4529,
 474               June 2006.
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503 Masarati                  Expires April 4, 2009                 [Page 9]
 504 \f
 505 Internet-Draft               LDAP WHATFAILED                October 2008
 506
 507
 508 Author's Address
 509
 510    Pierangelo Masarati
 511    Politecnico di Milano
 512    Dipartimento di Ingegneria Aerospaziale
 513    via La Masa 34
 514    Milano  20156
 515    IT
 516
 517    Phone: +39 02 2399 8309
 518    Fax:   +39 02 2399 8334
 519    Email: ando@OpenLDAP.org
 520    URI:   http://www.aero.polimi.it/masarati/
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559 Masarati                  Expires April 4, 2009                [Page 10]
 560 \f
 561 Internet-Draft               LDAP WHATFAILED                October 2008
 562
 563
 564 Full Copyright Statement
 565
 566    Copyright (C) The IETF Trust (2008).
 567
 568    This document is subject to the rights, licenses and restrictions
 569    contained in BCP 78, and except as set forth therein, the authors
 570    retain all their rights.
 571
 572    This document and the information contained herein are provided on an
 573    "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
 574    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
 575    THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
 576    OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
 577    THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
 578    WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 579
 580
 581 Intellectual Property
 582
 583    The IETF takes no position regarding the validity or scope of any
 584    Intellectual Property Rights or other rights that might be claimed to
 585    pertain to the implementation or use of the technology described in
 586    this document or the extent to which any license under such rights
 587    might or might not be available; nor does it represent that it has
 588    made any independent effort to identify any such rights.  Information
 589    on the procedures with respect to rights in RFC documents can be
 590    found in BCP 78 and BCP 79.
 591
 592    Copies of IPR disclosures made to the IETF Secretariat and any
 593    assurances of licenses to be made available, or the result of an
 594    attempt made to obtain a general license or permission for the use of
 595    such proprietary rights by implementers or users of this
 596    specification can be obtained from the IETF on-line IPR repository at
 597    http://www.ietf.org/ipr.
 598
 599    The IETF invites any interested party to bring to its attention any
 600    copyrights, patents or patent applications, or other proprietary
 601    rights that may cover technology that may be required to implement
 602    this standard.  Please address the information to the IETF at
 603    ietf-ipr@ietf.org.
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615 Masarati                  Expires April 4, 2009                [Page 11]
 616 \f