sudo-configure-superuser-privileges_en
sudo-configure-superuser-privileges_en
WHAT?
Get familiar with the basics of sudo configuration and learn how to
delegate superuser privileges with sudo .
WHY?
Some commands require administrator or root privileges. Using su-
do , you can delegate the privileges to execute these commands to cer-
tain users or groups.
EFFORT
It takes you up to 20 minutes to read through this article. Writing your
rst sudo configuration rule only takes a few minutes, but establishing
a functioning sudo configuration that works across your environment
will take considerably longer, depending on the complexity of your set-
up.
GOAL
Understand the basic aspects of sudo configuration. Address common
use cases for sudo configuration. Learn how to work with users, user
groups and aliases in sudo setups. Familiarize yourself with sudo best
practices and troubleshooting.
Contents
1 An introduction to sudo configuration 3
6 Troubleshooting 12
8 Legal Notice 17
Your own custom configurations are located under /etc/sudoers.d/ and take prece-
dence over anything that is provided in /usr/etc/sudoers.d/ . The visudo command
opens /usr/etc/sudoers and saves the changed le to /etc/sudoers , if there was no
prior sudoers le. If there was already one, visudo opens and writes that one. The
instance located under /etc/ takes precedence over the one that is kept under /usr/
etc/ . This way, user-made configuration adjustments will not get broken upon updates.
1. As system administrator ( root ), create a custom configuration le that holds the new
user-specific directives by starting visudo . Use both numbering and a descriptive name:
# visudo -f /etc/sudoers.d/02_usermanagement
2. Create a rule that allows tux to execute the /usr/sbin/useradd binary in the entire
environment that this sudo configuration is applied to:
1 Specify the user or group. List users by name or #UID , and groups by %GROUPNAME .
If you have several items here, separate them with commas. To negate entries, use ! .
2 Specify one or several (separated by commas) hosts. Use (fully qualified) host names
or IP addresses. Add ALL to enforce this setting globally across all hosts. Use ! for
negations.
/usr/sbin/useradd
Without any additional options added, this allows the execution of every pos-
sible useradd command.
/usr/sbin/useradd -c
If you explicitly specify an option, then that option is the only one that is al-
lowed. Nothing else would be available to the user you specified above.
/usr/sbin/useradd ""
This would just let the user invoke a mere useradd without any option at all.
In the example above, you would want to either allow all options and subcommands
or limit them to a few for security reasons, but forbidding a user to specify any option
at all would be pointless in this context.
3. To let the user use their own password instead of the root password, add the following
line:
Defaults:tux !targetpw
When active, this ag requires the user to enter the password of the target user, i.e. root .
This ag is enabled by default on any SUSE Linux Enterprise Server system. Negate it using
! to require the user to just enter their own password instead of the root password.
4. Save the configuration, leave the editor and open a second shell to test whether sudo
honors your new configuration.
# visudo /etc/sudoers.d/02_usermanagement
3. To allow the listed users to execute a list of commands, specify the commands as a com-
ma-separated list:
4. To let the listed users use their own password instead of the root password, add the
following line:
When active, this ag requires the listed users to enter the password of the target user,
i.e. root . This ag is enabled by default on any SUSE Linux Enterprise Server system.
Negate it using ! to require the listed users to just enter their own password instead of
the root password.
5. Save the configuration, leave the editor and open a second shell to test whether sudo
honors your new configuration.
# visudo /etc/sudoers.d/01_aliases
# visudo -f /etc/sudoers.d/02_usermanagement
6. Delete the previous rule and replace it with the following rule that uses the aliases you
have just defined above:
7. To let all the users defined by User_Alias use their own password instead of the root
password, add the following line:
Defaults:TEAMLEADERS !targetpw
8. Save the configuration, leave the editor and open a second shell to test whether sudo
honors your new configuration.
Learn how to change the timeout settings to execute commands that require root
privileges without being prompted for the root password for each command.
When running a command prefaced with sudo for the rst time, you are prompted for the
root password. This password remains valid for a certain period. Once it is expired, the user is
prompted for the password again. To extend or shorten the timeout when executing commands
that require root privileges, make the following changes to your sudo configuration le.
1. As system administrator, create a new sudo configuration le for the timestamp config-
uration with:
# visudo --f=/etc/sudoers.d/timestamp_timeout
After successful authentication with the root password, the le is opened.
2. Enable editing and add the line timestamp_timeout= . Enter a value for the timestamp.
For example, to shorten the timeout to three minutes, enter:
timestamp_timeout=3
If the timestamp is set to zero, you are prompted for the root password for every execu-
tion of a sudo command.
You have created a sudo configuration le and shortened the timeout setting for the execution
of sudo commands.
Start a shell with permanent root privileges by using the sudo -s or sudo -i
command. With both commands, you are prompted for the root password only
once.
sudo -s launches the shell with the environment of the current user and offers a few
privilege control measures. To run this command, enter the root password.
sudo -i starts the shell as an interactive login shell with a clean environment. To run
this command, you enter the root password.
With both commands, the shell is started with a new environment, and you are logged in as
root . Any subsequent command that is executed within that shell is run with elevated privileges
without having to enter the password again. This environment is terminated when you close the
shell, and you must enter the password again for another sudo command.
You have started a shell with permanently elevated privileges, and the command is logged in
your history. All subsequent commands are executed without prompting for the password again.
Learn about some of the best practices of sudo to control system access and enable
users to be productive.
Defaults secure_path="/usr/sbin:/usr/bin:/sbin:/bin:/usr/local/bin:/usr/local/sbin"
Defaults logfile=/var/log/sudo.log
6 Troubleshooting
This section provides a basic sudo configuration reference that helps you under-
stand and maintain both default and custom sudo configurations.
1 There are two exceptions: #include and #includedir are regular commands. The more
current version does not use the # anymore. Instead, include directives are now preceded
by @ . The # notation is still supported for backward compatibility reasons.
2 Remove the ! character to set the desired ag to ON.
3 Specify a list of environment variables that should be kept when env_reset is enabled.
4 A complex rule that states that the user tux requires a password to run /usr/bin/jour-
nalctl and does not require one to run /usr/bin/frobnicate on all hosts.
targetpw
If set, sudo prompts for the user password specified in the -u option or the root pass-
word, if -u is not used. The default is ON.
rootpw
If set, sudo prompts for the root password. The default is OFF.
env_reset
If set, sudo constructs a minimal environment with TERM , PATH , HOME , MAIL , SHELL ,
LOGNAME , USER , USERNAME , and SUDO_* . Additionally, variables listed in env_keep are
imported from the calling environment. The default is ON.
env_keep
The list of environment variables to keep when the env_reset ag is ON.
env_delete
The list of environment variables to remove when the env_reset ag is OFF.
User_List
One or several identifiers (separated by commas): either a user name, a group in the format
%GROUPNAME , or a user ID in the format #UID . Negation can be specified with the ! prefix.
Host_List
One or several identifiers (separated by commas): either a (fully qualified) host name or
an IP address. Negation can be specified with the ! prefix. ALL is a common choice for
Host_List .
NOPASSWD:|PASSWD:
The user is not prompted for a password when running commands matching Cmd_List
after NOPASSWD: .
PASSWD: is the default. It only needs to be specified when both PASSWD: and NOPASSWD:
are on the same line:
Cmnd_List
One or several specifiers (separated by commas): a path to an executable, followed by an
optional allowed argument.
User_Alias
A list of user names
Runas_Alias
A group of users by UID
Host_Alias
A list of host names
Cmnd_Alias
A list of commands and directories, and aliases
Think of aliases as named lists of users, groups, commands and hosts. To illustrate the power
of aliases, take this example:
1 The three servers are grouped into one Host_Alias WEBSERVERS . You can use (fully quali-
fied) host names or IP addresses.
2 Similar to the hosts grouped above, group users or even groups of users (like %wheel ) are
listed here. Negation is achieved with the ! prefix, as usual.
3 Specifies a group of commands that are used in the same context.
4 All aliases are wrapped into a single rule stating that all users specified by the User_Alias
can execute the group of commands specified under Cmnd_Alias on all hosts named in
Host_Alias .
In summary, aliases help administrators to keep sudoers lean and manageable (and therefore
secure). If, for example, one of the users has left the company, you can delete this person's name
from the User_Alias statement and any system group they belonged to just once instead of
having to search for all rules including this particular user.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful docu-
ment "free" in the sense of freedom: to assure everyone the effective freedom to copy and redis-
tribute it, with or without modifying it, either commercially or non-commercially. Secondarily,
this License preserves for the author and publisher a way to get credit for their work, while not
being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must
themselves be free in the same sense. It complements the GNU General Public License, which
is a copyleft license designed for free software.
We have designed this License to use it for manuals for free software, because free software needs
free documentation: a free program should come with manuals providing the same freedoms
that the software does. But this License is not limited to software manuals; it can be used for
any textual work, regardless of subject matter or whether it is published as a printed book. We
recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed
by the copyright holder saying it can be distributed under the terms of this License. Such a
notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under
the conditions stated herein. The "Document", below, refers to any such manual or work. Any
member of the public is a licensee, and is addressed as "you". You accept the license if you copy,
modify or distribute the work in a way requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the Document or a portion
of it, either copied verbatim, or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals
exclusively with the relationship of the publishers or authors of the Document to the Document's
overall subject (or to related matters) and contains nothing that could fall directly within that
overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section
may not explain any mathematics.) The relationship could be a matter of historical connection
with the subject or with related matters, or of legal, commercial, philosophical, ethical or po-
litical position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being
those of Invariant Sections, in the notice that says that the Document is released under this
License. If a section does not t the above definition of Secondary then it is not allowed to be
designated as Invariant. The Document may contain zero Invariant Sections. If the Document
does not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-
Cover Texts, in the notice that says that the Document is released under this License. A Front-
Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format
whose specification is available to the general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of pixels) generic paint
programs or (for drawings) some widely available drawing editor, and that is suitable for input
to text formatters or for automatic translation to a variety of formats suitable for input to text
formatters. A copy made in an otherwise Transparent le format whose markup, or absence of
markup, has been arranged to thwart or discourage subsequent modification by readers is not
Transparent. An image format is not Transparent if used for any substantial amount of text. A
copy that is not "Transparent" is called "Opaque".
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or non-com-
mercially, provided that this License, the copyright notices, and the license notice saying this
License applies to the Document are reproduced in all copies, and that you add no other condi-
tions whatsoever to those of this License. You may not use technical measures to obstruct or
control the reading or further copying of the copies you make or distribute. However, you may
accept compensation in exchange for copies. If you distribute a large enough number of copies
you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display
copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the
Document, numbering more than 100, and the Document's license notice requires Cover Texts,
you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-
Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also
clearly and legibly identify you as the publisher of these copies. The front cover must present the
full title with all words of the title equally prominent and visible. You may add other material
on the covers in addition. Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated as verbatim copying in
other respects.
If the required texts for either cover are too voluminous to t legibly, you should put the rst
ones listed (as many as t reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must
either include a machine-readable Transparent copy along with each Opaque copy, or state in
or with each Opaque copy a computer-network location from which the general network-using
public has access to download using public-standard network protocols a complete Transparent
copy of the Document, free of added material. If you use the latter option, you must take rea-
sonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that
this Transparent copy will remain thus accessible at the stated location until at least one year
after the last time you distribute an Opaque copy (directly or through your agents or retailers)
of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before
redistributing any large number of copies, to give them a chance to provide you with an updated
version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sec-
tions 2 and 3 above, provided that you release the Modified Version under precisely this License,
with the Modified Version filling the role of the Document, thus licensing distribution and mod-
ification of the Modified Version to whoever possesses a copy of it. In addition, you must do
these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document,
and from those of previous versions (which should, if there were any, be listed in the
History section of the Document). You may use the same title as a previous version if the
original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities responsible for authorship
of the modifications in the Modified Version, together with at least ve of the principal
authors of the Document (all of its principal authors, if it has fewer than ve), unless they
release you from this requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the publisher.
E. Add an appropriate copyright notice for your modifications adjacent to the other copyright
notices.
F. Include, immediately after the copyright notices, a license notice giving the public permis-
sion to use the Modified Version under the terms of this License, in the form shown in
the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts
given in the Document's license notice.
I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at
least the title, year, new authors, and publisher of the Modified Version as given on the
Title Page. If there is no section Entitled "History" in the Document, create one stating the
title, year, authors, and publisher of the Document as given on its Title Page, then add an
item describing the Modified Version as stated in the previous sentence.
K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the
section, and preserve in the section all the substance and tone of each of the contributor
acknowledgements and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their
titles. Section numbers or the equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements". Such a section may not be included in the
Modified Version.
N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with
any Invariant Section.
If the Modified Version includes new front-matter sections or appendices that qualify as Se-
condary Sections and contain no material copied from the Document, you may at your option
designate some or all of these sections as invariant. To do this, add their titles to the list of
Invariant Sections in the Modified Version's license notice. These titles must be distinct from
any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements
of your Modified Version by various parties--for example, statements of peer review or that the
text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to ve words as a Front-Cover Text, and a passage of up to 25
words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only
one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through
arrangements made by) any one entity. If the Document already includes a cover text for the
same cover, previously added by you or by arrangement made by the same entity you are acting
on behalf of, you may not add another; but you may replace the old one, on explicit permission
from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use
their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the
terms defined in section 4 above for modified versions, provided that you include in the combi-
nation all of the Invariant Sections of all of the original documents, unmodified, and list them
all as Invariant Sections of your combined work in its license notice, and that you preserve all
their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant
Sections may be replaced with a single copy. If there are multiple Invariant Sections with the
same name but different contents, make the title of each such section unique by adding at the
end of it, in parentheses, the name of the original author or publisher of that section if known,
or else a unique number. Make the same adjustment to the section titles in the list of Invariant
Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original
documents, forming one section Entitled "History"; likewise combine any sections Entitled "Ac-
knowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled
"Endorsements".
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under
this License, and replace the individual copies of this License in the various documents with a
single copy that is included in the collection, provided that you follow the rules of this License
for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under
this License, provided you insert a copy of this License into the extracted document, and follow
this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent docu-
ments or works, in or on a volume of a storage or distribution medium, is called an "aggregate"
if the copyright resulting from the compilation is not used to limit the legal rights of the com-
pilation's users beyond what the individual works permit. When the Document is included in
an aggregate, this License does not apply to the other works in the aggregate which are not
themselves derivative works of the Document.
8. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of the Doc-
ument under the terms of section 4. Replacing Invariant Sections with translations requires spe-
cial permission from their copyright holders, but you may include translations of some or all
Invariant Sections in addition to the original versions of these Invariant Sections. You may in-
clude a translation of this License, and all the license notices in the Document, and any War-
ranty Disclaimers, provided that you also include the original English version of this License
and the original versions of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice or disclaimer, the original
version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the
requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual
title.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided
for under this License. Any other attempt to copy, modify, sublicense or distribute the Document
is void, and will automatically terminate your rights under this License. However, parties who
have received copies, or rights, from you under this License will not have their licenses termi-
nated so long as such parties remain in full compliance.
The Free Software Foundation may publish new, revised versions of the GNU Free Documenta-
tion License from time to time. Such new versions will be similar in spirit to the present ver-
sion, but may differ in detail to address new problems or concerns. See https://www.gnu.org/
copyleft/ .
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the
“with...Texts.” line with this:
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other combination of the three,
merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these
examples in parallel under your choice of free software license, such as the GNU General Public
License, to permit their use in free software.