crypto/openssh/INSTALL

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