1ldapfilter.conf(4)               File Formats               ldapfilter.conf(4)
2
3
4

NAME

6       ldapfilter.conf - configuration file for LDAP filtering routines
7

SYNOPSIS

9       /etc/opt/SUNWconn/ldap/current/ldapfilter.conf
10
11

DESCRIPTION

13       The  ldapfilter.conf file contains information used by the LDAP filter‐
14       ing routines.
15
16
17       Blank lines and lines that begin with a hash character (#) are  treated
18       as  comments  and  ignored.  The  configuration information consists of
19       lines that contain one to five tokens. Tokens are  separated  by  white
20       space,  and  double  quotes can be used to include white space inside a
21       token.
22
23
24       The file consists of a sequence of one or more filter  sets.  A  filter
25       set begins with a line containing a single token called a tag.
26
27
28       The  filter set consists of a sequence of one or more filter lists. The
29       first line in a filter list must contain four or five tokens: the value
30       pattern, the delimiter list, a filtertemplate, a match description, and
31       an optional search scope. The value pattern  is  a  regular  expression
32       that  is  matched  against the value passed to the LDAP library call to
33       select the filter list.
34
35
36       The delimiter list is a list of the characters (in the form of a single
37       string) that can be used to break the value into distinct words.
38
39
40       The  filter  template is used to construct an LDAP filter (see descrip‐
41       tion below)
42
43
44       The match description is returned to the caller along with a filter  as
45       a  piece  of  text that can be used to describe the sort of LDAP search
46       that took place. It should correctly  compete  both  of  the  following
47       phrases:  "One  match  description  match was found for ..." and "Three
48       match description matches were found for...."
49
50
51       The search scope is optional, and should be one of base,  onelevel,  or
52       subtree. If search scope is not provided, the default is subtree.
53
54
55       The  remaining  lines  of  the  filter list should contain two or three
56       tokens, a filter template, a match description and an  optional  search
57       scope.
58
59
60       The  filter template is similar in concept to a printf(3C) style format
61       string.  Everything  is  taken  literally  except  for  the   character
62       sequences:
63
64       %v       Substitute the entire value string in place of the %v.
65
66
67       %v$      Substitute the last word in this field.
68
69
70       %vN      Substitute  word  N  in  this field (where N is a single digit
71                1-9). Words are numbered from left to right within  the  value
72                starting at 1.
73
74
75       %vM-N    Substitute  the  indicated sequence of words where M and N are
76                both single digits 1-9.
77
78
79       %vN-     Substitute word N through the last word in value  where  N  is
80                again a single digit 1-9.
81
82

EXAMPLES

84       Example 1 An LDAP Filter Configuration File
85
86
87       The  following LDAP filter configuration file contains two filter sets,
88       example1 and example2 onelevel, each  of  which  contains  four  filter
89       lists.
90
91
92         # ldap filter file
93         #
94         example1
95         "="                " "     "%v"                    "arbitrary filter"
96         "[0-9][0-9-]*"    " "     "(telephoneNumber=*%v)" "phone number"
97
98         "@"                " "     "(mail=%v)"             "email address"
99
100         "^.[. _].*"        ". _"   "(cn=%v1* %v2-)"        "first initial"
101
102         ".*[. _].$"        ". _"   "(cn=%v1-*)"            "last initial"
103
104         "[. _]"            ". _"   "(|(sn=%v1-)(cn=%v1-))"        "exact"
105                                    "(|(sn~=%v1-)(cn~=%v1-))"      "approximate"
106
107         ".*"               ". "    "(|(cn=%v1)(sn=%v1)(uid=%v1))" "exact"
108                                    "(|(cn~=%v1)(sn~=%v1))"        "approximate"
109
110         "example2 onelevel"
111         "^..$"  " "   "(|(o=%v)(c=%v)(l=%v)(co=%v))"       "exact" "onelevel"
112                       "(|(o~=%v)(c~=%v)(l~=%v)(co~=%v))"   "approximate"
113         "onelevel"
114
115         " "     " "   "(|(o=%v)(l=%v)(co=%v)"       "exact"        "onelevel"
116                       "(|(o~=%v)(l~=%v)(co~=%v)"    "approximate"  "onelevel"
117
118         "."    " "   "(associatedDomain=%v)"       "exact"        "onelevel"
119
120         ".*"    " "   "(|(o=%v)(l=%v)(co=%v)"       "exact"        "onelevel"
121                       "(|(o~=%v)(l~=%v)(co~=%v)"    "approximate"  "onelevel"
122
123
124

ATTRIBUTES

126       See attributes(5) for a description of the following attributes:
127
128
129
130
131       ┌─────────────────────────────┬─────────────────────────────┐
132       │ATTRIBUTE TYPE               │ATTRIBUTE VALUE              │
133       ├─────────────────────────────┼─────────────────────────────┤
134       │Availability                 │SUNWlldap                    │
135       │Stability Level              │Evolving                     │
136       └─────────────────────────────┴─────────────────────────────┘
137

SEE ALSO

139       ldap_getfilter(3LDAP), ldap_ufn(3LDAP), attributes(5)
140
141
142
143SunOS 5.11                        9 Jul 2003                ldapfilter.conf(4)
Impressum