sudo(8) MAINTENANCE COMMANDS sudo(8)
NNAAMMEE
sudo - execute a command as another user
SSYYNNOOPPSSIISS
ssuuddoo --VV | --hh | --ll | --LL | --vv | --kk | --KK | --ss | [ --HH ] [--PP ]
[--SS ] [ --bb ] | [ --pp prompt ] [ --cc class|- ] [ --aa auth_type
] [ --uu username|#uid ] command
DDEESSCCRRIIPPTTIIOONN
ssuuddoo allows a permitted user to execute a command as the
superuser or another user, as specified in the sudoers
file. The real and effective uid and gid are set to match
those of the target user as specified in the passwd file
(the group vector is also initialized when the target user
is not root). By default, ssuuddoo requires that users
authenticate themselves with a password (NOTE: by default
this is the user's password, not the root password). Once
a user has been authenticated, a timestamp is updated and
the user may then use sudo without a password for a short
period of time (5 minutes unless overridden in sudoers).
ssuuddoo determines who is an authorized user by consulting
the file /etc/sudoers. By giving ssuuddoo the --vv flag a user
can update the time stamp without running a command. The
password prompt itself will also time out if the user's
password is not entered within 5 minutes (unless overrid-
den via sudoers).
If a user who is not listed in the sudoers file tries to
run a command via ssuuddoo, mail is sent to the proper author-
ities, as defined at configure time or the sudoers file
(defaults to root). Note that the mail will not be sent
if an unauthorized user tries to run sudo with the --ll or
--vv flags. This allows users to determine for themselves
whether or not they are allowed to use ssuuddoo.
ssuuddoo can log both successful and unsuccessful attempts (as
well as errors) to syslog(3), a log file, or both. By
default ssuuddoo will log via syslog(3) but this is changeable
at configure time or via the sudoers file.
OOPPTTIIOONNSS
ssuuddoo accepts the following command line options:
-V The --VV (version) option causes ssuuddoo to print the ver-
sion number and exit. If the invoking user is already
root the --VV option will print out a list of the
defaults ssuuddoo was compiled with as well as the
machine's local network addresses.
-l The --ll (list) option will list out the allowed (and
forbidden) commands for the user on the current host.
January 16, 2002 1.6.5 1
sudo(8) MAINTENANCE COMMANDS sudo(8)
-L The --LL (list defaults) option will list out the param-
eters that may be set in a Defaults line along with a
short description for each. This option is useful in
conjunction with grep(1).
-h The --hh (help) option causes ssuuddoo to print a usage mes-
sage and exit.
-v If given the --vv (validate) option, ssuuddoo will update
the user's timestamp, prompting for the user's pass-
word if necessary. This extends the ssuuddoo timeout for
another 5 minutes (or whatever the timeout is set to
in sudoers) but does not run a command.
-k The --kk (kill) option to ssuuddoo invalidates the user's
timestamp by setting the time on it to the epoch. The
next time ssuuddoo is run a password will be required.
This option does not require a password and was added
to allow a user to revoke ssuuddoo permissions from a
.logout file.
-K The --KK (sure kill) option to ssuuddoo removes the user's
timestamp entirely. Likewise, this option does not
require a password.
-b The --bb (background) option tells ssuuddoo to run the given
command in the background. Note that if you use the
--bb option you cannot use shell job control to manipu-
late the process.
-p The --pp (prompt) option allows you to override the
default password prompt and use a custom one. If the
password prompt contains the %u escape, %u will be
replaced with the user's login name. Similarly, %h
will be replaced with the local hostname.
-c The --cc (class) option causes ssuuddoo to run the specified
command with resources limited by the specified login
class. The class argument can be either a class name
as defined in /etc/login.conf, or a single '-' charac-
ter. Specifying a class of - indicates that the com-
mand should be run restricted by the default login
capabilities for the user the command is run as. If
the class argument specifies an existing user class,
the command must be run as root, or the ssuuddoo command
must be run from a shell that is already root. This
option is only available on systems with BSD login
classes where ssuuddoo has been configured with the
--with-logincap option.
-a The --aa (authentication type) option causes ssuuddoo to use
the specified authentication type when validating the
user, as allowed by /etc/login.conf. The system
administrator may specify a list of sudo-specific
January 16, 2002 1.6.5 2
sudo(8) MAINTENANCE COMMANDS sudo(8)
authentication methods by adding an "auth-sudo" entry
in /etc/login.conf. This option is only available on
systems that support BSD authentication where ssuuddoo has
been configured with the --with-bsdauth option.
-u The --uu (user) option causes ssuuddoo to run the specified
command as a user other than root. To specify a uid
instead of a username, use #uid.
-s The --ss (shell) option runs the shell specified by the
SHELL environment variable if it is set or the shell
as specified in passwd(5).
-H The --HH (HOME) option sets the HOME environment vari-
able to the homedir of the target user (root by
default) as specified in passwd(5). By default, ssuuddoo
does not modify HOME.
-P The --PP (preserve group vector) option causes ssuuddoo to
preserve the user's group vector unaltered. By
default, ssuuddoo will initialize the group vector to the
list of groups the target user is in. The real and
effective group IDs, however, are still set to match
the target user.
-S The --SS (stdin) option causes ssuuddoo to read the password
from standard input instead of the terminal device.
-- The ---- flag indicates that ssuuddoo should stop processing
command line arguments. It is most useful in conjunc-
tion with the --ss flag.
RREETTUURRNN VVAALLUUEESS
Upon successful execution of a program, the return value
from ssuuddoo will simply be the return value of the program
that was executed.
Otherwise, ssuuddoo quits with an exit value of 1 if there is
a configuration/permission problem or if ssuuddoo cannot exe-
cute the given command. In the latter case the error
string is printed to stderr. If ssuuddoo cannot stat(2) one
or more entries in the user's PATH an error is printed on
stderr. (If the directory does not exist or if it is not
really a directory, the entry is ignored and no error is
printed.) This should not happen under normal circum-
stances. The most common reason for stat(2) to return
"permission denied" is if you are running an automounter
and one of the directories in your PATH is on a machine
that is currently unreachable.
SSEECCUURRIITTYY NNOOTTEESS
ssuuddoo tries to be safe when executing external commands.
Variables that control how dynamic loading and binding is
done can be used to subvert the program that ssuuddoo runs.
January 16, 2002 1.6.5 3
sudo(8) MAINTENANCE COMMANDS sudo(8)
To combat this the LD_*, _RLD_*, SHLIB_PATH (HP-UX only),
and LIBPATH (AIX only) environment variables are removed
from the environment passed on to all commands executed.
ssuuddoo will also remove the IFS, ENV, BASH_ENV, KRB_CONF,
KRBCONFDIR, KRBTKFILE, KRB5_CONFIG, LOCALDOMAIN,
RES_OPTIONS, HOSTALIASES, NLSPATH, PATH_LOCALE, TERMINFO,
TERMINFO_DIRS and TERMPATH variables as they too can pose
a threat. If the TERMCAP variable is set and is a path-
name, it too is ignored. Additionally, if the LC_* or
LANGUAGE variables contain the / or % characters, they are
ignored. If ssuuddoo has been compiled with SecurID support,
the VAR_ACE, USR_ACE and DLC_ACE variables are cleared as
well. The list of environment variables that ssuuddoo clears
is contained in the output of sudo -V when run as root.
To prevent command spoofing, ssuuddoo checks "." and "" (both
denoting current directory) last when searching for a com-
mand in the user's PATH (if one or both are in the PATH).
Note, however, that the actual PATH environment variable
is not modified and is passed unchanged to the program
that ssuuddoo executes.
For security reasons, if your OS supports shared libraries
and does not disable user-defined library search paths for
setuid programs (most do), you should either use a linker
option that disables this behavior or link ssuuddoo stati-
cally.
ssuuddoo will check the ownership of its timestamp directory
(/var/run/sudo by default) and ignore the directory's con-
tents if it is not owned by root and only writable by
root. On systems that allow non-root users to give away
files via chown(2), if the timestamp directory is located
in a directory writable by anyone (e.g.: /tmp), it is pos-
sible for a user to create the timestamp directory before
ssuuddoo is run. However, because ssuuddoo checks the ownership
and mode of the directory and its contents, the only dam-
age that can be done is to "hide" files by putting them in
the timestamp dir. This is unlikely to happen since once
the timestamp dir is owned by root and inaccessible by any
other user the user placing files there would be unable to
get them back out. To get around this issue you can use a
directory that is not world-writable for the timestamps
(/var/adm/sudo for instance) or create /var/run/sudo with
the appropriate owner (root) and permissions (0700) in the
system startup files.
ssuuddoo will not honor timestamps set far in the future.
Timestamps with a date greater than current_time + 2 *
TIMEOUT will be ignored and sudo will log and complain.
This is done to keep a user from creating his/her own
timestamp with a bogus date on systems that allow users to
give away files.
January 16, 2002 1.6.5 4
sudo(8) MAINTENANCE COMMANDS sudo(8)
Please note that ssuuddoo will only log the command it explic-
itly runs. If a user runs a command such as sudo su or
sudo sh, subsequent commands run from that shell will not
be logged, nor will ssuuddoo's access control affect them.
The same is true for commands that offer shell escapes
(including most editors). Because of this, care must be
taken when giving users access to commands via ssuuddoo to
verify that the command does not inadvertantly give the
user an effective root shell.
EEXXAAMMPPLLEESS
Note: the following examples assume suitable sudoers(5)
entries.
To get a file listing of an unreadable directory:
% sudo ls /usr/local/protected
To list the home directory of user yazza on a machine
where the filesystem holding ~yazza is not exported as
root:
% sudo -u yazza ls ~yazza
To edit the index.html file as user www:
% sudo -u www vi ~www/htdocs/index.html
To shutdown a machine:
% sudo shutdown -r +15 "quick reboot"
To make a usage listing of the directories in the /home
partition. Note that this runs the commands in a sub-
shell to make the cd and file redirection work.
% sudo sh -c "cd /home ; du -s * | sort -rn > USAGE"
EENNVVIIRROONNMMEENNTT
ssuuddoo utilizes the following environment variables:
January 16, 2002 1.6.5 5
sudo(8) MAINTENANCE COMMANDS sudo(8)
PATH Set to a sane value if SECURE_PATH is set
SHELL Used to determine shell to run with -s option
USER Set to the target user (root unless the -u option
is specified)
HOME In -s or -H mode (or if sudo was configured with
the --enable-shell-sets-home option), set to
homedir of the target user.
SUDO_PROMPT Used as the default password prompt
SUDO_COMMAND Set to the command run by sudo
SUDO_USER Set to the login of the user who invoked sudo
SUDO_UID Set to the uid of the user who invoked sudo
SUDO_GID Set to the gid of the user who invoked sudo
SUDO_PS1 If set, PS1 will be set to its value
FFIILLEESS
/etc/sudoers List of who can run what
/var/run/sudo Directory containing timestamps
AAUUTTHHOORRSS
Many people have worked on ssuuddoo over the years; this ver-
sion consists of code written primarily by:
Todd Miller
Chris Jepeway
See the HISTORY file in the ssuuddoo distribution or visit
http://www.sudo.ws/sudo/history.html for a short history
of ssuuddoo.
BBUUGGSS
If you feel you have found a bug in sudo, please submit a
bug report at http://www.sudo.ws/sudo/bugs/
DDIISSCCLLAAIIMMEERR
SSuuddoo is provided ``AS IS'' and any express or implied war-
ranties, including, but not limited to, the implied war-
ranties of merchantability and fitness for a particular
purpose are disclaimed. See the LICENSE file distributed
with ssuuddoo for complete details.
CCAAVVEEAATTSS
There is no easy way to prevent a user from gaining a root
shell if that user has access to commands allowing shell
escapes.
If users have sudo ALL there is nothing to prevent them
from creating their own program that gives them a root
shell regardless of any '!' elements in the user specifi-
cation.
Running shell scripts via ssuuddoo can expose the same kernel
bugs that make setuid shell scripts unsafe on some
January 16, 2002 1.6.5 6
sudo(8) MAINTENANCE COMMANDS sudo(8)
operating systems (if your OS supports the /dev/fd/ direc-
tory, setuid shell scripts are generally safe).
SSEEEE AALLSSOO
stat(2), login_cap(3), sudoers(5), passwd(5), visudo(8),
grep(1), su(1).
January 16, 2002 1.6.5 7