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 RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support.
  13 For Red Hat Linux 6.2, they have been released as errata.  RHL7 includes
  14 these.
  15
  16 OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
  17 supports it. PAM is standard on Redhat and Debian Linux, Solaris and
  18 HP-UX 11.
  19
  20 PAM:
  21 http://www.kernel.org/pub/linux/libs/pam/
  22
  23 If you wish to build the GNOME passphrase requester, you will need the GNOME
  24 libraries and headers.
  25
  26 GNOME:
  27 http://www.gnome.org/
  28
  29 Alternatively, Jim Knoble <jmknoble@jmknoble.cx> has written an excellent X11
  30 passphrase requester. This is maintained separately at:
  31
  32 http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
  33
  34 PRNGD:
  35
  36 If your system lacks Kernel based random collection, the use of Lutz
  37 Jaenicke's PRNGd is recommended.
  38
  39 http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
  40
  41 EGD:
  42
  43 The Entropy Gathering Daemon (EGD) is supported if you have a system which
  44 lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
  45
  46 http://www.lothar.com/tech/crypto/
  47
  48 S/Key Libraries:
  49 http://www.sparc.spb.su/solaris/skey/
  50
  51 If you wish to use --with-skey then you will need the above library
  52 installed.  No other current S/Key library is currently known to be
  53 supported.
  54
  55 2. Building / Installation
  56 --------------------------
  57
  58 To install OpenSSH with default options:
  59
  60 ./configure
  61 make
  62 make install
  63
  64 This will install the OpenSSH binaries in /usr/local/bin, configuration files
  65 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
  66 installation prefix, use the --prefix option to configure:
  67
  68 ./configure --prefix=/opt
  69 make
  70 make install
  71
  72 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
  73 specific paths, for example:
  74
  75 ./configure --prefix=/opt --sysconfdir=/etc/ssh
  76 make
  77 make install
  78
  79 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
  80 configuration files in /etc/ssh.
  81
  82 If you are using PAM, you may need to manually install a PAM control
  83 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
  84 them).  Note that the service name used to start PAM is __progname,
  85 which is the basename of the path of your sshd (e.g., the service name
  86 for /usr/sbin/osshd will be osshd).  If you have renamed your sshd
  87 executable, your PAM configuration may need to be modified.
  88
  89 A generic PAM configuration is included as "contrib/sshd.pam.generic",
  90 you may need to edit it before using it on your system. If you are
  91 using a recent version of Red Hat Linux, the config file in
  92 contrib/redhat/sshd.pam should be more useful.  Failure to install a
  93 valid PAM file may result in an inability to use password
  94 authentication.  On HP-UX 11 and Solaris, the standard /etc/pam.conf
  95 configuration will work with sshd (sshd will match the other service
  96 name).
  97
  98 There are a few other options to the configure script:
  99
 100 --with-rsh=PATH allows you to specify the path to your rsh program.
 101 Normally ./configure will search the current $PATH for 'rsh'. You
 102 may need to specify this option if rsh is not in your path or has a
 103 different name.
 104
 105 --with-pam enables PAM support.
 106
 107 --enable-gnome-askpass will build the GNOME passphrase dialog. You
 108 need a working installation of GNOME, including the development
 109 headers, for this to work.
 110
 111 --with-random=/some/file allows you to specify an alternate source of
 112 random numbers (the default is /dev/urandom). Unless you are absolutely
 113 sure of what you are doing, it is best to leave this alone.
 114
 115 --with-prngd-socket=/some/file allows you to enable EGD or PRNGD
 116 support and to specify a PRNGd socket. Use this if your Unix lacks
 117 /dev/random and you don't want to use OpenSSH's builtin entropy
 118 collection support.
 119
 120 --with-prngd-port=portnum allows you to enable EGD or PRNGD support
 121 and to specify a EGD localhost TCP port. Use this if your Unix lacks
 122 /dev/random and you don't want to use OpenSSH's builtin entropy
 123 collection support.
 124
 125 --with-lastlog=FILE will specify the location of the lastlog file.
 126 ./configure searches a few locations for lastlog, but may not find
 127 it if lastlog is installed in a different place.
 128
 129 --without-lastlog will disable lastlog support entirely.
 130
 131 --with-sia, --without-sia will enable or disable OSF1's Security
 132 Integration Architecture.  The default for OSF1 machines is enable.
 133
 134 --with-kerberos4=PATH will enable Kerberos IV support. You will need
 135 to have the Kerberos libraries and header files installed for this
 136 to work. Use the optional PATH argument to specify the root of your
 137 Kerberos installation.
 138
 139 --with-afs=PATH will enable AFS support. You will need to have the
 140 Kerberos IV and the AFS libraries and header files installed for this
 141 to work.  Use the optional PATH argument to specify the root of your
 142 AFS installation. AFS requires Kerberos support to be enabled.
 143
 144 --with-skey=PATH will enable S/Key one time password support. You will
 145 need the S/Key libraries and header files installed for this to work.
 146
 147 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 148 support. You will need libwrap.a and tcpd.h installed.
 149
 150 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 151 if your operating system uses MD5 passwords without using PAM.
 152
 153 --with-utmpx enables utmpx support. utmpx support is automatic for
 154 some platforms.
 155
 156 --without-shadow disables shadow password support.
 157
 158 --with-ipaddr-display forces the use of a numeric IP address in the
 159 $DISPLAY environment variable. Some broken systems need this.
 160
 161 --with-default-path=PATH allows you to specify a default $PATH for sessions
 162 started by sshd. This replaces the standard path entirely.
 163
 164 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
 165 created.
 166
 167 --with-xauth=PATH specifies the location of the xauth binary
 168
 169 --with-ipv4-default instructs OpenSSH to use IPv4 by default for new
 170 connections. Normally OpenSSH will try attempt to lookup both IPv6 and
 171 IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
 172 resolution. If this option is specified, you can still attempt to
 173 connect to IPv6 addresses using the command line option '-6'.
 174
 175 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 176 are installed.
 177
 178 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 179 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 180
 181 If you need to pass special options to the compiler or linker, you
 182 can specify these as environment variables before running ./configure.
 183 For example:
 184
 185 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 186
 187 3. Configuration
 188 ----------------
 189
 190 The runtime configuration files are installed by in ${prefix}/etc or
 191 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 192
 193 The default configuration should be instantly usable, though you should
 194 review it to ensure that it matches your security requirements.
 195
 196 To generate a host key, run "make host-key". Alternately you can do so
 197 manually using the following commands:
 198
 199     ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
 200     ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
 201     ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
 202
 203 Replacing /etc/ssh with the correct path to the configuration directory.
 204 (${prefix}/etc or whatever you specified with --sysconfdir during
 205 configuration)
 206
 207 If you have configured OpenSSH with EGD support, ensure that EGD is
 208 running and has collected some Entropy.
 209
 210 For more information on configuration, please refer to the manual pages
 211 for sshd, ssh and ssh-agent.
 212
 213 4. Problems?
 214 ------------
 215
 216 If you experience problems compiling, installing or running OpenSSH.
 217 Please refer to the "reporting bugs" section of the webpage at
 218 http://www.openssh.com/
 219
 220
 221 $Id$