MAN page from PLD openldap-2.0.27-1.i386.rpm

LDAPFILTER.CONF

Section: File Formats (5)
Updated: 20 August 2000
Index

NAME

ldapfilter.conf - configuration file for LDAP get filter routines

SYNOPSIS

/etc/openldap/ldapfilter.conf

DESCRIPTION

The file/etc/openldap/ldapfilter.confcontains information used bythe LDAP get filter routines (seeldap-getfilter(3)).Blank lines andlines that have a first character of `#' are treated as comments andignored. The configuration information consists of lines that containone, two, three, four, or five tokens. Tokens are separatedby white space, and double quotes `"' can be used to include white spaceinside a token.

The file consists of a sequence of one or more filter sets. A filterset begins with a line containing a single token called atag.Thetagis used in theldap_getfirstfilter(3)call to select the filter set.

The filter set consists of a sequence of one or more filter lists. Thefirst line in a filter list must contain four or five tokens: thevalue pattern,thedelimiter list,afilter template,amatch description,and an optionalsearch scope.Thevalue patternis a regular expression that is matched against thevaluepassed to theldap_getfirstfilter(3)call to select the filter list.

Thedelimiter listis a list of characters (in the form of a single string) that are used tobreak thevalueinto distinct words.

Thefilter templateis used to construct an LDAP filter (it is described further below)

Thematch descriptionis returned to the called along with a filter as a piece of text that canbe used to describe the sort of LDAP search that took place. It shouldcorrectly compete both of the following phrases:"Onematch descriptionmatch was found for..."and"Threematch descriptionmatches were found for...."

Thesearch scopeis optional, and should be one of "base", "onelevel", or "subtree". Ifsearch scopeis not provided, the default is "subtree".

The remaining lines of the filter list should contain two or three tokens,afilter template,amatch descriptionand an optionalsearch scope(as described above).

Thefilter templateis similar in concept to a printf(3) style formatstring. Everything is taken literally except for the charactersequences:

    %v    %v$    %vN    %vM-N    %vN-

A plain%vmeans to substitute the entirevaluestring in place of the%v.%v$means substitute the last word in this spot.A%vN,where N is a single digit 1-9, means substitute word N in this spot.Words are number from left to right within the value starting at 1.A%vM-N,where M and N are both single digits 1-9, means substitute the indicatedsequence of words.A%vN-,where N is again a single digit 1-9, means substitute word N through thelast word invalue.

EXAMPLE

The following ldap filter configuration file contains two filter sets(fingerandgo500gwonelevel),each of which contains four filter lists.

  # ldap filter file  #  finger    "="                " "     "%v"                    "arbitrary filter"    "[0-9][0-9-]*"    " "     "(telephoneNumber=*%v)" "phone number"    "@"                " "     "(mail=%v)"             "email address"    "^.[. _].*"       ". _"   "(cn=%v1* %v2-)"        "first initial"    ".*[. _].$"        ". _"   "(cn=%v1-*)"            "last initial"    "[. _]"            ". _"   "(|(sn=%v1-)(cn=%v1-))"        "exact"                               "(|(sn~=%v1-)(cn~=%v1-))"      "approximate"    ".*"               ". "    "(|(cn=%v1)(sn=%v1)(uid=%v1))" "exact"                               "(|(cn~=%v1)(sn~=%v1))"        "approximate"  "go500gw onelevel"    "^..$"  " "   "(|(o=%v)(c=%v)(l=%v)(co=%v))"       "exact" "onelevel"                  "(|(o~=%v)(c~=%v)(l~=%v)(co~=%v))"   "approximate" "onelevel"    " "     " "   "(|(o=%v)(l=%v)(co=%v)"       "exact"        "onelevel"                  "(|(o~=%v)(l~=%v)(co~=%v)"    "approximate"  "onelevel"    "."    " "   "(associatedDomain=%v)"       "exact"        "onelevel"    ".*"    " "   "(|(o=%v)(l=%v)(co=%v)"       "exact"        "onelevel"                  "(|(o~=%v)(l~=%v)(co~=%v)"    "approximate"  "onelevel"

The callldap_getfirstfilter( lfdp, "finger", "m.smith" );will return an LDAPFiltInfo structure with thelfi_filtermember containing the string(cn=m* smith)with thelfi_descmember containing the stringfirst initial,andlfi_scopecontaining the value LDAP_SCOPE_SUBTREE.

The callldap_getfirstfilter( lfdp, "go500gw onelevel", "umich" );will return an LDAPFiltInfo structure with thelfi_filtermember containing the string(|(o=umich)(l=umich)(co=umich)with thelfi_descmember containing the stringexact,andlfi_scopecontaining the value LDAP_SCOPE_ONELEVEL.

FILES

/etc/openldap/ldapfilter.conf

ACKNOWLEDGEMENTS

is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).is derived from University of Michigan LDAP 3.3 Release.

This document was created byman2html,using the manual pages.