]> andersk Git - openssh.git/blobdiff - INSTALL
- (dtucker) [openbsd-compat/port-aix.h] Bug #640: Don't include audit.h
[openssh.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 11ddf17861ae4aa02e122400363b677990a00e70..7fa123d6c22b52d707ec5c347230a0a5f3da4bb5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,48 +4,57 @@
 You will need working installations of Zlib and OpenSSL.
 
 Zlib:
-http://www.cdrom.com/pub/infozip/zlib/
+http://www.gzip.org/zlib/ 
 
-OpenSSL:
+OpenSSL 0.9.6 or greater:
 http://www.openssl.org/
 
+(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 and on Solaris.
+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/
 
-Dante:
-http://www.inet.no/dante
-
-OpenSSH can also use the Dante SOCKS libraries, version 1.1.1pre1 or higher,
-if you have them installed on your system. 
-
 If you wish to build the GNOME passphrase requester, you will need the GNOME
 libraries and headers.
 
 GNOME:
 http://www.gnome.org/
 
-Alternatly Jim Knoble <jmknoble@pobox.com> has written an excellent X11
-passphrase requester. This is maintained seperatly at:
+Alternatively, Jim Knoble <jmknoble@jmknoble.cx> has written an excellent X11
+passphrase requester. This is maintained separately at:
+
+http://www.jmknoble.net/software/x11-ssh-askpass/
 
-http://www.pobox.com/~jmknoble/jmk/
+PRNGD:
 
+If your system lacks Kernel based random collection, the use of Lutz 
+Jaenicke's PRNGd is recommended.
 
-If you are planning to use OpenSSH on a Unix which lacks a Kernel random
-number generator (/dev/urandom), you will need to install the Entropy
-Gathering Daemon (or similar). You will also need to specify the 
---with-egd-pool option to ./configure.
+http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
 
 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/
 
-GNU Make:
-ftp://ftp.gnu.org/gnu/make/
+S/Key Libraries:
+http://www.sparc.spb.su/solaris/skey/
 
-OpenSSH has only been tested with GNU make. It may work with other
-'make' programs, but you are on your own.
+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
 --------------------------
@@ -74,34 +83,39 @@ make install
 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 will need to manually install a PAM control
+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 "sshd.pam.generic",
-you may need to edit it before using it on your system.
+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:
 
---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.
-
---without-pam will disable PAM support. PAM is automatically detected 
-and switched on if found.
+--with-pam enables PAM support.
 
 --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 absolutly
-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 Entropy Gathering
-Daemon support and to specify a EGD pool socket. You will need to
-use this if your Unix does not support the /dev/urandom device (or
-similar). The file argument refers to the EGD pool file, not the 
-EGD program itself. Please refer to the EGD documentation.
+--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.
 
 --with-lastlog=FILE will specify the location of the lastlog file. 
 ./configure searches a few locations for lastlog, but may not find
@@ -109,6 +123,9 @@ it if lastlog is installed in a different place.
 
 --without-lastlog will disable lastlog support entirely.
 
+--with-osfsia, --without-osfsia will enable or disable OSF1's Security 
+Integration Architecture.  The default for OSF1 machines is enable.
+
 --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
@@ -119,8 +136,8 @@ 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-skey will enable S/Key one time password support. You will need
-the S/Key libraries and header files installed for this to work.
+--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.
@@ -137,22 +154,28 @@ some platforms.
 $DISPLAY environment variable. Some broken systems need this.
 
 --with-default-path=PATH allows you to specify a default $PATH for sessions
-started by sshd.
+started by sshd. This replaces the standard path entirely.
 
 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 created.
 
 --with-xauth=PATH specifies the location of the xauth binary
 
---with-dante[=DIR] will enable Dante SOCKS library support. If the Dante
-libsocks library isn't installed in a library searched by the compiler,
-add the directory name as the option.
+--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 enviornment variables before running ./configure.
+can specify these as environment variables before running ./configure.
 For example:
 
-CFLAGS="-O -m486" LFLAGS="-s" ./configure
+CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 
 3. Configuration
 ----------------
@@ -163,10 +186,12 @@ whatever you specified as your --sysconfdir (/usr/local/etc by default).
 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, issue the following command: (replacing
-/etc/ssh/ssh_host_key with an appropriate path)
+To generate a host key, run "make host-key". Alternately you can do so
+manually using the following commands: 
 
-/usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_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.
 (${prefix}/etc or whatever you specified with --sysconfdir during 
@@ -183,5 +208,7 @@ for sshd, ssh and ssh-agent.
 
 If you experience problems compiling, installing or running OpenSSH. 
 Please refer to the "reporting bugs" section of the webpage at
-http://violet.ibs.com.au/openssh/
+http://www.openssh.com/
+
 
+$Id$
This page took 0.047556 seconds and 4 git commands to generate.