crypto/openssh/INSTALL

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