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