LDAPSEARCHPREFS.CONF

LDAPSEARCHPREFS.CONF

NAME SYNOPSIS DESCRIPTION EXAMPLE FILES SEE ALSO ACKNOWLEDGEMENTS

NAME

ldapsearchprefs.conf - configuration file for LDAP search preference routines

SYNOPSIS

/etc/ldap/ldapsearchprefs.conf

DESCRIPTION

The file /etc/ldap/ldapsearchprefs.conf contains information used by the LDAP search preference routines (see ldap-searchpref(3)?). Blank lines and lines that have a first character of `#' are treated as comments and ignored. Non-comment lines contain one or more tokens. Tokens are separated by white space, and double quotes `

Search preferences are typically used by LDAP-based client programs to specify what a user may search for, which attributes are searched, and which options are available to the user.

The first non-commment line specifies the version of the template information and must contain the token Version followed by an integer version number. E.g.,

Version 1 The current version is 1, so the above example is always the correct opening line.

The remainder of the file consists of one or more search preference configurations. The first line of a search preference is a human-readable name for the type of object being searched for, e.g. so_objtypeprompt member of the ldap_searchobj'' structure. E.g.,

specifies a label for a search preference designed to find X.500 entries for People.

The next line specifies a list of options for this search object. The only option currently allowed is so_options member of the ldap_searchobj structure and can be tested using the LDAP_IS_SEARCHOBJ_OPTION_SET() macro. Use

The next line specifes a label to use for

For example:

can be used by LDAP client programs to label the field into which the user can type a so_prompt member of the ldap_searchobj'' structure.

The next line specifies an LDAP filter prefix to append to all

would cause only entries containing the object class so_filterprefix member of the ldap_searchobj'' structure.

The next line is an LDAP filter tag (see ldap-filter(3)?) which specifies the set of LDAP filters to be applied for

would tell the client program to use the set of LDAP filters from the ldap filter configuration file tagged so_filtertag member of the ldap_searchobj'' structure.

The next line specifies an LDAP attribute to retrieve to help the user choose when several entries match the search terms specified. For example:

specifies that if more than one entry matches the search criteria, the client program should retrieve the

The above information is stored in the so_defaultselectattr and so_defaultselecttext members of the ldap_searchobj structure. Note that these are defaults, and are intended to be overridden by the sa_selectattr and sa_selecttext fields of the ldap_searchattr data structure (see below).

The next line specifies the scope of the LDAP search to be performed. Acceptable values are subtree, onelevel, and base. See ldap(3)? for more information.

The next section is a list of

Each line represents one method of searching. In this example, there are three ways of searching - by Common Name, by Surname, and by Business Phone number. The first field is the text which should be displayed to user. The second field is the attribute which will be searched. The third field is a bitmap which specifies which of the match types (discussed below) are permitted for this search type. A

The next section is a list of search match options, terminated by a a line containing only the string

In this example, there are five ways of refining the search. For each method, there is an LDAP filter suffix which is appended to the ldap filter thus far constructed. The routine ldap_build_filter() may be used to construct the whole filter. It substitutes the appropriate attribute for

EXAMPLE

The following example illustrates one possible configuration of search preferences for

1. Version number

Version 1

1. Name for this search object

People

1. Label to place before text box user types in

In this example, the user may search for People. For

FILES

/etc/ldap/ldapsearchprefs.conf

SEE ALSO

ldap(3)?. ldap-searchprefs(3)?

ACKNOWLEDGEMENTS

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