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 included) do not work correctly.)
  14
  15 RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support.
  16 For Red Hat Linux 6.2, they have been released as errata.  RHL7 includes
  17 these.
  18
  19 OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
  20 supports it. PAM is standard on Redhat and Debian Linux, Solaris and
  21 HP-UX 11.
  22
  23 NB. If you operating system supports /dev/random, you should configure
  24 OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of
  25 /dev/random. If you don't you will have to rely on ssh-rand-helper, which
  26 is inferior to a good kernel-based solution.
  27
  28 PAM:
  29 http://www.kernel.org/pub/linux/libs/pam/
  30
  31 If you wish to build the GNOME passphrase requester, you will need the GNOME
  32 libraries and headers.
  33
  34 GNOME:
  35 http://www.gnome.org/
  36
  37 Alternatively, Jim Knoble <jmknoble@jmknoble.cx> has written an excellent X11
  38 passphrase requester. This is maintained separately at:
  39
  40 http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
  41
  42 PRNGD:
  43
  44 If your system lacks Kernel based random collection, the use of Lutz
  45 Jaenicke's PRNGd is recommended.
  46
  47 http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
  48
  49 EGD:
  50
  51 The Entropy Gathering Daemon (EGD) is supported if you have a system which
  52 lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
  53
  54 http://www.lothar.com/tech/crypto/
  55
  56 S/Key Libraries:
  57 http://www.sparc.spb.su/solaris/skey/
  58
  59 If you wish to use --with-skey then you will need the above library
  60 installed.  No other current S/Key library is currently known to be
  61 supported.
  62
  63 2. Building / Installation
  64 --------------------------
  65
  66 To install OpenSSH with default options:
  67
  68 ./configure
  69 make
  70 make install
  71
  72 This will install the OpenSSH binaries in /usr/local/bin, configuration files
  73 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
  74 installation prefix, use the --prefix option to configure:
  75
  76 ./configure --prefix=/opt
  77 make
  78 make install
  79
  80 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
  81 specific paths, for example:
  82
  83 ./configure --prefix=/opt --sysconfdir=/etc/ssh
  84 make
  85 make install
  86
  87 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
  88 configuration files in /etc/ssh.
  89
  90 If you are using PAM, you may need to manually install a PAM control
  91 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
  92 them).  Note that the service name used to start PAM is __progname,
  93 which is the basename of the path of your sshd (e.g., the service name
  94 for /usr/sbin/osshd will be osshd).  If you have renamed your sshd
  95 executable, your PAM configuration may need to be modified.
  96
  97 A generic PAM configuration is included as "contrib/sshd.pam.generic",
  98 you may need to edit it before using it on your system. If you are
  99 using a recent version of Red Hat Linux, the config file in
 100 contrib/redhat/sshd.pam should be more useful.  Failure to install a
 101 valid PAM file may result in an inability to use password
 102 authentication.  On HP-UX 11 and Solaris, the standard /etc/pam.conf
 103 configuration will work with sshd (sshd will match the other service
 104 name).
 105
 106 There are a few other options to the configure script:
 107
 108 --with-rsh=PATH allows you to specify the path to your rsh program.
 109 Normally ./configure will search the current $PATH for 'rsh'. You
 110 may need to specify this option if rsh is not in your path or has a
 111 different name.
 112
 113 --with-pam enables PAM support.
 114
 115 --enable-gnome-askpass will build the GNOME passphrase dialog. You
 116 need a working installation of GNOME, including the development
 117 headers, for this to work.
 118
 119 --with-prngd-socket=/some/file allows you to enable EGD or PRNGD
 120 support and to specify a PRNGd socket. Use this if your Unix lacks
 121 /dev/random and you don't want to use OpenSSH's builtin entropy
 122 collection support.
 123
 124 --with-prngd-port=portnum allows you to enable EGD or PRNGD support
 125 and to specify a EGD localhost TCP port. Use this if your Unix lacks
 126 /dev/random and you don't want to use OpenSSH's builtin entropy
 127 collection support.
 128
 129 --with-lastlog=FILE will specify the location of the lastlog file.
 130 ./configure searches a few locations for lastlog, but may not find
 131 it if lastlog is installed in a different place.
 132
 133 --without-lastlog will disable lastlog support entirely.
 134
 135 --with-sia, --without-sia will enable or disable OSF1's Security
 136 Integration Architecture.  The default for OSF1 machines is enable.
 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 --with-opensc=DIR
 186 --with-sectok=DIR allows for OpenSC or sectok smartcard libraries to
 187 be used with OpenSSH.  See 'README.smartcard' for more details.
 188
 189 If you need to pass special options to the compiler or linker, you
 190 can specify these as environment variables before running ./configure.
 191 For example:
 192
 193 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 194
 195 3. Configuration
 196 ----------------
 197
 198 The runtime configuration files are installed by in ${prefix}/etc or
 199 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 200
 201 The default configuration should be instantly usable, though you should
 202 review it to ensure that it matches your security requirements.
 203
 204 To generate a host key, run "make host-key". Alternately you can do so
 205 manually using the following commands:
 206
 207     ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
 208     ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
 209     ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
 210
 211 Replacing /etc/ssh with the correct path to the configuration directory.
 212 (${prefix}/etc or whatever you specified with --sysconfdir during
 213 configuration)
 214
 215 If you have configured OpenSSH with EGD support, ensure that EGD is
 216 running and has collected some Entropy.
 217
 218 For more information on configuration, please refer to the manual pages
 219 for sshd, ssh and ssh-agent.
 220
 221 4. Problems?
 222 ------------
 223
 224 If you experience problems compiling, installing or running OpenSSH.
 225 Please refer to the "reporting bugs" section of the webpage at
 226 http://www.openssh.com/
 227
 228
 229 $Id$