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