One document matched: draft-legg-ldap-binary-00.txt

INTERNET-DRAFT                                                   S. Legg
draft-legg-ldap-binary-00.txt                        Adacel Technologies
Intended Category: Standard Track                           19 June 2003
Updates: RFC 2251bis


                    LDAP: The Binary Encoding Option

    Copyright (C) The Internet Society (2003). All Rights Reserved.

   Status of this Memo


   This document is an Internet-Draft and is in full conformance with
   all provisions of Section 10 of RFC2026.

   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 document is intended to be, after appropriate review and
   revision, submitted to the RFC Editor as a Standard Track document.
   Distribution of this document is unlimited.  Technical discussion of
   this document should take place on the IETF LDAP Revision Working
   Group (LDAPbis) mailing list <ietf-ldapbis@openldap.org>.  Please
   send editorial comments directly to the editor
   <steven.legg@adacel.com.au>.

   This Internet-Draft expires on 19 December 2003.


Abstract

   Each attribute stored in a Lightweight Directory Access Protocol
   (LDAP) directory has a defined syntax (i.e. data type).  A syntax
   definition specifies how attribute values conforming to the syntax



Legg                    Expires 19 December 2003                [Page 1]

INTERNET-DRAFT      LDAP: The Binary Encoding Option       June 19, 2003


   are normally represented when transferred in LDAP operations.  This
   representation is referred to as the LDAP-specific encoding to
   distinguish it from other methods of encoding attribute values.  This
   document defines an attribute option, the binary option, which can be
   used to specify that the associated attribute values are instead
   encoded according to the Basic Encoding Rules (BER) used by X.500
   directories.












































Legg                    Expires 19 December 2003                [Page 2]

INTERNET-DRAFT      LDAP: The Binary Encoding Option       June 19, 2003


1. Table of Contents

   1. Table of Contents .............................................  3
   2. Introduction ..................................................  3
   3. Conventions ...................................................  4
   4. The binary Option .............................................  4
   5. Syntaxes Requiring Binary Transfer ............................  4
   6. Attributes Returned in a Search ...............................  5
   7. All User Attributes ...........................................  5
   8. Conflicting Requests ..........................................  6
   9. Security Considerations .......................................  6
   10. IANA Considerations ..........................................  6
   11. Normative References .........................................  7
   12. Informative References .......................................  7
   13. Intellectual Property Notice .................................  8
   14. Copyright Notice .............................................  8
   15. Author's Address .............................................  9


2. Introduction

   Each attribute stored in a Lightweight Directory Access Protocol
   (LDAP) directory [ROADMAP] has a defined syntax (i.e. data type)
   which constrains the structure and format of its values.

   The description of each syntax [SYNTAX] specifies how attribute or
   assertion values [MODELS] conforming to the syntax are normally
   represented when transferred in LDAP operations [PROT].  This
   representation is referred to as the LDAP-specific encoding to
   distinguish it from other methods of encoding attribute values.

   This document defines an attribute option, the binary option, which
   can be used in an attribute description [MODELS] in an LDAP operation
   to specify that the associated attribute values or assertion value
   are, or are requested to be, encoded according to the Basic Encoding
   Rules (BER) [BER] as used by X.500 [X500] directories, instead of the
   usual LDAP-specific encoding.

   The binary option was originally defined in RFC 2251 [RFC2251].  The
   LDAP technical specification [ROADMAP] has obsoleted the previously
   defined LDAP technical specification [RFC3377], which included RFC
   2251.  However the binary option was not included in the newer LDAP
   technical specification due to a lack of consistency in its
   implementation.  This document reintroduces the binary option.
   However, except for the case of certain attribute syntaxes whose
   values are required to BER encoded, no attempt is made here to
   eliminate the known consistency problems.  Rather the focus is on
   capturing current behaviours.  A more thorough solution is left for a



Legg                    Expires 19 December 2003                [Page 3]

INTERNET-DRAFT      LDAP: The Binary Encoding Option       June 19, 2003


   future specification.


3. Conventions

   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 RFC 2119 [KEYWORD].


4. The binary Option

   The binary option is indicated with the attribute option string
   "binary" in an attribute description.  Note that, like all attribute
   options, the string representing the binary option is case
   insensitive.

   In terms of the protocol [PROT], the binary option specifies that the
   contents octets of the associated AttributeValue or AssertionValue
   OCTET STRING are a complete BER encoding of the relevant value.

   Where the binary option is present in an attribute description the
   associated attribute values or assertion value MUST be BER encoded.
   Note that it is possible for a syntax to be defined such that its
   LDAP-specific encoding is exactly the same as its BER encoding.

   The binary option is not a tagging option [MODELS] so the presence of
   the binary option does not specify an attribute subtype.  An
   attribute description containing the binary option references exactly
   the same attribute as the same attribute description without the
   binary option.  The supertype/subtype relationships of attributes
   with tagging options are not altered in any way by the presence or
   absence of the binary option.

   An attribute description SHALL be treated as unrecognized if it
   contains the binary option and the syntax of the attribute does not
   have an associated ASN.1 type [SYNTAX], or the BER encoding of that
   type is not supported.

   The presence or absence of the binary option only affects the
   transfer of attribute and assertion values in protocol; servers store
   any particular attribute value in a single format of their choosing.


5. Syntaxes Requiring Binary Transfer

   Certain syntaxes are required to be transferred in the BER encoded
   form.  These syntaxes are said to have a binary transfer requirement.



Legg                    Expires 19 December 2003                [Page 4]

INTERNET-DRAFT      LDAP: The Binary Encoding Option       June 19, 2003


   The Certificate, Certificate List, Certificate Pair and Supported
   Algorithm syntaxes [PKI] are examples of syntaxes with a binary
   transfer requirement.  These syntaxes also have an additional
   requirement that the exact BER encoding must be preserved.  Note that
   this is a property of the syntaxes themselves, and not a property of
   the binary option.


6. Attributes Returned in a Search

   An LDAP search request [PROT] contains a list of the attributes (the
   requested attributes list) to be returned from each entry matching
   the search filter.  An attribute description in the requested
   attributes list also implicitly requests all subtypes of the
   attribute type in the attribute description, whether through
   attribute subtyping or attribute tagging option subtyping [MODELS].

   The requested attributes list MAY contain attribute descriptions with
   the binary option, but MUST NOT contain two attribute descriptions
   with the same attribute type and the same tagging options (even if
   only one of them has the binary option).  The binary option in an
   attribute description in the requested attributes list implicitly
   applies to all the subtypes of the attribute type in the attribute
   description (however see Section 8).

   Attributes of a syntax with the binary transfer requirement SHALL be
   returned in the binary form, i.e. with the binary option in the
   attribute description and the associated attribute values BER
   encoded, regardless of whether the binary option was present in the
   request (for the attribute or for one of its supertypes).

   Attributes of a syntax without the binary transfer requirement SHOULD
   be returned in the form explicitly requested.  That is, if the
   attribute description in the requested attributes list contains the
   binary option then the corresponding attribute in the result SHOULD
   be in the binary form.  If the attribute description in the request
   does not contain the binary option then the corresponding attribute
   in the result SHOULD NOT be in the binary form.  A server MAY omit an
   attribute from the result if it does not support the requested
   encoding.

   Regardless of the encoding chosen, a particular attribute value is
   returned at most once.


7. All User Attributes

   If the list of attributes in a search request is empty, or contains



Legg                    Expires 19 December 2003                [Page 5]

INTERNET-DRAFT      LDAP: The Binary Encoding Option       June 19, 2003


   the special attribute description string "*", then all user
   attributes are requested to be returned.

   Attributes of a syntax with the binary transfer requirement SHALL be
   returned in the binary form.

   Attributes of a syntax without the binary transfer requirement and
   having a defined LDAP-specific encoding SHOULD NOT be returned in the
   binary form.

   Attributes of a syntax without the binary transfer requirement and
   without a defined LDAP-specific encoding may be returned in the
   binary form or omitted from the result.


8. Conflicting Requests

   A particular attribute could be explicitly requested by an attribute
   description and/or implicitly requested by the attribute descriptions
   of one or more of its supertypes, or by the special attribute
   description string "*".  If the binary option is not present in all
   these attribute descriptions, nor absent in all these attribute
   descriptions, then the server is free to choose whether to return the
   attribute in the binary form.


9. Security Considerations

   When interpreting security-sensitive fields, and in particular fields
   used to grant or deny access, implementations MUST ensure that any
   matching rule comparisons are done on the underlying abstract value,
   regardless of the particular encoding used.


10. IANA Considerations

   The Internet Assigned Numbers Authority (IANA) is requested to update
   the LDAP attribute description option registry [BCP64] as indicated
   by the following template:

      Subject: Request for
        LDAP Attribute Description Option Registration
      Option Name: binary
      Family of Options: NO
      Person & email address to contact for further information:
        Steven Legg <steven.legg@adacel.com.au>
      Specification: RFC XXXX
      Author/Change Controller: IESG



Legg                    Expires 19 December 2003                [Page 6]

INTERNET-DRAFT      LDAP: The Binary Encoding Option       June 19, 2003


      Comments: The existing registration for "binary"
                should be updated to refer to RFC XXXX.


11. Normative References

   [KEYWORD]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119, March 1997.

   [BCP64]    Zeilenga, K., "Internet Assigned Numbers Authority (IANA)
              Considerations for the Lightweight Directory Access
              Protcol (LDAP)", BCP 64, RFC 3383, September 2002.

   [ROADMAP]  Zeilenga, K., "LDAP: Technical Specification Road Map",
              draft-ietf-ldapbis-roadmap-xx.txt, a work in progress,
              March 2003.

   [MODELS]   Zeilenga, K., "LDAP: Directory Information Models",
              draft-ietf-ldapbis-models-xx.txt, a work in progress,
              March 2003.

   [PROT]     Sermersheim, J., "LDAP: The Protocol",
              draft-ietf-ldapbis-protocol-xx.txt, a work in progress,
              June 2003.

   [SYNTAX]   Legg, S. and K. Dally, "LDAP: Syntaxes and Matching
              Rules", draft-ietf-ldapbis-syntaxes-xx.txt, a work in
              progress, June 2003.

   [PKI]      Chadwick, D. and S. Legg, "Internet X.509 Public Key
              Infrastructure Additional LDAP Schema for PKIs and PMIs",
              draft-pkix-ldap-schema-xx.txt, a work in progress, April
              2002.

   [BER]      ITU-T Recommendation X.690 (07/02) | ISO/IEC 8825-1,
              Information Technology - ASN.1 encoding rules:
              Specification of Basic Encoding Rules (BER), Canonical
              Encoding Rules (CER) and Distinguished Encoding Rules
              (DER).


12. Informative References

   [BCP11]    Hovey, R. and S. Bradner, "The Organizations Involved in
              the IETF Standards Process", BCP 11, RFC 2028, October
              1996.

   [RFC2251]  Wahl, M., Howes, T. and S. Kille, "Lightweight Directory



Legg                    Expires 19 December 2003                [Page 7]

INTERNET-DRAFT      LDAP: The Binary Encoding Option       June 19, 2003


              Access Protocol (v3)", RFC 2251, December 1997.

   [RFC3377]  Hodges, J. and R. Morgan, "Lightweight Directory Access
              Protocol (v3): Technical Specification", RFC 3377,
              September 2002.

   [X500]     ITU-T Recommendation X.500 (1993) | ISO/IEC 9594-1:1994,
              "Information Technology - Open Systems Interconnection -
              The Directory: Overview of concepts, models and services".


13. Intellectual Property Notice

   The IETF takes no position regarding the validity or scope of any
   intellectual property 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; neither does it represent that it
   has made any effort to identify any such rights.  Information on the
   IETF's procedures with respect to rights in standards-track and
   standards-related documentation can be found in BCP-11. [BCP11]
   Copies of claims of rights made available for publication 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 implementors or users of this
   specification can be obtained from the IETF Secretariat.

   The IETF invites any interested party to bring to its attention any
   copyrights, patents or patent applications, or other proprietary
   rights which may cover technology that may be required to practice
   this standard.  Please address the information to the IETF Executive
   Director.


14. Copyright Notice

      Copyright (C) The Internet Society (2003). All Rights Reserved.

   This document and translations of it may be copied and furnished to
   others, and derivative works that comment on or otherwise explain it
   or assist in its implementation may be prepared, copied, published
   and distributed, in whole or in part, without restriction of any
   kind, provided that the above copyright notice and this paragraph are
   included on all such copies and derivative works.  However, this
   document itself may not be modified in any way, such as by removing
   the copyright notice or references to the Internet Society or other
   Internet organizations, except as needed for the purpose of
   developing Internet standards in which case the procedures for



Legg                    Expires 19 December 2003                [Page 8]

INTERNET-DRAFT      LDAP: The Binary Encoding Option       June 19, 2003


   copyrights defined in the Internet Standards process must be
   followed, or as required to translate it into languages other than
   English.

   The limited permissions granted above are perpetual and will not be
   revoked by the Internet Society or its successors or assigns.

   This document and the information contained herein is provided on an
   "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
   TASK FORCE DISCLAIMS 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.


15.  Author's Address

   Steven Legg
   Adacel Technologies Ltd.
   250 Bay Street
   Brighton, Victoria 3186
   AUSTRALIA

   Phone: +61 3 8530 7710
     Fax: +61 3 8530 7888
   Email: steven.legg@adacel.com.au

























Legg                    Expires 19 December 2003                [Page 9]