1 Installation instructions for Sudo 1.6.9
2 ========================================
4 Sudo uses a `configure' script to probe the capabilities and type
5 of the system in question. In this release, `configure' takes many
6 more options than it did before. Please read this document fully
7 before configuring and building sudo. You may also wish to read the
8 file INSTALL.configure which explains more about the `configure' script.
10 Simple sudo installation
11 ========================
13 For most systems and configurations it is possible simply to:
15 0) If you are upgrading from a previous version of sudo
16 please read the info in the UPGRADE file before proceeding.
18 1) If you previously ran `configure' on a different host
19 you will probably want to do a `make distclean' to remove
20 the old `config.cache' file. Otherwise, `configure'
21 will complain and refuse to run. Alternately, one can
22 simply `rm config.cache'.
24 2) Read the `OS dependent notes' section for any particular
25 "gotchas" relating to your operating system.
27 3) `cd' to the source or build directory and type `./configure'
28 to generate a Makefile and config.h file suitable for
29 building sudo. Before you actually run configure you
30 should read the `Available configure options' section
31 to see if there are any special options you may want
34 4) Edit the configure-generated Makefile if you wish to
35 change any of the default paths (alternatively, you could
36 have changed the paths via options to `configure'.
38 5) Type `make' to compile sudo. If you are building sudo
39 in a separate build tree (apart from the sudo source)
40 GNU make will probably be required. If `configure' did
41 its job properly (and you have a supported configuration)
42 there won't be any problems. If this doesn't work, take
43 a look at the files TROUBLESHOOTING and PORTING for tips
44 on what might have gone wrong. Please mail us if you have a
45 fix or if you are unable to come up with a fix (address at EOF).
47 6) Type `make install' (as root) to install sudo, visudo, the
48 man pages, and a skeleton sudoers file. Note that the install
49 will not overwrite an existing sudoers file. You can also
50 install various pieces the package via the install-binaries,
51 install-man, and install-sudoers make targets.
53 7) Edit the sudoers file with `visudo' as necessary for your
54 site. You will probably want to refer the sample.sudoers
55 file and sudoers man page included with the sudo package.
57 8) If you want to use syslogd(8) to do the logging, you'll need
58 to update your /etc/syslog.conf file. See the sample.syslog.conf
59 file included in the distribution for an example.
61 Available configure options
62 ===========================
64 This section describes flags accepted by the sudo's `configure' script.
65 Defaults are listed in brackets after the description.
69 Cache test results in FILE
72 Alias for `--cache-file=config.cache'
75 Print the usage/help info
78 Do not create output files
81 Do not print `checking...' messages
83 Directory and file names:
85 Install architecture-independent files in PREFIX This really only
86 applies to man pages. [/usr/local]
89 Install architecture-dependent files in EPREFIX This includes the
90 sudo and visudo executables. [same as prefix]
93 Install `sudo' in DIR [EPREFIX/bin]
96 Install `visudo' in DIR [EPREFIX/sbin]
99 Install `sudoers' file in DIR [/etc]
102 Install man pages in DIR [PREFIX/man]
105 Find the sources in DIR [configure dir or ..]
107 Special features/options:
109 Specifies path to C compiler you wish to use.
112 Adds the specified directory (or directories) to CPPFLAGS
113 so configure and the compiler will look there for include
114 files. Multiple directories may be specified as long as
115 they are space separated.
116 Eg: --with-incpath="/usr/local/include /opt/include"
119 Adds the specified directory (or directories) to LDFLAGS
120 so configure and the compiler will look there for libraries.
121 Multiple directories may be specified as with --with-incpath.
124 Tells configure to use -Rpath in addition to -Lpath when
125 passing library paths to the loader. This option is on
126 by default for Solaris and SVR4.
128 --with-blibpath[=PATH]
129 Tells configure to construct a -blibpath argument to the
130 loader. If a PATH is specified, it will be used as the
131 base. Otherwise, "/usr/lib:/lib:/usr/local/lib" will be
132 used for gcc and "/usr/lib:/lib" for non-gcc. Additional
133 library paths will be appended as needed by configure.
134 This option is only valid for AIX where it is on by default.
136 --with-libraries=LIBRARY
137 Adds the specified library (or libaries) to SUDO_LIBS and
138 and VISUDO_LIBS so sudo will link against them. If the
139 library doesn't start with `-l' or end in `.a' or `.o' a
140 `-l' will be prepended to it. Multiple libraries may be
141 specified as long as they are space separated.
144 Add CSOps standard options. You probably aren't interested in this.
147 Enable S/Key OTP (One Time Password) support. If specified,
148 DIR should contain include and lib directories with skey.h
149 and libskey.a respectively.
152 Enable NRL OPIE OTP (One Time Password) support. If specified,
153 DIR should contain include and lib directories with opie.h
154 and libopie.a respectively.
157 Enable SecurID support. If specified, DIR is directory containing
158 sdiclient.a, sdi_athd.h, sdconf.h, and sdacmvls.h.
161 Enable TIS Firewall Toolkit (FWTK) 'authsrv' support. If specified,
162 DIR is the base directory containing the compiled FWTK package
163 (or at least the library and header files).
166 Enable Kerberos IV support. If specified, DIR is the base
167 directory containing the Kerberos IV include and lib dirs.
168 This uses Kerberos passphrases for authentication but does
169 not use the Kerberos cookie scheme.
172 Enable Kerberos V support. If specified, DIR is the base
173 directory containing the Kerberos V include and lib dirs.
174 This This uses Kerberos passphrases for authentication but
175 does not use the Kerberos cookie scheme. Will not work for
176 Kerberos V older than version 1.1.
179 Enable LDAP support. If specified, DIR is the base directory
180 containing the LDAP include and lib directories. Please see
181 README.LDAP for more information.
183 --with-ldap-conf-file=filename
184 Path to LDAP configuration file. If specified, sudo reads
185 this file instead of /etc/ldap.conf to locate the LDAP server.
187 --with-ldap-secret-file=filename
188 Path to LDAP secret password file. If specified, sudo uses
189 this file instead of /etc/ldap.secret to read the secret password
190 when rootbinddn is specified in the ldap config file.
193 Enable support for the AIX 4.x general authentication function.
194 This will use the authentication scheme specified for the user
195 on the machine. It is on by default for AIX systems that
199 Enable PAM support. This is on by default for Darwin, FreeBSD,
200 Linux, Solaris and HP-UX (version 11 and higher).
202 NOTE: on RedHat Linux and Fedora you *must* have an /etc/pam.d/sudo
203 file installed. You may either use the sample.pam file included with
204 sudo or use /etc/pam.d/su as a reference. The sample.pam file
205 included with sudo may or may not work with other Linux distributions.
206 On Solaris and HP-UX 11 systems you should check (and understand)
207 the contents of /etc/pam.conf. Do a "man pam.conf" for more
208 information and consider using the "debug" option, if available,
209 with your PAM libraries in /etc/pam.conf to obtain syslog output
210 for debugging purposes.
213 Enable AFS support with Kerberos authentication. Should work under
214 AFS 3.3. If your AFS doesn't have -laudit you should be able to
218 Enable DCE support for systems without PAM. Known to work on
219 HP-UX 9.X, 10.X, and 11.0; other systems may require source
220 code and/or `configure' changes. On systems with PAM support
221 (such as HP-UX 11.0 and higher, Solaris, FreeBSD and Linux), the
222 DCE PAM module (usually libpam_dce) should be used instead.
225 This adds support for login classes specified in /etc/login.conf.
226 It is enabled by default on BSD/OS, Darwin, FreeBSD, OpenBSD and
227 NetBSD (where available). By default, a login class is not applied
228 unless the 'use_loginclass' option is defined in sudoers or the user
229 specifies a class on the command line.
232 Enable support for Solaris project resource limits.
233 This option is only available on Solaris 9 and above.
236 Enable support for BSD authentication. This is the default
237 for BSD/OS and OpenBSD systems that support it.
238 It is not possible to mix BSD authentication with other
239 authentication methods (and there really should be no need
240 to do so). Note that only the newer BSD authentication API
241 is supported. If you don't have /usr/include/bsd_auth.h
242 then you cannot use this.
245 Enable support for the "noexec" functionality which prevents
246 a dynamically-linked program being run by sudo from executing
247 another program (think shell escapes). Please see the
248 "PREVENTING SHELL ESCAPES" section in the sudoers man page
249 for details. If specified, PATH should be a fully qualified
250 pathname, e.g. /usr/local/libexec/sudo_noexec.so. If PATH
251 is "no", noexec support will not be compiled in. The default
252 is to compile noexec support if libtool supports building
253 shared objects on your OS.
255 --disable-pam-session
256 Disable sudo's PAM session support. This may be needed on
257 older PAM implementations or on operating systems where
258 opening a PAM session changes the utmp or wtmp files. If
259 PAM session support is disabled, resource limits may not
260 be updatedin for command being run.
262 --disable-root-mailer
263 By default sudo will run the mailer as root when tattling
264 on a user so as to prevent that user from killing the mailer.
265 With this option, sudo will run the mailer as the invoking
266 user which some people consider to be safer.
269 Disable use of the setreuid() function for operating systems
270 where it is broken. Mac OS X has setreuid() but it doesn't
274 Disable use of the setresuid() function for operating systems
275 where it is broken (none currently known).
278 Disable SIA support. This is the "Security Integration
279 Architecture" on Digital UNIX. If you disable SIA sudo will
280 use its own authentication routines.
283 Disable shadow password support. Normally, sudo will compile
284 in shadow password support and use a shadow password if it
287 --with-sudoers-mode=MODE
288 File mode for the sudoers file (octal). Note that if you
289 wish to NFS-mount the sudoers file this must be group
290 readable. Also note that this is actually set in the
291 Makefile. The default mode is 0440.
293 --with-sudoers-uid=UID
294 User id that "owns" the sudoers file. Note that this is
295 the numeric id, *not* the symbolic name. Also note that
296 this is actually set in the Makefile. The default is 0.
298 --with-sudoers-gid=GID
299 Group id that "owns" the sudoers file. Note that this is
300 the numeric id, *not* the symbolic name. Also note that
301 this is actually set in the Makefile. The default is 0.
304 This option keeps sudo from trying to glean the ip address
305 from each attached ethernet interface. It is only useful
306 on a machine where sudo's interface reading support does
307 not work, which may be the case on some SysV-based OS's
311 This option excludes authentication via the passwd (or
312 shadow) file. It should only be used when another, alternative,
313 authentication scheme is in use.
316 This option is now just an alias for --without-passwd.
319 Properly handle GNU stow packaging. The sudoers file will
320 physically live in ${prefix}/etc and /etc/sudoers will be
323 The following options are also configurable at runtime:
325 --with-long-otp-prompt
326 When validating with a One Time Password scheme (S/Key or
327 OPIE), a two-line prompt is used to make it easier to cut
328 and paste the challenge to a local window. It's not as
329 pretty as the default but some people find it more convenient.
332 How you want to do your logging. You may choose "syslog",
333 "file", or "both". Setting this to "syslog" is nice because
334 you can keep all of your sudo logs in one place (see the
335 sample.syslog.conf file). The default is "syslog".
337 --with-logfac=FACILITY
338 Determines which syslog facility to log to. This requires
339 a 4.3BSD or later version of syslog. You can still set
340 this for ancient syslogs but it will have no effect. The
341 following facilities are supported: authpriv (if your OS
342 supports it), auth, daemon, user, local0, local1, local2,
343 local3, local4, local5, local6, and local7.
345 --with-goodpri=PRIORITY
346 Determines which syslog priority to log successfully
347 authenticated commands. The following priorities are
348 supported: alert, crit, debug, emerg, err, info, notice,
351 --with-badpri=PRIORITY
352 Determines which syslog priority to log unauthenticated
353 commands and errors. The following priorities are supported:
354 alert, crit, debug, emerg, err, info, notice, and warning.
357 Override the default location of the sudo log file and use
358 "path" instead. By default will use /var/log/sudo.log if
359 there is a /var/log dir, falling back to /var/adm/sudo.log
360 or /usr/adm/sudo.log if not.
363 Number of characters per line for the file log. This is only used if
364 you are to "file" or "both". This value is used to decide when to wrap
365 lines for nicer log files. The default is 80. Setting this to 0
366 will disable the wrapping.
369 If set, sudo will ignore '.' or '' (current dir) in $PATH.
370 The $PATH itself is not modified.
372 --with-mailto=USER|MAIL_ALIAS
373 User (or mail alias) that mail from sudo is sent to.
374 This should go to a sysadmin at your site. The default is "root".
376 --with-mailsubject="SUBJECT OF MAIL"
377 Subject of the mail sent to the "mailto" user. The token "%h"
378 will expand to the hostname of the machine.
379 Default is "*** SECURITY information for %h ***".
381 --without-mail-if-no-user
382 Normally, sudo will mail to the "alertmail" user if the user invoking
383 sudo is not in the sudoers file. This option disables that behavior.
385 --with-mail-if-no-host
386 Send mail to the "alermail" user if the user exists in the sudoers
387 file, but is not allowed to run commands on the current host.
389 --with-mail-if-noperms
390 Send mail to the "alermail" user if the user is allowed to use sudo but
391 the command they are trying is not listed in their sudoers file entry.
393 --with-passprompt="PASSWORD PROMPT"
394 Default prompt to use when asking for a password; can be overridden
395 via the -p option and the SUDO_PROMPT environment variable. Supports
396 the "%H", "%h", "%U" and "%u" escapes as documented in the sudo
397 manual page. The default value is "Password:".
399 --with-badpass-message="BAD PASSWORD MESSAGE"
400 Message that is displayed if a user enters an incorrect password.
401 The default is "Sorry, try again." unless insults are turned on.
404 Define this if you want to put fully qualified hostnames in the sudoers
405 file. Ie: instead of myhost you would use myhost.mydomain.edu. You may
406 still use the short form if you wish (and even mix the two). Beware
407 that turning FQDN on requires sudo to make DNS lookups which may make
408 sudo unusable if your DNS is totally hosed. Also note that you must
409 use the host's official name as DNS knows it. That is, you may not use
410 a host alias (CNAME entry) due to performance issues and the fact that
411 there is no way to get all aliases from DNS.
414 Override the default location of the sudo timestamp directory and
418 Override configure's guess as to the location of sendmail.
421 Do not use sendmail to mail messages to the "mailto" user.
422 Use only if don't run sendmail or the equivalent.
425 Umask to use when running the root command. The default is 0022.
428 Preserves the umask of the user invoking sudo.
430 --with-runas-default=USER
431 The default user to run commands as if the -u flag is not specified
432 on the command line. This defaults to "root".
435 Users in the specified group don't need to enter a password when
436 running sudo. This may be useful for sites that don't want their
437 "core" sysadmins to have to enter a password but where Jr. sysadmins
438 need to. You should probably use NOPASSWD in sudoers instead.
440 --with-passwd-tries=NUMBER
441 Number of tries a user gets to enter his/her password before sudo logs
442 the failure and exits. The default is 3.
444 --with-timeout=NUMBER
445 Number of minutes that can elapse before sudo will ask for a passwd
446 again. The default is 5, set this to 0 to always prompt for a password.
448 --with-password-timeout=NUMBER
449 Number of minutes before the sudo password prompt times out.
450 The default is 5, set this to 0 for no password timeout.
453 This makes sudo use a different ticket file for each user/tty combo.
454 Ie: instead of the ticket path being "username" it is "username/tty".
455 This is useful for "shared" accounts like "operator". Note that this
456 means that there will be more files in the timestamp dir. This is not
457 a problem if your system has a cron job to remove of files from /tmp
458 (or wherever you specified the timestamp dir to be).
461 Define this if you want to be insulted for typing an incorrect password
462 just like the original sudo(8). This is off by default.
465 Include all the insult sets listed below. You must either specify
466 --with-insults or enable insults in the sudoers file for this to
469 --with-classic-insults
470 Uses insults from sudo "classic." If you just specify --with-insults
471 you will get the classic and CSOps insults. This is on by default if
472 --with-insults is given.
475 Insults the user with an extra set of insults (some quotes, some
476 original) from a sysadmin group at CU (CSOps). You must specify
477 --with-insults as well for this to have any effect. This is on by
478 default if --with-insults is given.
481 Uses 2001-like insults when an incorrect password is entered.
482 You must either specify --with-insults or enable insults in the
483 sudoers file for this to have any effect.
486 Insults the user with lines from the "Goon Show" when an incorrect
487 password is entered. You must either specify --with-insults or
488 enable insults in the sudoers file for this to have any effect.
491 Replace politically incorrect insults with less objectionable ones.
493 --with-secure-path[=PATH]
494 Path used for every command run from sudo(8). If you don't trust the
495 people running sudo to have a sane PATH environment variable you may
496 want to use this. Another use is if you want to have the "root path"
497 be separate from the "user path." You will need to customize the path
498 for your site. NOTE: this is not applied to users in the group
499 specified by --with-exemptgroup. If you do not specify a path,
500 "/bin:/usr/ucb:/usr/bin:/usr/sbin:/sbin:/usr/etc:/etc" is used.
503 Don't print the lecture the first time a user runs sudo.
506 Specify the default editor path for use by visudo. This may be a
507 single pathname or a colon-separated list of editors. In the latter
508 case, visudo will choose the editor that matches the user's VISUAL
509 or EDITOR environment variables or the first editor in the list that
510 exists. The default is the path to vi on your system.
513 Makes visudo consult the VISUAL and EDITOR environment variables before
514 falling back on the default editor list (as specified by --with-editor).
515 Note that this may create a security hole as it allows the user to
516 run any arbitrary command as root without logging. A safer alternative
517 is to use a colon-separated list of editors with the --with-editor
518 option. visudo will then only use the VISUAL or EDITOR variables
519 if they match a value specified via --with-editor.
521 --disable-authentication
522 By default, sudo requires the user to authenticate via a
523 password or similar means. This options causes sudo to
524 *not* require authentication. It is possible to turn
525 authentication back on in sudoers via the PASSWD attribute.
528 Don't let root run sudo. This can be used to prevent people from
529 "chaining" sudo commands to get a root shell by doing something
530 like "sudo sudo /bin/sh".
533 Log the hostname in the log file.
535 --enable-noargs-shell
536 If sudo is invoked with no arguments it acts as if the "-s" flag had
537 been given. That is, it runs a shell as root (the shell is determined
538 by the SHELL environment variable, falling back on the shell listed
539 in the invoking user's /etc/passwd entry).
541 --enable-shell-sets-home
542 If sudo is invoked with the "-s" flag the HOME environment variable
543 will be set to the home directory of the target user (which is root
544 unless the "-u" option is used). This option effectively makes the
545 "-s" flag imply "-H".
548 Normally, sudo will tell the user when a command could not be found
549 in their $PATH. Some sites may wish to disable this as it could
550 be used to gather information on the location of executables that
551 the normal user does not have access to. The disadvantage is that
552 if the executable is simply not in the user's path, sudo will tell
553 the user that they are not allowed to run it, which can be confusing.
555 Shadow password and C2 support
556 ==============================
558 Shadow passwords (also included with most C2 security packages) are
559 supported on most major platforms for which they exist. The
560 `configure' script will attempt to determine if your system can use
561 shadow passwords and include support for them if so. Shadow password
562 support is now compiled in by default (it doesn't hurt anything if you
563 don't have them configured). To disable the shadow password support,
564 use the --disable-shadow option to configure.
566 Shadow passwords are known to work on the following platforms:
575 ConvexOS with C2 security (not tested recently)
580 SVR4 (and variants using standard SVR4 shadow passwords)
581 4.4BSD based systems (including OpenBSD, NetBSD, FreeBSD, and BSD/OS)
582 OS's using SecureWare's C2 security.
587 OpenBSD < 2.2 and NetBSD < 1.2.1:
588 The fdesc file system has a bug wrt /dev/tty handling that
589 causes sudo to hang at the password prompt. The workaround
590 is to run configure with --with-password-timeout=0
593 You need to have a C compiler in order to build sudo.
594 Since Solaris 2.x does not come with one by default this
595 means that you either need to have purchased the unbundled Sun
596 C compiler or have a copy of the GNU C compiler (gcc).
597 The SunSoft Catalyst CD should contain gcc binaries for
598 Solaris. You can also get them from various places on the
599 net, including http://www.sunfreeware.com/
600 NOTE: sudo will *not* build with the sun C compiler in BSD
601 compatibility mode (/usr/ucb/cc). Sudo is designed to
602 compile with the standard C compiler (or gcc) and will
603 not build correctly with /usr/ucb/cc. You can use the
604 `--with-CC' option to point `configure' to the non-ucb
605 compiler if it is not the first cc in your path. Some
606 sites link /usr/ucb/cc to gcc; configure will not notice
607 this an still refuse to use /usr/ucb/cc, so make sure gcc
608 is also in your path if your site is setup this way.
609 Also: Many versions of Solaris come with a broken syslogd.
610 If you have having problems with sudo logging you should
611 make sure you have the latest syslogd patch installed.
612 This is a problem for Solaris 2.4 and 2.5 at least.
615 I've had various problems with the AIX C compiler producing
616 incorrect code when the -O flag was used. When optimization
617 is not used, the problems go away. Gcc does not appear
618 to have this problem.
620 Also, the AIX 3.2.x lex will not work with sudo's parse.lex.
621 This should not be a problem as sudo comes shipped with
622 a pre-generated lex.yy.c (created by flex). If you want
623 to modify the lex tokenizer, make sure you grab a copy of
624 flex from ftp.ee.lbl.gov (also available on most GNU mirrors)
625 and sudo will use that instead.
628 Ultrix still ships with the 4.2BSD syslog(3) which does not
629 allow things like logging different facilities to different
630 files, redirecting logs to a single loghost and other niceties.
631 You may want to just grab and install:
632 ftp://gatekeeper.dec.com/pub/DEC/jtkohl-syslog-complete.tar.Z
633 (available via anonymous ftp) which is a port if the 4.3BSD
634 syslog/syslogd that is backwards compatible with the Ultrix version.
635 I recommend it highly. If you do not do this you probably want
636 to run configure with --with-logging=file
639 By default, sudo will use SIA (Security Integration Architecture)
640 to validate a user. If you want to use an alternative authentication
641 method that does not go through SIA, you need to use the
642 --disable-sia option to configure. If you use gcc to compile
643 you will get warnings when building interfaces.c. These are
644 harmless but if they really bug you, you can edit
645 /usr/include/net/if.h around line 123, right after the comment:
646 /* forward decls for C++ */
650 #if defined(__cplusplus) || defined(__GNUC__)
651 If you don't like the idea of editing the system header file
652 you can just make a copy in gcc's private include tree and
656 PAM and LDAP headers are not installed by default on most Linux
657 systems. You will need to install the "pav-dev" package if
658 /usr/include/security/pam_appl.h is not present on your system.
659 If you wish to build with LDAP support you will also need the
660 openldap-devel package.
662 Versions of glibc 2.x previous to 2.0.7 have a broken lsearch().
663 You will need to either upgrade to glibc-2.0.7 or use sudo's
664 version of lsearch(). To use sudo's lsearch(), comment out
665 the "#define HAVE_LSEARCH 1" line in config.h and add lsearch.o
666 to the LIBOBJS line in the Makefile.
668 If you are using a Linux kernel older than 2.4 it is not possible
669 to access the sudoers file via NFS. This is due to a bug in
670 the Linux client-side NFS implementation that has since been
671 fixed. There is a workaround on the sudo ftp site, linux_nfs.patch,
672 if you need to NFS-mount sudoers on older Linux kernels.
675 It has been reported that for sudo to work on Mac OS X it must
676 either be built with the --with-password-timeout=0 option or the
677 password timeout must be disabled in the Defaults line in the
678 sudoers file. If sudo just hangs when you try to enter a password,
679 you need to disable the password timeout (Note: this is not a bug
683 You'll probably need libcrypt_i.a available via anonymous ftp
684 from sosco.sco.com. The necessary files are /SLS/lng225b.Z
685 and /SLS/lng225b.ltr.Z.
688 Some people have experienced problems building sudo with gcc
689 on Dynix. If you experience problems compiling sudo using gcc
690 on Dynix, try using the native compiler (cc). You can do so
691 by removing the config.cache file and then re-running configure
692 with the --with-CC=cc option.
695 The default C compiler shipped with HP-UX does not support creating
696 position independent code and so is unable to support sudo's "noexec"
697 functionality. You must use either the HP ANSI C compiler or gcc for
698 noexec to work. Binary packages of gcc are available from
699 http://hpux.connect.org.uk/ and http://hpux.cs.utah.edu/.
702 The /bin/sh shipped with SunOS blows up while running configure.
703 You can work around this by installalling bash or zsh. If you
704 have bash or zsh in your path, configure will use it instead