INSTALL

   1 1. Prerequisites
   2 ----------------
   3
   4 You will need working installations of Zlib and OpenSSL.
   5
   6 Zlib:
   7 http://www.freesoftware.com/pub/infozip/zlib/
   8
   9 OpenSSL 0.9.5a or greater:
  10 http://www.openssl.org/
  11
  12 RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support
  13
  14 OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
  15 supports it. PAM is standard on Redhat and Debian Linux, Solaris and
  16 HP-UX 11.
  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@jmknoble.cx> 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 PRNGD:
  33
  34 If your system lacks Kernel based random collection, the use of Lutz
  35 Jaenicke's PRNGd is recommended.
  36
  37 http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
  38
  39 EGD:
  40
  41 The Entropy Gathering Daemon (EGD) is supported if you have a system which
  42 lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
  43
  44 http://www.lothar.com/tech/crypto/
  45
  46 GNU Make:
  47 ftp://ftp.gnu.org/gnu/make/
  48
  49 OpenSSH has only been tested with GNU make. It may work with other
  50 'make' programs, but you are on your own.
  51
  52 pcre (POSIX Regular Expression library):
  53 ftp://ftp.cus.cam.ac.uk/pub/software/programs/pcre/
  54
  55 Most platforms do not required this.  However older 4.3 BSD do not
  56 have a posix regex library.
  57
  58 S/Key Libraries:
  59 http://www.sparc.spb.su/solaris/skey/
  60
  61 If you wish to use --with-skey then you will need the above library
  62 installed.  No other current S/Key library is currently known to be
  63 supported.
  64
  65 2. Building / Installation
  66 --------------------------
  67
  68 To install OpenSSH with default options:
  69
  70 ./configure
  71 make
  72 make install
  73
  74 This will install the OpenSSH binaries in /usr/local/bin, configuration files
  75 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
  76 installation prefix, use the --prefix option to configure:
  77
  78 ./configure --prefix=/opt
  79 make
  80 make install
  81
  82 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
  83 specific paths, for example:
  84
  85 ./configure --prefix=/opt --sysconfdir=/etc/ssh
  86 make
  87 make install
  88
  89 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
  90 configuration files in /etc/ssh.
  91
  92 If you are using PAM, you may need to manually install a PAM
  93 control file as "/etc/pam.d/sshd" (or wherever your system
  94 prefers to keep them). A generic PAM configuration is included as
  95 "contrib/sshd.pam.generic", you may need to edit it before using it on
  96 your system. If you are using a recent version of Redhat Linux, the
  97 config file in contrib/redhat/sshd.pam should be more useful.
  98 Failure to install a valid PAM file may result in an inability to
  99 use password authentication.  On HP-UX 11, 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 --without-pam will disable PAM support. PAM is automatically detected
 111 and switched on if found.
 112
 113 --enable-gnome-askpass will build the GNOME passphrase dialog. You
 114 need a working installation of GNOME, including the development
 115 headers, for this to work.
 116
 117 --with-random=/some/file allows you to specify an alternate source of
 118 random numbers (the default is /dev/urandom). Unless you are absolutely
 119 sure of what you are doing, it is best to leave this alone.
 120
 121 --with-egd-pool=/some/file allows you to enable EGD or PRNGD support
 122 and to specify a EGD pool socket. 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-kerberos4=PATH will enable Kerberos IV support. You will need
 133 to have the Kerberos libraries and header files installed for this
 134 to work. Use the optional PATH argument to specify the root of your
 135 Kerberos installation.
 136
 137 --with-afs=PATH will enable AFS support. You will need to have the
 138 Kerberos IV and the AFS libraries and header files installed for this
 139 to work.  Use the optional PATH argument to specify the root of your
 140 AFS installation. AFS requires Kerberos support to be enabled.
 141
 142 --with-skey=PATH will enable S/Key one time password support. You will
 143 need the S/Key libraries and header files installed for this to work.
 144
 145 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 146 support. You will need libwrap.a and tcpd.h installed.
 147
 148 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 149 if your operating system uses MD5 passwords without using PAM.
 150
 151 --with-utmpx enables utmpx support. utmpx support is automatic for
 152 some platforms.
 153
 154 --without-shadow disables shadow password support.
 155
 156 --with-ipaddr-display forces the use of a numeric IP address in the
 157 $DISPLAY environment variable. Some broken systems need this.
 158
 159 --with-default-path=PATH allows you to specify a default $PATH for sessions
 160 started by sshd. This replaces the standard path entirely.
 161
 162 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 163 created.
 164
 165 --with-xauth=PATH specifies the location of the xauth binary
 166
 167 --with-ipv4-default instructs OpenSSH to use IPv4 by default for new
 168 connections. Normally OpenSSH will try attempt to lookup both IPv6 and
 169 IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
 170 resolution. If this option is specified, you can still attempt to
 171 connect to IPv6 addresses using the command line option '-6'.
 172
 173 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 174 are installed.
 175
 176 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 177 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 178
 179 If you need to pass special options to the compiler or linker, you
 180 can specify these as environment variables before running ./configure.
 181 For example:
 182
 183 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 184
 185 3. Configuration
 186 ----------------
 187
 188 The runtime configuration files are installed by in ${prefix}/etc or
 189 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 190
 191 The default configuration should be instantly usable, though you should
 192 review it to ensure that it matches your security requirements.
 193
 194 To generate a host key, run "make host-key". Alternately you can do so
 195 manually using the following commands:
 196
 197     ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ""
 198     ssh-keygen -d -f /etc/ssh/ssh_host_dsa_key -N ""
 199
 200 Replacing /etc/ssh with the correct path to the configuration directory.
 201 (${prefix}/etc or whatever you specified with --sysconfdir during
 202 configuration)
 203
 204 If you have configured OpenSSH with EGD support, ensure that EGD is
 205 running and has collected some Entropy.
 206
 207 For more information on configuration, please refer to the manual pages
 208 for sshd, ssh and ssh-agent.
 209
 210 4. Problems?
 211 ------------
 212
 213 If you experience problems compiling, installing or running OpenSSH.
 214 Please refer to the "reporting bugs" section of the webpage at
 215 http://www.openssh.com/
 216