Merge commit 'upstream/1.7.4'
[debian/sudo] / sudoers.ldap.man.in
1 .\" Copyright (c) 2003-2010
2 .\"     Todd C. Miller <Todd.Miller@courtesan.com>
3 .\" 
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\" 
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
16 .\" 
17 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
18 .\"
19 .\" Standard preamble:
20 .\" ========================================================================
21 .de Sp \" Vertical space (when we can't use .PP)
22 .if t .sp .5v
23 .if n .sp
24 ..
25 .de Vb \" Begin verbatim text
26 .ft CW
27 .nf
28 .ne \\$1
29 ..
30 .de Ve \" End verbatim text
31 .ft R
32 .fi
33 ..
34 .\" Set up some character translations and predefined strings.  \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
37 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
38 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
39 .\" nothing in troff, for use with C<>.
40 .tr \(*W-
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
42 .ie n \{\
43 .    ds -- \(*W-
44 .    ds PI pi
45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
47 .    ds L" ""
48 .    ds R" ""
49 .    ds C` 
50 .    ds C' 
51 'br\}
52 .el\{\
53 .    ds -- \|\(em\|
54 .    ds PI \(*p
55 .    ds L" ``
56 .    ds R" ''
57 'br\}
58 .\"
59 .\" Escape single quotes in literal strings from groff's Unicode transform.
60 .ie \n(.g .ds Aq \(aq
61 .el       .ds Aq '
62 .\"
63 .\" If the F register is turned on, we'll generate index entries on stderr for
64 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
65 .\" entries marked with X<> in POD.  Of course, you'll have to process the
66 .\" output yourself in some meaningful fashion.
67 .ie \nF \{\
68 .    de IX
69 .    tm Index:\\$1\t\\n%\t"\\$2"
70 ..
71 .    nr % 0
72 .    rr F
73 .\}
74 .el \{\
75 .    de IX
76 ..
77 .\}
78 .\"
79 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
80 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
81 .    \" fudge factors for nroff and troff
82 .if n \{\
83 .    ds #H 0
84 .    ds #V .8m
85 .    ds #F .3m
86 .    ds #[ \f1
87 .    ds #] \fP
88 .\}
89 .if t \{\
90 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
91 .    ds #V .6m
92 .    ds #F 0
93 .    ds #[ \&
94 .    ds #] \&
95 .\}
96 .    \" simple accents for nroff and troff
97 .if n \{\
98 .    ds ' \&
99 .    ds ` \&
100 .    ds ^ \&
101 .    ds , \&
102 .    ds ~ ~
103 .    ds /
104 .\}
105 .if t \{\
106 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
107 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
108 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
109 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
110 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
111 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
112 .\}
113 .    \" troff and (daisy-wheel) nroff accents
114 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
115 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
116 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
117 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
118 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
119 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
120 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
121 .ds ae a\h'-(\w'a'u*4/10)'e
122 .ds Ae A\h'-(\w'A'u*4/10)'E
123 .    \" corrections for vroff
124 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
125 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
126 .    \" for low resolution devices (crt and lpr)
127 .if \n(.H>23 .if \n(.V>19 \
128 \{\
129 .    ds : e
130 .    ds 8 ss
131 .    ds o a
132 .    ds d- d\h'-1'\(ga
133 .    ds D- D\h'-1'\(hy
134 .    ds th \o'bp'
135 .    ds Th \o'LP'
136 .    ds ae ae
137 .    ds Ae AE
138 .\}
139 .rm #[ #] #H #V #F C
140 .\" ========================================================================
141 .\"
142 .IX Title "SUDOERS.LDAP @mansectform@"
143 .TH SUDOERS.LDAP @mansectform@ "July 12, 2010" "1.7.4" "MAINTENANCE COMMANDS"
144 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
145 .\" way too many mistakes in technical documents.
146 .if n .ad l
147 .nh
148 .SH "NAME"
149 sudoers.ldap \- sudo LDAP configuration
150 .SH "DESCRIPTION"
151 .IX Header "DESCRIPTION"
152 In addition to the standard \fIsudoers\fR file, \fBsudo\fR may be configured
153 via \s-1LDAP\s0.  This can be especially useful for synchronizing \fIsudoers\fR
154 in a large, distributed environment.
155 .PP
156 Using \s-1LDAP\s0 for \fIsudoers\fR has several benefits:
157 .IP "\(bu" 4
158 \&\fBsudo\fR no longer needs to read \fIsudoers\fR in its entirety.  When
159 \&\s-1LDAP\s0 is used, there are only two or three \s-1LDAP\s0 queries per invocation.
160 This makes it especially fast and particularly usable in \s-1LDAP\s0
161 environments.
162 .IP "\(bu" 4
163 \&\fBsudo\fR no longer exits if there is a typo in \fIsudoers\fR.
164 It is not possible to load \s-1LDAP\s0 data into the server that does
165 not conform to the sudoers schema, so proper syntax is guaranteed.
166 It is still possible to have typos in a user or host name, but
167 this will not prevent \fBsudo\fR from running.
168 .IP "\(bu" 4
169 It is possible to specify per-entry options that override the global
170 default options.  \fI@sysconfdir@/sudoers\fR only supports default options and
171 limited options associated with user/host/commands/aliases.  The
172 syntax is complicated and can be difficult for users to understand.
173 Placing the options directly in the entry is more natural.
174 .IP "\(bu" 4
175 The \fBvisudo\fR program is no longer needed.  \fBvisudo\fR provides
176 locking and syntax checking of the \fI@sysconfdir@/sudoers\fR file.
177 Since \s-1LDAP\s0 updates are atomic, locking is no longer necessary.
178 Because syntax is checked when the data is inserted into \s-1LDAP\s0, there
179 is no need for a specialized tool to check syntax.
180 .PP
181 Another major difference between \s-1LDAP\s0 and file-based \fIsudoers\fR
182 is that in \s-1LDAP\s0, \fBsudo\fR\-specific Aliases are not supported.
183 .PP
184 For the most part, there is really no need for \fBsudo\fR\-specific
185 Aliases.  Unix groups or user netgroups can be used in place of
186 User_Aliases and RunasAliases.  Host netgroups can be used in place
187 of HostAliases.  Since Unix groups and netgroups can also be stored
188 in \s-1LDAP\s0 there is no real need for \fBsudo\fR\-specific aliases.
189 .PP
190 Cmnd_Aliases are not really required either since it is possible
191 to have multiple users listed in a sudoRole.  Instead of defining
192 a Cmnd_Alias that is referenced by multiple users, one can create
193 a sudoRole that contains the commands and assign multiple users
194 to it.
195 .SS "SUDOers \s-1LDAP\s0 container"
196 .IX Subsection "SUDOers LDAP container"
197 The \fIsudoers\fR configuration is contained in the \f(CW\*(C`ou=SUDOers\*(C'\fR \s-1LDAP\s0
198 container.
199 .PP
200 Sudo first looks for the \f(CW\*(C`cn=default\*(C'\fR entry in the SUDOers container.
201 If found, the multi-valued \f(CW\*(C`sudoOption\*(C'\fR attribute is parsed in the
202 same manner as a global \f(CW\*(C`Defaults\*(C'\fR line in \fI@sysconfdir@/sudoers\fR.  In
203 the following example, the \f(CW\*(C`SSH_AUTH_SOCK\*(C'\fR variable will be preserved
204 in the environment for all users.
205 .PP
206 .Vb 6
207 \&    dn: cn=defaults,ou=SUDOers,dc=example,dc=com
208 \&    objectClass: top
209 \&    objectClass: sudoRole
210 \&    cn: defaults
211 \&    description: Default sudoOption\*(Aqs go here
212 \&    sudoOption: env_keep+=SSH_AUTH_SOCK
213 .Ve
214 .PP
215 The equivalent of a sudoer in \s-1LDAP\s0 is a \f(CW\*(C`sudoRole\*(C'\fR.  It consists of
216 the following components:
217 .IP "\fBsudoUser\fR" 4
218 .IX Item "sudoUser"
219 A user name, uid (prefixed with \f(CW\*(Aq#\*(Aq\fR), Unix group (prefixed with
220 a \f(CW\*(Aq%\*(Aq\fR) or user netgroup (prefixed with a \f(CW\*(Aq+\*(Aq\fR).
221 .IP "\fBsudoHost\fR" 4
222 .IX Item "sudoHost"
223 A host name, \s-1IP\s0 address, \s-1IP\s0 network, or host netgroup (prefixed
224 with a \f(CW\*(Aq+\*(Aq\fR).
225 The special value \f(CW\*(C`ALL\*(C'\fR will match any host.
226 .IP "\fBsudoCommand\fR" 4
227 .IX Item "sudoCommand"
228 A Unix command with optional command line arguments, potentially
229 including globbing characters (aka wild cards).
230 The special value \f(CW\*(C`ALL\*(C'\fR will match any command.
231 If a command is prefixed with an exclamation point \f(CW\*(Aq!\*(Aq\fR, the
232 user will be prohibited from running that command.
233 .IP "\fBsudoOption\fR" 4
234 .IX Item "sudoOption"
235 Identical in function to the global options described above, but
236 specific to the \f(CW\*(C`sudoRole\*(C'\fR in which it resides.
237 .IP "\fBsudoRunAsUser\fR" 4
238 .IX Item "sudoRunAsUser"
239 A user name or uid (prefixed with \f(CW\*(Aq#\*(Aq\fR) that commands may be run
240 as or a Unix group (prefixed with a \f(CW\*(Aq%\*(Aq\fR) or user netgroup (prefixed
241 with a \f(CW\*(Aq+\*(Aq\fR) that contains a list of users that commands may be
242 run as.
243 The special value \f(CW\*(C`ALL\*(C'\fR will match any user.
244 .IP "\fBsudoRunAsGroup\fR" 4
245 .IX Item "sudoRunAsGroup"
246 A Unix group or gid (prefixed with \f(CW\*(Aq#\*(Aq\fR) that commands may be run as.
247 The special value \f(CW\*(C`ALL\*(C'\fR will match any group.
248 .PP
249 Each component listed above should contain a single value, but there
250 may be multiple instances of each component type.  A sudoRole must
251 contain at least one \f(CW\*(C`sudoUser\*(C'\fR, \f(CW\*(C`sudoHost\*(C'\fR and \f(CW\*(C`sudoCommand\*(C'\fR.
252 .PP
253 The following example allows users in group wheel to run any command
254 on any host via \fBsudo\fR:
255 .PP
256 .Vb 7
257 \&    dn: cn=%wheel,ou=SUDOers,dc=example,dc=com
258 \&    objectClass: top
259 \&    objectClass: sudoRole
260 \&    cn: %wheel
261 \&    sudoUser: %wheel
262 \&    sudoHost: ALL
263 \&    sudoCommand: ALL
264 .Ve
265 .SS "Anatomy of \s-1LDAP\s0 sudoers lookup"
266 .IX Subsection "Anatomy of LDAP sudoers lookup"
267 When looking up a sudoer using \s-1LDAP\s0 there are only two or three
268 \&\s-1LDAP\s0 queries per invocation.  The first query is to parse the global
269 options.  The second is to match against the user's name and the
270 groups that the user belongs to.  (The special \s-1ALL\s0 tag is matched
271 in this query too.)  If no match is returned for the user's name
272 and groups, a third query returns all entries containing user
273 netgroups and checks to see if the user belongs to any of them.
274 .SS "Differences between \s-1LDAP\s0 and non-LDAP sudoers"
275 .IX Subsection "Differences between LDAP and non-LDAP sudoers"
276 There are some subtle differences in the way sudoers is handled
277 once in \s-1LDAP\s0.  Probably the biggest is that according to the \s-1RFC\s0,
278 \&\s-1LDAP\s0 ordering is arbitrary and you cannot expect that Attributes
279 and Entries are returned in any specific order.  If there are
280 conflicting command rules on an entry, the negative takes precedence.
281 This is called paranoid behavior (not necessarily the most specific
282 match).
283 .PP
284 Here is an example:
285 .PP
286 .Vb 5
287 \&    # /etc/sudoers:
288 \&    # Allow all commands except shell
289 \&    johnny  ALL=(root) ALL,!/bin/sh
290 \&    # Always allows all commands because ALL is matched last
291 \&    puddles ALL=(root) !/bin/sh,ALL
292 \&
293 \&    # LDAP equivalent of johnny
294 \&    # Allows all commands except shell
295 \&    dn: cn=role1,ou=Sudoers,dc=my\-domain,dc=com
296 \&    objectClass: sudoRole
297 \&    objectClass: top
298 \&    cn: role1
299 \&    sudoUser: johnny
300 \&    sudoHost: ALL
301 \&    sudoCommand: ALL
302 \&    sudoCommand: !/bin/sh
303 \&
304 \&    # LDAP equivalent of puddles
305 \&    # Notice that even though ALL comes last, it still behaves like
306 \&    # role1 since the LDAP code assumes the more paranoid configuration
307 \&    dn: cn=role2,ou=Sudoers,dc=my\-domain,dc=com
308 \&    objectClass: sudoRole
309 \&    objectClass: top
310 \&    cn: role2
311 \&    sudoUser: puddles
312 \&    sudoHost: ALL
313 \&    sudoCommand: !/bin/sh
314 \&    sudoCommand: ALL
315 .Ve
316 .PP
317 Another difference is that negations on the Host, User or Runas are
318 currently ignorred.  For example, the following attributes do not
319 behave the way one might expect.
320 .PP
321 .Vb 3
322 \&    # does not match all but joe
323 \&    # rather, does not match anyone
324 \&    sudoUser: !joe
325 \&
326 \&    # does not match all but joe
327 \&    # rather, matches everyone including Joe
328 \&    sudoUser: ALL
329 \&    sudoUser: !joe
330 \&
331 \&    # does not match all but web01
332 \&    # rather, matches all hosts including web01
333 \&    sudoHost: ALL
334 \&    sudoHost: !web01
335 .Ve
336 .SS "Sudoers Schema"
337 .IX Subsection "Sudoers Schema"
338 In order to use \fBsudo\fR's \s-1LDAP\s0 support, the \fBsudo\fR schema must be
339 installed on your \s-1LDAP\s0 server.  In addition, be sure to index the
340 \&'sudoUser' attribute.
341 .PP
342 Three versions of the schema: one for OpenLDAP servers (\fIschema.OpenLDAP\fR),
343 one for Netscape-derived servers (\fIschema.iPlanet\fR), and one for
344 Microsoft Active Directory (\fIschema.ActiveDirectory\fR) may
345 be found in the \fBsudo\fR distribution.
346 .PP
347 The schema for \fBsudo\fR in OpenLDAP form is included in the \s-1EXAMPLES\s0
348 section.
349 .SS "Configuring ldap.conf"
350 .IX Subsection "Configuring ldap.conf"
351 Sudo reads the \fI@ldap_conf@\fR file for LDAP-specific configuration.
352 Typically, this file is shared amongst different LDAP-aware clients.
353 As such, most of the settings are not \fBsudo\fR\-specific.  Note that
354 \&\fBsudo\fR parses \fI@ldap_conf@\fR itself and may support options
355 that differ from those described in the \fIldap.conf\fR\|(@mansectform@) manual.
356 .PP
357 Also note that on systems using the OpenLDAP libraries, default
358 values specified in \fI/etc/openldap/ldap.conf\fR or the user's
359 \&\fI.ldaprc\fR files are not used.
360 .PP
361 Only those options explicitly listed in \fI@ldap_conf@\fR that are
362 supported by \fBsudo\fR are honored.  Configuration options are listed
363 below in upper case but are parsed in a case-independent manner.
364 .IP "\fB\s-1URI\s0\fR ldap[s]://[hostname[:port]] ..." 4
365 .IX Item "URI ldap[s]://[hostname[:port]] ..."
366 Specifies a whitespace-delimited list of one or more URIs describing
367 the \s-1LDAP\s0 server(s) to connect to.  The \fIprotocol\fR may be either
368 \&\fBldap\fR or \fBldaps\fR, the latter being for servers that support \s-1TLS\s0
369 (\s-1SSL\s0) encryption.  If no \fIport\fR is specified, the default is port
370 389 for \f(CW\*(C`ldap://\*(C'\fR or port 636 for \f(CW\*(C`ldaps://\*(C'\fR.  If no \fIhostname\fR
371 is specified, \fBsudo\fR will connect to \fBlocalhost\fR.  Multiple \fB\s-1URI\s0\fR
372 lines are treated identically to a \fB\s-1URI\s0\fR line containing multiple
373 entries.  Only systems using the OpenSSL libraries support the
374 mixing of \f(CW\*(C`ldap://\*(C'\fR and \f(CW\*(C`ldaps://\*(C'\fR URIs.  The Netscape-derived
375 libraries used on most commercial versions of Unix are only capable
376 of supporting one or the other.
377 .IP "\fB\s-1HOST\s0\fR name[:port] ..." 4
378 .IX Item "HOST name[:port] ..."
379 If no \fB\s-1URI\s0\fR is specified, the \fB\s-1HOST\s0\fR parameter specifies a
380 whitespace-delimited list of \s-1LDAP\s0 servers to connect to.  Each host
381 may include an optional \fIport\fR separated by a colon (':').  The
382 \&\fB\s-1HOST\s0\fR parameter is deprecated in favor of the \fB\s-1URI\s0\fR specification
383 and is included for backwards compatibility.
384 .IP "\fB\s-1PORT\s0\fR port_number" 4
385 .IX Item "PORT port_number"
386 If no \fB\s-1URI\s0\fR is specified, the \fB\s-1PORT\s0\fR parameter specifies the
387 default port to connect to on the \s-1LDAP\s0 server if a \fB\s-1HOST\s0\fR parameter
388 does not specify the port itself.  If no \fB\s-1PORT\s0\fR parameter is used,
389 the default is port 389 for \s-1LDAP\s0 and port 636 for \s-1LDAP\s0 over \s-1TLS\s0
390 (\s-1SSL\s0).  The \fB\s-1PORT\s0\fR parameter is deprecated in favor of the \fB\s-1URI\s0\fR
391 specification and is included for backwards compatibility.
392 .IP "\fB\s-1BIND_TIMELIMIT\s0\fR seconds" 4
393 .IX Item "BIND_TIMELIMIT seconds"
394 The \fB\s-1BIND_TIMELIMIT\s0\fR parameter specifies the amount of time, in seconds,
395 to wait while trying to connect to an \s-1LDAP\s0 server.  If multiple \fB\s-1URI\s0\fRs or
396 \&\fB\s-1HOST\s0\fRs are specified, this is the amount of time to wait before trying
397 the next one in the list.
398 .IP "\fB\s-1TIMELIMIT\s0\fR seconds" 4
399 .IX Item "TIMELIMIT seconds"
400 The \fB\s-1TIMELIMIT\s0\fR parameter specifies the amount of time, in seconds,
401 to wait for a response to an \s-1LDAP\s0 query.
402 .IP "\fB\s-1SUDOERS_BASE\s0\fR base" 4
403 .IX Item "SUDOERS_BASE base"
404 The base \s-1DN\s0 to use when performing \fBsudo\fR \s-1LDAP\s0 queries.  Typically
405 this is of the form \f(CW\*(C`ou=SUDOers,dc=example,dc=com\*(C'\fR for the domain
406 \&\f(CW\*(C`example.com\*(C'\fR.  Multiple \fB\s-1SUDOERS_BASE\s0\fR lines may be specified,
407 in which case they are queried in the order specified.
408 .IP "\fB\s-1SUDOERS_DEBUG\s0\fR debug_level" 4
409 .IX Item "SUDOERS_DEBUG debug_level"
410 This sets the debug level for \fBsudo\fR \s-1LDAP\s0 queries.  Debugging
411 information is printed to the standard error.  A value of 1 results
412 in a moderate amount of debugging information.  A value of 2 shows
413 the results of the matches themselves.  This parameter should not
414 be set in a production environment as the extra information is
415 likely to confuse users.
416 .IP "\fB\s-1BINDDN\s0\fR \s-1DN\s0" 4
417 .IX Item "BINDDN DN"
418 The \fB\s-1BINDDN\s0\fR parameter specifies the identity, in the form of a
419 Distinguished Name (\s-1DN\s0), to use when performing \s-1LDAP\s0 operations.
420 If not specified, \s-1LDAP\s0 operations are performed with an anonymous
421 identity.  By default, most \s-1LDAP\s0 servers will allow anonymous access.
422 .IP "\fB\s-1BINDPW\s0\fR secret" 4
423 .IX Item "BINDPW secret"
424 The \fB\s-1BINDPW\s0\fR parameter specifies the password to use when performing
425 \&\s-1LDAP\s0 operations.  This is typically used in conjunction with the
426 \&\fB\s-1BINDDN\s0\fR parameter.
427 .IP "\fB\s-1ROOTBINDDN\s0\fR \s-1DN\s0" 4
428 .IX Item "ROOTBINDDN DN"
429 The \fB\s-1ROOTBINDDN\s0\fR parameter specifies the identity, in the form of
430 a Distinguished Name (\s-1DN\s0), to use when performing privileged \s-1LDAP\s0
431 operations, such as \fIsudoers\fR queries.  The password corresponding
432 to the identity should be stored in \fI@ldap_secret@\fR.
433 If not specified, the \fB\s-1BINDDN\s0\fR identity is used (if any).
434 .IP "\fB\s-1LDAP_VERSION\s0\fR number" 4
435 .IX Item "LDAP_VERSION number"
436 The version of the \s-1LDAP\s0 protocol to use when connecting to the server.
437 The default value is protocol version 3.
438 .IP "\fB\s-1SSL\s0\fR on/true/yes/off/false/no" 4
439 .IX Item "SSL on/true/yes/off/false/no"
440 If the \fB\s-1SSL\s0\fR parameter is set to \f(CW\*(C`on\*(C'\fR, \f(CW\*(C`true\*(C'\fR or \f(CW\*(C`yes\*(C'\fR, \s-1TLS\s0
441 (\s-1SSL\s0) encryption is always used when communicating with the \s-1LDAP\s0
442 server.  Typically, this involves connecting to the server on port
443 636 (ldaps).
444 .IP "\fB\s-1SSL\s0\fR start_tls" 4
445 .IX Item "SSL start_tls"
446 If the \fB\s-1SSL\s0\fR parameter is set to \f(CW\*(C`start_tls\*(C'\fR, the \s-1LDAP\s0 server
447 connection is initiated normally and \s-1TLS\s0 encryption is begun before
448 the bind credentials are sent.  This has the advantage of not
449 requiring a dedicated port for encrypted communications.  This
450 parameter is only supported by \s-1LDAP\s0 servers that honor the \f(CW\*(C`start_tls\*(C'\fR
451 extension, such as the OpenLDAP server.
452 .IP "\fB\s-1TLS_CHECKPEER\s0\fR on/true/yes/off/false/no" 4
453 .IX Item "TLS_CHECKPEER on/true/yes/off/false/no"
454 If enabled, \fB\s-1TLS_CHECKPEER\s0\fR will cause the \s-1LDAP\s0 server's \s-1TLS\s0
455 certificated to be verified.  If the server's \s-1TLS\s0 certificate cannot
456 be verified (usually because it is signed by an unknown certificate
457 authority), \fBsudo\fR will be unable to connect to it.  If \fB\s-1TLS_CHECKPEER\s0\fR
458 is disabled, no check is made.  Note that disabling the check creates
459 an opportunity for man-in-the-middle attacks since the server's
460 identity will not be authenticated.  If possible, the \s-1CA\s0's certificate
461 should be installed locally so it can be verified.
462 .IP "\fB\s-1TLS_CACERT\s0\fR file name" 4
463 .IX Item "TLS_CACERT file name"
464 An alias for \fB\s-1TLS_CACERTFILE\s0\fR.
465 .IP "\fB\s-1TLS_CACERTFILE\s0\fR file name" 4
466 .IX Item "TLS_CACERTFILE file name"
467 The path to a certificate authority bundle which contains the certificates
468 for all the Certificate Authorities the client knows to be valid,
469 e.g. \fI/etc/ssl/ca\-bundle.pem\fR.
470 This option is only supported by the OpenLDAP libraries.
471 Netscape-derived \s-1LDAP\s0 libraries use the same certificate
472 database for \s-1CA\s0 and client certificates (see \fB\s-1TLS_CERT\s0\fR).
473 .IP "\fB\s-1TLS_CACERTDIR\s0\fR directory" 4
474 .IX Item "TLS_CACERTDIR directory"
475 Similar to \fB\s-1TLS_CACERTFILE\s0\fR but instead of a file, it is a
476 directory containing individual Certificate Authority certificates,
477 e.g. \fI/etc/ssl/certs\fR.
478 The directory specified by \fB\s-1TLS_CACERTDIR\s0\fR is checked after
479 \&\fB\s-1TLS_CACERTFILE\s0\fR.
480 This option is only supported by the OpenLDAP libraries.
481 .IP "\fB\s-1TLS_CERT\s0\fR file name" 4
482 .IX Item "TLS_CERT file name"
483 The path to a file containing the client certificate which can
484 be used to authenticate the client to the \s-1LDAP\s0 server.
485 The certificate type depends on the \s-1LDAP\s0 libraries used.
486 .Sp
487 OpenLDAP:
488     \f(CW\*(C`tls_cert /etc/ssl/client_cert.pem\*(C'\fR
489 .Sp
490 Netscape-derived:
491     \f(CW\*(C`tls_cert /var/ldap/cert7.db\*(C'\fR
492 .Sp
493 When using Netscape-derived libraries, this file may also contain
494 Certificate Authority certificates.
495 .IP "\fB\s-1TLS_KEY\s0\fR file name" 4
496 .IX Item "TLS_KEY file name"
497 The path to a file containing the private key which matches the
498 certificate specified by \fB\s-1TLS_CERT\s0\fR.  The private key must not be
499 password-protected.  The key type depends on the \s-1LDAP\s0 libraries
500 used.
501 .Sp
502 OpenLDAP:
503     \f(CW\*(C`tls_key /etc/ssl/client_key.pem\*(C'\fR
504 .Sp
505 Netscape-derived:
506     \f(CW\*(C`tls_key /var/ldap/key3.db\*(C'\fR
507 .IP "\fB\s-1TLS_RANDFILE\s0\fR file name" 4
508 .IX Item "TLS_RANDFILE file name"
509 The \fB\s-1TLS_RANDFILE\s0\fR parameter specifies the path to an entropy
510 source for systems that lack a random device.  It is generally used
511 in conjunction with \fIprngd\fR or \fIegd\fR.
512 This option is only supported by the OpenLDAP libraries.
513 .IP "\fB\s-1TLS_CIPHERS\s0\fR cipher list" 4
514 .IX Item "TLS_CIPHERS cipher list"
515 The \fB\s-1TLS_CIPHERS\s0\fR parameter allows the administer to restrict
516 which encryption algorithms may be used for \s-1TLS\s0 (\s-1SSL\s0) connections.
517 See the OpenSSL manual for a list of valid ciphers.
518 This option is only supported by the OpenLDAP libraries.
519 .IP "\fB\s-1USE_SASL\s0\fR on/true/yes/off/false/no" 4
520 .IX Item "USE_SASL on/true/yes/off/false/no"
521 Enable \fB\s-1USE_SASL\s0\fR for \s-1LDAP\s0 servers that support \s-1SASL\s0 authentication.
522 .IP "\fB\s-1SASL_AUTH_ID\s0\fR identity" 4
523 .IX Item "SASL_AUTH_ID identity"
524 The \s-1SASL\s0 user name to use when connecting to the \s-1LDAP\s0 server.
525 By default, \fBsudo\fR will use an anonymous connection.
526 .IP "\fB\s-1ROOTUSE_SASL\s0\fR on/true/yes/off/false/no" 4
527 .IX Item "ROOTUSE_SASL on/true/yes/off/false/no"
528 Enable \fB\s-1ROOTUSE_SASL\s0\fR to enable \s-1SASL\s0 authentication when connecting
529 to an \s-1LDAP\s0 server from a privileged process, such as \fBsudo\fR.
530 .IP "\fB\s-1ROOTSASL_AUTH_ID\s0\fR identity" 4
531 .IX Item "ROOTSASL_AUTH_ID identity"
532 The \s-1SASL\s0 user name to use when \fB\s-1ROOTUSE_SASL\s0\fR is enabled.
533 .IP "\fB\s-1SASL_SECPROPS\s0\fR none/properties" 4
534 .IX Item "SASL_SECPROPS none/properties"
535 \&\s-1SASL\s0 security properties or \fInone\fR for no properties.  See the
536 \&\s-1SASL\s0 programmer's manual for details.
537 .IP "\fB\s-1KRB5_CCNAME\s0\fR file name" 4
538 .IX Item "KRB5_CCNAME file name"
539 The path to the Kerberos 5 credential cache to use when authenticating
540 with the remote server.
541 .PP
542 See the \f(CW\*(C`ldap.conf\*(C'\fR entry in the \s-1EXAMPLES\s0 section.
543 .SS "Configuring nsswitch.conf"
544 .IX Subsection "Configuring nsswitch.conf"
545 Unless it is disabled at build time, \fBsudo\fR consults the Name
546 Service Switch file, \fI@nsswitch_conf@\fR, to specify the \fIsudoers\fR
547 search order.  Sudo looks for a line beginning with \f(CW\*(C`sudoers\*(C'\fR: and
548 uses this to determine the search order.  Note that \fBsudo\fR does
549 not stop searching after the first match and later matches take
550 precedence over earlier ones.
551 .PP
552 The following sources are recognized:
553 .PP
554 .Vb 2
555 \&    files       read sudoers from F<@sysconfdir@/sudoers>
556 \&    ldap        read sudoers from LDAP
557 .Ve
558 .PP
559 In addition, the entry \f(CW\*(C`[NOTFOUND=return]\*(C'\fR will short-circuit the
560 search if the user was not found in the preceding source.
561 .PP
562 To consult \s-1LDAP\s0 first followed by the local sudoers file (if it
563 exists), use:
564 .PP
565 .Vb 1
566 \&    sudoers: ldap files
567 .Ve
568 .PP
569 The local \fIsudoers\fR file can be ignored completely by using:
570 .PP
571 .Vb 1
572 \&    sudoers: ldap
573 .Ve
574 .PP
575 If the \fI@nsswitch_conf@\fR file is not present or there is no
576 sudoers line, the following default is assumed:
577 .PP
578 .Vb 1
579 \&    sudoers: files
580 .Ve
581 .PP
582 Note that \fI@nsswitch_conf@\fR is supported even when the underlying
583 operating system does not use an nsswitch.conf file.
584 .SS "Configuring netsvc.conf"
585 .IX Subsection "Configuring netsvc.conf"
586 On \s-1AIX\s0 systems, the \fI@netsvc_conf@\fR file is consulted instead of
587 \&\fI@nsswitch_conf@\fR.  \fBsudo\fR simply treats \fInetsvc.conf\fR as a
588 variant of \fInsswitch.conf\fR; information in the previous section
589 unrelated to the file format itself still applies.
590 .PP
591 To consult \s-1LDAP\s0 first followed by the local sudoers file (if it
592 exists), use:
593 .PP
594 .Vb 1
595 \&    sudoers = ldap, files
596 .Ve
597 .PP
598 The local \fIsudoers\fR file can be ignored completely by using:
599 .PP
600 .Vb 1
601 \&    sudoers = ldap
602 .Ve
603 .PP
604 To treat \s-1LDAP\s0 as authoratative and only use the local sudoers file
605 if the user is not present in \s-1LDAP\s0, use:
606 .PP
607 .Vb 1
608 \&    sudoers = ldap = auth, files
609 .Ve
610 .PP
611 Note that in the above example, the \f(CW\*(C`auth\*(C'\fR qualfier only affects
612 user lookups; both \s-1LDAP\s0 and \fIsudoers\fR will be queried for \f(CW\*(C`Defaults\*(C'\fR
613 entries.
614 .PP
615 If the \fI@netsvc_conf@\fR file is not present or there is no
616 sudoers line, the following default is assumed:
617 .PP
618 .Vb 1
619 \&    sudoers = files
620 .Ve
621 .SH "FILES"
622 .IX Header "FILES"
623 .ie n .IP "\fI@ldap_conf@\fR" 24
624 .el .IP "\fI@ldap_conf@\fR" 24
625 .IX Item "@ldap_conf@"
626 \&\s-1LDAP\s0 configuration file
627 .ie n .IP "\fI@nsswitch_conf@\fR" 24
628 .el .IP "\fI@nsswitch_conf@\fR" 24
629 .IX Item "@nsswitch_conf@"
630 determines sudoers source order
631 .ie n .IP "\fI@netsvc_conf@\fR" 24
632 .el .IP "\fI@netsvc_conf@\fR" 24
633 .IX Item "@netsvc_conf@"
634 determines sudoers source order on \s-1AIX\s0
635 .SH "EXAMPLES"
636 .IX Header "EXAMPLES"
637 .SS "Example ldap.conf"
638 .IX Subsection "Example ldap.conf"
639 .Vb 10
640 \&  # Either specify one or more URIs or one or more host:port pairs.
641 \&  # If neither is specified sudo will default to localhost, port 389.
642 \&  #
643 \&  #host          ldapserver
644 \&  #host          ldapserver1 ldapserver2:390
645 \&  #
646 \&  # Default port if host is specified without one, defaults to 389.
647 \&  #port          389
648 \&  #
649 \&  # URI will override the host and port settings.
650 \&  uri            ldap://ldapserver
651 \&  #uri            ldaps://secureldapserver
652 \&  #uri            ldaps://secureldapserver ldap://ldapserver
653 \&  #
654 \&  # The amount of time, in seconds, to wait while trying to connect to
655 \&  # an LDAP server.
656 \&  bind_timelimit 30
657 \&  #
658 \&  # The amount of time, in seconds, to wait while performing an LDAP query.
659 \&  timelimit 30
660 \&  #
661 \&  # Must be set or sudo will ignore LDAP; may be specified multiple times.
662 \&  sudoers_base   ou=SUDOers,dc=example,dc=com
663 \&  #
664 \&  # verbose sudoers matching from ldap
665 \&  #sudoers_debug 2
666 \&  #
667 \&  # optional proxy credentials
668 \&  #binddn        <who to search as>
669 \&  #bindpw        <password>
670 \&  #rootbinddn    <who to search as, uses /etc/ldap.secret for bindpw>
671 \&  #
672 \&  # LDAP protocol version, defaults to 3
673 \&  #ldap_version 3
674 \&  #
675 \&  # Define if you want to use an encrypted LDAP connection.
676 \&  # Typically, you must also set the port to 636 (ldaps).
677 \&  #ssl on
678 \&  #
679 \&  # Define if you want to use port 389 and switch to
680 \&  # encryption before the bind credentials are sent.
681 \&  # Only supported by LDAP servers that support the start_tls
682 \&  # extension such as OpenLDAP.
683 \&  #ssl start_tls
684 \&  #
685 \&  # Additional TLS options follow that allow tweaking of the
686 \&  # SSL/TLS connection.
687 \&  #
688 \&  #tls_checkpeer yes # verify server SSL certificate
689 \&  #tls_checkpeer no  # ignore server SSL certificate
690 \&  #
691 \&  # If you enable tls_checkpeer, specify either tls_cacertfile
692 \&  # or tls_cacertdir.  Only supported when using OpenLDAP.
693 \&  #
694 \&  #tls_cacertfile /etc/certs/trusted_signers.pem
695 \&  #tls_cacertdir  /etc/certs
696 \&  #
697 \&  # For systems that don\*(Aqt have /dev/random
698 \&  # use this along with PRNGD or EGD.pl to seed the
699 \&  # random number pool to generate cryptographic session keys.
700 \&  # Only supported when using OpenLDAP.
701 \&  #
702 \&  #tls_randfile /etc/egd\-pool
703 \&  #
704 \&  # You may restrict which ciphers are used.  Consult your SSL
705 \&  # documentation for which options go here.
706 \&  # Only supported when using OpenLDAP.
707 \&  #
708 \&  #tls_ciphers <cipher\-list>
709 \&  #
710 \&  # Sudo can provide a client certificate when communicating to
711 \&  # the LDAP server.
712 \&  # Tips:
713 \&  #   * Enable both lines at the same time.
714 \&  #   * Do not password protect the key file.
715 \&  #   * Ensure the keyfile is only readable by root.
716 \&  #
717 \&  # For OpenLDAP:
718 \&  #tls_cert /etc/certs/client_cert.pem
719 \&  #tls_key  /etc/certs/client_key.pem
720 \&  #
721 \&  # For SunONE or iPlanet LDAP, tls_cert and tls_key may specify either
722 \&  # a directory, in which case the files in the directory must have the
723 \&  # default names (e.g. cert8.db and key4.db), or the path to the cert
724 \&  # and key files themselves.  However, a bug in version 5.0 of the LDAP
725 \&  # SDK will prevent specific file names from working.  For this reason
726 \&  # it is suggested that tls_cert and tls_key be set to a directory,
727 \&  # not a file name.
728 \&  #
729 \&  # The certificate database specified by tls_cert may contain CA certs
730 \&  # and/or the client\*(Aqs cert.  If the client\*(Aqs cert is included, tls_key
731 \&  # should be specified as well.
732 \&  # For backward compatibility, "sslpath" may be used in place of tls_cert.
733 \&  #tls_cert /var/ldap
734 \&  #tls_key /var/ldap
735 \&  #
736 \&  # If using SASL authentication for LDAP (OpenSSL)
737 \&  # use_sasl yes
738 \&  # sasl_auth_id <SASL user name>
739 \&  # rootuse_sasl yes
740 \&  # rootsasl_auth_id <SASL user name for root access>
741 \&  # sasl_secprops none
742 \&  # krb5_ccname /etc/.ldapcache
743 .Ve
744 .SS "Sudo schema for OpenLDAP"
745 .IX Subsection "Sudo schema for OpenLDAP"
746 The following schema is in OpenLDAP format.  Simply copy it to the
747 schema directory (e.g. \fI/etc/openldap/schema\fR), add the proper
748 \&\f(CW\*(C`include\*(C'\fR line in \f(CW\*(C`slapd.conf\*(C'\fR and restart \fBslapd\fR.
749 .PP
750 .Vb 6
751 \& attributetype ( 1.3.6.1.4.1.15953.9.1.1
752 \&    NAME \*(AqsudoUser\*(Aq
753 \&    DESC \*(AqUser(s) who may  run sudo\*(Aq
754 \&    EQUALITY caseExactIA5Match
755 \&    SUBSTR caseExactIA5SubstringsMatch
756 \&    SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
757 \&
758 \& attributetype ( 1.3.6.1.4.1.15953.9.1.2
759 \&    NAME \*(AqsudoHost\*(Aq
760 \&    DESC \*(AqHost(s) who may run sudo\*(Aq
761 \&    EQUALITY caseExactIA5Match
762 \&    SUBSTR caseExactIA5SubstringsMatch
763 \&    SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
764 \&
765 \& attributetype ( 1.3.6.1.4.1.15953.9.1.3
766 \&    NAME \*(AqsudoCommand\*(Aq
767 \&    DESC \*(AqCommand(s) to be executed by sudo\*(Aq
768 \&    EQUALITY caseExactIA5Match
769 \&    SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
770 \&
771 \& attributetype ( 1.3.6.1.4.1.15953.9.1.4
772 \&    NAME \*(AqsudoRunAs\*(Aq
773 \&    DESC \*(AqUser(s) impersonated by sudo\*(Aq
774 \&    EQUALITY caseExactIA5Match
775 \&    SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
776 \&
777 \& attributetype ( 1.3.6.1.4.1.15953.9.1.5
778 \&    NAME \*(AqsudoOption\*(Aq
779 \&    DESC \*(AqOptions(s) followed by sudo\*(Aq
780 \&    EQUALITY caseExactIA5Match
781 \&    SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
782 \&
783 \& attributetype ( 1.3.6.1.4.1.15953.9.1.6
784 \&    NAME \*(AqsudoRunAsUser\*(Aq
785 \&    DESC \*(AqUser(s) impersonated by sudo\*(Aq
786 \&    EQUALITY caseExactIA5Match
787 \&    SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
788 \&
789 \& attributetype ( 1.3.6.1.4.1.15953.9.1.7
790 \&    NAME \*(AqsudoRunAsGroup\*(Aq
791 \&    DESC \*(AqGroup(s) impersonated by sudo\*(Aq
792 \&    EQUALITY caseExactIA5Match
793 \&    SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
794 \&
795 \& objectclass ( 1.3.6.1.4.1.15953.9.2.1 NAME \*(AqsudoRole\*(Aq SUP top STRUCTURAL
796 \&    DESC \*(AqSudoer Entries\*(Aq
797 \&    MUST ( cn )
798 \&    MAY ( sudoUser $ sudoHost $ sudoCommand $ sudoRunAs $ sudoRunAsUser $
799 \&          sudoRunAsGroup $ sudoOption $ description )
800 \&    )
801 .Ve
802 .SH "SEE ALSO"
803 .IX Header "SEE ALSO"
804 \&\fIldap.conf\fR\|(@mansectform@), \fIsudoers\fR\|(5)
805 .SH "CAVEATS"
806 .IX Header "CAVEATS"
807 The way that \fIsudoers\fR is parsed differs between Note that there
808 are differences in the way that LDAP-based \fIsudoers\fR is parsed
809 compared to file-based \fIsudoers\fR.  See the \*(L"Differences between
810 \&\s-1LDAP\s0 and non-LDAP sudoers\*(R" section for more information.
811 .SH "BUGS"
812 .IX Header "BUGS"
813 If you feel you have found a bug in \fBsudo\fR, please submit a bug report
814 at http://www.sudo.ws/sudo/bugs/
815 .SH "SUPPORT"
816 .IX Header "SUPPORT"
817 Limited free support is available via the sudo-users mailing list,
818 see http://www.sudo.ws/mailman/listinfo/sudo\-users to subscribe or
819 search the archives.
820 .SH "DISCLAIMER"
821 .IX Header "DISCLAIMER"
822 \&\fBsudo\fR is provided ``\s-1AS\s0 \s-1IS\s0'' and any express or implied warranties,
823 including, but not limited to, the implied warranties of merchantability
824 and fitness for a particular purpose are disclaimed.  See the \s-1LICENSE\s0
825 file distributed with \fBsudo\fR or http://www.sudo.ws/sudo/license.html
826 for complete details.