INSTALL

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