crypto/openssh/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
  20
  21 PRNGD:
  22
  23 If your system lacks kernel-based random collection, the use of Lutz
  24 Jaenicke's PRNGd is recommended.
  25
  26 http://prngd.sourceforge.net/
  27
  28 EGD:
  29
  30 The Entropy Gathering Daemon (EGD) is supported if you have a system which
  31 lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
  32
  33 http://www.lothar.com/tech/crypto/
  34
  35 PAM:
  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 TCP Wrappers:
  59
  60 If you wish to use the TCP wrappers functionality you will need at least
  61 tcpd.h and libwrap.a, either in the standard include and library paths,
  62 or in the directory specified by --with-tcp-wrappers.  Version 7.6 is
  63 known to work.
  64
  65 http://ftp.porcupine.org/pub/security/index.html
  66
  67 S/Key Libraries:
  68
  69 If you wish to use --with-skey then you will need the library below
  70 installed.  No other S/Key library is currently known to be supported.
  71
  72 http://www.sparc.spb.su/solaris/skey/
  73
  74 LibEdit:
  75
  76 sftp supports command-line editing via NetBSD's libedit.  If your platform
  77 has it available natively you can use that, alternatively you might try
  78 these multi-platform ports:
  79
  80 http://www.thrysoee.dk/editline/
  81 http://sourceforge.net/projects/libedit/
  82
  83 LDNS:
  84
  85 LDNS is a DNS BSD-licensed resolver library which supports DNSSEC.
  86
  87 http://nlnetlabs.nl/projects/ldns/
  88
  89 Autoconf:
  90
  91 If you modify configure.ac or configure doesn't exist (eg if you checked
  92 the code out of CVS yourself) then you will need autoconf-2.68 to rebuild
  93 the automatically generated files by running "autoreconf".  Earlier
  94 versions may also work but this is not guaranteed.
  95
  96 http://www.gnu.org/software/autoconf/
  97
  98 Basic Security Module (BSM):
  99
 100 Native BSM support is know to exist in Solaris from at least 2.5.1,
 101 FreeBSD 6.1 and OS X.  Alternatively, you may use the OpenBSM
 102 implementation (http://www.openbsm.org).
 103
 104
 105 2. Building / Installation
 106 --------------------------
 107
 108 To install OpenSSH with default options:
 109
 110 ./configure
 111 make
 112 make install
 113
 114 This will install the OpenSSH binaries in /usr/local/bin, configuration files
 115 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
 116 installation prefix, use the --prefix option to configure:
 117
 118 ./configure --prefix=/opt
 119 make
 120 make install
 121
 122 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
 123 specific paths, for example:
 124
 125 ./configure --prefix=/opt --sysconfdir=/etc/ssh
 126 make
 127 make install
 128
 129 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
 130 configuration files in /etc/ssh.
 131
 132 If you are using Privilege Separation (which is enabled by default)
 133 then you will also need to create the user, group and directory used by
 134 sshd for privilege separation.  See README.privsep for details.
 135
 136 If you are using PAM, you may need to manually install a PAM control
 137 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
 138 them).  Note that the service name used to start PAM is __progname,
 139 which is the basename of the path of your sshd (e.g., the service name
 140 for /usr/sbin/osshd will be osshd).  If you have renamed your sshd
 141 executable, your PAM configuration may need to be modified.
 142
 143 A generic PAM configuration is included as "contrib/sshd.pam.generic",
 144 you may need to edit it before using it on your system. If you are
 145 using a recent version of Red Hat Linux, the config file in
 146 contrib/redhat/sshd.pam should be more useful.  Failure to install a
 147 valid PAM file may result in an inability to use password
 148 authentication.  On HP-UX 11 and Solaris, the standard /etc/pam.conf
 149 configuration will work with sshd (sshd will match the other service
 150 name).
 151
 152 There are a few other options to the configure script:
 153
 154 --with-audit=[module] enable additional auditing via the specified module.
 155 Currently, drivers for "debug" (additional info via syslog) and "bsm"
 156 (Sun's Basic Security Module) are supported.
 157
 158 --with-pam enables PAM support. If PAM support is compiled in, it must
 159 also be enabled in sshd_config (refer to the UsePAM directive).
 160
 161 --with-prngd-socket=/some/file allows you to enable EGD or PRNGD
 162 support and to specify a PRNGd socket. Use this if your Unix lacks
 163 /dev/random and you don't want to use OpenSSH's builtin entropy
 164 collection support.
 165
 166 --with-prngd-port=portnum allows you to enable EGD or PRNGD support
 167 and to specify a EGD localhost TCP port. Use this if your Unix lacks
 168 /dev/random and you don't want to use OpenSSH's builtin entropy
 169 collection support.
 170
 171 --with-lastlog=FILE will specify the location of the lastlog file.
 172 ./configure searches a few locations for lastlog, but may not find
 173 it if lastlog is installed in a different place.
 174
 175 --without-lastlog will disable lastlog support entirely.
 176
 177 --with-osfsia, --without-osfsia will enable or disable OSF1's Security
 178 Integration Architecture.  The default for OSF1 machines is enable.
 179
 180 --with-skey=PATH will enable S/Key one time password support. You will
 181 need the S/Key libraries and header files installed for this to work.
 182
 183 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
 184 support.
 185
 186 --with-md5-passwords will enable the use of MD5 passwords. Enable this
 187 if your operating system uses MD5 passwords and the system crypt() does
 188 not support them directly (see the crypt(3/3c) man page). If enabled, the
 189 resulting binary will support both MD5 and traditional crypt passwords.
 190
 191 --with-utmpx enables utmpx support. utmpx support is automatic for
 192 some platforms.
 193
 194 --without-shadow disables shadow password support.
 195
 196 --with-ipaddr-display forces the use of a numeric IP address in the
 197 $DISPLAY environment variable. Some broken systems need this.
 198
 199 --with-default-path=PATH allows you to specify a default $PATH for sessions
 200 started by sshd. This replaces the standard path entirely.
 201
 202 --with-pid-dir=PATH specifies the directory in which the sshd.pid file is
 203 created.
 204
 205 --with-xauth=PATH specifies the location of the xauth binary
 206
 207 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
 208 are installed.
 209
 210 --with-ssl-engine enables OpenSSL's (hardware) ENGINE support
 211
 212 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
 213 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
 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.88 2013/03/07 01:33:35 dtucker Exp $