[buildpkg.sh.in] Last minute fix didn't make it in the .in file. :-(

[openssh.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index f4fd9561b12a497eecf456c6288d174069e71e3d..0fa4a6d29f6f396d06e27537488c170fd472b401 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -3,20 +3,24 @@
 
 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 greater:
+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.
-For Red Hat Linux 6.2, they have been released as errata.  RHL7 includes
-these.
+(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.
 
 
 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.
 

+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. If you don't you will have to rely on ssh-rand-helper, which
+is inferior to a good kernel-based solution.
+

 PAM:
 http://www.kernel.org/pub/linux/libs/pam/
 
 PAM:
 http://www.kernel.org/pub/linux/libs/pam/
 


@@ -26,14 +30,14 @@ 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:
 
 
 PRNGD:
 

-If your system lacks Kernel based random collection, the use of Lutz 
+If your system lacks Kernel based random collection, the use of Lutz

 Jaenicke's PRNGd is recommended.
 
 http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
 Jaenicke's PRNGd is recommended.
 
 http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html


@@ -45,24 +49,12 @@ lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
 
 http://www.lothar.com/tech/crypto/
 
 
 http://www.lothar.com/tech/crypto/
 

-GNU Make:
-ftp://ftp.gnu.org/gnu/make/
-
-OpenSSH has only been tested with GNU make. It may work with other
-'make' programs, but you are on your own.
-
-PCRE (PERL-compatible Regular Expression library):
-ftp://ftp.cus.cam.ac.uk/pub/software/programs/pcre/
-
-Most platforms do not require this.  However older Unices may not have a 
-posix regex library. PCRE provides a POSIX interface.
-

 S/Key Libraries:
 http://www.sparc.spb.su/solaris/skey/
 
 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
 S/Key Libraries:
 http://www.sparc.spb.su/solaris/skey/
 
 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. 
+supported.

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


@@ -81,7 +73,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


@@ -109,62 +101,45 @@ name).
 
 There are a few other options to the configure script:
 
 
 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-pam enables PAM support.
+--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 
+--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.
 
 collection support.
 

---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 
+--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)
 support. You will need libwrap.a and tcpd.h installed.
 
 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 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.
 
 --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
 $DISPLAY environment variable. Some broken systems need this.
 
 --with-default-path=PATH allows you to specify a default $PATH for sessions


@@ -175,18 +150,16 @@ created.
 
 --with-xauth=PATH specifies the location of the xauth binary
 
 
 --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-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 
 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 are installed.
 
 --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:


@@ -196,33 +169,33 @@ 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 -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.
 
     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.

-(${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.
 
 4. Problems?
 ------------
 
 for sshd, ssh and ssh-agent.
 
 4. 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/