INSTALL

   1 1. Prerequisites
   2 ----------------
   3
   4 You will need working installations of Zlib and OpenSSL.
   5
   6 Zlib:
   7 http://www.gzip.org/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 S/Key Libraries:
  55 http://www.sparc.spb.su/solaris/skey/
  56
  57 If you wish to use --with-skey then you will need the above library
  58 installed.  No other current S/Key library is currently known to be
  59 supported.
  60
  61 2. Building / Installation
  62 --------------------------
  63
  64 To install OpenSSH with default options:
  65
  66 ./configure
  67 make
  68 make install
  69
  70 This will install the OpenSSH binaries in /usr/local/bin, configuration files
  71 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
  72 installation prefix, use the --prefix option to configure:
  73
  74 ./configure --prefix=/opt
  75 make
  76 make install
  77
  78 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
  79 specific paths, for example:
  80
  81 ./configure --prefix=/opt --sysconfdir=/etc/ssh
  82 make
  83 make install
  84
  85 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
  86 configuration files in /etc/ssh.
  87
  88 If you are using PAM, you may need to manually install a PAM control
  89 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
  90 them).  Note that the service name used to start PAM is __progname,
  91 which is the basename of the path of your sshd (e.g., the service name
  92 for /usr/sbin/osshd will be osshd).  If you have renamed your sshd
  93 executable, your PAM configuration may need to be modified.
  94
  95 A generic PAM configuration is included as "contrib/sshd.pam.generic",
  96 you may need to edit it before using it on your system. If you are
  97 using a recent version of Red Hat Linux, the config file in
  98 contrib/redhat/sshd.pam should be more useful.  Failure to install a
  99 valid PAM file may result in an inability to use password
 100 authentication.  On HP-UX 11 and Solaris, the standard /etc/pam.conf
 101 configuration will work with sshd (sshd will match the other service
 102 name).
 103
 104 There are a few other options to the configure script:
 105
 106 --with-rsh=PATH allows you to specify the path to your rsh program.
 107 Normally ./configure will search the current $PATH for 'rsh'. You
 108 may need to specify this option if rsh is not in your path or has a
 109 different name.
 110
 111 --with-pam enables PAM support.
 112
 113 --enable-gnome-askpass will build the GNOME passphrase dialog. You
 114 need a working installation of GNOME, including the development
 115 headers, for this to work.
 116
 117 --with-random=/some/file allows you to specify an alternate source of
 118 random numbers (the default is /dev/urandom). Unless you are absolutely
 119 sure of what you are doing, it is best to leave this alone.
 120
 121 --with-prngd-socket=/some/file allows you to enable EGD or PRNGD
 122 support and to specify a PRNGd socket. Use this if your Unix lacks
 123 /dev/random and you don't want to use OpenSSH's builtin entropy
 124 collection support.
 125
 126 --with-prngd-port=portnum allows you to enable EGD or PRNGD support
 127 and to specify a EGD localhost TCP port. Use this if your Unix lacks
 128 /dev/random and you don't want to use OpenSSH's builtin entropy
 129 collection support.
 130
 131 --with-lastlog=FILE will specify the location of the lastlog file.
 132 ./configure searches a few locations for lastlog, but may not find
 133 it if lastlog is installed in a different place.
 134
 135 --without-lastlog will disable lastlog support entirely.
 136
 137 --with-sia, --without-sia will enable or disable OSF1's Security
 138 Integration Architecture.  The default for OSF1 machines is enable.
 139
 140 --with-kerberos4=PATH will enable Kerberos IV support. You will need
 141 to have the Kerberos libraries and header files installed for this
 142 to work. Use the optional PATH argument to specify the root of your
 143 Kerberos installation.
 144
 145 --with-afs=PATH will enable AFS support. You will need to have the
 146 Kerberos IV and the AFS libraries and header files installed for this
 147 to work.  Use the optional PATH argument to specify the root of your
 148 AFS installation. AFS requires Kerberos support to be enabled.
 149
 150 --with-skey=PATH will enable S/Key one time password support. You will
 151 need the S/Key libraries and header files installed for this to work.
 152
 153 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 154 support. You will need libwrap.a and tcpd.h installed.
 155
 156 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 157 if your operating system uses MD5 passwords without using PAM.
 158
 159 --with-utmpx enables utmpx support. utmpx support is automatic for
 160 some platforms.
 161
 162 --without-shadow disables shadow password support.
 163
 164 --with-ipaddr-display forces the use of a numeric IP address in the
 165 $DISPLAY environment variable. Some broken systems need this.
 166
 167 --with-default-path=PATH allows you to specify a default $PATH for sessions
 168 started by sshd. This replaces the standard path entirely.
 169
 170 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 171 created.
 172
 173 --with-xauth=PATH specifies the location of the xauth binary
 174
 175 --with-ipv4-default instructs OpenSSH to use IPv4 by default for new
 176 connections. Normally OpenSSH will try attempt to lookup both IPv6 and
 177 IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
 178 resolution. If this option is specified, you can still attempt to
 179 connect to IPv6 addresses using the command line option '-6'.
 180
 181 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 182 are installed.
 183
 184 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 185 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 186
 187 If you need to pass special options to the compiler or linker, you
 188 can specify these as environment variables before running ./configure.
 189 For example:
 190
 191 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 192
 193 3. Configuration
 194 ----------------
 195
 196 The runtime configuration files are installed by in ${prefix}/etc or
 197 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 198
 199 The default configuration should be instantly usable, though you should
 200 review it to ensure that it matches your security requirements.
 201
 202 To generate a host key, run "make host-key". Alternately you can do so
 203 manually using the following commands:
 204
 205     ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
 206     ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
 207     ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
 208
 209 Replacing /etc/ssh with the correct path to the configuration directory.
 210 (${prefix}/etc or whatever you specified with --sysconfdir during
 211 configuration)
 212
 213 If you have configured OpenSSH with EGD support, ensure that EGD is
 214 running and has collected some Entropy.
 215
 216 For more information on configuration, please refer to the manual pages
 217 for sshd, ssh and ssh-agent.
 218
 219 4. Problems?
 220 ------------
 221
 222 If you experience problems compiling, installing or running OpenSSH.
 223 Please refer to the "reporting bugs" section of the webpage at
 224 http://www.openssh.com/
 225
 226
 227 $Id$