version 4, including all changes.
.
| Rev |
Author |
# |
Line |
| 1 |
perry |
1 |
LDAPFILTER.CONF |
| |
|
2 |
!!!LDAPFILTER.CONF |
| |
|
3 |
NAME |
| |
|
4 |
SYNOPSIS |
| |
|
5 |
DESCRIPTION |
| |
|
6 |
EXAMPLE |
| |
|
7 |
FILES |
| |
|
8 |
SEE ALSO |
| |
|
9 |
ACKNOWLEDGEMENTS |
| |
|
10 |
---- |
| |
|
11 |
!!NAME |
| |
|
12 |
|
| |
|
13 |
|
| |
|
14 |
ldapfilter.conf - configuration file for LDAP get filter routines |
| |
|
15 |
!!SYNOPSIS |
| |
|
16 |
|
| |
|
17 |
|
| |
|
18 |
/etc/ldap/ldapfilter.conf |
| |
|
19 |
!!DESCRIPTION |
| |
|
20 |
|
| |
|
21 |
|
| |
|
22 |
The file __/etc/ldap/ldapfilter.conf__ contains |
| |
|
23 |
information used by the LDAP get filter routines (see |
| 4 |
perry |
24 |
ldap-getfilter(3)). Blank lines and lines that have a |
| 1 |
perry |
25 |
first character of `#' are treated as comments and ignored. |
| |
|
26 |
The configuration information consists of lines that contain |
| |
|
27 |
one, two, three, four, or five tokens. Tokens are separated |
| |
|
28 |
by white space, and double quotes ` |
| |
|
29 |
__ |
| |
|
30 |
|
| |
|
31 |
|
| |
|
32 |
The file consists of a sequence of one or more filter sets. |
| |
|
33 |
A filter set begins with a line containing a single token |
| |
|
34 |
called a ''tag.'' The ''tag'' is used in the |
| 4 |
perry |
35 |
ldap_getfirstfilter(3) call to select the filter |
| 1 |
perry |
36 |
set. |
| |
|
37 |
|
| |
|
38 |
|
| |
|
39 |
The filter set consists of a sequence of one or more filter |
| |
|
40 |
lists. The first line in a filter list must contain four or |
| |
|
41 |
five tokens: the ''value pattern,'' the ''delimiter |
| |
|
42 |
list,'' a ''filter template,'' a ''match |
| |
|
43 |
description,'' and an optional ''search scope.'' The |
| |
|
44 |
''value pattern'' is a regular expression that is matched |
| |
|
45 |
against the __value__ passed to the |
| 4 |
perry |
46 |
ldap_getfirstfilter(3) call to select the filter |
| 1 |
perry |
47 |
list. |
| |
|
48 |
|
| |
|
49 |
|
| |
|
50 |
The ''delimiter list'' is a list of characters (in the |
| |
|
51 |
form of a single string) that are used to break the |
| |
|
52 |
__value__ into distinct words. |
| |
|
53 |
|
| |
|
54 |
|
| |
|
55 |
The ''filter template'' is used to construct an LDAP |
| |
|
56 |
filter (it is described further below) |
| |
|
57 |
|
| |
|
58 |
|
| |
|
59 |
The ''match description'' is returned to the called along |
| |
|
60 |
with a filter as a piece of text that can be used to |
| |
|
61 |
describe the sort of LDAP search that took place. It should |
| |
|
62 |
correctly compete both of the following phrases: |
| |
|
63 |
''match description'' match was found for... |
| |
|
64 |
''match description'' matches were found |
| |
|
65 |
for....'' |
| |
|
66 |
|
| |
|
67 |
|
| |
|
68 |
The ''search scope'' is optional, and should be one of |
| |
|
69 |
''search scope'' is not provided, |
| |
|
70 |
the default is '' |
| |
|
71 |
|
| |
|
72 |
|
| |
|
73 |
The remaining lines of the filter list should contain two or |
| |
|
74 |
three tokens, a ''filter template,'' a ''match |
| |
|
75 |
description'' and an optional ''search scope'' (as |
| |
|
76 |
described above). |
| |
|
77 |
|
| |
|
78 |
|
| |
|
79 |
The ''filter template'' is similar in concept to a |
| |
|
80 |
printf(3) style format string. Everything is taken literally |
| |
|
81 |
except for the character sequences: |
| |
|
82 |
|
| |
|
83 |
|
| |
|
84 |
'' %v |
| |
|
85 |
%v$ |
| |
|
86 |
%vN |
| |
|
87 |
%vM-N |
| |
|
88 |
%vN- |
| |
|
89 |
''A plain ''%v'' means to substitute the entire __value__ string 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 indicated sequence of words. A ''%vN-,'' where N is again a single digit 1-9, means substitute word N through the last word in __value.__ |
| |
|
90 |
!!EXAMPLE |
| |
|
91 |
|
| |
|
92 |
|
| |
|
93 |
The following ldap filter configuration file contains two |
| |
|
94 |
filter sets (__finger__ and __go500gw onelevel__), |
| |
|
95 |
each of which contains four filter lists. |
| |
|
96 |
|
| |
|
97 |
|
| |
|
98 |
# ldap filter file |
| |
|
99 |
# |
| |
|
100 |
finger |
| |
|
101 |
The call __ldap_getfirstfilter( lfdp, __ will return an LDAPFiltInfo structure with the __lfi_filter__ member containing the string ''(cn=m* smith)'' with the __lfi_desc__ member containing the string ''first initial,'' and __lfi_scope__ containing the value LDAP_SCOPE_SUBTREE. |
| |
|
102 |
|
| |
|
103 |
|
| |
|
104 |
The call __ldap_getfirstfilter( lfdp, |
| |
|
105 |
__ will return an |
| |
|
106 |
LDAPFiltInfo structure with the __lfi_filter__ member |
| |
|
107 |
containing the string ''(|(o=umich)(l=umich)(co=umich)'' |
| |
|
108 |
with the __lfi_desc__ member containing the string |
| |
|
109 |
''exact,'' and __lfi_scope__ containing the value |
| |
|
110 |
LDAP_SCOPE_ONELEVEL. |
| |
|
111 |
!!FILES |
| |
|
112 |
|
| |
|
113 |
|
| |
|
114 |
/etc/ldap/ldapfilter.conf |
| |
|
115 |
!!SEE ALSO |
| |
|
116 |
|
| |
|
117 |
|
| 4 |
perry |
118 |
ldap(3), ldap_getfilter(3) |
| 1 |
perry |
119 |
!!ACKNOWLEDGEMENTS |
| |
|
120 |
|
| |
|
121 |
|
| |
|
122 |
__OpenLDAP__ is developed and maintained by The OpenLDAP |
| |
|
123 |
Project (http://www.openldap.org/). __OpenLDAP__ is |
| |
|
124 |
derived from University of Michigan LDAP 3.3 |
| |
|
125 |
Release. |
| |
|
126 |
---- |
