INSTALL

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