Merge commit 'upstream/1.8.3p2'
[debian/sudo] / INSTALL
diff --git a/INSTALL b/INSTALL
index b03d9e8ef39ca35306a5c0350af3b6908fa008b2..a2c9cb46c4004cad237e5a5e438267123cc3a28b 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
-Installation instructions for Sudo 1.6.9
-========================================
+Sudo installation instructions
+==============================
 
 Sudo uses a `configure' script to probe the capabilities and type
 of the system in question.  In this release, `configure' takes many
@@ -15,40 +15,34 @@ For most systems and configurations it is possible simply to:
     0) If you are upgrading from a previous version of sudo
        please read the info in the UPGRADE file before proceeding.
 
-    1) If you previously ran `configure' on a different host
-       you will probably want to do a `make distclean' to remove
-       the old `config.cache' file.  Otherwise, `configure'
-       will complain and refuse to run.  Alternately, one can
-       simply `rm config.cache'.
-
-    2) Read the `OS dependent notes' section for any particular
+    1) Read the `OS dependent notes' section for any particular
        "gotchas" relating to your operating system.
 
-    3) `cd' to the source or build directory and type `./configure'
+    2) `cd' to the source or build directory and type `./configure'
        to generate a Makefile and config.h file suitable for
        building sudo.  Before you actually run configure you
        should read the `Available configure options' section
        to see if there are any special options you may want
        or need.
 
-    4) Edit the configure-generated Makefile if you wish to
+    3) Edit the configure-generated Makefile if you wish to
        change any of the default paths (alternatively, you could
        have changed the paths via options to `configure'.
 
     5) Type `make' to compile sudo.  If you are building sudo
-       in a separate build tree (apart from the sudo source)
-       GNU make will probably be required.  If `configure' did
-       its job properly (and you have a supported configuration)
-       there won't be any problems.  If this doesn't work, take
-       a look at the files TROUBLESHOOTING and PORTING for tips
-       on what might have gone wrong.  Please mail us if you have a
-       fix or if you are unable to come up with a fix (address at EOF).
+       in a separate build tree (apart from the sudo source) GNU
+       make will probably be required.  If `configure' did its job
+       properly (and you have a supported configuration) there won't
+       be any problems.  If this doesn't work, take a look at the
+       TROUBLESHOOTING file for tips on what might have gone wrong.
+       Please mail us if you have a fix or if you are unable to
+       come up with a fix (address at EOF).
 
     6) Type `make install' (as root) to install sudo, visudo, the
        man pages, and a skeleton sudoers file.  Note that the install
        will not overwrite an existing sudoers file.  You can also
        install various pieces the package via the install-binaries,
-       install-man, and install-sudoers make targets.
+       install-doc, and install-sudoers make targets.
 
     7) Edit the sudoers file with `visudo' as necessary for your
        site.  You will probably want to refer the sample.sudoers
@@ -105,9 +99,6 @@ Directory and file names:
        Find the sources in DIR [configure dir or ..]
 
 Special features/options:
-  --with-CC=PATH
-       Specifies path to C compiler you wish to use.
-
   --with-incpath=DIR
        Adds the specified directory (or directories) to CPPFLAGS
        so configure and the compiler will look there for include
@@ -140,9 +131,29 @@ Special features/options:
        `-l' will be prepended to it.  Multiple libraries may be
        specified as long as they are space separated.
 
+  --with-plugindir=PATH
+       Set the directory that sudo looks in to find the policy and I/O
+       logging plugins.  Defaults to the libexec dir used by configure.
+
+  --with-efence
+       Link with the "electric fence" debugging malloc.
+
+  --with-bsm-audit
+       Enable support for sudo BSM audit logs on systems that support
+       it.  Currently only supported under FreeBSD and Mac OS X.
+
   --with-csops
        Add CSOps standard options.  You probably aren't interested in this.
 
+  --with-devel
+        Configure development options.  This will enable compiler warnings
+       and set the Makefile to be able to regenerate the sudoers parser
+       as well as the manual pages.
+
+  --with-linux-audit
+       Enable audit support for Linux systems.  Audits attempts
+       to run a command as well as SELinux role changes.
+
   --with-skey[=DIR]
        Enable S/Key OTP (One Time Password) support.  If specified,
        DIR should contain include and lib directories with skey.h
@@ -180,15 +191,26 @@ Special features/options:
        containing the LDAP include and lib directories.  Please see
        README.LDAP for more information.
 
-  --with-ldap-conf-file=filename
+  --with-ldap-conf-file=PATH
        Path to LDAP configuration file.  If specified, sudo reads
        this file instead of /etc/ldap.conf to locate the LDAP server.
 
-  --with-ldap-secret-file=filename
+  --with-ldap-secret-file=PATH
        Path to LDAP secret password file.  If specified, sudo uses
        this file instead of /etc/ldap.secret to read the secret password
        when rootbinddn is specified in the ldap config file.
 
+  --with-nsswitch[=PATH]
+       Path to nsswitch.conf or "no" to disable nsswitch support.
+       If specified, sudo uses this file instead of /etc/nsswitch.conf.
+       If nsswitch is disabled but LDAP is enabled, sudo will check
+       LDAP first, then the sudoers file.
+
+  --with-netsvc[=PATH]
+        Path to netsvc.conf or "no" to disable netsvc.conf support.
+        If specified, sudo uses this file instead of /etc/netsvc.conf
+        on AIX systems.
+
   --with-aixauth
        Enable support for the AIX 4.x general authentication function.
        This will use the authentication scheme specified for the user
@@ -200,7 +222,7 @@ Special features/options:
        Linux, Solaris and HP-UX (version 11 and higher).
 
        NOTE: on RedHat Linux and Fedora you *must* have an /etc/pam.d/sudo
-       file installed.  You may either use the sample.pam file included with
+       file install.  You may either use the sample.pam file included with
        sudo or use /etc/pam.d/su as a reference.  The sample.pam file
        included with sudo may or may not work with other Linux distributions.
        On Solaris and HP-UX 11 systems you should check (and understand)
@@ -209,6 +231,12 @@ Special features/options:
        with your PAM libraries in /etc/pam.conf to obtain syslog output
        for debugging purposes.
 
+  --with-pam-login
+        Enable a specific PAM session when sudo is given the -i option.
+       This changes the PAM service name when sudo is run with the -i
+       option from "sudo" to "sudo-i", allowing for a separate pam
+       configuration for sudo's initial login mode.
+
   --with-AFS
        Enable AFS support with Kerberos authentication.  Should work under
        AFS 3.3.  If your AFS doesn't have -laudit you should be able to
@@ -228,10 +256,6 @@ Special features/options:
        unless the 'use_loginclass' option is defined in sudoers or the user
        specifies a class on the command line.
 
-  --with-project
-         Enable support for Solaris project resource limits.
-         This option is only available on Solaris 9 and above.
-
   --with-bsdauth
        Enable support for BSD authentication.  This is the default
        for BSD/OS and OpenBSD systems that support it.
@@ -241,13 +265,17 @@ Special features/options:
        is supported.  If you don't have /usr/include/bsd_auth.h
        then you cannot use this.
 
+  --with-project
+       Enable support for Solaris project resource limits.
+       This option is only available on Solaris 9 and above.
+
   --with-noexec[=PATH]
        Enable support for the "noexec" functionality which prevents
        a dynamically-linked program being run by sudo from executing
        another program (think shell escapes).  Please see the
        "PREVENTING SHELL ESCAPES" section in the sudoers man page
        for details.  If specified, PATH should be a fully qualified
-       pathname, e.g. /usr/local/libexec/sudo_noexec.so.  If PATH
+       path name, e.g. /usr/local/libexec/sudo_noexec.so.  If PATH
        is "no", noexec support will not be compiled in.  The default
        is to compile noexec support if libtool supports building
        shared objects on your OS.
@@ -320,6 +348,10 @@ Special features/options:
        physically live in ${prefix}/etc and /etc/sudoers will be
        a symbolic link.
 
+  --with-selinux 
+       Enable support for role based access control (RBAC) on
+       systems that support SELinux.
+
 The following options are also configurable at runtime:
 
   --with-long-otp-prompt
@@ -427,6 +459,11 @@ The following options are also configurable at runtime:
   --without-umask
        Preserves the umask of the user invoking sudo.
 
+  --with-umask-override
+        Use the umask specified in sudoers even if it is less restrictive
+       than the user's.  The default is to use the intersection of the
+       user's umask and the umask specified in sudoers.
+
   --with-runas-default=USER
        The default user to run commands as if the -u flag is not specified
        on the command line.  This defaults to "root".
@@ -449,18 +486,19 @@ The following options are also configurable at runtime:
        Number of minutes before the sudo password prompt times out.
        The default is 5, set this to 0 for no password timeout.
 
-  --with-tty-tickets
-       This makes sudo use a different ticket file for each user/tty combo.
-       Ie: instead of the ticket path being "username" it is "username/tty".
-       This is useful for "shared" accounts like "operator".  Note that this
-       means that there will be more files in the timestamp dir.  This is not
-       a problem if your system has a cron job to remove of files from /tmp
-       (or wherever you specified the timestamp dir to be).
+  --without-tty-tickets
+       By default, sudo uses a different ticket file for each user/tty combo.
+       With this option disabled, a single ticket will be used for all
+       of a user's login sessions.
 
   --with-insults
        Define this if you want to be insulted for typing an incorrect password
        just like the original sudo(8).  This is off by default.
 
+  --with-insults=disabled
+        Include support for insults but disable them unless explicitly
+        enabled in sudoers.
+
   --with-all-insults
        Include all the insult sets listed below.  You must either specify
        --with-insults or enable insults in the sudoers file for this to
@@ -504,7 +542,7 @@ The following options are also configurable at runtime:
 
   --with-editor=PATH
        Specify the default editor path for use by visudo.  This may be a
-       single pathname or a colon-separated list of editors.  In the latter
+       single path name or a colon-separated list of editors.  In the latter
        case, visudo will choose the editor that matches the user's VISUAL
        or EDITOR environment variables or the first editor in the list that
        exists.  The default is the path to vi on your system.
@@ -518,6 +556,19 @@ The following options are also configurable at runtime:
        option.  visudo will then only use the VISUAL or EDITOR variables
        if they match a value specified via --with-editor.
 
+  --with-askpass=PATH
+        Set PATH as the "askpass" program to use when no tty is
+        available.  Typically, this is a graphical password prompter,
+        similar to the one used by ssh.  The program must take a
+        prompt as an argument and print the received password to
+        the standard output.
+
+  --with-iologdir[=DIR]
+        By default, sudo stores I/O log files in either /var/log/sudo-io,
+        /var/adm/sudo-io, or /usr/log/sudo-io.  If this option is
+        specified, I/O logs will be stored in the indicated directory
+        instead.
+
   --disable-authentication
        By default, sudo requires the user to authenticate via a
        password or similar means.  This options causes sudo to
@@ -529,6 +580,13 @@ The following options are also configurable at runtime:
        "chaining" sudo commands to get a root shell by doing something
        like "sudo sudo /bin/sh".
 
+  --enable-gss-krb5-ccache-name
+        Use the gss_krb5_ccache_name() function to set the Kerberos
+        V credential cache file name.  By default, sudo will use
+        the KRB5CCNAME environment variable to set this.  While
+        gss_krb5_ccache_name() provides a better API to do this it
+        is not supported by all Kerberos V and SASL combinations.
+
   --enable-log-host
        Log the hostname in the log file.
 
@@ -552,6 +610,49 @@ The following options are also configurable at runtime:
        if the executable is simply not in the user's path, sudo will tell
        the user that they are not allowed to run it, which can be confusing.
 
+  --enable-zlib[=location]
+       Enable the use of the zlib compress library when storing
+       I/O log files.  If specified, location is the base directory
+       containing the zlib include and lib directories.  The special
+       values "system" and "builtin" can be used to indicate that
+       the system version of zlib should be used or that the version
+       of zlib shipped with sudo should be used instead.
+       If this option is not specified, configure will use the
+       system zlib if it is present.
+
+  --disable-zlib
+        Disable the use of the zlib compress library when storing
+        I/O log files.
+
+  --enable-warnings
+       Enable compiler warnings when building sudo with gcc.
+
+  --enable-werror
+       Enable the -Werror compiler option when building sudo with gcc.
+
+  --enable-admin-flag
+       Enable the creation of an Ubuntu-style admin flag file
+       the first time sudo is run.
+
+  --disable-env-reset
+        Disable environment resetting.  This sets the default value
+        of the "env_reset" Defaults option in sudoers to false.
+
+  --enable-nls[=location]
+        Enable natural language support using the gettext() family
+        of functions.  If specified, location is the base directory
+        containing the libintl include and lib directories.  If
+        this option is not specified, configure will look for the
+        gettext() family of functions in the standard C library
+        first, then check for a standalone libintl (linking with
+        libiconv as needed).
+
+  --disable-nls
+        Disable natural language support.  By default, sudo will
+        use the gettext() family of functions, if available, to
+        implement messages in the invoking user's native language.
+       Note that translations do not exist for all languages.
+
 Shadow password and C2 support
 ==============================
 
@@ -572,68 +673,76 @@ Shadow passwords are known to work on the following platforms:
     Digital UNIX
     IRIX >= 5.x
     AIX >= 3.2.x
-    ConvexOS with C2 security (not tested recently)
     Linux
     SCO >= 3.2.2
     Pyramid DC/OSx
     UnixWare
     SVR4 (and variants using standard SVR4 shadow passwords)
-    4.4BSD based systems (including OpenBSD, NetBSD, FreeBSD, and BSD/OS)
-    OS's using SecureWare's C2 security.
+    4.4BSD based systems (including OpenBSD, NetBSD, FreeBSD, and Mac OS X)
+    Systems using SecureWare's C2 security.
 
 OS dependent notes
 ==================
 
-OpenBSD < 2.2 and NetBSD < 1.2.1:
-    The fdesc file system has a bug wrt /dev/tty handling that
-    causes sudo to hang at the password prompt.  The workaround
-    is to run configure with --with-password-timeout=0
+Linux:
+    PAM and LDAP headers are not installed by default on most Linux
+    systems.  You will need to install the "pam-dev" package if
+    /usr/include/security/pam_appl.h is not present on your system.
+    If you wish to build with LDAP support you will also need the
+    openldap-devel package.
+
+    Versions of glibc 2.x previous to 2.0.7 have a broken lsearch().
+    You will need to either upgrade to glibc-2.0.7 or use sudo's
+    version of lsearch().  To use sudo's lsearch(), comment out
+    the "#define HAVE_LSEARCH 1" line in config.h and add lsearch.o
+    to the LIBOBJS line in the Makefile.
+
+    If you are using a Linux kernel older than 2.4 it is not possible
+    to access the sudoers file via NFS.  This is due to a bug in
+    the Linux client-side NFS implementation that has since been
+    fixed.  There is a workaround on the sudo ftp site, linux_nfs.patch,
+    if you need to NFS-mount sudoers on older Linux kernels.
 
 Solaris 2.x:
-    You need to have a C compiler in order to build sudo.
-    Since Solaris 2.x does not come with one by default this
-    means that you either need to have purchased the unbundled Sun
-    C compiler or have a copy of the GNU C compiler (gcc).
-    The SunSoft Catalyst CD should contain gcc binaries for
-    Solaris.  You can also get them from various places on the
-    net, including http://www.sunfreeware.com/
+    You need to have a C compiler in order to build sudo.  Since
+    Solaris 2.x does not come with one by default this means that
+    you either need to install the Sun Studio compiler suite,
+    available for free from www.sun.com, or have a copy of the GNU
+    C compiler (gcc) which is distributed on the Solaris Companion
+    CD.  You can also get them from various places on the net,
+    including http://www.sunfreeware.com/
     NOTE: sudo will *not* build with the sun C compiler in BSD
-         compatibility mode (/usr/ucb/cc).  Sudo is designed to
-         compile with the standard C compiler (or gcc) and will
-         not build correctly with /usr/ucb/cc.  You can use the
-         `--with-CC' option to point `configure' to the non-ucb
-         compiler if it is not the first cc in your path.  Some
-         sites link /usr/ucb/cc to gcc; configure will not notice
-         this an still refuse to use /usr/ucb/cc, so make sure gcc
-         is also in your path if your site is setup this way.
-    Also: Many versions of Solaris come with a broken syslogd.
+          compatibility mode (/usr/ucb/cc).  Sudo is designed to
+          compile with the standard C compiler (or gcc) and will
+          not build correctly with /usr/ucb/cc.  You can set the
+          CC environment variable to the non-ucb compiler when
+          running `configure' if it is not the first cc in your
+          path.  Some sites link /usr/ucb/cc to gcc; configure will
+          not notice this and still refuse to use /usr/ucb/cc, so
+          make sure gcc is also in your path if your site is setup
+          this way.
+    Also: Older versions of Solaris come with a broken syslogd.
          If you have having problems with sudo logging you should
          make sure you have the latest syslogd patch installed.
          This is a problem for Solaris 2.4 and 2.5 at least.
 
-AIX 3.2.x:
-    I've had various problems with the AIX C compiler producing
-    incorrect code when the -O flag was used.  When optimization
-    is not used, the problems go away.  Gcc does not appear
-    to have this problem.
+Mac OS X:
+    The pseudo-tty support in the Mac OS X kernel has bugs related
+    to its handling of the SIGTSTP, SIGTTIN and SIGTTOU signals.
+    It does not restart reads and writes when those signals are
+    delivered.  This may cause problems for some commands when I/O
+    logging is enabled.  The issue has been reported to Apple and
+    is bug id #7952709.
 
-    Also, the AIX 3.2.x lex will not work with sudo's parse.lex.
-    This should not be a problem as sudo comes shipped with
-    a pre-generated lex.yy.c (created by flex).  If you want
-    to modify the lex tokenizer, make sure you grab a copy of
-    flex from ftp.ee.lbl.gov (also available on most GNU mirrors)
-    and sudo will use that instead.
+HP-UX:
+    The default C compiler shipped with HP-UX is not an ANSI compiler.
+    You must use either the HP ANSI C compiler or gcc to build sudo.
+    Binary packages of gcc are available from http://hpux.connect.org.uk/.
 
-Ultrix 4.x:
-    Ultrix still ships with the 4.2BSD syslog(3) which does not
-    allow things like logging different facilities to different
-    files, redirecting logs to a single loghost and other niceties.
-    You may want to just grab and install:
-       ftp://gatekeeper.dec.com/pub/DEC/jtkohl-syslog-complete.tar.Z
-    (available via anonymous ftp) which is a port if the 4.3BSD
-    syslog/syslogd that is backwards compatible with the Ultrix version.
-    I recommend it highly.  If you do not do this you probably want
-    to run configure with --with-logging=file
+    To prevent PAM from overriding the value of umask on HP-UX 11,
+    you will need to add a line like the following to /etc/pam.conf:
+
+    sudo       session required        libpam_hpsec.so.1 bypass_umask
 
 Digital UNIX:
     By default, sudo will use SIA (Security Integration Architecture)
@@ -652,54 +761,41 @@ Digital UNIX:
     you can just make a copy in gcc's private include tree and
     edit that.
 
-Linux:
-    PAM and LDAP headers are not installed by default on most Linux
-    systems.  You will need to install the "pav-dev" package if
-    /usr/include/security/pam_appl.h is not present on your system.
-    If you wish to build with LDAP support you will also need the
-    openldap-devel package.
-
-    Versions of glibc 2.x previous to 2.0.7 have a broken lsearch().
-    You will need to either upgrade to glibc-2.0.7 or use sudo's
-    version of lsearch().  To use sudo's lsearch(), comment out
-    the "#define HAVE_LSEARCH 1" line in config.h and add lsearch.o
-    to the LIBOBJS line in the Makefile.
-
-    If you are using a Linux kernel older than 2.4 it is not possible
-    to access the sudoers file via NFS.  This is due to a bug in
-    the Linux client-side NFS implementation that has since been
-    fixed.  There is a workaround on the sudo ftp site, linux_nfs.patch,
-    if you need to NFS-mount sudoers on older Linux kernels.
-
-Mac OS X:
-    It has been reported that for sudo to work on Mac OS X it must
-    either be built with the --with-password-timeout=0 option or the
-    password timeout must be disabled in the Defaults line in the
-    sudoers file.  If sudo just hangs when you try to enter a password,
-    you need to disable the password timeout (Note: this is not a bug
-    in sudo).
+AIX 3.2.x:
+    I've had various problems with the AIX C compiler producing
+    incorrect code when the -O flag was used.  When optimization
+    is not used, the problems go away.  Gcc does not appear
+    to have this problem.
 
 SCO ODT:
     You'll probably need libcrypt_i.a available via anonymous ftp
     from sosco.sco.com.  The necessary files are /SLS/lng225b.Z
     and /SLS/lng225b.ltr.Z.
 
-Dynix:
-    Some people have experienced problems building sudo with gcc
-    on Dynix.  If you experience problems compiling sudo using gcc
-    on Dynix, try using the native compiler (cc).  You can do so
-    by removing the config.cache file and then re-running configure
-    with the --with-CC=cc option.
-
-HP-UX:
-    The default C compiler shipped with HP-UX does not support creating
-    position independent code and so is unable to support sudo's "noexec"
-    functionality.  You must use either the HP ANSI C compiler or gcc for
-    noexec to work.  Binary packages of gcc are available from
-    http://hpux.connect.org.uk/ and http://hpux.cs.utah.edu/.
-
 SunOS 4.x:
+    SunOS does not ship with an ANSI C compiler.  You will need to
+    install an ANSI compiler such as gcc to build sudo.
+
     The /bin/sh shipped with SunOS blows up while running configure.
-    You can work around this by installalling bash or zsh.  If you
+    You can work around this by installing bash or zsh.  If you
     have bash or zsh in your path, configure will use it instead
     automatically.
+
+ULTRIX 4.x:
+    ULTRIX does not ship with an ANSI C compiler.  You will need to
+    install an ANSI compiler such as gcc to build sudo.
+
+    The /bin/sh shipped with ULTRIX blows up while running configure.
+    You can work around this by installing bash or zsh.  If you
+    have bash or zsh in your path, configure will use it instead
+    automatically.
+
+    ULTRIX ships with the 4.2BSD syslog(3) which does not
+    allow things like logging different facilities to different
+    files, redirecting logs to a single loghost and other niceties.
+    You may want to just grab and install:
+       ftp://www.sudo.ws/pub/sudo/misc/jtkohl-syslog-complete.tar.gz
+    (available via anonymous ftp) which is a port if the 4.3BSD
+    syslog/syslogd that is backwards compatible with the Ultrix version.
+    I recommend it highly.  If you do not do this you probably want
+    to run configure with --with-logging=file