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