INSTALL

   1 1. Prerequisites
   2 ----------------
   3
   4 You will need working installations of Zlib and OpenSSL.
   5
   6 Zlib:
   7 http://www.freesoftware.com/pub/infozip/zlib/
   8
   9 OpenSSL 0.9.5a or greater:
  10 http://www.openssl.org/
  11
  12 RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support.
  13 For Red Hat Linux 6.2, they have been released as errata.  RHL7 includes
  14 these.
  15
  16 OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
  17 supports it. PAM is standard on Redhat and Debian Linux, Solaris and
  18 HP-UX 11.
  19
  20 PAM:
  21 http://www.kernel.org/pub/linux/libs/pam/
  22
  23 If you wish to build the GNOME passphrase requester, you will need the GNOME
  24 libraries and headers.
  25
  26 GNOME:
  27 http://www.gnome.org/
  28
  29 Alternatively, Jim Knoble <jmknoble@jmknoble.cx> has written an excellent X11
  30 passphrase requester. This is maintained separately at:
  31
  32 http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
  33
  34 PRNGD:
  35
  36 If your system lacks Kernel based random collection, the use of Lutz
  37 Jaenicke's PRNGd is recommended.
  38
  39 http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
  40
  41 EGD:
  42
  43 The Entropy Gathering Daemon (EGD) is supported if you have a system which
  44 lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
  45
  46 http://www.lothar.com/tech/crypto/
  47
  48 GNU Make:
  49 ftp://ftp.gnu.org/gnu/make/
  50
  51 OpenSSH has only been tested with GNU make. It may work with other
  52 'make' programs, but you are on your own.
  53
  54 PCRE (PERL-compatible Regular Expression library):
  55 ftp://ftp.cus.cam.ac.uk/pub/software/programs/pcre/
  56
  57 Most platforms do not require this.  However older Unices may not have a
  58 posix regex library. PCRE provides a POSIX interface.
  59
  60 S/Key Libraries:
  61 http://www.sparc.spb.su/solaris/skey/
  62
  63 If you wish to use --with-skey then you will need the above library
  64 installed.  No other current S/Key library is currently known to be
  65 supported.
  66
  67 2. Building / Installation
  68 --------------------------
  69
  70 To install OpenSSH with default options:
  71
  72 ./configure
  73 make
  74 make install
  75
  76 This will install the OpenSSH binaries in /usr/local/bin, configuration files
  77 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
  78 installation prefix, use the --prefix option to configure:
  79
  80 ./configure --prefix=/opt
  81 make
  82 make install
  83
  84 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
  85 specific paths, for example:
  86
  87 ./configure --prefix=/opt --sysconfdir=/etc/ssh
  88 make
  89 make install
  90
  91 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
  92 configuration files in /etc/ssh.
  93
  94 If you are using PAM, you may need to manually install a PAM
  95 control file as "/etc/pam.d/sshd" (or wherever your system
  96 prefers to keep them). A generic PAM configuration is included as
  97 "contrib/sshd.pam.generic", you may need to edit it before using it on
  98 your system. If you are using a recent version of Red Hat Linux, the
  99 config file in contrib/redhat/sshd.pam should be more useful.
 100 Failure to install a valid PAM file may result in an inability to
 101 use password authentication.  On HP-UX 11, the standard /etc/pam.conf
 102 configuration will work with sshd (sshd will match the OTHER service
 103 name).
 104
 105 There are a few other options to the configure script:
 106
 107 --with-rsh=PATH allows you to specify the path to your rsh program.
 108 Normally ./configure will search the current $PATH for 'rsh'. You
 109 may need to specify this option if rsh is not in your path or has a
 110 different name.
 111
 112 --with-pam enables PAM support.
 113
 114 --enable-gnome-askpass will build the GNOME passphrase dialog. You
 115 need a working installation of GNOME, including the development
 116 headers, for this to work.
 117
 118 --with-random=/some/file allows you to specify an alternate source of
 119 random numbers (the default is /dev/urandom). Unless you are absolutely
 120 sure of what you are doing, it is best to leave this alone.
 121
 122 --with-prngd-socket=/some/file allows you to enable EGD or PRNGD
 123 support and to specify a PRNGd socket. Use this if your Unix lacks
 124 /dev/random and you don't want to use OpenSSH's builtin entropy
 125 collection support.
 126
 127 --with-prngd-port=portnum allows you to enable EGD or PRNGD support
 128 and to specify a EGD localhost TCP port. Use this if your Unix lacks
 129 /dev/random and you don't want to use OpenSSH's builtin entropy
 130 collection support.
 131
 132 --with-lastlog=FILE will specify the location of the lastlog file.
 133 ./configure searches a few locations for lastlog, but may not find
 134 it if lastlog is installed in a different place.
 135
 136 --without-lastlog will disable lastlog support entirely.
 137
 138 --with-kerberos4=PATH will enable Kerberos IV support. You will need
 139 to have the Kerberos libraries and header files installed for this
 140 to work. Use the optional PATH argument to specify the root of your
 141 Kerberos installation.
 142
 143 --with-afs=PATH will enable AFS support. You will need to have the
 144 Kerberos IV and the AFS libraries and header files installed for this
 145 to work.  Use the optional PATH argument to specify the root of your
 146 AFS installation. AFS requires Kerberos support to be enabled.
 147
 148 --with-skey=PATH will enable S/Key one time password support. You will
 149 need the S/Key libraries and header files installed for this to work.
 150
 151 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 152 support. You will need libwrap.a and tcpd.h installed.
 153
 154 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 155 if your operating system uses MD5 passwords without using PAM.
 156
 157 --with-utmpx enables utmpx support. utmpx support is automatic for
 158 some platforms.
 159
 160 --without-shadow disables shadow password support.
 161
 162 --with-ipaddr-display forces the use of a numeric IP address in the
 163 $DISPLAY environment variable. Some broken systems need this.
 164
 165 --with-default-path=PATH allows you to specify a default $PATH for sessions
 166 started by sshd. This replaces the standard path entirely.
 167
 168 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 169 created.
 170
 171 --with-xauth=PATH specifies the location of the xauth binary
 172
 173 --with-ipv4-default instructs OpenSSH to use IPv4 by default for new
 174 connections. Normally OpenSSH will try attempt to lookup both IPv6 and
 175 IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
 176 resolution. If this option is specified, you can still attempt to
 177 connect to IPv6 addresses using the command line option '-6'.
 178
 179 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 180 are installed.
 181
 182 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 183 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 184
 185 If you need to pass special options to the compiler or linker, you
 186 can specify these as environment variables before running ./configure.
 187 For example:
 188
 189 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 190
 191 3. Configuration
 192 ----------------
 193
 194 The runtime configuration files are installed by in ${prefix}/etc or
 195 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 196
 197 The default configuration should be instantly usable, though you should
 198 review it to ensure that it matches your security requirements.
 199
 200 To generate a host key, run "make host-key". Alternately you can do so
 201 manually using the following commands:
 202
 203     ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
 204     ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
 205     ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
 206
 207 Replacing /etc/ssh with the correct path to the configuration directory.
 208 (${prefix}/etc or whatever you specified with --sysconfdir during
 209 configuration)
 210
 211 If you have configured OpenSSH with EGD support, ensure that EGD is
 212 running and has collected some Entropy.
 213
 214 For more information on configuration, please refer to the manual pages
 215 for sshd, ssh and ssh-agent.
 216
 217 4. Problems?
 218 ------------
 219
 220 If you experience problems compiling, installing or running OpenSSH.
 221 Please refer to the "reporting bugs" section of the webpage at
 222 http://www.openssh.com/
 223
 224
 225 $Id$