- djm@cvs.openbsd.org 2010/01/30 02:54:53

[openssh.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 84a6602256838e17b1f621c9add024758e45d756..a35c6747d1de78ed4fddaf273e68a0973f784a37 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -3,20 +3,48 @@
 
 You will need working installations of Zlib and OpenSSL.
 
 
 You will need working installations of Zlib and OpenSSL.
 

-Zlib:
-http://www.freesoftware.com/pub/infozip/zlib/
+Zlib 1.1.4 or 1.2.1.2 or greater (ealier 1.2.x versions have problems):
+http://www.gzip.org/zlib/

 
 

-OpenSSL 0.9.5a or greater:
+OpenSSL 0.9.6 or greater:

 http://www.openssl.org/
 
 http://www.openssl.org/
 

-RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support
+(OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1
+Blowfish) do not work correctly.)

 
 

-OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
-supports it. PAM is standard on Redhat and Debian Linux, Solaris and
-HP-UX 11.
+The remaining items are optional.
+
+NB. If you operating system supports /dev/random, you should configure
+OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of
+/dev/random, or failing that, either prngd or egd.  If you don't have
+any of these you will have to rely on ssh-rand-helper, which is inferior
+to a good kernel-based solution or prngd.
+
+PRNGD:
+
+If your system lacks kernel-based random collection, the use of Lutz
+Jaenicke's PRNGd is recommended.
+
+http://prngd.sourceforge.net/
+
+EGD:
+
+The Entropy Gathering Daemon (EGD) is supported if you have a system which
+lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
+
+http://www.lothar.com/tech/crypto/

 
 PAM:
 
 PAM:

-http://www.kernel.org/pub/linux/libs/pam/
+
+OpenSSH can utilise Pluggable Authentication Modules (PAM) if your
+system supports it. PAM is standard most Linux distributions, Solaris,
+HP-UX 11, AIX >= 5.2, FreeBSD and NetBSD.
+
+Information about the various PAM implementations are available:
+
+Solaris PAM:   http://www.sun.com/software/solaris/pam/
+Linux PAM:     http://www.kernel.org/pub/linux/libs/pam/
+OpenPAM:       http://www.openpam.org/

 
 If you wish to build the GNOME passphrase requester, you will need the GNOME
 libraries and headers.
 
 If you wish to build the GNOME passphrase requester, you will need the GNOME
 libraries and headers.


@@ -24,43 +52,51 @@ libraries and headers.
 GNOME:
 http://www.gnome.org/
 
 GNOME:
 http://www.gnome.org/
 

-Alternatively, Jim Knoble <jmknoble@jmknoble.cx> has written an excellent X11
+Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11

 passphrase requester. This is maintained separately at:
 
 passphrase requester. This is maintained separately at:
 

-http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
+http://www.jmknoble.net/software/x11-ssh-askpass/

 
 

-PRNGD:
+TCP Wrappers:

 
 

-If your system lacks Kernel based random collection, the use of Lutz 
-Jaenicke's PRNGd is recommended.
+If you wish to use the TCP wrappers functionality you will need at least
+tcpd.h and libwrap.a, either in the standard include and library paths,
+or in the directory specified by --with-tcp-wrappers.  Version 7.6 is
+known to work.

 
 

-http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
+http://ftp.porcupine.org/pub/security/index.html

 
 

-EGD:
+S/Key Libraries:

 
 

-The Entropy Gathering Daemon (EGD) is supported if you have a system which
-lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
+If you wish to use --with-skey then you will need the library below
+installed.  No other S/Key library is currently known to be supported.

 
 

-http://www.lothar.com/tech/crypto/
+http://www.sparc.spb.su/solaris/skey/

 
 

-GNU Make:
-ftp://ftp.gnu.org/gnu/make/
+LibEdit:

 
 

-OpenSSH has only been tested with GNU make. It may work with other
-'make' programs, but you are on your own.
+sftp supports command-line editing via NetBSD's libedit.  If your platform
+has it available natively you can use that, alternatively you might try
+these multi-platform ports:

 
 

-pcre (POSIX Regular Expression library):
-ftp://ftp.cus.cam.ac.uk/pub/software/programs/pcre/
+http://www.thrysoee.dk/editline/
+http://sourceforge.net/projects/libedit/

 
 

-Most platforms do not required this.  However older 4.3 BSD do not
-have a posix regex library. 
+Autoconf:

 
 

-S/Key Libraries:
-http://www.sparc.spb.su/solaris/skey/
+If you modify configure.ac or configure doesn't exist (eg if you checked
+the code out of CVS yourself) then you will need autoconf-2.61 to rebuild
+the automatically generated files by running "autoreconf".  Earlier
+versions may also work but this is not guaranteed.
+
+http://www.gnu.org/software/autoconf/
+
+Basic Security Module (BSM):
+
+Native BSM support is know to exist in Solaris from at least 2.5.1,
+FreeBSD 6.1 and OS X.  Alternatively, you may use the OpenBSM
+implementation (http://www.openbsm.org).

 
 

-If you wish to use --with-skey then you will need the above library
-installed.  No other current S/Key library is currently known to be
-supported. 

 
 2. Building / Installation
 --------------------------
 
 2. Building / Installation
 --------------------------


@@ -79,7 +115,7 @@ installation prefix, use the --prefix option to configure:
 make
 make install
 
 make
 make install
 

-Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override 
+Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override

 specific paths, for example:
 
 ./configure --prefix=/opt --sysconfdir=/etc/ssh
 specific paths, for example:
 
 ./configure --prefix=/opt --sysconfdir=/etc/ssh


@@ -89,93 +125,93 @@ make install
 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
 configuration files in /etc/ssh.
 
 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
 configuration files in /etc/ssh.
 

-If you are using PAM, you may need to manually install a PAM
-control file as "/etc/pam.d/sshd" (or wherever your system
-prefers to keep them). A generic PAM configuration is included as
-"contrib/sshd.pam.generic", you may need to edit it before using it on
-your system. If you are using a recent version of Redhat Linux, the
-config file in contrib/redhat/sshd.pam should be more useful. 
-Failure to install a valid PAM file may result in an inability to
-use password authentication.  On HP-UX 11, the standard /etc/pam.conf
-configuration will work with sshd (sshd will match the OTHER service
+If you are using Privilege Separation (which is enabled by default)
+then you will also need to create the user, group and directory used by
+sshd for privilege separation.  See README.privsep for details.
+
+If you are using PAM, you may need to manually install a PAM control
+file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
+them).  Note that the service name used to start PAM is __progname,
+which is the basename of the path of your sshd (e.g., the service name
+for /usr/sbin/osshd will be osshd).  If you have renamed your sshd
+executable, your PAM configuration may need to be modified.
+
+A generic PAM configuration is included as "contrib/sshd.pam.generic",
+you may need to edit it before using it on your system. If you are
+using a recent version of Red Hat Linux, the config file in
+contrib/redhat/sshd.pam should be more useful.  Failure to install a
+valid PAM file may result in an inability to use password
+authentication.  On HP-UX 11 and Solaris, the standard /etc/pam.conf
+configuration will work with sshd (sshd will match the other service

 name).
 
 There are a few other options to the configure script:
 
 name).
 
 There are a few other options to the configure script:
 

---with-rsh=PATH allows you to specify the path to your rsh program. 
-Normally ./configure will search the current $PATH for 'rsh'. You 
-may need to specify this option if rsh is not in your path or has a
-different name.
+--with-audit=[module] enable additional auditing via the specified module.
+Currently, drivers for "debug" (additional info via syslog) and "bsm"
+(Sun's Basic Security Module) are supported.

 
 

---without-pam will disable PAM support. PAM is automatically detected 
-and switched on if found.
+--with-pam enables PAM support. If PAM support is compiled in, it must
+also be enabled in sshd_config (refer to the UsePAM directive).

 
 

---enable-gnome-askpass will build the GNOME passphrase dialog. You
-need a working installation of GNOME, including the development
-headers, for this to work.
-
---with-random=/some/file allows you to specify an alternate source of
-random numbers (the default is /dev/urandom). Unless you are absolutely
-sure of what you are doing, it is best to leave this alone.
+--with-prngd-socket=/some/file allows you to enable EGD or PRNGD
+support and to specify a PRNGd socket. Use this if your Unix lacks
+/dev/random and you don't want to use OpenSSH's builtin entropy
+collection support.

 
 

---with-egd-pool=/some/file allows you to enable EGD or PRNGD support 
-and to specify a EGD pool socket. Use this if your Unix lacks 
-/dev/random and you don't want to use OpenSSH's builtin entropy 
+--with-prngd-port=portnum allows you to enable EGD or PRNGD support
+and to specify a EGD localhost TCP port. Use this if your Unix lacks
+/dev/random and you don't want to use OpenSSH's builtin entropy

 collection support.
 
 collection support.
 

---with-lastlog=FILE will specify the location of the lastlog file. 
+--with-lastlog=FILE will specify the location of the lastlog file.

 ./configure searches a few locations for lastlog, but may not find
 it if lastlog is installed in a different place.
 
 --without-lastlog will disable lastlog support entirely.
 
 ./configure searches a few locations for lastlog, but may not find
 it if lastlog is installed in a different place.
 
 --without-lastlog will disable lastlog support entirely.
 

---with-kerberos4=PATH will enable Kerberos IV support. You will need
-to have the Kerberos libraries and header files installed for this
-to work. Use the optional PATH argument to specify the root of your
-Kerberos installation.
-
---with-afs=PATH will enable AFS support. You will need to have the
-Kerberos IV and the AFS libraries and header files installed for this
-to work.  Use the optional PATH argument to specify the root of your
-AFS installation. AFS requires Kerberos support to be enabled.
+--with-osfsia, --without-osfsia will enable or disable OSF1's Security
+Integration Architecture.  The default for OSF1 machines is enable.

 
 

---with-skey=PATH will enable S/Key one time password support. You will 
+--with-skey=PATH will enable S/Key one time password support. You will

 need the S/Key libraries and header files installed for this to work.
 
 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 need the S/Key libraries and header files installed for this to work.
 
 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)

-support. You will need libwrap.a and tcpd.h installed.
+support.

 
 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 
 --with-md5-passwords will enable the use of MD5 passwords. Enable this

-if your operating system uses MD5 passwords without using PAM.
+if your operating system uses MD5 passwords and the system crypt() does
+not support them directly (see the crypt(3/3c) man page). If enabled, the
+resulting binary will support both MD5 and traditional crypt passwords.

 
 

---with-utmpx enables utmpx support. utmpx support is automatic for 
+--with-utmpx enables utmpx support. utmpx support is automatic for

 some platforms.
 
 --without-shadow disables shadow password support.
 
 some platforms.
 
 --without-shadow disables shadow password support.
 

---with-ipaddr-display forces the use of a numeric IP address in the 
+--with-ipaddr-display forces the use of a numeric IP address in the

 $DISPLAY environment variable. Some broken systems need this.
 
 --with-default-path=PATH allows you to specify a default $PATH for sessions
 started by sshd. This replaces the standard path entirely.
 
 $DISPLAY environment variable. Some broken systems need this.
 
 --with-default-path=PATH allows you to specify a default $PATH for sessions
 started by sshd. This replaces the standard path entirely.
 

---with-pid-dir=PATH specifies the directory in which the ssh.pid file is
+--with-pid-dir=PATH specifies the directory in which the sshd.pid file is

 created.
 
 --with-xauth=PATH specifies the location of the xauth binary
 
 created.
 
 --with-xauth=PATH specifies the location of the xauth binary
 

---with-ipv4-default instructs OpenSSH to use IPv4 by default for new
-connections. Normally OpenSSH will try attempt to lookup both IPv6 and
-IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
-resolution. If this option is specified, you can still attempt to 
-connect to IPv6 addresses using the command line option '-6'.
-

 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 are installed.
 
 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 are installed.
 

+--with-ssl-engine enables OpenSSL's (hardware) ENGINE support
+

 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 
 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 

+--with-opensc=DIR
+--with-sectok=DIR allows for OpenSC or sectok smartcard libraries to
+be used with OpenSSH.  See 'README.smartcard' for more details.
+

 If you need to pass special options to the compiler or linker, you
 can specify these as environment variables before running ./configure.
 For example:
 If you need to pass special options to the compiler or linker, you
 can specify these as environment variables before running ./configure.
 For example:


@@ -185,32 +221,47 @@ CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 3. Configuration
 ----------------
 
 3. Configuration
 ----------------
 

-The runtime configuration files are installed by in ${prefix}/etc or 
+The runtime configuration files are installed by in ${prefix}/etc or

 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 
 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 

-The default configuration should be instantly usable, though you should 
+The default configuration should be instantly usable, though you should

 review it to ensure that it matches your security requirements.
 
 To generate a host key, run "make host-key". Alternately you can do so
 review it to ensure that it matches your security requirements.
 
 To generate a host key, run "make host-key". Alternately you can do so

-manually using the following commands: 
+manually using the following commands:

 
 

-    ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ""
-    ssh-keygen -d -f /etc/ssh/ssh_host_dsa_key -N ""
+    ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
+    ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
+    ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""

 
 Replacing /etc/ssh with the correct path to the configuration directory.
 
 Replacing /etc/ssh with the correct path to the configuration directory.

-(${prefix}/etc or whatever you specified with --sysconfdir during 
+(${prefix}/etc or whatever you specified with --sysconfdir during

 configuration)
 
 If you have configured OpenSSH with EGD support, ensure that EGD is
 running and has collected some Entropy.
 
 configuration)
 
 If you have configured OpenSSH with EGD support, ensure that EGD is
 running and has collected some Entropy.
 

-For more information on configuration, please refer to the manual pages 
+For more information on configuration, please refer to the manual pages

 for sshd, ssh and ssh-agent.
 
 for sshd, ssh and ssh-agent.
 

-4. Problems?
+4. (Optional) Send survey
+-------------------------
+
+$ make survey
+[check the contents of the file "survey" to ensure there's no information
+that you consider sensitive]
+$ make send-survey
+
+This will send configuration information for the currently configured
+host to a survey address.  This will help determine which configurations
+are actually in use, and what valid combinations of configure options
+exist.  The raw data is available only to the OpenSSH developers, however
+summary data may be published.
+
+5. Problems?

 ------------
 
 ------------
 

-If you experience problems compiling, installing or running OpenSSH. 
+If you experience problems compiling, installing or running OpenSSH.

 Please refer to the "reporting bugs" section of the webpage at
 http://www.openssh.com/
 
 Please refer to the "reporting bugs" section of the webpage at
 http://www.openssh.com/