4 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
8 sudo, sudoedit - execute a command as another user
10 S
\bSY
\bYN
\bNO
\bOP
\bPS
\bSI
\bIS
\bS
11 s
\bsu
\bud
\bdo
\bo -
\b-h
\bh | -
\b-K
\bK | -
\b-k
\bk | -
\b-L
\bL | -
\b-V
\bV
13 s
\bsu
\bud
\bdo
\bo -
\b-v
\bv [-
\b-A
\bAk
\bkn
\bnS
\bS] [-
\b-a
\ba _
\ba_
\bu_
\bt_
\bh_
\b__
\bt_
\by_
\bp_
\be] [-
\b-g
\bg _
\bg_
\br_
\bo_
\bu_
\bp _
\bn_
\ba_
\bm_
\be|_
\b#_
\bg_
\bi_
\bd] [-
\b-p
\bp _
\bp_
\br_
\bo_
\bm_
\bp_
\bt]
14 [-
\b-u
\bu _
\bu_
\bs_
\be_
\br_
\bn_
\ba_
\bm_
\be|_
\b#_
\bu_
\bi_
\bd]
16 s
\bsu
\bud
\bdo
\bo -
\b-l
\bl[
\b[l
\bl]
\b] [-
\b-A
\bAk
\bkn
\bnS
\bS] [-
\b-a
\ba _
\ba_
\bu_
\bt_
\bh_
\b__
\bt_
\by_
\bp_
\be] [-
\b-g
\bg _
\bg_
\br_
\bo_
\bu_
\bp _
\bn_
\ba_
\bm_
\be|_
\b#_
\bg_
\bi_
\bd] [-
\b-p
\bp _
\bp_
\br_
\bo_
\bm_
\bp_
\bt]
17 [-
\b-U
\bU _
\bu_
\bs_
\be_
\br _
\bn_
\ba_
\bm_
\be] [-
\b-u
\bu _
\bu_
\bs_
\be_
\br _
\bn_
\ba_
\bm_
\be|_
\b#_
\bu_
\bi_
\bd] [_
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd]
19 s
\bsu
\bud
\bdo
\bo [-
\b-A
\bAb
\bbE
\bEH
\bHn
\bnP
\bPS
\bS] [-
\b-a
\ba _
\ba_
\bu_
\bt_
\bh_
\b__
\bt_
\by_
\bp_
\be] [-
\b-C
\bC _
\bf_
\bd] [-
\b-c
\bc _
\bc_
\bl_
\ba_
\bs_
\bs|_
\b-]
20 [-
\b-g
\bg _
\bg_
\br_
\bo_
\bu_
\bp _
\bn_
\ba_
\bm_
\be|_
\b#_
\bg_
\bi_
\bd] [-
\b-p
\bp _
\bp_
\br_
\bo_
\bm_
\bp_
\bt] [-
\b-r
\br _
\br_
\bo_
\bl_
\be] [-
\b-t
\bt _
\bt_
\by_
\bp_
\be]
21 [-
\b-u
\bu _
\bu_
\bs_
\be_
\br _
\bn_
\ba_
\bm_
\be|_
\b#_
\bu_
\bi_
\bd] [V
\bVA
\bAR
\bR=_
\bv_
\ba_
\bl_
\bu_
\be] [-
\b-i
\bi | -
\b-s
\bs] [_
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd]
23 s
\bsu
\bud
\bdo
\boe
\bed
\bdi
\bit
\bt [-
\b-A
\bAn
\bnS
\bS] [-
\b-a
\ba _
\ba_
\bu_
\bt_
\bh_
\b__
\bt_
\by_
\bp_
\be] [-
\b-C
\bC _
\bf_
\bd] [-
\b-c
\bc _
\bc_
\bl_
\ba_
\bs_
\bs|_
\b-]
24 [-
\b-g
\bg _
\bg_
\br_
\bo_
\bu_
\bp _
\bn_
\ba_
\bm_
\be|_
\b#_
\bg_
\bi_
\bd] [-
\b-p
\bp _
\bp_
\br_
\bo_
\bm_
\bp_
\bt] [-
\b-u
\bu _
\bu_
\bs_
\be_
\br _
\bn_
\ba_
\bm_
\be|_
\b#_
\bu_
\bi_
\bd] file ...
26 D
\bDE
\bES
\bSC
\bCR
\bRI
\bIP
\bPT
\bTI
\bIO
\bON
\bN
27 s
\bsu
\bud
\bdo
\bo allows a permitted user to execute a _
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd as the superuser or
28 another user, as specified in the _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs file. The real and effective
29 uid and gid are set to match those of the target user as specified in
30 the passwd file and the group vector is initialized based on the group
31 file (unless the -
\b-P
\bP option was specified). If the invoking user is
32 root or if the target user is the same as the invoking user, no
33 password is required. Otherwise, s
\bsu
\bud
\bdo
\bo requires that users authenticate
34 themselves with a password by default (NOTE: in the default
35 configuration this is the user's password, not the root password).
36 Once a user has been authenticated, a time stamp is updated and the
37 user may then use sudo without a password for a short period of time (5
38 minutes unless overridden in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs).
40 When invoked as s
\bsu
\bud
\bdo
\boe
\bed
\bdi
\bit
\bt, the -
\b-e
\be option (described below), is implied.
42 s
\bsu
\bud
\bdo
\bo determines who is an authorized user by consulting the file
43 _
\b/_
\be_
\bt_
\bc_
\b/_
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs. By running s
\bsu
\bud
\bdo
\bo with the -
\b-v
\bv option, a user can update
44 the time stamp without running a _
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd. If a password is required,
45 s
\bsu
\bud
\bdo
\bo will exit if the user's password is not entered within a
46 configurable time limit. The default password prompt timeout is 5
49 If a user who is not listed in the _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs file tries to run a command
50 via s
\bsu
\bud
\bdo
\bo, mail is sent to the proper authorities, as defined at
51 configure time or in the _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs file (defaults to root). Note that
52 the mail will not be sent if an unauthorized user tries to run sudo
53 with the -
\b-l
\bl or -
\b-v
\bv option. This allows users to determine for
54 themselves whether or not they are allowed to use s
\bsu
\bud
\bdo
\bo.
56 If s
\bsu
\bud
\bdo
\bo is run by root and the SUDO_USER environment variable is set,
57 s
\bsu
\bud
\bdo
\bo will use this value to determine who the actual user is. This can
58 be used by a user to log commands through sudo even when a root shell
59 has been invoked. It also allows the -
\b-e
\be option to remain useful even
60 when being run via a sudo-run script or program. Note however, that
70 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
73 the sudoers lookup is still done for root, not the user specified by
76 s
\bsu
\bud
\bdo
\bo can log both successful and unsuccessful attempts (as well as
77 errors) to _
\bs_
\by_
\bs_
\bl_
\bo_
\bg(3), a log file, or both. By default s
\bsu
\bud
\bdo
\bo will log
78 via _
\bs_
\by_
\bs_
\bl_
\bo_
\bg(3) but this is changeable at configure time or via the
79 _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs file.
81 O
\bOP
\bPT
\bTI
\bIO
\bON
\bNS
\bS
82 s
\bsu
\bud
\bdo
\bo accepts the following command line options:
84 -A Normally, if s
\bsu
\bud
\bdo
\bo requires a password, it will read it from
85 the current terminal. If the -
\b-A
\bA (_
\ba_
\bs_
\bk_
\bp_
\ba_
\bs_
\bs) option is
86 specified, a (possibly graphical) helper program is
87 executed to read the user's password and output the
88 password to the standard output. If the SUDO_ASKPASS
89 environment variable is set, it specifies the path to the
90 helper program. Otherwise, the value specified by the
91 _
\ba_
\bs_
\bk_
\bp_
\ba_
\bs_
\bs option in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4) is used.
93 -a _
\bt_
\by_
\bp_
\be The -
\b-a
\ba (_
\ba_
\bu_
\bt_
\bh_
\be_
\bn_
\bt_
\bi_
\bc_
\ba_
\bt_
\bi_
\bo_
\bn _
\bt_
\by_
\bp_
\be) option causes s
\bsu
\bud
\bdo
\bo to use the
94 specified authentication type when validating the user, as
95 allowed by _
\b/_
\be_
\bt_
\bc_
\b/_
\bl_
\bo_
\bg_
\bi_
\bn_
\b._
\bc_
\bo_
\bn_
\bf. The system administrator may
96 specify a list of sudo-specific authentication methods by
97 adding an "auth-sudo" entry in _
\b/_
\be_
\bt_
\bc_
\b/_
\bl_
\bo_
\bg_
\bi_
\bn_
\b._
\bc_
\bo_
\bn_
\bf. This
98 option is only available on systems that support BSD
101 -b The -
\b-b
\bb (_
\bb_
\ba_
\bc_
\bk_
\bg_
\br_
\bo_
\bu_
\bn_
\bd) option tells s
\bsu
\bud
\bdo
\bo to run the given
102 command in the background. Note that if you use the -
\b-b
\bb
103 option you cannot use shell job control to manipulate the
106 -C _
\bf_
\bd Normally, s
\bsu
\bud
\bdo
\bo will close all open file descriptors other
107 than standard input, standard output and standard error.
108 The -
\b-C
\bC (_
\bc_
\bl_
\bo_
\bs_
\be _
\bf_
\br_
\bo_
\bm) option allows the user to specify a
109 starting point above the standard error (file descriptor
110 three). Values less than three are not permitted. This
111 option is only available if the administrator has enabled
112 the _
\bc_
\bl_
\bo_
\bs_
\be_
\bf_
\br_
\bo_
\bm_
\b__
\bo_
\bv_
\be_
\br_
\br_
\bi_
\bd_
\be option in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4).
114 -c _
\bc_
\bl_
\ba_
\bs_
\bs The -
\b-c
\bc (_
\bc_
\bl_
\ba_
\bs_
\bs) option causes s
\bsu
\bud
\bdo
\bo to run the specified
115 command with resources limited by the specified login
116 class. The _
\bc_
\bl_
\ba_
\bs_
\bs argument can be either a class name as
117 defined in _
\b/_
\be_
\bt_
\bc_
\b/_
\bl_
\bo_
\bg_
\bi_
\bn_
\b._
\bc_
\bo_
\bn_
\bf, or a single '-' character.
118 Specifying a _
\bc_
\bl_
\ba_
\bs_
\bs of - indicates that the command should
119 be run restricted by the default login capabilities for the
120 user the command is run as. If the _
\bc_
\bl_
\ba_
\bs_
\bs argument
121 specifies an existing user class, the command must be run
122 as root, or the s
\bsu
\bud
\bdo
\bo command must be run from a shell that
123 is already root. This option is only available on systems
124 with BSD login classes.
126 -E The -
\b-E
\bE (_
\bp_
\br_
\be_
\bs_
\be_
\br_
\bv_
\be _
\be_
\bn_
\bv_
\bi_
\br_
\bo_
\bn_
\bm_
\be_
\bn_
\bt) option will override the
130 1.7.4 July 19, 2010 2
136 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
139 _
\be_
\bn_
\bv_
\b__
\br_
\be_
\bs_
\be_
\bt option in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4)). It is only available when
140 either the matching command has the SETENV tag or the
141 _
\bs_
\be_
\bt_
\be_
\bn_
\bv option is set in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4).
143 -e The -
\b-e
\be (_
\be_
\bd_
\bi_
\bt) option indicates that, instead of running a
144 command, the user wishes to edit one or more files. In
145 lieu of a command, the string "sudoedit" is used when
146 consulting the _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs file. If the user is authorized by
147 _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs the following steps are taken:
149 1. Temporary copies are made of the files to be edited
150 with the owner set to the invoking user.
152 2. The editor specified by the SUDO_EDITOR, VISUAL or
153 EDITOR environment variables is run to edit the
154 temporary files. If none of SUDO_EDITOR, VISUAL or
155 EDITOR are set, the first program listed in the _
\be_
\bd_
\bi_
\bt_
\bo_
\br
156 _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs variable is used.
158 3. If they have been modified, the temporary files are
159 copied back to their original location and the
160 temporary versions are removed.
162 If the specified file does not exist, it will be created.
163 Note that unlike most commands run by s
\bsu
\bud
\bdo
\bo, the editor is
164 run with the invoking user's environment unmodified. If,
165 for some reason, s
\bsu
\bud
\bdo
\bo is unable to update a file with its
166 edited version, the user will receive a warning and the
167 edited copy will remain in a temporary file.
169 -g _
\bg_
\br_
\bo_
\bu_
\bp Normally, s
\bsu
\bud
\bdo
\bo sets the primary group to the one specified
170 by the passwd database for the user the command is being
171 run as (by default, root). The -
\b-g
\bg (_
\bg_
\br_
\bo_
\bu_
\bp) option causes
172 s
\bsu
\bud
\bdo
\bo to run the specified command with the primary group
173 set to _
\bg_
\br_
\bo_
\bu_
\bp. To specify a _
\bg_
\bi_
\bd instead of a _
\bg_
\br_
\bo_
\bu_
\bp _
\bn_
\ba_
\bm_
\be,
174 use _
\b#_
\bg_
\bi_
\bd. When running commands as a _
\bg_
\bi_
\bd, many shells
175 require that the '#' be escaped with a backslash ('\'). If
176 no -
\b-u
\bu option is specified, the command will be run as the
177 invoking user (not root). In either case, the primary
178 group will be set to _
\bg_
\br_
\bo_
\bu_
\bp.
180 -H The -
\b-H
\bH (_
\bH_
\bO_
\bM_
\bE) option sets the HOME environment variable to
181 the homedir of the target user (root by default) as
182 specified in _
\bp_
\ba_
\bs_
\bs_
\bw_
\bd(4). The default handling of the HOME
183 environment variable depends on _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4) settings. By
184 default, s
\bsu
\bud
\bdo
\bo will set HOME if _
\be_
\bn_
\bv_
\b__
\br_
\be_
\bs_
\be_
\bt or _
\ba_
\bl_
\bw_
\ba_
\by_
\bs_
\b__
\bs_
\be_
\bt_
\b__
\bh_
\bo_
\bm_
\be
185 are set, or if _
\bs_
\be_
\bt_
\b__
\bh_
\bo_
\bm_
\be is set and the -
\b-s
\bs option is
186 specified on the command line.
188 -h The -
\b-h
\bh (_
\bh_
\be_
\bl_
\bp) option causes s
\bsu
\bud
\bdo
\bo to print a usage message
192 The -
\b-i
\bi (_
\bs_
\bi_
\bm_
\bu_
\bl_
\ba_
\bt_
\be _
\bi_
\bn_
\bi_
\bt_
\bi_
\ba_
\bl _
\bl_
\bo_
\bg_
\bi_
\bn) option runs the shell
196 1.7.4 July 19, 2010 3
202 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
205 specified in the _
\bp_
\ba_
\bs_
\bs_
\bw_
\bd(4) entry of the target user as a
206 login shell. This means that login-specific resource files
207 such as .profile or .login will be read by the shell. If a
208 command is specified, it is passed to the shell for
209 execution. Otherwise, an interactive shell is executed.
210 s
\bsu
\bud
\bdo
\bo attempts to change to that user's home directory
211 before running the shell. It also initializes the
212 environment, leaving _
\bD_
\bI_
\bS_
\bP_
\bL_
\bA_
\bY and _
\bT_
\bE_
\bR_
\bM unchanged, setting
213 _
\bH_
\bO_
\bM_
\bE, _
\bM_
\bA_
\bI_
\bL, _
\bS_
\bH_
\bE_
\bL_
\bL, _
\bU_
\bS_
\bE_
\bR, _
\bL_
\bO_
\bG_
\bN_
\bA_
\bM_
\bE, and _
\bP_
\bA_
\bT_
\bH, as well as the
214 contents of _
\b/_
\be_
\bt_
\bc_
\b/_
\be_
\bn_
\bv_
\bi_
\br_
\bo_
\bn_
\bm_
\be_
\bn_
\bt on Linux and AIX systems. All
215 other environment variables are removed.
217 -K The -
\b-K
\bK (sure _
\bk_
\bi_
\bl_
\bl) option is like -
\b-k
\bk except that it removes
218 the user's time stamp entirely and may not be used in
219 conjunction with a command or other option. This option
220 does not require a password.
222 -k When used by itself, the -
\b-k
\bk (_
\bk_
\bi_
\bl_
\bl) option to s
\bsu
\bud
\bdo
\bo
223 invalidates the user's time stamp by setting the time on it
224 to the Epoch. The next time s
\bsu
\bud
\bdo
\bo is run a password will be
225 required. This option does not require a password and was
226 added to allow a user to revoke s
\bsu
\bud
\bdo
\bo permissions from a
229 When used in conjunction with a command or an option that
230 may require a password, the -
\b-k
\bk option will cause s
\bsu
\bud
\bdo
\bo to
231 ignore the user's time stamp file. As a result, s
\bsu
\bud
\bdo
\bo will
232 prompt for a password (if one is required by _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs) and
233 will not update the user's time stamp file.
235 -L The -
\b-L
\bL (_
\bl_
\bi_
\bs_
\bt defaults) option will list the parameters that
236 may be set in a _
\bD_
\be_
\bf_
\ba_
\bu_
\bl_
\bt_
\bs line along with a short
237 description for each. This option will be removed from a
238 future version of s
\bsu
\bud
\bdo
\bo.
240 -l[l] [_
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd]
241 If no _
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd is specified, the -
\b-l
\bl (_
\bl_
\bi_
\bs_
\bt) option will list
242 the allowed (and forbidden) commands for the invoking user
243 (or the user specified by the -
\b-U
\bU option) on the current
244 host. If a _
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd is specified and is permitted by
245 _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs, the fully-qualified path to the command is
246 displayed along with any command line arguments. If
247 _
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd is specified but not allowed, s
\bsu
\bud
\bdo
\bo will exit with a
248 status value of 1. If the -
\b-l
\bl option is specified with an l
\bl
249 argument (i.e. -
\b-l
\bll
\bl), or if -
\b-l
\bl is specified multiple times,
250 a longer list format is used.
252 -n The -
\b-n
\bn (_
\bn_
\bo_
\bn_
\b-_
\bi_
\bn_
\bt_
\be_
\br_
\ba_
\bc_
\bt_
\bi_
\bv_
\be) option prevents s
\bsu
\bud
\bdo
\bo from
253 prompting the user for a password. If a password is
254 required for the command to run, s
\bsu
\bud
\bdo
\bo will display an error
257 -P The -
\b-P
\bP (_
\bp_
\br_
\be_
\bs_
\be_
\br_
\bv_
\be _
\bg_
\br_
\bo_
\bu_
\bp _
\bv_
\be_
\bc_
\bt_
\bo_
\br) option causes s
\bsu
\bud
\bdo
\bo to
258 preserve the invoking user's group vector unaltered. By
262 1.7.4 July 19, 2010 4
268 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
271 default, s
\bsu
\bud
\bdo
\bo will initialize the group vector to the list
272 of groups the target user is in. The real and effective
273 group IDs, however, are still set to match the target user.
275 -p _
\bp_
\br_
\bo_
\bm_
\bp_
\bt The -
\b-p
\bp (_
\bp_
\br_
\bo_
\bm_
\bp_
\bt) option allows you to override the default
276 password prompt and use a custom one. The following
277 percent (`%') escapes are supported:
279 %H expanded to the local host name including the domain
280 name (on if the machine's host name is fully qualified
281 or the _
\bf_
\bq_
\bd_
\bn _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs option is set)
283 %h expanded to the local host name without the domain name
285 %p expanded to the user whose password is being asked for
286 (respects the _
\br_
\bo_
\bo_
\bt_
\bp_
\bw, _
\bt_
\ba_
\br_
\bg_
\be_
\bt_
\bp_
\bw and _
\br_
\bu_
\bn_
\ba_
\bs_
\bp_
\bw flags in
287 _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs)
289 %U expanded to the login name of the user the command will
290 be run as (defaults to root)
292 %u expanded to the invoking user's login name
294 %% two consecutive % characters are collapsed into a
297 The prompt specified by the -
\b-p
\bp option will override the
298 system password prompt on systems that support PAM unless
299 the _
\bp_
\ba_
\bs_
\bs_
\bp_
\br_
\bo_
\bm_
\bp_
\bt_
\b__
\bo_
\bv_
\be_
\br_
\br_
\bi_
\bd_
\be flag is disabled in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs.
301 -r _
\br_
\bo_
\bl_
\be The -
\b-r
\br (_
\br_
\bo_
\bl_
\be) option causes the new (SELinux) security
302 context to have the role specified by _
\br_
\bo_
\bl_
\be.
304 -S The -
\b-S
\bS (_
\bs_
\bt_
\bd_
\bi_
\bn) option causes s
\bsu
\bud
\bdo
\bo to read the password from
305 the standard input instead of the terminal device. The
306 password must be followed by a newline character.
309 The -
\b-s
\bs (_
\bs_
\bh_
\be_
\bl_
\bl) option runs the shell specified by the _
\bS_
\bH_
\bE_
\bL_
\bL
310 environment variable if it is set or the shell as specified
311 in _
\bp_
\ba_
\bs_
\bs_
\bw_
\bd(4). If a command is specified, it is passed to
312 the shell for execution. Otherwise, an interactive shell
315 -t _
\bt_
\by_
\bp_
\be The -
\b-t
\bt (_
\bt_
\by_
\bp_
\be) option causes the new (SELinux) security
316 context to have the type specified by _
\bt_
\by_
\bp_
\be. If no type is
317 specified, the default type is derived from the specified
320 -U _
\bu_
\bs_
\be_
\br The -
\b-U
\bU (_
\bo_
\bt_
\bh_
\be_
\br _
\bu_
\bs_
\be_
\br) option is used in conjunction with the
321 -
\b-l
\bl option to specify the user whose privileges should be
322 listed. Only root or a user with s
\bsu
\bud
\bdo
\bo ALL on the current
323 host may use this option.
328 1.7.4 July 19, 2010 5
334 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
337 -u _
\bu_
\bs_
\be_
\br The -
\b-u
\bu (_
\bu_
\bs_
\be_
\br) option causes s
\bsu
\bud
\bdo
\bo to run the specified
338 command as a user other than _
\br_
\bo_
\bo_
\bt. To specify a _
\bu_
\bi_
\bd
339 instead of a _
\bu_
\bs_
\be_
\br _
\bn_
\ba_
\bm_
\be, use _
\b#_
\bu_
\bi_
\bd. When running commands as
340 a _
\bu_
\bi_
\bd, many shells require that the '#' be escaped with a
341 backslash ('\'). Note that if the _
\bt_
\ba_
\br_
\bg_
\be_
\bt_
\bp_
\bw Defaults option
342 is set (see _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4)) it is not possible to run commands
343 with a uid not listed in the password database.
345 -V The -
\b-V
\bV (_
\bv_
\be_
\br_
\bs_
\bi_
\bo_
\bn) option causes s
\bsu
\bud
\bdo
\bo to print the version
346 number and exit. If the invoking user is already root the
347 -
\b-V
\bV option will print out a list of the defaults s
\bsu
\bud
\bdo
\bo was
348 compiled with as well as the machine's local network
351 -v If given the -
\b-v
\bv (_
\bv_
\ba_
\bl_
\bi_
\bd_
\ba_
\bt_
\be) option, s
\bsu
\bud
\bdo
\bo will update the
352 user's time stamp, prompting for the user's password if
353 necessary. This extends the s
\bsu
\bud
\bdo
\bo timeout for another 5
354 minutes (or whatever the timeout is set to in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs) but
355 does not run a command.
357 -- The -
\b--
\b- option indicates that s
\bsu
\bud
\bdo
\bo should stop processing
358 command line arguments.
360 Environment variables to be set for the command may also be passed on
361 the command line in the form of V
\bVA
\bAR
\bR=_
\bv_
\ba_
\bl_
\bu_
\be, e.g.
362 L
\bLD
\bD_
\b_L
\bLI
\bIB
\bBR
\bRA
\bAR
\bRY
\bY_
\b_P
\bPA
\bAT
\bTH
\bH=_
\b/_
\bu_
\bs_
\br_
\b/_
\bl_
\bo_
\bc_
\ba_
\bl_
\b/_
\bp_
\bk_
\bg_
\b/_
\bl_
\bi_
\bb. Variables passed on the command
363 line are subject to the same restrictions as normal environment
364 variables with one important exception. If the _
\bs_
\be_
\bt_
\be_
\bn_
\bv option is set in
365 _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs, the command to be run has the SETENV tag set or the command
366 matched is ALL, the user may set variables that would overwise be
367 forbidden. See _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4) for more information.
369 R
\bRE
\bET
\bTU
\bUR
\bRN
\bN V
\bVA
\bAL
\bLU
\bUE
\bES
\bS
370 Upon successful execution of a program, the exit status from s
\bsu
\bud
\bdo
\bo will
371 simply be the exit status of the program that was executed.
373 Otherwise, s
\bsu
\bud
\bdo
\bo quits with an exit value of 1 if there is a
374 configuration/permission problem or if s
\bsu
\bud
\bdo
\bo cannot execute the given
375 command. In the latter case the error string is printed to stderr. If
376 s
\bsu
\bud
\bdo
\bo cannot _
\bs_
\bt_
\ba_
\bt(2) one or more entries in the user's PATH an error is
377 printed on stderr. (If the directory does not exist or if it is not
378 really a directory, the entry is ignored and no error is printed.)
379 This should not happen under normal circumstances. The most common
380 reason for _
\bs_
\bt_
\ba_
\bt(2) to return "permission denied" is if you are running
381 an automounter and one of the directories in your PATH is on a machine
382 that is currently unreachable.
384 S
\bSE
\bEC
\bCU
\bUR
\bRI
\bIT
\bTY
\bY N
\bNO
\bOT
\bTE
\bES
\bS
385 s
\bsu
\bud
\bdo
\bo tries to be safe when executing external commands.
387 There are two distinct ways to deal with environment variables. By
388 default, the _
\be_
\bn_
\bv_
\b__
\br_
\be_
\bs_
\be_
\bt _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs option is enabled. This causes commands
389 to be executed with a minimal environment containing TERM, PATH, HOME,
390 SHELL, LOGNAME, USER and USERNAME in addition to variables from the
394 1.7.4 July 19, 2010 6
400 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
403 invoking process permitted by the _
\be_
\bn_
\bv_
\b__
\bc_
\bh_
\be_
\bc_
\bk and _
\be_
\bn_
\bv_
\b__
\bk_
\be_
\be_
\bp _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs
404 options. There is effectively a whitelist for environment variables.
406 If, however, the _
\be_
\bn_
\bv_
\b__
\br_
\be_
\bs_
\be_
\bt option is disabled in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs, any variables
407 not explicitly denied by the _
\be_
\bn_
\bv_
\b__
\bc_
\bh_
\be_
\bc_
\bk and _
\be_
\bn_
\bv_
\b__
\bd_
\be_
\bl_
\be_
\bt_
\be options are
408 inherited from the invoking process. In this case, _
\be_
\bn_
\bv_
\b__
\bc_
\bh_
\be_
\bc_
\bk and
409 _
\be_
\bn_
\bv_
\b__
\bd_
\be_
\bl_
\be_
\bt_
\be behave like a blacklist. Since it is not possible to
410 blacklist all potentially dangerous environment variables, use of the
411 default _
\be_
\bn_
\bv_
\b__
\br_
\be_
\bs_
\be_
\bt behavior is encouraged.
413 In all cases, environment variables with a value beginning with () are
414 removed as they could be interpreted as b
\bba
\bas
\bsh
\bh functions. The list of
415 environment variables that s
\bsu
\bud
\bdo
\bo allows or denies is contained in the
416 output of sudo -V when run as root.
418 Note that the dynamic linker on most operating systems will remove
419 variables that can control dynamic linking from the environment of
420 setuid executables, including s
\bsu
\bud
\bdo
\bo. Depending on the operating system
421 this may include _RLD*, DYLD_*, LD_*, LDR_*, LIBPATH, SHLIB_PATH, and
422 others. These type of variables are removed from the environment
423 before s
\bsu
\bud
\bdo
\bo even begins execution and, as such, it is not possible for
424 s
\bsu
\bud
\bdo
\bo to preserve them.
426 To prevent command spoofing, s
\bsu
\bud
\bdo
\bo checks "." and "" (both denoting
427 current directory) last when searching for a command in the user's PATH
428 (if one or both are in the PATH). Note, however, that the actual PATH
429 environment variable is _
\bn_
\bo_
\bt modified and is passed unchanged to the
430 program that s
\bsu
\bud
\bdo
\bo executes.
432 s
\bsu
\bud
\bdo
\bo will check the ownership of its time stamp directory
433 (_
\b/_
\bv_
\ba_
\br_
\b/_
\ba_
\bd_
\bm_
\b/_
\bs_
\bu_
\bd_
\bo by default) and ignore the directory's contents if it is
434 not owned by root or if it is writable by a user other than root. On
435 systems that allow non-root users to give away files via _
\bc_
\bh_
\bo_
\bw_
\bn(2), if
436 the time stamp directory is located in a directory writable by anyone
437 (e.g., _
\b/_
\bt_
\bm_
\bp), it is possible for a user to create the time stamp
438 directory before s
\bsu
\bud
\bdo
\bo is run. However, because s
\bsu
\bud
\bdo
\bo checks the
439 ownership and mode of the directory and its contents, the only damage
440 that can be done is to "hide" files by putting them in the time stamp
441 dir. This is unlikely to happen since once the time stamp dir is owned
442 by root and inaccessible by any other user, the user placing files
443 there would be unable to get them back out. To get around this issue
444 you can use a directory that is not world-writable for the time stamps
445 (_
\b/_
\bv_
\ba_
\br_
\b/_
\ba_
\bd_
\bm_
\b/_
\bs_
\bu_
\bd_
\bo for instance) or create _
\b/_
\bv_
\ba_
\br_
\b/_
\ba_
\bd_
\bm_
\b/_
\bs_
\bu_
\bd_
\bo with the
446 appropriate owner (root) and permissions (0700) in the system startup
449 s
\bsu
\bud
\bdo
\bo will not honor time stamps set far in the future. Timestamps with
450 a date greater than current_time + 2 * TIMEOUT will be ignored and sudo
451 will log and complain. This is done to keep a user from creating
452 his/her own time stamp with a bogus date on systems that allow users to
455 On systems where the boot time is available, s
\bsu
\bud
\bdo
\bo will also not honor
456 time stamps from before the machine booted.
460 1.7.4 July 19, 2010 7
466 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
469 Since time stamp files live in the file system, they can outlive a
470 user's login session. As a result, a user may be able to login, run a
471 command with s
\bsu
\bud
\bdo
\bo after authenticating, logout, login again, and run
472 s
\bsu
\bud
\bdo
\bo without authenticating so long as the time stamp file's
473 modification time is within 5 minutes (or whatever the timeout is set
474 to in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs). When the _
\bt_
\bt_
\by_
\b__
\bt_
\bi_
\bc_
\bk_
\be_
\bt_
\bs option is enabled in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs, the
475 time stamp has per-tty granularity but still may outlive the user's
476 session. On Linux systems where the devpts filesystem is used, Solaris
477 systems with the devices filesystem, as well as other systems that
478 utilize a devfs filesystem that monotonically increase the inode number
479 of devices as they are created (such as Mac OS X), s
\bsu
\bud
\bdo
\bo is able to
480 determine when a tty-based time stamp file is stale and will ignore it.
481 Administrators should not rely on this feature as it is not universally
484 Please note that s
\bsu
\bud
\bdo
\bo will normally only log the command it explicitly
485 runs. If a user runs a command such as sudo su or sudo sh, subsequent
486 commands run from that shell will _
\bn_
\bo_
\bt be logged, nor will s
\bsu
\bud
\bdo
\bo's access
487 control affect them. The same is true for commands that offer shell
488 escapes (including most editors). Because of this, care must be taken
489 when giving users access to commands via s
\bsu
\bud
\bdo
\bo to verify that the
490 command does not inadvertently give the user an effective root shell.
491 For more information, please see the PREVENTING SHELL ESCAPES section
492 in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4).
494 E
\bEN
\bNV
\bVI
\bIR
\bRO
\bON
\bNM
\bME
\bEN
\bNT
\bT
495 s
\bsu
\bud
\bdo
\bo utilizes the following environment variables:
497 EDITOR Default editor to use in -
\b-e
\be (sudoedit) mode if neither
498 SUDO_EDITOR nor VISUAL is set
500 MAIL In -
\b-i
\bi mode or when _
\be_
\bn_
\bv_
\b__
\br_
\be_
\bs_
\be_
\bt is enabled in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs, set
501 to the mail spool of the target user
503 HOME Set to the home directory of the target user if -
\b-i
\bi or
504 -
\b-H
\bH are specified, _
\be_
\bn_
\bv_
\b__
\br_
\be_
\bs_
\be_
\bt or _
\ba_
\bl_
\bw_
\ba_
\by_
\bs_
\b__
\bs_
\be_
\bt_
\b__
\bh_
\bo_
\bm_
\be are set
505 in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs, or when the -
\b-s
\bs option is specified and
506 _
\bs_
\be_
\bt_
\b__
\bh_
\bo_
\bm_
\be is set in _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs
508 PATH Set to a sane value if the _
\bs_
\be_
\bc_
\bu_
\br_
\be_
\b__
\bp_
\ba_
\bt_
\bh sudoers option
511 SHELL Used to determine shell to run with -s option
513 SUDO_ASKPASS Specifies the path to a helper program used to read the
514 password if no terminal is available or if the -A
517 SUDO_COMMAND Set to the command run by sudo
519 SUDO_EDITOR Default editor to use in -
\b-e
\be (sudoedit) mode
521 SUDO_GID Set to the group ID of the user who invoked sudo
526 1.7.4 July 19, 2010 8
532 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
535 SUDO_PROMPT Used as the default password prompt
537 SUDO_PS1 If set, PS1 will be set to its value for the program
540 SUDO_UID Set to the user ID of the user who invoked sudo
542 SUDO_USER Set to the login of the user who invoked sudo
544 USER Set to the target user (root unless the -
\b-u
\bu option is
547 VISUAL Default editor to use in -
\b-e
\be (sudoedit) mode if
548 SUDO_EDITOR is not set
551 _
\b/_
\be_
\bt_
\bc_
\b/_
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs List of who can run what
553 _
\b/_
\bv_
\ba_
\br_
\b/_
\ba_
\bd_
\bm_
\b/_
\bs_
\bu_
\bd_
\bo Directory containing time stamps
555 _
\b/_
\be_
\bt_
\bc_
\b/_
\be_
\bn_
\bv_
\bi_
\br_
\bo_
\bn_
\bm_
\be_
\bn_
\bt Initial environment for -
\b-i
\bi mode on Linux and
558 E
\bEX
\bXA
\bAM
\bMP
\bPL
\bLE
\bES
\bS
559 Note: the following examples assume suitable _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4) entries.
561 To get a file listing of an unreadable directory:
563 $ sudo ls /usr/local/protected
565 To list the home directory of user yaz on a machine where the file
566 system holding ~yaz is not exported as root:
568 $ sudo -u yaz ls ~yaz
570 To edit the _
\bi_
\bn_
\bd_
\be_
\bx_
\b._
\bh_
\bt_
\bm_
\bl file as user www:
572 $ sudo -u www vi ~www/htdocs/index.html
574 To view system logs only accessible to root and users in the adm group:
576 $ sudo -g adm view /var/log/syslog
578 To run an editor as jim with a different primary group:
580 $ sudo -u jim -g audio vi ~jim/sound.txt
582 To shutdown a machine:
584 $ sudo shutdown -r +15 "quick reboot"
586 To make a usage listing of the directories in the /home partition.
587 Note that this runs the commands in a sub-shell to make the cd and file
592 1.7.4 July 19, 2010 9
598 SUDO(1m) MAINTENANCE COMMANDS SUDO(1m)
601 $ sudo sh -c "cd /home ; du -s * | sort -rn > USAGE"
603 S
\bSE
\bEE
\bE A
\bAL
\bLS
\bSO
\bO
604 _
\bg_
\br_
\be_
\bp(1), _
\bs_
\bu(1), _
\bs_
\bt_
\ba_
\bt(2), _
\bl_
\bo_
\bg_
\bi_
\bn_
\b__
\bc_
\ba_
\bp(3), _
\bp_
\ba_
\bs_
\bs_
\bw_
\bd(4), _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(5),
605 _
\bv_
\bi_
\bs_
\bu_
\bd_
\bo(1m)
607 A
\bAU
\bUT
\bTH
\bHO
\bOR
\bRS
\bS
608 Many people have worked on s
\bsu
\bud
\bdo
\bo over the years; this version consists
609 of code written primarily by:
613 See the HISTORY file in the s
\bsu
\bud
\bdo
\bo distribution or visit
614 http://www.sudo.ws/sudo/history.html for a short history of s
\bsu
\bud
\bdo
\bo.
616 C
\bCA
\bAV
\bVE
\bEA
\bAT
\bTS
\bS
617 There is no easy way to prevent a user from gaining a root shell if
618 that user is allowed to run arbitrary commands via s
\bsu
\bud
\bdo
\bo. Also, many
619 programs (such as editors) allow the user to run commands via shell
620 escapes, thus avoiding s
\bsu
\bud
\bdo
\bo's checks. However, on most systems it is
621 possible to prevent shell escapes with s
\bsu
\bud
\bdo
\bo's _
\bn_
\bo_
\be_
\bx_
\be_
\bc functionality.
622 See the _
\bs_
\bu_
\bd_
\bo_
\be_
\br_
\bs(4) manual for details.
624 It is not meaningful to run the cd command directly via sudo, e.g.,
626 $ sudo cd /usr/local/protected
628 since when the command exits the parent process (your shell) will still
629 be the same. Please see the EXAMPLES section for more information.
631 If users have sudo ALL there is nothing to prevent them from creating
632 their own program that gives them a root shell regardless of any '!'
633 elements in the user specification.
635 Running shell scripts via s
\bsu
\bud
\bdo
\bo can expose the same kernel bugs that
636 make setuid shell scripts unsafe on some operating systems (if your OS
637 has a /dev/fd/ directory, setuid shell scripts are generally safe).
640 If you feel you have found a bug in s
\bsu
\bud
\bdo
\bo, please submit a bug report at
641 http://www.sudo.ws/sudo/bugs/
643 S
\bSU
\bUP
\bPP
\bPO
\bOR
\bRT
\bT
644 Limited free support is available via the sudo-users mailing list, see
645 http://www.sudo.ws/mailman/listinfo/sudo-users to subscribe or search
648 D
\bDI
\bIS
\bSC
\bCL
\bLA
\bAI
\bIM
\bME
\bER
\bR
649 s
\bsu
\bud
\bdo
\bo is provided ``AS IS'' and any express or implied warranties,
650 including, but not limited to, the implied warranties of
651 merchantability and fitness for a particular purpose are disclaimed.
652 See the LICENSE file distributed with s
\bsu
\bud
\bdo
\bo or
653 http://www.sudo.ws/sudo/license.html for complete details.
658 1.7.4 July 19, 2010 10