1 .\" Copyright (c) 1994-1996, 1998-2005, 2007-2012
2 .\" Todd C. Miller <Todd.Miller@courtesan.com>
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.
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.
17 .\" Sponsored in part by the Defense Advanced Research Projects
18 .\" Agency (DARPA) and Air Force Research Laboratory, Air Force
19 .\" Materiel Command, USAF, under agreement number F39502-99-1-0512.
24 .nr PT @password_timeout@
26 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
28 .\" Standard preamble:
29 .\" ========================================================================
30 .de Sp \" Vertical space (when we can't use .PP)
34 .de Vb \" Begin verbatim text
39 .de Ve \" End verbatim text
43 .\" Set up some character translations and predefined strings. \*(-- will
44 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
45 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
46 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
47 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
48 .\" nothing in troff, for use with C<>.
50 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
54 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
55 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
68 .\" Escape single quotes in literal strings from groff's Unicode transform.
72 .\" If the F register is turned on, we'll generate index entries on stderr for
73 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
74 .\" entries marked with X<> in POD. Of course, you'll have to process the
75 .\" output yourself in some meaningful fashion.
78 . tm Index:\\$1\t\\n%\t"\\$2"
88 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
89 .\" Fear. Run. Save yourself. No user-serviceable parts.
90 . \" fudge factors for nroff and troff
99 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
105 . \" simple accents for nroff and troff
115 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
116 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
117 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
118 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
119 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
120 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
122 . \" troff and (daisy-wheel) nroff accents
123 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
124 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
125 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
126 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
127 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
128 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
129 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
130 .ds ae a\h'-(\w'a'u*4/10)'e
131 .ds Ae A\h'-(\w'A'u*4/10)'E
132 . \" corrections for vroff
133 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
134 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
135 . \" for low resolution devices (crt and lpr)
136 .if \n(.H>23 .if \n(.V>19 \
149 .\" ========================================================================
151 .IX Title "SUDO @mansectsu@"
152 .TH SUDO @mansectsu@ "February 5, 2012" "1.8.4" "MAINTENANCE COMMANDS"
153 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
154 .\" way too many mistakes in technical documents.
158 sudo, sudoedit \- execute a command as another user
160 .IX Header "SYNOPSIS"
161 \&\fBsudo\fR \fB\-h\fR | \fB\-K\fR | \fB\-k\fR | \fB\-V\fR
163 \&\fBsudo\fR \fB\-v\fR [\fB\-AknS\fR]
164 .if \n(BA [\fB\-a\fR\ \fIauth_type\fR]
165 [\fB\-g\fR\ \fIgroup\ name\fR|\fI#gid\fR] [\fB\-p\fR\ \fIprompt\fR]
166 [\fB\-u\fR\ \fIuser\ name\fR|\fI#uid\fR]
168 \&\fBsudo\fR \fB\-l[l]\fR [\fB\-AknS\fR]
169 .if \n(BA [\fB\-a\fR\ \fIauth_type\fR]
170 [\fB\-g\fR\ \fIgroup\ name\fR|\fI#gid\fR] [\fB\-p\fR\ \fIprompt\fR]
171 [\fB\-U\fR\ \fIuser\ name\fR] [\fB\-u\fR\ \fIuser\ name\fR|\fI#uid\fR] [\fIcommand\fR]
173 \&\fBsudo\fR [\fB\-AbEHnPS\fR]
174 .if \n(BA [\fB\-a\fR\ \fIauth_type\fR]
175 [\fB\-C\fR\ \fIfd\fR]
176 .if \n(LC [\fB\-c\fR\ \fIclass\fR|\fI\-\fR]
177 [\fB\-g\fR\ \fIgroup\ name\fR|\fI#gid\fR] [\fB\-p\fR\ \fIprompt\fR]
178 .if \n(SL [\fB\-r\fR\ \fIrole\fR] [\fB\-t\fR\ \fItype\fR]
179 [\fB\-u\fR\ \fIuser\ name\fR|\fI#uid\fR]
180 [\fB\s-1VAR\s0\fR=\fIvalue\fR] [\fB\-i\fR\ |\ \fB\-s\fR] [\fIcommand\fR]
182 \&\fBsudoedit\fR [\fB\-AnS\fR]
183 .if \n(BA [\fB\-a\fR\ \fIauth_type\fR]
184 [\fB\-C\fR\ \fIfd\fR]
185 .if \n(LC [\fB\-c\fR\ \fIclass\fR|\fI\-\fR]
186 [\fB\-g\fR\ \fIgroup\ name\fR|\fI#gid\fR] [\fB\-p\fR\ \fIprompt\fR]
187 [\fB\-u\fR\ \fIuser\ name\fR|\fI#uid\fR] file ...
189 .IX Header "DESCRIPTION"
190 \&\fBsudo\fR allows a permitted user to execute a \fIcommand\fR as the
191 superuser or another user, as specified by the security policy.
192 The real and effective uid and gid are set to match those of the
193 target user, as specified in the password database, and the group
194 vector is initialized based on the group database (unless the \fB\-P\fR
195 option was specified).
197 \&\fBsudo\fR supports a plugin architecture for security policies and
198 input/output logging. Third parties can develop and distribute
199 their own policy and I/O logging modules to work seamlessly with
200 the \fBsudo\fR front end. The default security policy is \fIsudoers\fR,
201 which is configured via the file \fI@sysconfdir@/sudoers\fR, or via
202 \&\s-1LDAP\s0. See the \s-1PLUGINS\s0 section for more information.
204 The security policy determines what privileges, if any, a user has
205 to run \fBsudo\fR. The policy may require that users authenticate
206 themselves with a password or another authentication mechanism. If
207 authentication is required, \fBsudo\fR will exit if the user's password
208 is not entered within a configurable time limit. This limit is
209 policy-specific; the default password prompt timeout for the
210 \&\fIsudoers\fR security policy is
211 .ie \n(PT \f(CW\*(C`@password_timeout@\*(C'\fR minutes.
214 Security policies may support credential caching to allow the user
215 to run \fBsudo\fR again for a period of time without requiring
216 authentication. The \fIsudoers\fR policy caches credentials for
217 \&\f(CW\*(C`@timeout@\*(C'\fR minutes, unless overridden in \fIsudoers\fR\|(@mansectform@). By
218 running \fBsudo\fR with the \fB\-v\fR option, a user can update the cached
219 credentials without running a \fIcommand\fR.
221 When invoked as \fBsudoedit\fR, the \fB\-e\fR option (described below),
224 Security policies may log successful and failed attempts to use
225 \&\fBsudo\fR. If an I/O plugin is configured, the running command's
226 input and output may be logged as well.
229 \&\fBsudo\fR accepts the following command line options:
232 Normally, if \fBsudo\fR requires a password, it will read it from the
233 user's terminal. If the \fB\-A\fR (\fIaskpass\fR) option is specified,
234 a (possibly graphical) helper program is executed to read the user's
235 password and output the password to the standard output. If the
236 \&\f(CW\*(C`SUDO_ASKPASS\*(C'\fR environment variable is set, it specifies the path
237 to the helper program. Otherwise, if \fI@sysconfdir@/sudo.conf\fR
238 contains a line specifying the askpass program, that value will be
242 \& # Path to askpass helper program
243 \& Path askpass /usr/X11R6/bin/ssh\-askpass
246 If no askpass program is available, sudo will exit with an error.
248 .IP "\-a \fItype\fR" 12
250 The \fB\-a\fR (\fIauthentication type\fR) option causes \fBsudo\fR to use the
251 specified authentication type when validating the user, as allowed
252 by \fI/etc/login.conf\fR. The system administrator may specify a list
253 of sudo-specific authentication methods by adding an \*(L"auth-sudo\*(R"
254 entry in \fI/etc/login.conf\fR. This option is only available on systems
255 that support \s-1BSD\s0 authentication.
259 The \fB\-b\fR (\fIbackground\fR) option tells \fBsudo\fR to run the given
260 command in the background. Note that if you use the \fB\-b\fR
261 option you cannot use shell job control to manipulate the process.
262 Most interactive commands will fail to work properly in background
264 .IP "\-C \fIfd\fR" 12
266 Normally, \fBsudo\fR will close all open file descriptors other than
267 standard input, standard output and standard error. The \fB\-C\fR
268 (\fIclose from\fR) option allows the user to specify a starting point
269 above the standard error (file descriptor three). Values less than
270 three are not permitted. The security policy may restrict the
271 user's ability to use the \fB\-C\fR option. The \fIsudoers\fR policy only
272 permits use of the \fB\-C\fR option when the administrator has enabled
273 the \fIclosefrom_override\fR option.
275 .IP "\-c \fIclass\fR" 12
277 The \fB\-c\fR (\fIclass\fR) option causes \fBsudo\fR to run the specified command
278 with resources limited by the specified login class. The \fIclass\fR
279 argument can be either a class name as defined in \fI/etc/login.conf\fR,
280 or a single '\-' character. Specifying a \fIclass\fR of \f(CW\*(C`\-\*(C'\fR indicates
281 that the command should be run restricted by the default login
282 capabilities for the user the command is run as. If the \fIclass\fR
283 argument specifies an existing user class, the command must be run
284 as root, or the \fBsudo\fR command must be run from a shell that is already
285 root. This option is only available on systems with \s-1BSD\s0 login classes.
289 The \fB\-E\fR (\fIpreserve\fR \fIenvironment\fR) option indicates to the
290 security policy that the user wishes to preserve their existing
291 environment variables. The security policy may return an error if
292 the \fB\-E\fR option is specified and the user does not have permission
293 to preserve the environment.
296 The \fB\-e\fR (\fIedit\fR) option indicates that, instead of running a
297 command, the user wishes to edit one or more files. In lieu of a
298 command, the string \*(L"sudoedit\*(R" is used when consulting the security
299 policy. If the user is authorized by the policy, the following
303 Temporary copies are made of the files to be edited with the owner
304 set to the invoking user.
306 The editor specified by the policy is run to edit the temporary files.
307 The \fIsudoers\fR policy uses the \f(CW\*(C`SUDO_EDITOR\*(C'\fR, \f(CW\*(C`VISUAL\*(C'\fR and \f(CW\*(C`EDITOR\*(C'\fR
308 environment variables (in that order). If none of \f(CW\*(C`SUDO_EDITOR\*(C'\fR,
309 \&\f(CW\*(C`VISUAL\*(C'\fR or \f(CW\*(C`EDITOR\*(C'\fR are set, the first program listed in the
310 \&\fIeditor\fR \fIsudoers\fR\|(@mansectform@) option is used.
312 If they have been modified, the temporary files are copied back to
313 their original location and the temporary versions are removed.
317 If the specified file does not exist, it will be created. Note
318 that unlike most commands run by \fBsudo\fR, the editor is run with
319 the invoking user's environment unmodified. If, for some reason,
320 \&\fBsudo\fR is unable to update a file with its edited version, the
321 user will receive a warning and the edited copy will remain in a
324 .IP "\-g \fIgroup\fR" 12
326 Normally, \fBsudo\fR runs a command with the primary group set to the
327 one specified by the password database for the user the command is
328 being run as (by default, root). The \fB\-g\fR (\fIgroup\fR) option causes
329 \&\fBsudo\fR to run the command with the primary group set to \fIgroup\fR
330 instead. To specify a \fIgid\fR instead of a \fIgroup name\fR, use
331 \&\fI#gid\fR. When running commands as a \fIgid\fR, many shells require
332 that the '#' be escaped with a backslash ('\e'). If no \fB\-u\fR option
333 is specified, the command will be run as the invoking user (not
334 root). In either case, the primary group will be set to \fIgroup\fR.
337 The \fB\-H\fR (\fI\s-1HOME\s0\fR) option requests that the security policy set
338 the \f(CW\*(C`HOME\*(C'\fR environment variable to the home directory of the target
339 user (root by default) as specified by the password database.
340 Depending on the policy, this may be the default behavior.
343 The \fB\-h\fR (\fIhelp\fR) option causes \fBsudo\fR to print a short help message
344 to the standard output and exit.
345 .IP "\-i [command]" 12
346 .IX Item "-i [command]"
347 The \fB\-i\fR (\fIsimulate initial login\fR) option runs the shell specified
348 by the password database entry of the target user as a login shell.
349 This means that login-specific resource files such as \f(CW\*(C`.profile\*(C'\fR
350 or \f(CW\*(C`.login\*(C'\fR will be read by the shell. If a command is specified,
351 it is passed to the shell for execution via the shell's \fB\-c\fR option.
352 If no command is specified, an interactive shell is executed.
353 \&\fBsudo\fR attempts to change to that user's home directory before
354 running the shell. The security policy shall initialize the
355 environment to a minimal set of variables, similar to what is present
356 when a user logs in. The \fICommand Environment\fR section in the
357 \&\fIsudoers\fR\|(@mansectform@) manual documents how the \fB\-i\fR option affects the
358 environment in which a command is run when the \fIsudoers\fR policy
362 The \fB\-K\fR (sure \fIkill\fR) option is like \fB\-k\fR except that it removes
363 the user's cached credentials entirely and may not be used in
364 conjunction with a command or other option. This option does not
365 require a password. Not all security policies support credential
367 .IP "\-k [command]" 12
368 .IX Item "-k [command]"
369 When used alone, the \fB\-k\fR (\fIkill\fR) option to \fBsudo\fR invalidates
370 the user's cached credentials. The next time \fBsudo\fR is run a
371 password will be required. This option does not require a password
372 and was added to allow a user to revoke \fBsudo\fR permissions from a
373 \&.logout file. Not all security policies support credential
376 When used in conjunction with a command or an option that may require
377 a password, the \fB\-k\fR option will cause \fBsudo\fR to ignore the user's
378 cached credentials. As a result, \fBsudo\fR will prompt for a password
379 (if one is required by the security policy) and will not update the
380 user's cached credentials.
381 .IP "\-l[l] [\fIcommand\fR]" 12
382 .IX Item "-l[l] [command]"
383 If no \fIcommand\fR is specified, the \fB\-l\fR (\fIlist\fR) option will list
384 the allowed (and forbidden) commands for the invoking user (or the
385 user specified by the \fB\-U\fR option) on the current host. If a
386 \&\fIcommand\fR is specified and is permitted by the security policy,
387 the fully-qualified path to the command is displayed along with any
388 command line arguments. If \fIcommand\fR is specified but not allowed,
389 \&\fBsudo\fR will exit with a status value of 1. If the \fB\-l\fR option
390 is specified with an \fBl\fR argument (i.e. \fB\-ll\fR), or if \fB\-l\fR is
391 specified multiple times, a longer list format is used.
394 The \fB\-n\fR (\fInon-interactive\fR) option prevents \fBsudo\fR from prompting
395 the user for a password. If a password is required for the command
396 to run, \fBsudo\fR will display an error messages and exit.
399 The \fB\-P\fR (\fIpreserve\fR \fIgroup vector\fR) option causes \fBsudo\fR to
400 preserve the invoking user's group vector unaltered. By default,
401 the \fIsudoers\fR policy will initialize the group vector to the list
402 of groups the target user is in. The real and effective group IDs,
403 however, are still set to match the target user.
404 .IP "\-p \fIprompt\fR" 12
406 The \fB\-p\fR (\fIprompt\fR) option allows you to override the default
407 password prompt and use a custom one. The following percent (`\f(CW\*(C`%\*(C'\fR')
408 escapes are supported by the \fIsudoers\fR policy:
411 .el .IP "\f(CW%H\fR" 4
413 expanded to the host name including the domain name (on if
414 the machine's host name is fully qualified or the \fIfqdn\fR option
415 is set in \fIsudoers\fR\|(@mansectform@))
417 .el .IP "\f(CW%h\fR" 4
419 expanded to the local host name without the domain name
421 .el .IP "\f(CW%p\fR" 4
423 expanded to the name of the user whose password is being requested
424 (respects the \fIrootpw\fR, \fItargetpw\fR and \fIrunaspw\fR flags in
425 \&\fIsudoers\fR\|(@mansectform@))
427 .el .IP "\f(CW%U\fR" 4
429 expanded to the login name of the user the command will be run as
430 (defaults to root unless the \f(CW\*(C`\-u\*(C'\fR option is also specified)
432 .el .IP "\f(CW%u\fR" 4
434 expanded to the invoking user's login name
435 .ie n .IP "\*(C`%%\*(C'" 4
436 .el .IP "\f(CW\*(C`%%\*(C'\fR" 4
438 two consecutive \f(CW\*(C`%\*(C'\fR characters are collapsed into a single \f(CW\*(C`%\*(C'\fR character
442 The prompt specified by the \fB\-p\fR option will override the system
443 password prompt on systems that support \s-1PAM\s0 unless the
444 \&\fIpassprompt_override\fR flag is disabled in \fIsudoers\fR.
447 .IP "\-r \fIrole\fR" 12
449 The \fB\-r\fR (\fIrole\fR) option causes the new (SELinux) security context to
450 have the role specified by \fIrole\fR.
454 The \fB\-S\fR (\fIstdin\fR) option causes \fBsudo\fR to read the password from
455 the standard input instead of the terminal device. The password must
456 be followed by a newline character.
457 .IP "\-s [command]" 12
458 .IX Item "-s [command]"
459 The \fB\-s\fR (\fIshell\fR) option runs the shell specified by the \fI\s-1SHELL\s0\fR
460 environment variable if it is set or the shell as specified in the
461 password database. If a command is specified, it is passed to the
462 shell for execution via the shell's \fB\-c\fR option. If no command
463 is specified, an interactive shell is executed.
465 .IP "\-t \fItype\fR" 12
467 The \fB\-t\fR (\fItype\fR) option causes the new (SELinux) security context to
468 have the type specified by \fItype\fR. If no type is specified, the default
469 type is derived from the specified role.
471 .IP "\-U \fIuser\fR" 12
473 The \fB\-U\fR (\fIother user\fR) option is used in conjunction with the
474 \&\fB\-l\fR option to specify the user whose privileges should be listed.
475 The security policy may restrict listing other users' privileges.
476 The \fIsudoers\fR policy only allows root or a user with the \f(CW\*(C`ALL\*(C'\fR
477 privilege on the current host to use this option.
478 .IP "\-u \fIuser\fR" 12
480 The \fB\-u\fR (\fIuser\fR) option causes \fBsudo\fR to run the specified
481 command as a user other than \fIroot\fR. To specify a \fIuid\fR instead
482 of a \fIuser name\fR, use \fI#uid\fR. When running commands as a \fIuid\fR,
483 many shells require that the '#' be escaped with a backslash ('\e').
484 Security policies may restrict \fIuid\fRs to those listed in the
485 password database. The \fIsudoers\fR policy allows \fIuid\fRs that are
486 not in the password database as long as the \fItargetpw\fR option is
487 not set. Other security policies may not support this.
490 The \fB\-V\fR (\fIversion\fR) option causes \fBsudo\fR to print its version
491 string and the version string of the security policy plugin and any
492 I/O plugins. If the invoking user is already root the \fB\-V\fR option
493 will display the arguments passed to configure when \fIsudo\fR was
494 built and plugins may display more verbose information such as
498 When given the \fB\-v\fR (\fIvalidate\fR) option, \fBsudo\fR will update the
499 user's cached credentials, authenticating the user's password if
500 necessary. For the \fIsudoers\fR plugin, this extends the \fBsudo\fR
501 timeout for another \f(CW\*(C`@timeout@\*(C'\fR minutes (or whatever the timeout
502 is set to in \fIsudoers\fR) but does not run a command. Not all
503 security policies support cached credentials.
505 The \fB\-\-\fR option indicates that \fBsudo\fR should stop processing command
508 Environment variables to be set for the command may also be passed
509 on the command line in the form of \fB\s-1VAR\s0\fR=\fIvalue\fR, e.g.
510 \&\fB\s-1LD_LIBRARY_PATH\s0\fR=\fI/usr/local/pkg/lib\fR. Variables passed on the
511 command line are subject to the same restrictions as normal environment
512 variables with one important exception. If the \fIsetenv\fR option
513 is set in \fIsudoers\fR, the command to be run has the \f(CW\*(C`SETENV\*(C'\fR tag
514 set or the command matched is \f(CW\*(C`ALL\*(C'\fR, the user may set variables
515 that would otherwise be forbidden. See \fIsudoers\fR\|(@mansectform@) for more information.
518 Plugins are dynamically loaded based on the contents of the
519 \&\fI@sysconfdir@/sudo.conf\fR file. If no \fI@sysconfdir@/sudo.conf\fR
520 file is present, or it contains no \f(CW\*(C`Plugin\*(C'\fR lines, \fBsudo\fR
521 will use the traditional \fIsudoers\fR security policy and I/O logging,
522 which corresponds to the following \fI@sysconfdir@/sudo.conf\fR file.
526 \& # Default @sysconfdir@/sudo.conf file
529 \& # Plugin plugin_name plugin_path
530 \& # Path askpass /path/to/askpass
531 \& # Path noexec /path/to/noexec.so
532 \& # Debug sudo /var/log/sudo_debug all@warn
533 \& # Set disable_coredump true
535 \& # The plugin_path is relative to @prefix@/libexec unless
536 \& # fully qualified.
537 \& # The plugin_name corresponds to a global symbol in the plugin
538 \& # that contains the plugin interface structure.
540 \& Plugin policy_plugin sudoers.so
541 \& Plugin io_plugin sudoers.so
544 A \f(CW\*(C`Plugin\*(C'\fR line consists of the \f(CW\*(C`Plugin\*(C'\fR keyword, followed by the
545 \&\fIsymbol_name\fR and the \fIpath\fR to the shared object containing the
546 plugin. The \fIsymbol_name\fR is the name of the \f(CW\*(C`struct policy_plugin\*(C'\fR
547 or \f(CW\*(C`struct io_plugin\*(C'\fR in the plugin shared object. The \fIpath\fR
548 may be fully qualified or relative. If not fully qualified it is
549 relative to the \fI@prefix@/libexec\fR directory. Any additional
550 parameters after the \fIpath\fR are ignored. Lines that don't begin
551 with \f(CW\*(C`Plugin\*(C'\fR or \f(CW\*(C`Path\*(C'\fR are silently ignored
553 For more information, see the \fIsudo_plugin\fR\|(@mansectsu@) manual.
556 A \f(CW\*(C`Path\*(C'\fR line consists of the \f(CW\*(C`Path\*(C'\fR keyword, followed by the
557 name of the path to set and its value. E.g.
560 \& Path noexec @noexec_file@
561 \& Path askpass /usr/X11R6/bin/ssh\-askpass
564 The following plugin-agnostic paths may be set in the
565 \&\fI@sysconfdir@/sudo.conf\fR file.
568 The fully qualified path to a helper program used to read the user's
569 password when no terminal is available. This may be the case when
570 \&\fBsudo\fR is executed from a graphical (as opposed to text-based)
571 application. The program specified by \fIaskpass\fR should display
572 the argument passed to it as the prompt and write the user's password
573 to the standard output. The value of \fIaskpass\fR may be overridden
574 by the \f(CW\*(C`SUDO_ASKPASS\*(C'\fR environment variable.
577 The fully-qualified path to a shared library containing dummy
578 versions of the \fIexecv()\fR, \fIexecve()\fR and \fIfexecve()\fR library functions
579 that just return an error. This is used to implement the \fInoexec\fR
580 functionality on systems that support \f(CW\*(C`LD_PRELOAD\*(C'\fR or its equivalent.
581 Defaults to \fI@noexec_file@\fR.
583 .IX Header "DEBUG FLAGS"
584 \&\fBsudo\fR versions 1.8.4 and higher support a flexible debugging
585 framework that can help track down what \fBsudo\fR is doing internally
586 if there is a problem.
588 A \f(CW\*(C`Debug\*(C'\fR line consists of the \f(CW\*(C`Debug\*(C'\fR keyword, followed by the
589 name of the program to debug (\fBsudo\fR, \fBvisudo\fR, \fBsudoreplay\fR),
590 the debug file name and a comma-separated list of debug flags.
591 The debug flag syntax used by \fBsudo\fR and the \fIsudoers\fR plugin is
592 \&\fIsubsystem\fR@\fIpriority\fR but the plugin is free to use a different
593 format so long as it does not include a command \f(CW\*(C`,\*(C'\fR.
598 \& Debug sudo /var/log/sudo_debug all@warn,plugin@info
601 would log all debugging statements at the \fIwarn\fR level and higher
602 in addition to those at the \fIinfo\fR level for the plugin subsystem.
604 Currently, only one \f(CW\*(C`Debug\*(C'\fR entry per program is supported. The
605 \&\f(CW\*(C`sudo\*(C'\fR \f(CW\*(C`Debug\*(C'\fR entry is shared by the \fBsudo\fR front end, \fBsudoedit\fR
606 and the plugins. A future release may add support for per-plugin
607 \&\f(CW\*(C`Debug\*(C'\fR lines and/or support for multiple debugging files for a
610 The priorities used by the \fBsudo\fR front end, in order of decreasing
611 severity, are: \fIcrit\fR, \fIerr\fR, \fIwarn\fR, \fInotice\fR, \fIdiag\fR, \fIinfo\fR,
612 \&\fItrace\fR and \fIdebug\fR. Each priority, when specified, also includes
613 all priorities higher than it. For example, a priority of \fInotice\fR
614 would include debug messages logged at \fInotice\fR and higher.
616 The following subsystems are used by \fBsudo\fR:
619 matches every subsystem
622 command line argument processing
634 \&\fBsudo\fR main function
637 network interface handling
640 communication with the plugin
641 .IP "\fIplugin\fR" 10
646 pseudo-tty related code
647 .IP "\fIselinux\fR" 10
649 SELinux-specific handling
657 .IX Header "RETURN VALUES"
658 Upon successful execution of a program, the exit status from \fBsudo\fR
659 will simply be the exit status of the program that was executed.
661 Otherwise, \fBsudo\fR exits with a value of 1 if there is a
662 configuration/permission problem or if \fBsudo\fR cannot execute the
663 given command. In the latter case the error string is printed to
664 the standard error. If \fBsudo\fR cannot \fIstat\fR\|(2) one or more entries
665 in the user's \f(CW\*(C`PATH\*(C'\fR, an error is printed on stderr. (If the
666 directory does not exist or if it is not really a directory, the
667 entry is ignored and no error is printed.) This should not happen
668 under normal circumstances. The most common reason for \fIstat\fR\|(2)
669 to return \*(L"permission denied\*(R" is if you are running an automounter
670 and one of the directories in your \f(CW\*(C`PATH\*(C'\fR is on a machine that is
671 currently unreachable.
673 .IX Header "SECURITY NOTES"
674 \&\fBsudo\fR tries to be safe when executing external commands.
676 To prevent command spoofing, \fBsudo\fR checks \*(L".\*(R" and "" (both denoting
677 current directory) last when searching for a command in the user's
678 \&\s-1PATH\s0 (if one or both are in the \s-1PATH\s0). Note, however, that the
679 actual \f(CW\*(C`PATH\*(C'\fR environment variable is \fInot\fR modified and is passed
680 unchanged to the program that \fBsudo\fR executes.
682 Please note that \fBsudo\fR will normally only log the command it
683 explicitly runs. If a user runs a command such as \f(CW\*(C`sudo su\*(C'\fR or
684 \&\f(CW\*(C`sudo sh\*(C'\fR, subsequent commands run from that shell are not subject
685 to \fBsudo\fR's security policy. The same is true for commands that
686 offer shell escapes (including most editors). If I/O logging is
687 enabled, subsequent commands will have their input and/or output
688 logged, but there will not be traditional logs for those commands.
689 Because of this, care must be taken when giving users access to
690 commands via \fBsudo\fR to verify that the command does not inadvertently
691 give the user an effective root shell. For more information, please
692 see the \f(CW\*(C`PREVENTING SHELL ESCAPES\*(C'\fR section in \fIsudoers\fR\|(@mansectform@).
694 To prevent the disclosure of potentially sensitive information,
695 \&\fBsudo\fR disables core dumps by default while it is executing (they
696 are re-enabled for the command that is run). To aid in debugging
697 \&\fBsudo\fR crashes, you may wish to re-enable core dumps by setting
698 \&\*(L"disable_coredump\*(R" to false in the \fI@sysconfdir@/sudo.conf\fR file.
701 \& Set disable_coredump false
704 Note that by default, most operating systems disable core dumps
705 from setuid programs, which includes \fBsudo\fR. To actually get a
706 \&\fBsudo\fR core file you may need to enable core dumps for setuid
707 processes. On \s-1BSD\s0 and Linux systems this is accomplished via the
708 sysctl command, on Solaris the coreadm command can be used.
710 .IX Header "ENVIRONMENT"
711 \&\fBsudo\fR utilizes the following environment variables. The security
712 policy has control over the content of the command's environment.
713 .ie n .IP "\*(C`EDITOR\*(C'" 16
714 .el .IP "\f(CW\*(C`EDITOR\*(C'\fR" 16
716 Default editor to use in \fB\-e\fR (sudoedit) mode if neither \f(CW\*(C`SUDO_EDITOR\*(C'\fR
717 nor \f(CW\*(C`VISUAL\*(C'\fR is set
718 .ie n .IP "\*(C`MAIL\*(C'" 16
719 .el .IP "\f(CW\*(C`MAIL\*(C'\fR" 16
721 In \fB\-i\fR mode or when \fIenv_reset\fR is enabled in \fIsudoers\fR, set
722 to the mail spool of the target user
723 .ie n .IP "\*(C`HOME\*(C'" 16
724 .el .IP "\f(CW\*(C`HOME\*(C'\fR" 16
726 Set to the home directory of the target user if \fB\-i\fR or \fB\-H\fR are
727 specified, \fIenv_reset\fR or \fIalways_set_home\fR are set in \fIsudoers\fR,
728 or when the \fB\-s\fR option is specified and \fIset_home\fR is set in
730 .ie n .IP "\*(C`PATH\*(C'" 16
731 .el .IP "\f(CW\*(C`PATH\*(C'\fR" 16
733 May be overridden by the security policy.
734 .ie n .IP "\*(C`SHELL\*(C'" 16
735 .el .IP "\f(CW\*(C`SHELL\*(C'\fR" 16
737 Used to determine shell to run with \f(CW\*(C`\-s\*(C'\fR option
738 .ie n .IP "\*(C`SUDO_ASKPASS\*(C'" 16
739 .el .IP "\f(CW\*(C`SUDO_ASKPASS\*(C'\fR" 16
740 .IX Item "SUDO_ASKPASS"
741 Specifies the path to a helper program used to read the password
742 if no terminal is available or if the \f(CW\*(C`\-A\*(C'\fR option is specified.
743 .ie n .IP "\*(C`SUDO_COMMAND\*(C'" 16
744 .el .IP "\f(CW\*(C`SUDO_COMMAND\*(C'\fR" 16
745 .IX Item "SUDO_COMMAND"
746 Set to the command run by sudo
747 .ie n .IP "\*(C`SUDO_EDITOR\*(C'" 16
748 .el .IP "\f(CW\*(C`SUDO_EDITOR\*(C'\fR" 16
749 .IX Item "SUDO_EDITOR"
750 Default editor to use in \fB\-e\fR (sudoedit) mode
751 .ie n .IP "\*(C`SUDO_GID\*(C'" 16
752 .el .IP "\f(CW\*(C`SUDO_GID\*(C'\fR" 16
754 Set to the group \s-1ID\s0 of the user who invoked sudo
755 .ie n .IP "\*(C`SUDO_PROMPT\*(C'" 16
756 .el .IP "\f(CW\*(C`SUDO_PROMPT\*(C'\fR" 16
757 .IX Item "SUDO_PROMPT"
758 Used as the default password prompt
759 .ie n .IP "\*(C`SUDO_PS1\*(C'" 16
760 .el .IP "\f(CW\*(C`SUDO_PS1\*(C'\fR" 16
762 If set, \f(CW\*(C`PS1\*(C'\fR will be set to its value for the program being run
763 .ie n .IP "\*(C`SUDO_UID\*(C'" 16
764 .el .IP "\f(CW\*(C`SUDO_UID\*(C'\fR" 16
766 Set to the user \s-1ID\s0 of the user who invoked sudo
767 .ie n .IP "\*(C`SUDO_USER\*(C'" 16
768 .el .IP "\f(CW\*(C`SUDO_USER\*(C'\fR" 16
770 Set to the login of the user who invoked sudo
771 .ie n .IP "\*(C`USER\*(C'" 16
772 .el .IP "\f(CW\*(C`USER\*(C'\fR" 16
774 Set to the target user (root unless the \fB\-u\fR option is specified)
775 .ie n .IP "\*(C`VISUAL\*(C'" 16
776 .el .IP "\f(CW\*(C`VISUAL\*(C'\fR" 16
778 Default editor to use in \fB\-e\fR (sudoedit) mode if \f(CW\*(C`SUDO_EDITOR\*(C'\fR
782 .ie n .IP "\fI@sysconfdir@/sudo.conf\fR" 24
783 .el .IP "\fI@sysconfdir@/sudo.conf\fR" 24
784 .IX Item "@sysconfdir@/sudo.conf"
785 \&\fBsudo\fR front end configuration
787 .IX Header "EXAMPLES"
788 Note: the following examples assume a properly configured security policy.
790 To get a file listing of an unreadable directory:
793 \& $ sudo ls /usr/local/protected
796 To list the home directory of user yaz on a machine where the
797 file system holding ~yaz is not exported as root:
800 \& $ sudo \-u yaz ls ~yaz
803 To edit the \fIindex.html\fR file as user www:
806 \& $ sudo \-u www vi ~www/htdocs/index.html
809 To view system logs only accessible to root and users in the adm group:
812 \& $ sudo \-g adm view /var/log/syslog
815 To run an editor as jim with a different primary group:
818 \& $ sudo \-u jim \-g audio vi ~jim/sound.txt
821 To shutdown a machine:
824 \& $ sudo shutdown \-r +15 "quick reboot"
827 To make a usage listing of the directories in the /home
828 partition. Note that this runs the commands in a sub-shell
829 to make the \f(CW\*(C`cd\*(C'\fR and file redirection work.
832 \& $ sudo sh \-c "cd /home ; du \-s * | sort \-rn > USAGE"
835 .IX Header "SEE ALSO"
836 \&\fIgrep\fR\|(1), \fIsu\fR\|(1), \fIstat\fR\|(2),
837 .if \n(LC \&\fIlogin_cap\fR\|(3),
838 \&\fIpasswd\fR\|(@mansectform@), \fIsudoers\fR\|(@mansectform@), \fIsudo_plugin\fR\|(@mansectsu@), \fIsudoreplay\fR\|(@mansectsu@), \fIvisudo\fR\|(@mansectsu@)
841 Many people have worked on \fBsudo\fR over the years; this
842 version consists of code written primarily by:
848 See the \s-1CONTRIBUTORS\s0 file in the \fBsudo\fR distribution
849 (http://www.sudo.ws/sudo/contributors.html) for a list of people
850 who have contributed to \fBsudo\fR.
853 See the \s-1HISTORY\s0 file in the \fBsudo\fR distribution
854 (http://www.sudo.ws/sudo/history.html) for a brief history of sudo.
857 There is no easy way to prevent a user from gaining a root shell
858 if that user is allowed to run arbitrary commands via \fBsudo\fR.
859 Also, many programs (such as editors) allow the user to run commands
860 via shell escapes, thus avoiding \fBsudo\fR's checks. However, on
861 most systems it is possible to prevent shell escapes with the
862 \&\fIsudoers\fR\|(@mansectform@) module's \fInoexec\fR functionality.
864 It is not meaningful to run the \f(CW\*(C`cd\*(C'\fR command directly via sudo, e.g.,
867 \& $ sudo cd /usr/local/protected
870 since when the command exits the parent process (your shell) will
871 still be the same. Please see the \s-1EXAMPLES\s0 section for more information.
873 Running shell scripts via \fBsudo\fR can expose the same kernel bugs that
874 make setuid shell scripts unsafe on some operating systems (if your \s-1OS\s0
875 has a /dev/fd/ directory, setuid shell scripts are generally safe).
878 If you feel you have found a bug in \fBsudo\fR, please submit a bug report
879 at http://www.sudo.ws/sudo/bugs/
882 Limited free support is available via the sudo-users mailing list,
883 see http://www.sudo.ws/mailman/listinfo/sudo\-users to subscribe or
886 .IX Header "DISCLAIMER"
887 \&\fBsudo\fR is provided ``\s-1AS\s0 \s-1IS\s0'' and any express or implied warranties,
888 including, but not limited to, the implied warranties of merchantability
889 and fitness for a particular purpose are disclaimed. See the \s-1LICENSE\s0
890 file distributed with \fBsudo\fR or http://www.sudo.ws/sudo/license.html
891 for complete details.
projects / debian / sudo / blob