Imported Upstream version 1.8.7

[debian/sudo] / doc / sudo.conf.cat

SUDO(4)                       Programmer's Manual                      SUDO(4)

N\bNA\bAM\bME\bE
     s\bsu\bud\bdo\bo.\b.c\bco\bon\bnf\bf - configuration for sudo front end

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     The s\bsu\bud\bdo\bo.\b.c\bco\bon\bnf\bf file is used to configure the s\bsu\bud\bdo\bo front end.  It specifies
     the security policy and I/O logging plugins, debug flags as well as
     plugin-agnostic path names and settings.

     The s\bsu\bud\bdo\bo.\b.c\bco\bon\bnf\bf file supports the following directives, described in detail
     below.

     Plugin    a security policy or I/O logging plugin

     Path      a plugin-agnostic path

     Set       a front end setting, such as _\bd_\bi_\bs_\ba_\bb_\bl_\be_\b__\bc_\bo_\br_\be_\bd_\bu_\bm_\bp or _\bg_\br_\bo_\bu_\bp_\b__\bs_\bo_\bu_\br_\bc_\be

     Debug     debug flags to aid in debugging s\bsu\bud\bdo\bo, s\bsu\bud\bdo\bor\bre\bep\bpl\bla\bay\by, v\bvi\bis\bsu\bud\bdo\bo, and
               the s\bsu\bud\bdo\boe\ber\brs\bs plugin.

     The pound sign (`#') is used to indicate a comment.  Both the comment
     character and any text after it, up to the end of the line, are ignored.

     Long lines can be continued with a backslash (`\') as the last character
     on the line.  Note that leading white space is removed from the beginning
     of lines even when the continuation character is used.

     Non-comment lines that don't begin with Plugin, Path, Debug, or Set are
     silently ignored.

     The s\bsu\bud\bdo\bo.\b.c\bco\bon\bnf\bf file is always parsed in the ``C'' locale.

   P\bPl\blu\bug\bgi\bin\bn c\bco\bon\bnf\bfi\big\bgu\bur\bra\bat\bti\bio\bon\bn
     s\bsu\bud\bdo\bo supports a plugin architecture for security policies and
     input/output logging.  Third parties can develop and distribute their own
     policy and I/O logging plugins to work seamlessly with the s\bsu\bud\bdo\bo front
     end.  Plugins are dynamically loaded based on the contents of s\bsu\bud\bdo\bo.\b.c\bco\bon\bnf\bf.

     A Plugin line consists of the Plugin keyword, followed by the _\bs_\by_\bm_\bb_\bo_\bl_\b__\bn_\ba_\bm_\be
     and the _\bp_\ba_\bt_\bh to the shared object containing the plugin.  The _\bs_\by_\bm_\bb_\bo_\bl_\b__\bn_\ba_\bm_\be
     is the name of the struct policy_plugin or struct io_plugin in the plugin
     shared object.  The _\bp_\ba_\bt_\bh may be fully qualified or relative.  If not
     fully qualified, it is relative to the _\b/_\bu_\bs_\br_\b/_\bl_\bo_\bc_\ba_\bl_\b/_\bl_\bi_\bb_\be_\bx_\be_\bc_\b/_\bs_\bu_\bd_\bo directory.
     In other words:

           Plugin sudoers_policy sudoers.so

     is equivalent to:

           Plugin sudoers_policy /usr/local/libexec/sudo/sudoers.so

     Starting with s\bsu\bud\bdo\bo 1.8.5, any additional parameters after the _\bp_\ba_\bt_\bh are
     passed as arguments to the plugin's _\bo_\bp_\be_\bn function.  For example, to
     override the compile-time default sudoers file mode:

           Plugin sudoers_policy sudoers.so sudoers_mode=0440

     The same shared object may contain multiple plugins, each with a
     different symbol name.  The shared object file must be owned by uid 0 and
     only writable by its owner.  Because of ambiguities that arise from
     composite policies, only a single policy plugin may be specified.  This
     limitation does not apply to I/O plugins.

     If no s\bsu\bud\bdo\bo.\b.c\bco\bon\bnf\bf file is present, or if it contains no Plugin lines, the
     s\bsu\bud\bdo\boe\ber\brs\bs plugin will be used as the default security policy and for I/O
     logging (if enabled by the policy).  This is equivalent to the following:

           Plugin sudoers_policy sudoers.so
           Plugin sudoers_io sudoers.so

     For more information on the s\bsu\bud\bdo\bo plugin architecture, see the
     sudo_plugin(1m) manual.

   P\bPa\bat\bth\bh s\bse\bet\btt\bti\bin\bng\bgs\bs
     A Path line consists of the Path keyword, followed by the name of the
     path to set and its value.  For example:

           Path noexec /usr/local/libexec/sudo/sudo_noexec.so
           Path askpass /usr/X11R6/bin/ssh-askpass

     The following plugin-agnostic paths may be set in the _\b/_\be_\bt_\bc_\b/_\bs_\bu_\bd_\bo_\b._\bc_\bo_\bn_\bf
     file:

     askpass   The fully qualified path to a helper program used to read the
               user's password when no terminal is available.  This may be the
               case when s\bsu\bud\bdo\bo is executed from a graphical (as opposed to
               text-based) application.  The program specified by _\ba_\bs_\bk_\bp_\ba_\bs_\bs
               should display the argument passed to it as the prompt and
               write the user's password to the standard output.  The value of
               _\ba_\bs_\bk_\bp_\ba_\bs_\bs may be overridden by the SUDO_ASKPASS environment
               variable.

     noexec    The fully-qualified path to a shared library containing dummy
               versions of the e\bex\bxe\bec\bcv\bv(), e\bex\bxe\bec\bcv\bve\be() and f\bfe\bex\bxe\bec\bcv\bve\be() library
               functions that just return an error.  This is used to implement
               the _\bn_\bo_\be_\bx_\be_\bc functionality on systems that support LD_PRELOAD or
               its equivalent.  The default value is:
               _\b/_\bu_\bs_\br_\b/_\bl_\bo_\bc_\ba_\bl_\b/_\bl_\bi_\bb_\be_\bx_\be_\bc_\b/_\bs_\bu_\bd_\bo_\b/_\bs_\bu_\bd_\bo_\b__\bn_\bo_\be_\bx_\be_\bc_\b._\bs_\bo.

     sesh      The fully-qualified path to the s\bse\bes\bsh\bh binary.  This setting is
               only used when s\bsu\bud\bdo\bo is built with SELinux support.  The default
               value is _\b/_\bu_\bs_\br_\b/_\bl_\bo_\bc_\ba_\bl_\b/_\bl_\bi_\bb_\be_\bx_\be_\bc_\b/_\bs_\bu_\bd_\bo_\b/_\bs_\be_\bs_\bh.

   O\bOt\bth\bhe\ber\br s\bse\bet\btt\bti\bin\bng\bgs\bs
     The s\bsu\bud\bdo\bo.\b.c\bco\bon\bnf\bf file also supports the following front end settings:

     disable_coredump
               Core dumps of s\bsu\bud\bdo\bo itself are disabled by default.  To aid in
               debugging s\bsu\bud\bdo\bo crashes, you may wish to re-enable core dumps by
               setting ``disable_coredump'' to false in s\bsu\bud\bdo\bo.\b.c\bco\bon\bnf\bf as follows:

                     Set disable_coredump false

               Note that most operating systems disable core dumps from setuid
               programs, including s\bsu\bud\bdo\bo.  To actually get a s\bsu\bud\bdo\bo core file you
               will likely need to enable core dumps for setuid processes.  On
               BSD and Linux systems this is accomplished in the sysctl
               command.  On Solaris, the coreadm command is used to configure
               core dump behavior.

               This setting is only available in s\bsu\bud\bdo\bo version 1.8.4 and
               higher.

     group_source
               s\bsu\bud\bdo\bo passes the invoking user's group list to the policy and
               I/O plugins.  On most systems, there is an upper limit to the
               number of groups that a user may belong to simultaneously
               (typically 16 for compatibility with NFS).  On systems with the
               getconf(1) utility, running:
                     getconf NGROUPS_MAX
               will return the maximum number of groups.

               However, it is still possible to be a member of a larger number
               of groups--they simply won't be included in the group list
               returned by the kernel for the user.  Starting with s\bsu\bud\bdo\bo
               version 1.8.7, if the user's kernel group list has the maximum
               number of entries, s\bsu\bud\bdo\bo will consult the group database
               directly to determine the group list.  This makes it possible
               for the security policy to perform matching by group name even
               when the user is a member of more than the maximum number of
               groups.

               The _\bg_\br_\bo_\bu_\bp_\b__\bs_\bo_\bu_\br_\bc_\be setting allows the administrator to change
               this default behavior.  Supported values for _\bg_\br_\bo_\bu_\bp_\b__\bs_\bo_\bu_\br_\bc_\be are:

               static    Use the static group list that the kernel returns.
                         Retrieving the group list this way is very fast but
                         it is subject to an upper limit as described above.
                         It is ``static'' in that it does not reflect changes
                         to the group database made after the user logs in.
                         This was the default behavior prior to s\bsu\bud\bdo\bo 1.8.7.

               dynamic   Always query the group database directly.  It is
                         ``dynamic'' in that changes made to the group
                         database after the user logs in will be reflected in
                         the group list.  On some systems, querying the group
                         database for all of a user's groups can be time
                         consuming when querying a network-based group
                         database.  Most operating systems provide an
                         efficient method of performing such queries.
                         Currently, s\bsu\bud\bdo\bo supports efficient group queries on
                         AIX, BSD, HP-UX, Linux and Solaris.

               adaptive  Only query the group database if the static group
                         list returned by the kernel has the maximum number of
                         entries.  This is the default behavior in s\bsu\bud\bdo\bo 1.8.7
                         and higher.

               For example, to cause s\bsu\bud\bdo\bo to only use the kernel's static list
               of groups for the user:

                     Set group_source static

               This setting is only available in s\bsu\bud\bdo\bo version 1.8.7 and
               higher.

     max_groups
               The maximum number of user groups to retrieve from the group
               database.  This setting is only used when querying the group
               database directly.  It is intended to be used on systems where
               it is not possible to detect when the array to be populated
               with group entries is not sufficiently large.  By default, s\bsu\bud\bdo\bo
               will allocate four times the system's maximum number of groups
               (see above) and retry with double that number if the group
               database query fails.  However, some systems just return as
               many entries as will fit and do not indicate an error when
               there is a lack of space.

               This setting is only available in s\bsu\bud\bdo\bo version 1.8.7 and
               higher.

   D\bDe\beb\bbu\bug\bg f\bfl\bla\bag\bgs\bs
     s\bsu\bud\bdo\bo versions 1.8.4 and higher support a flexible debugging framework
     that can help track down what s\bsu\bud\bdo\bo is doing internally if there is a
     problem.

     A Debug line consists of the Debug keyword, followed by the name of the
     program (or plugin) to debug (s\bsu\bud\bdo\bo, v\bvi\bis\bsu\bud\bdo\bo, s\bsu\bud\bdo\bor\bre\bep\bpl\bla\bay\by, s\bsu\bud\bdo\boe\ber\brs\bs), the
     debug file name and a comma-separated list of debug flags.  The debug
     flag syntax used by s\bsu\bud\bdo\bo and the s\bsu\bud\bdo\boe\ber\brs\bs plugin is _\bs_\bu_\bb_\bs_\by_\bs_\bt_\be_\bm@_\bp_\br_\bi_\bo_\br_\bi_\bt_\by but
     a plugin is free to use a different format so long as it does not include
     a comma (`,').

     For example:

           Debug sudo /var/log/sudo_debug all@warn,plugin@info

     would log all debugging statements at the _\bw_\ba_\br_\bn level and higher in
     addition to those at the _\bi_\bn_\bf_\bo level for the plugin subsystem.

     Currently, only one Debug entry per program is supported.  The s\bsu\bud\bdo\bo Debug
     entry is shared by the s\bsu\bud\bdo\bo front end, s\bsu\bud\bdo\boe\bed\bdi\bit\bt and the plugins.  A
     future release may add support for per-plugin Debug lines and/or support
     for multiple debugging files for a single program.

     The priorities used by the s\bsu\bud\bdo\bo front end, in order of decreasing
     severity, are: _\bc_\br_\bi_\bt, _\be_\br_\br, _\bw_\ba_\br_\bn, _\bn_\bo_\bt_\bi_\bc_\be, _\bd_\bi_\ba_\bg, _\bi_\bn_\bf_\bo, _\bt_\br_\ba_\bc_\be and _\bd_\be_\bb_\bu_\bg.
     Each priority, when specified, also includes all priorities higher than
     it.  For example, a priority of _\bn_\bo_\bt_\bi_\bc_\be would include debug messages
     logged at _\bn_\bo_\bt_\bi_\bc_\be and higher.

     The following subsystems are used by the s\bsu\bud\bdo\bo front-end:

     _\ba_\bl_\bl         matches every subsystem

     _\ba_\br_\bg_\bs        command line argument processing

     _\bc_\bo_\bn_\bv        user conversation

     _\be_\bd_\bi_\bt        sudoedit

     _\be_\bx_\be_\bc        command execution

     _\bm_\ba_\bi_\bn        s\bsu\bud\bdo\bo main function

     _\bn_\be_\bt_\bi_\bf       network interface handling

     _\bp_\bc_\bo_\bm_\bm       communication with the plugin

     _\bp_\bl_\bu_\bg_\bi_\bn      plugin configuration

     _\bp_\bt_\by         pseudo-tty related code

     _\bs_\be_\bl_\bi_\bn_\bu_\bx     SELinux-specific handling

     _\bu_\bt_\bi_\bl        utility functions

     _\bu_\bt_\bm_\bp        utmp handling

     The sudoers(4) plugin includes support for additional subsystems.

F\bFI\bIL\bLE\bES\bS
     _\b/_\be_\bt_\bc_\b/_\bs_\bu_\bd_\bo_\b._\bc_\bo_\bn_\bf            s\bsu\bud\bdo\bo front end configuration

E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
     #
     # Default /etc/sudo.conf file
     #
     # Format:
     #   Plugin plugin_name plugin_path plugin_options ...
     #   Path askpass /path/to/askpass
     #   Path noexec /path/to/sudo_noexec.so
     #   Debug sudo /var/log/sudo_debug all@warn
     #   Set disable_coredump true
     #
     # The plugin_path is relative to /usr/local/libexec/sudo unless
     #   fully qualified.
     # The plugin_name corresponds to a global symbol in the plugin
     #   that contains the plugin interface structure.
     # The plugin_options are optional.
     #
     # The sudoers plugin is used by default if no Plugin lines are
     # present.
     Plugin sudoers_policy sudoers.so
     Plugin sudoers_io sudoers.so

     #
     # Sudo askpass:
     #
     # An askpass helper program may be specified to provide a graphical
     # password prompt for "sudo -A" support.  Sudo does not ship with
     # its own askpass program but can use the OpenSSH askpass.
     #
     # Use the OpenSSH askpass
     #Path askpass /usr/X11R6/bin/ssh-askpass
     #
     # Use the Gnome OpenSSH askpass
     #Path askpass /usr/libexec/openssh/gnome-ssh-askpass

     #
     # Sudo noexec:
     #
     # Path to a shared library containing dummy versions of the execv(),
     # execve() and fexecve() library functions that just return an error.
     # This is used to implement the "noexec" functionality on systems that
     # support C<LD_PRELOAD> or its equivalent.
     # The compiled-in value is usually sufficient and should only be
     # changed if you rename or move the sudo_noexec.so file.
     #
     #Path noexec /usr/local/libexec/sudo/sudo_noexec.so

     #
     # Core dumps:
     #
     # By default, sudo disables core dumps while it is executing
     # (they are re-enabled for the command that is run).
     # To aid in debugging sudo problems, you may wish to enable core
     # dumps by setting "disable_coredump" to false.
     #
     #Set disable_coredump false

     #
     # User groups:
     #
     # Sudo passes the user's group list to the policy plugin.
     # If the user is a member of the maximum number of groups (usually 16),
     # sudo will query the group database directly to be sure to include
     # the full list of groups.
     #
     # On some systems, this can be expensive so the behavior is configurable.
     # The "group_source" setting has three possible values:
     #   static   - use the user's list of groups returned by the kernel.
     #   dynamic  - query the group database to find the list of groups.
     #   adaptive - if user is in less than the maximum number of groups.
     #              use the kernel list, else query the group database.
     #
     #Set group_source static

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
     sudoers(4), sudo(1m), sudo_plugin(1m)

H\bHI\bIS\bST\bTO\bOR\bRY\bY
     See the HISTORY file in the s\bsu\bud\bdo\bo distribution
     (http://www.sudo.ws/sudo/history.html) for a brief history of sudo.

A\bAU\bUT\bTH\bHO\bOR\bRS\bS
     Many people have worked on s\bsu\bud\bdo\bo over the years; this version consists of
     code written primarily by:

           Todd C. Miller

     See the CONTRIBUTORS file in the s\bsu\bud\bdo\bo distribution
     (http://www.sudo.ws/sudo/contributors.html) for an exhaustive list of
     people who have contributed to s\bsu\bud\bdo\bo.

B\bBU\bUG\bGS\bS
     If you feel you have found a bug in s\bsu\bud\bdo\bo, please submit a bug report at
     http://www.sudo.ws/sudo/bugs/

S\bSU\bUP\bPP\bPO\bOR\bRT\bT
     Limited free support is available via the sudo-users mailing list, see
     http://www.sudo.ws/mailman/listinfo/sudo-users to subscribe or search the
     archives.

D\bDI\bIS\bSC\bCL\bLA\bAI\bIM\bME\bER\bR
     s\bsu\bud\bdo\bo is provided ``AS IS'' and any express or implied warranties,
     including, but not limited to, the implied warranties of merchantability
     and fitness for a particular purpose are disclaimed.  See the LICENSE
     file distributed with s\bsu\bud\bdo\bo or http://www.sudo.ws/sudo/license.html for
     complete details.

Sudo 1.8.7                      March 14, 2013                      Sudo 1.8.7