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