INSTALL

   1 1. Prerequisites
   2 ----------------
   3
   4 You will need working installations of Zlib and OpenSSL.
   5
   6 Zlib 1.1.4 or 1.2.1.2 or greater (ealier 1.2.x versions have problems):
   7 http://www.gzip.org/zlib/
   8
   9 OpenSSL 0.9.6 or greater:
  10 http://www.openssl.org/
  11
  12 (OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1
  13 Blowfish) do not work correctly.)
  14
  15 The remaining items are optional.
  16
  17 NB. If you operating system supports /dev/random, you should configure
  18 OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of
  19 /dev/random, or failing that, either prngd or egd.  If you don't have
  20 any of these you will have to rely on ssh-rand-helper, which is inferior
  21 to a good kernel-based solution or prngd.
  22
  23 PRNGD:
  24
  25 If your system lacks kernel-based random collection, the use of Lutz
  26 Jaenicke's PRNGd is recommended.
  27
  28 http://prngd.sourceforge.net/
  29
  30 EGD:
  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 http://www.lothar.com/tech/crypto/
  36
  37 PAM:
  38
  39 OpenSSH can utilise Pluggable Authentication Modules (PAM) if your
  40 system supports it. PAM is standard most Linux distributions, Solaris,
  41 HP-UX 11, AIX >= 5.2, FreeBSD and NetBSD.
  42
  43 Information about the various PAM implementations are available:
  44
  45 Solaris PAM:    http://www.sun.com/software/solaris/pam/
  46 Linux PAM:      http://www.kernel.org/pub/linux/libs/pam/
  47 OpenPAM:        http://www.openpam.org/
  48
  49 If you wish to build the GNOME passphrase requester, you will need the GNOME
  50 libraries and headers.
  51
  52 GNOME:
  53 http://www.gnome.org/
  54
  55 Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11
  56 passphrase requester. This is maintained separately at:
  57
  58 http://www.jmknoble.net/software/x11-ssh-askpass/
  59
  60 TCP Wrappers:
  61
  62 If you wish to use the TCP wrappers functionality you will need at least
  63 tcpd.h and libwrap.a, either in the standard include and library paths,
  64 or in the directory specified by --with-tcp-wrappers.  Version 7.6 is
  65 known to work.
  66
  67 http://ftp.porcupine.org/pub/security/index.html
  68
  69 S/Key Libraries:
  70
  71 If you wish to use --with-skey then you will need the library below
  72 installed.  No other S/Key library is currently known to be supported.
  73
  74 http://www.sparc.spb.su/solaris/skey/
  75
  76 LibEdit:
  77
  78 sftp supports command-line editing via NetBSD's libedit.  If your platform
  79 has it available natively you can use that, alternatively you might try
  80 these multi-platform ports:
  81
  82 http://www.thrysoee.dk/editline/
  83 http://sourceforge.net/projects/libedit/
  84
  85 Autoconf:
  86
  87 If you modify configure.ac or configure doesn't exist (eg if you checked
  88 the code out of CVS yourself) then you will need autoconf-2.61 to rebuild
  89 the automatically generated files by running "autoreconf".  Earlier
  90 versions may also work but this is not guaranteed.
  91
  92 http://www.gnu.org/software/autoconf/
  93
  94 Basic Security Module (BSM):
  95
  96 Native BSM support is know to exist in Solaris from at least 2.5.1,
  97 FreeBSD 6.1 and OS X.  Alternatively, you may use the OpenBSM
  98 implementation (http://www.openbsm.org).
  99
 100
 101 2. Building / Installation
 102 --------------------------
 103
 104 To install OpenSSH with default options:
 105
 106 ./configure
 107 make
 108 make install
 109
 110 This will install the OpenSSH binaries in /usr/local/bin, configuration files
 111 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
 112 installation prefix, use the --prefix option to configure:
 113
 114 ./configure --prefix=/opt
 115 make
 116 make install
 117
 118 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
 119 specific paths, for example:
 120
 121 ./configure --prefix=/opt --sysconfdir=/etc/ssh
 122 make
 123 make install
 124
 125 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
 126 configuration files in /etc/ssh.
 127
 128 If you are using Privilege Separation (which is enabled by default)
 129 then you will also need to create the user, group and directory used by
 130 sshd for privilege separation.  See README.privsep for details.
 131
 132 If you are using PAM, you may need to manually install a PAM control
 133 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
 134 them).  Note that the service name used to start PAM is __progname,
 135 which is the basename of the path of your sshd (e.g., the service name
 136 for /usr/sbin/osshd will be osshd).  If you have renamed your sshd
 137 executable, your PAM configuration may need to be modified.
 138
 139 A generic PAM configuration is included as "contrib/sshd.pam.generic",
 140 you may need to edit it before using it on your system. If you are
 141 using a recent version of Red Hat Linux, the config file in
 142 contrib/redhat/sshd.pam should be more useful.  Failure to install a
 143 valid PAM file may result in an inability to use password
 144 authentication.  On HP-UX 11 and Solaris, the standard /etc/pam.conf
 145 configuration will work with sshd (sshd will match the other service
 146 name).
 147
 148 There are a few other options to the configure script:
 149
 150 --with-audit=[module] enable additional auditing via the specified module.
 151 Currently, drivers for "debug" (additional info via syslog) and "bsm"
 152 (Sun's Basic Security Module) are supported.
 153
 154 --with-pam enables PAM support. If PAM support is compiled in, it must
 155 also be enabled in sshd_config (refer to the UsePAM directive).
 156
 157 --with-prngd-socket=/some/file allows you to enable EGD or PRNGD
 158 support and to specify a PRNGd socket. Use this if your Unix lacks
 159 /dev/random and you don't want to use OpenSSH's builtin entropy
 160 collection support.
 161
 162 --with-prngd-port=portnum allows you to enable EGD or PRNGD support
 163 and to specify a EGD localhost TCP port. Use this if your Unix lacks
 164 /dev/random and you don't want to use OpenSSH's builtin entropy
 165 collection support.
 166
 167 --with-lastlog=FILE will specify the location of the lastlog file.
 168 ./configure searches a few locations for lastlog, but may not find
 169 it if lastlog is installed in a different place.
 170
 171 --without-lastlog will disable lastlog support entirely.
 172
 173 --with-osfsia, --without-osfsia will enable or disable OSF1's Security
 174 Integration Architecture.  The default for OSF1 machines is enable.
 175
 176 --with-skey=PATH will enable S/Key one time password support. You will
 177 need the S/Key libraries and header files installed for this to work.
 178
 179 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 180 support.
 181
 182 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 183 if your operating system uses MD5 passwords and the system crypt() does
 184 not support them directly (see the crypt(3/3c) man page). If enabled, the
 185 resulting binary will support both MD5 and traditional crypt passwords.
 186
 187 --with-utmpx enables utmpx support. utmpx support is automatic for
 188 some platforms.
 189
 190 --without-shadow disables shadow password support.
 191
 192 --with-ipaddr-display forces the use of a numeric IP address in the
 193 $DISPLAY environment variable. Some broken systems need this.
 194
 195 --with-default-path=PATH allows you to specify a default $PATH for sessions
 196 started by sshd. This replaces the standard path entirely.
 197
 198 --with-pid-dir=PATH specifies the directory in which the sshd.pid file is
 199 created.
 200
 201 --with-xauth=PATH specifies the location of the xauth binary
 202
 203 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 204 are installed.
 205
 206 --with-ssl-engine enables OpenSSL's (hardware) ENGINE support
 207
 208 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 209 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 210
 211 --with-opensc=DIR
 212 --with-sectok=DIR allows for OpenSC or sectok smartcard libraries to
 213 be used with OpenSSH.  See 'README.smartcard' for more details.
 214
 215 If you need to pass special options to the compiler or linker, you
 216 can specify these as environment variables before running ./configure.
 217 For example:
 218
 219 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
 220
 221 3. Configuration
 222 ----------------
 223
 224 The runtime configuration files are installed by in ${prefix}/etc or
 225 whatever you specified as your --sysconfdir (/usr/local/etc by default).
 226
 227 The default configuration should be instantly usable, though you should
 228 review it to ensure that it matches your security requirements.
 229
 230 To generate a host key, run "make host-key". Alternately you can do so
 231 manually using the following commands:
 232
 233     ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
 234     ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
 235     ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
 236
 237 Replacing /etc/ssh with the correct path to the configuration directory.
 238 (${prefix}/etc or whatever you specified with --sysconfdir during
 239 configuration)
 240
 241 If you have configured OpenSSH with EGD support, ensure that EGD is
 242 running and has collected some Entropy.
 243
 244 For more information on configuration, please refer to the manual pages
 245 for sshd, ssh and ssh-agent.
 246
 247 4. (Optional) Send survey
 248 -------------------------
 249
 250 $ make survey
 251 [check the contents of the file "survey" to ensure there's no information
 252 that you consider sensitive]
 253 $ make send-survey
 254
 255 This will send configuration information for the currently configured
 256 host to a survey address.  This will help determine which configurations
 257 are actually in use, and what valid combinations of configure options
 258 exist.  The raw data is available only to the OpenSSH developers, however
 259 summary data may be published.
 260
 261 5. Problems?
 262 ------------
 263
 264 If you experience problems compiling, installing or running OpenSSH.
 265 Please refer to the "reporting bugs" section of the webpage at
 266 http://www.openssh.com/
 267
 268
 269 $Id: INSTALL,v 1.84 2007/08/17 12:52:05 dtucker Exp $