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