Difference between revisions of "RFC4526"

From RFC-Wiki
 
Line 6: Line 6:
 
                 Absolute True and False Filters
 
                 Absolute True and False Filters
  
Status of This Memo
+
'''Status of This Memo'''
  
 
This document specifies an Internet standards track protocol for the
 
This document specifies an Internet standards track protocol for the
 
Internet community, and requests discussion and suggestions for
 
Internet community, and requests discussion and suggestions for
 
improvements.  Please refer to the current edition of the "Internet
 
improvements.  Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
+
Official Protocol Standards" ([[STD1|STD 1]]) for the standardization state
 
and status of this protocol.  Distribution of this memo is unlimited.
 
and status of this protocol.  Distribution of this memo is unlimited.
  
Copyright Notice
+
'''Copyright Notice'''
  
 
Copyright (C) The Internet Society (2006).
 
Copyright (C) The Internet Society (2006).
  
Abstract
+
'''Abstract'''
  
 
This document extends the Lightweight Directory Access Protocol
 
This document extends the Lightweight Directory Access Protocol
Line 25: Line 25:
 
extends the String Representation of LDAP Search Filters to support
 
extends the String Representation of LDAP Search Filters to support
 
these filters.
 
these filters.
 
Table of Contents
 
 
1. Background ......................................................1
 
2. Absolute True and False Filters .................................2
 
3. Security Considerations .........................................2
 
4. IANA Considerations .............................................3
 
5. References ......................................................3
 
  5.1. Normative References .......................................3
 
  5.2. Informative References .....................................3
 
  
 
== Background ==
 
== Background ==
Line 46: Line 36:
 
evaluate to False.
 
evaluate to False.
  
Although LDAPv2 [RFC1777][RFC3494] placed no restriction on the
+
Although LDAPv2 [[RFC1777]][[RFC3494]] placed no restriction on the
 
number of elements in 'and' and 'or' filter sets, the LDAPv2 string
 
number of elements in 'and' and 'or' filter sets, the LDAPv2 string
representation [RFC1960][RFC3494] could not represent empty 'and' and
+
representation [[RFC1960]][[RFC3494]] could not represent empty 'and' and
 
'or' filter sets.  Due to this, absolute True or False filters were
 
'or' filter sets.  Due to this, absolute True or False filters were
(unfortunately) eliminated from LDAPv3 [RFC4510].
+
(unfortunately) eliminated from LDAPv3 [[RFC4510]].
  
 
This documents extends LDAPv3 to support absolute True and False
 
This documents extends LDAPv3 to support absolute True and False
 
assertions by allowing empty 'and' and 'or' in Search filters
 
assertions by allowing empty 'and' and 'or' in Search filters
[RFC4511] and extends the filter string representation [RFC4515] to
+
[[RFC4511]] and extends the filter string representation [[RFC4515]] to
 
allow empty filter lists.
 
allow empty filter lists.
  
 
It is noted that certain search operations, such as those used to
 
It is noted that certain search operations, such as those used to
retrieve subschema information [RFC4512], require use of particular
+
retrieve subschema information [[RFC4512]], require use of particular
 
filters.  This document does not change these requirements.
 
filters.  This document does not change these requirements.
  
Line 66: Line 56:
 
In this document, the key words "MUST", "MUST NOT", "REQUIRED",
 
In this document, the key words "MUST", "MUST NOT", "REQUIRED",
 
"SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
 
"SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
and "OPTIONAL" are to be interpreted as described in BCP 14
+
and "OPTIONAL" are to be interpreted as described in [[BCP14|BCP 14]]
[RFC2119].
+
[[RFC2119]].
  
 
== Absolute True and False Filters ==
 
== Absolute True and False Filters ==
Line 82: Line 72:
 
Servers supporting this feature SHOULD publish the Object Identifier
 
Servers supporting this feature SHOULD publish the Object Identifier
 
1.3.6.1.4.1.4203.1.5.3 as a value of the 'supportedFeatures'
 
1.3.6.1.4.1.4203.1.5.3 as a value of the 'supportedFeatures'
[RFC4512] attribute in the root DSE.
+
[[RFC4512]] attribute in the root DSE.
  
 
Clients supporting this feature SHOULD NOT use the feature unless
 
Clients supporting this feature SHOULD NOT use the feature unless
Line 93: Line 83:
  
 
Implementors of this (or any) LDAPv3 extension should be familiar
 
Implementors of this (or any) LDAPv3 extension should be familiar
with general LDAPv3 security considerations [RFC4510].
+
with general LDAPv3 security considerations [[RFC4510]].
  
 
== IANA Considerations ==
 
== IANA Considerations ==
  
 
Registration of this feature has been completed by the IANA
 
Registration of this feature has been completed by the IANA
[RFC4520].
+
[[RFC4520]].
  
 
Subject: Request for LDAP Protocol Mechanism Registration Object
 
Subject: Request for LDAP Protocol Mechanism Registration Object
Line 104: Line 94:
 
Person & email address to contact for further information:
 
Person & email address to contact for further information:
 
     Kurt Zeilenga <[email protected]> Usage: Feature Specification:
 
     Kurt Zeilenga <[email protected]> Usage: Feature Specification:
RFC 4526 Author/Change Controller: IESG Comments: none
+
[[RFC4526|RFC 4526]] Author/Change Controller: IESG Comments: none
  
 
This OID was assigned [ASSIGN] by OpenLDAP Foundation, under its
 
This OID was assigned [ASSIGN] by OpenLDAP Foundation, under its
Line 114: Line 104:
 
=== Normative References ===
 
=== Normative References ===
  
[RFC2119]    Bradner, S., "Key words for use in RFCs to Indicate
+
[[RFC2119]]    Bradner, S., "Key words for use in RFCs to Indicate
               Requirement Levels", BCP 14, RFC 2119, March 1997.
+
               Requirement Levels", [[BCP14|BCP 14]], [[RFC2119|RFC 2119]], March 1997.
  
[RFC4510]    Zeilenga, K., Ed, "Lightweight Directory Access
+
[[RFC4510]]    Zeilenga, K., Ed, "Lightweight Directory Access
 
               Protocol (LDAP): Technical Specification Road Map", RFC
 
               Protocol (LDAP): Technical Specification Road Map", RFC
 
               4510, June 2006.
 
               4510, June 2006.
  
[RFC4511]    Sermersheim, J., Ed., "Lightweight Directory Access
+
[[RFC4511]]    Sermersheim, J., Ed., "Lightweight Directory Access
               Protocol (LDAP): The Protocol", RFC 4511, June 2006.
+
               Protocol (LDAP): The Protocol", [[RFC4511|RFC 4511]], June 2006.
  
[RFC4512]    Zeilenga, K., "Lightweight Directory Access Protocol
+
[[RFC4512]]    Zeilenga, K., "Lightweight Directory Access Protocol
               (LDAP): Directory Information Models", RFC 4512, June
+
               (LDAP): Directory Information Models", [[RFC4512|RFC 4512]], June
 
               2006.
 
               2006.
  
[RFC4515]    Smith, M., Ed. and T. Howes, "Lightweight Directory
+
[[RFC4515]]    Smith, M., Ed. and T. Howes, "Lightweight Directory
 
               Access Protocol (LDAP): String Representation of Search
 
               Access Protocol (LDAP): String Representation of Search
               Filters", RFC 4515, June 2006.
+
               Filters", [[RFC4515|RFC 4515]], June 2006.
  
 
=== Informative References ===
 
=== Informative References ===
  
[RFC1777]    Yeong, W., Howes, T., and S. Kille, "Lightweight
+
[[RFC1777]]    Yeong, W., Howes, T., and S. Kille, "Lightweight
               Directory Access Protocol", RFC 1777, March 1995.
+
               Directory Access Protocol", [[RFC1777|RFC 1777]], March 1995.
  
[RFC1960]    Howes, T., "A String Representation of LDAP Search
+
[[RFC1960]]    Howes, T., "A String Representation of LDAP Search
               Filters", RFC 1960, June 1996.
+
               Filters", [[RFC1960|RFC 1960]], June 1996.
  
[RFC3494]    Zeilenga, K., "Lightweight Directory Access Protocol
+
[[RFC3494]]    Zeilenga, K., "Lightweight Directory Access Protocol
               version 2 (LDAPv2) to Historic Status", RFC 3494, March
+
               version 2 (LDAPv2) to Historic Status", [[RFC3494|RFC 3494]], March
 
               2003.
 
               2003.
  
[RFC4520]    Zeilenga, K., "Internet Assigned Numbers Authority
+
[[RFC4520]]    Zeilenga, K., "Internet Assigned Numbers Authority
 
               (IANA) Considerations for the Lightweight Directory
 
               (IANA) Considerations for the Lightweight Directory
               Access Protocol (LDAP)", BCP 64, RFC 4520, June 2006.
+
               Access Protocol (LDAP)", [[BCP64|BCP 64]], [[RFC4520|RFC 4520]], June 2006.
  
 
[X.500]      International Telecommunication Union -
 
[X.500]      International Telecommunication Union -
Line 181: Line 171:
  
 
This document is subject to the rights, licenses and restrictions
 
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
+
contained in [[BCP78|BCP 78]], and except as set forth therein, the authors
 
retain all their rights.
 
retain all their rights.
  
Line 201: Line 191:
 
made any independent effort to identify any such rights.  Information
 
made any independent effort to identify any such rights.  Information
 
on the procedures with respect to rights in RFC documents can be
 
on the procedures with respect to rights in RFC documents can be
found in BCP 78 and BCP 79.
+
found in [[BCP78|BCP 78]] and [[BCP79|BCP 79]].
  
 
Copies of IPR disclosures made to the IETF Secretariat and any
 
Copies of IPR disclosures made to the IETF Secretariat and any
Line 220: Line 210:
 
Funding for the RFC Editor function is provided by the IETF
 
Funding for the RFC Editor function is provided by the IETF
 
Administrative Support Activity (IASA).
 
Administrative Support Activity (IASA).
 +
 +
[[Category:Standards Track]]

Latest revision as of 11:42, 5 October 2020

Network Working Group K. Zeilenga Request for Comments: 4526 OpenLDAP Foundation Category: Standards Track June 2006

          Lightweight Directory Access Protocol (LDAP)
                Absolute True and False Filters

Status of This Memo

This document specifies an Internet standards track protocol for the Internet community, and requests discussion and suggestions for improvements. Please refer to the current edition of the "Internet Official Protocol Standards" (STD 1) for the standardization state and status of this protocol. Distribution of this memo is unlimited.

Copyright Notice

Copyright (C) The Internet Society (2006).

Abstract

This document extends the Lightweight Directory Access Protocol (LDAP) to support absolute True and False filters based upon similar capabilities found in X.500 directory systems. The document also extends the String Representation of LDAP Search Filters to support these filters.

Background

The X.500 Directory Access Protocol (DAP) [X.511] supports absolute True and False assertions. An 'and' filter with zero elements always evaluates to True. An 'or' filter with zero elements always evaluates to False. These filters are commonly used when requesting DSA-specific Entries (DSEs) that do not necessarily have 'objectClass' attributes; that is, where "(objectClass=*)" may evaluate to False.

Although LDAPv2 RFC1777RFC3494 placed no restriction on the number of elements in 'and' and 'or' filter sets, the LDAPv2 string representation RFC1960RFC3494 could not represent empty 'and' and 'or' filter sets. Due to this, absolute True or False filters were (unfortunately) eliminated from LDAPv3 RFC4510.

This documents extends LDAPv3 to support absolute True and False assertions by allowing empty 'and' and 'or' in Search filters RFC4511 and extends the filter string representation RFC4515 to allow empty filter lists.

It is noted that certain search operations, such as those used to retrieve subschema information RFC4512, require use of particular filters. This document does not change these requirements.

This feature is intended to allow a more direct mapping between DAP and LDAP (as needed to implement DAP-to-LDAP gateways).

In this document, the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in BCP 14 RFC2119.

Absolute True and False Filters

Implementations of this extension SHALL allow 'and' and 'or' choices with zero filter elements.

An 'and' filter consisting of an empty set of filters SHALL evaluate to True. This filter is represented by the string "(&)".

An 'or' filter consisting of an empty set of filters SHALL evaluate to False. This filter is represented by the string "(|)".

Servers supporting this feature SHOULD publish the Object Identifier 1.3.6.1.4.1.4203.1.5.3 as a value of the 'supportedFeatures' RFC4512 attribute in the root DSE.

Clients supporting this feature SHOULD NOT use the feature unless they know that the server supports it.

Security Considerations

The (re)introduction of absolute True and False filters is not believed to raise any new security considerations.

Implementors of this (or any) LDAPv3 extension should be familiar with general LDAPv3 security considerations RFC4510.

IANA Considerations

Registration of this feature has been completed by the IANA RFC4520.

Subject: Request for LDAP Protocol Mechanism Registration Object Identifier: 1.3.6.1.4.1.4203.1.5.3 Description: True/False filters Person & email address to contact for further information:

    Kurt Zeilenga <[email protected]> Usage: Feature Specification:

RFC 4526 Author/Change Controller: IESG Comments: none

This OID was assigned [ASSIGN] by OpenLDAP Foundation, under its IANA-assigned private enterprise allocation [PRIVATE], for use in this specification.

References

Normative References

RFC2119 Bradner, S., "Key words for use in RFCs to Indicate

             Requirement Levels", BCP 14, RFC 2119, March 1997.

RFC4510 Zeilenga, K., Ed, "Lightweight Directory Access

             Protocol (LDAP): Technical Specification Road Map", RFC
             4510, June 2006.

RFC4511 Sermersheim, J., Ed., "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.

RFC4515 Smith, M., Ed. and T. Howes, "Lightweight Directory

             Access Protocol (LDAP): String Representation of Search
             Filters", RFC 4515, June 2006.

Informative References

RFC1777 Yeong, W., Howes, T., and S. Kille, "Lightweight

             Directory Access Protocol", RFC 1777, March 1995.

RFC1960 Howes, T., "A String Representation of LDAP Search

             Filters", RFC 1960, June 1996.

RFC3494 Zeilenga, K., "Lightweight Directory Access Protocol

             version 2 (LDAPv2) to Historic Status", RFC 3494, March
             2003.

RFC4520 Zeilenga, K., "Internet Assigned Numbers Authority

             (IANA) Considerations for the Lightweight Directory
             Access Protocol (LDAP)", BCP 64, RFC 4520, June 2006.

[X.500] International Telecommunication Union -

             Telecommunication Standardization Sector, "The
             Directory -- Overview of concepts, models and
             services," X.500(1993) (also ISO/IEC 9594-1:1994).

[X.501] International Telecommunication Union -

             Telecommunication Standardization Sector, "The
             Directory -- Models," X.501(1993) (also ISO/IEC 9594-
             2:1994).

[X.511] International Telecommunication Union -

             Telecommunication Standardization Sector, "The
             Directory: Abstract Service Definition", X.511(1993)
             (also ISO/IEC 9594-3:1993).

[ASSIGN] OpenLDAP Foundation, "OpenLDAP OID Delegations",

             http://www.openldap.org/foundation/oid-delegate.txt.

[PRIVATE] IANA, "Private Enterprise Numbers",

             http://www.iana.org/assignments/enterprise-numbers.

Author's Address

Kurt D. Zeilenga OpenLDAP Foundation

EMail: [email protected]

Full Copyright Statement

Copyright (C) The Internet Society (2006).

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 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 [email protected].

Acknowledgement

Funding for the RFC Editor function is provided by the IETF Administrative Support Activity (IASA).