Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 1 | ---------------- |
| 2 | |
Darren Tucker | 560c006 | 2016-08-17 13:38:30 +1000 | [diff] [blame^] | 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 | (--with-ldflags=--rtlib=compiler-rt) |
| 8 | |
Damien Miller | ad01394 | 2014-08-26 09:27:28 +1000 | [diff] [blame] | 9 | You will need working installations of Zlib and libcrypto (LibreSSL / |
| 10 | OpenSSL) |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 11 | |
Darren Tucker | 2f0b5c4 | 2005-04-24 17:52:22 +1000 | [diff] [blame] | 12 | Zlib 1.1.4 or 1.2.1.2 or greater (ealier 1.2.x versions have problems): |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 13 | http://www.gzip.org/zlib/ |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 14 | |
Darren Tucker | a162dd5 | 2016-07-14 21:19:59 +1000 | [diff] [blame] | 15 | libcrypto (LibreSSL or OpenSSL >= 0.9.8f < 1.1.0) |
Damien Miller | ad01394 | 2014-08-26 09:27:28 +1000 | [diff] [blame] | 16 | LibreSSL http://www.libressl.org/ ; or |
| 17 | OpenSSL http://www.openssl.org/ |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 18 | |
Damien Miller | ad01394 | 2014-08-26 09:27:28 +1000 | [diff] [blame] | 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 |
Darren Tucker | a162dd5 | 2016-07-14 21:19:59 +1000 | [diff] [blame] | 22 | to configure OpenSSH --without-pie. Note that because of API changes, |
| 23 | OpenSSL 1.1.x is not currently supported. |
Damien Miller | e71eb91 | 2000-04-13 12:19:32 +1000 | [diff] [blame] | 24 | |
Darren Tucker | db4c54b | 2006-06-30 16:20:58 +1000 | [diff] [blame] | 25 | The remaining items are optional. |
| 26 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 27 | NB. If you operating system supports /dev/random, you should configure |
Damien Miller | ad01394 | 2014-08-26 09:27:28 +1000 | [diff] [blame] | 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 |
Damien Miller | 780b376 | 1999-12-26 13:36:11 +1100 | [diff] [blame] | 30 | |
Damien Miller | 0736c4d | 2001-01-25 10:51:46 +1100 | [diff] [blame] | 31 | PRNGD: |
| 32 | |
Darren Tucker | 2a38685 | 2007-04-06 12:25:08 +1000 | [diff] [blame] | 33 | If your system lacks kernel-based random collection, the use of Lutz |
Damien Miller | 0736c4d | 2001-01-25 10:51:46 +1100 | [diff] [blame] | 34 | Jaenicke's PRNGd is recommended. |
| 35 | |
Darren Tucker | 2a38685 | 2007-04-06 12:25:08 +1000 | [diff] [blame] | 36 | http://prngd.sourceforge.net/ |
Damien Miller | 0736c4d | 2001-01-25 10:51:46 +1100 | [diff] [blame] | 37 | |
| 38 | EGD: |
| 39 | |
Darren Tucker | ad7d23d | 2014-09-09 12:23:10 +1000 | [diff] [blame] | 40 | If the kernel lacks /dev/random the Entropy Gathering Daemon (EGD) is |
| 41 | supported only if libcrypto supports it. |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 42 | |
Darren Tucker | ad7d23d | 2014-09-09 12:23:10 +1000 | [diff] [blame] | 43 | http://egd.sourceforge.net/ |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 44 | |
Darren Tucker | 8ea8456 | 2007-08-17 22:12:14 +1000 | [diff] [blame] | 45 | PAM: |
| 46 | |
Darren Tucker | 1a32953 | 2007-08-17 22:03:09 +1000 | [diff] [blame] | 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 | |
Ben Lindstrom | 305fb00 | 2000-11-10 02:41:30 +0000 | [diff] [blame] | 68 | S/Key Libraries: |
Darren Tucker | 16bcc1c | 2004-11-07 20:14:34 +1100 | [diff] [blame] | 69 | |
Darren Tucker | 8d158c9 | 2005-04-19 15:40:51 +1000 | [diff] [blame] | 70 | If you wish to use --with-skey then you will need the library below |
| 71 | installed. No other S/Key library is currently known to be supported. |
Ben Lindstrom | ca1c2a0 | 2000-10-14 21:33:19 +0000 | [diff] [blame] | 72 | |
Darren Tucker | ad1e5e2 | 2005-04-19 15:31:49 +1000 | [diff] [blame] | 73 | http://www.sparc.spb.su/solaris/skey/ |
| 74 | |
| 75 | LibEdit: |
Darren Tucker | 3eb4834 | 2006-06-23 21:05:12 +1000 | [diff] [blame] | 76 | |
| 77 | sftp supports command-line editing via NetBSD's libedit. If your platform |
| 78 | has it available natively you can use that, alternatively you might try |
| 79 | these multi-platform ports: |
Darren Tucker | ad1e5e2 | 2005-04-19 15:31:49 +1000 | [diff] [blame] | 80 | |
| 81 | http://www.thrysoee.dk/editline/ |
| 82 | http://sourceforge.net/projects/libedit/ |
| 83 | |
Darren Tucker | aa3cbd1 | 2011-11-04 11:25:24 +1100 | [diff] [blame] | 84 | LDNS: |
| 85 | |
| 86 | LDNS is a DNS BSD-licensed resolver library which supports DNSSEC. |
| 87 | |
| 88 | http://nlnetlabs.nl/projects/ldns/ |
| 89 | |
Darren Tucker | db4c54b | 2006-06-30 16:20:58 +1000 | [diff] [blame] | 90 | Autoconf: |
| 91 | |
Darren Tucker | f32f552 | 2006-07-06 19:12:08 +1000 | [diff] [blame] | 92 | If you modify configure.ac or configure doesn't exist (eg if you checked |
Damien Miller | b0b48be | 2016-08-02 11:06:23 +1000 | [diff] [blame] | 93 | the code out of CVS yourself) then you will need autoconf-2.69 to rebuild |
Darren Tucker | aef5bee | 2007-03-02 17:53:41 +1100 | [diff] [blame] | 94 | the automatically generated files by running "autoreconf". Earlier |
Darren Tucker | 637cc40 | 2007-08-17 21:40:22 +1000 | [diff] [blame] | 95 | versions may also work but this is not guaranteed. |
Darren Tucker | db4c54b | 2006-06-30 16:20:58 +1000 | [diff] [blame] | 96 | |
| 97 | http://www.gnu.org/software/autoconf/ |
| 98 | |
Darren Tucker | 83bbb03 | 2006-09-17 22:55:52 +1000 | [diff] [blame] | 99 | Basic Security Module (BSM): |
| 100 | |
| 101 | Native BSM support is know to exist in Solaris from at least 2.5.1, |
| 102 | FreeBSD 6.1 and OS X. Alternatively, you may use the OpenBSM |
| 103 | implementation (http://www.openbsm.org). |
| 104 | |
Darren Tucker | db4c54b | 2006-06-30 16:20:58 +1000 | [diff] [blame] | 105 | |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 106 | 2. Building / Installation |
| 107 | -------------------------- |
| 108 | |
| 109 | To install OpenSSH with default options: |
| 110 | |
| 111 | ./configure |
| 112 | make |
| 113 | make install |
| 114 | |
| 115 | This will install the OpenSSH binaries in /usr/local/bin, configuration files |
| 116 | in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different |
| 117 | installation prefix, use the --prefix option to configure: |
| 118 | |
| 119 | ./configure --prefix=/opt |
| 120 | make |
| 121 | make install |
| 122 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 123 | Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 124 | specific paths, for example: |
| 125 | |
| 126 | ./configure --prefix=/opt --sysconfdir=/etc/ssh |
| 127 | make |
| 128 | make install |
| 129 | |
| 130 | This will install the binaries in /opt/{bin,lib,sbin}, but will place the |
| 131 | configuration files in /etc/ssh. |
| 132 | |
Darren Tucker | d9c8813 | 2005-04-19 12:21:21 +1000 | [diff] [blame] | 133 | If you are using Privilege Separation (which is enabled by default) |
| 134 | then you will also need to create the user, group and directory used by |
| 135 | sshd for privilege separation. See README.privsep for details. |
| 136 | |
Kevin Steves | 32c97c3 | 2001-04-20 20:56:21 +0000 | [diff] [blame] | 137 | If you are using PAM, you may need to manually install a PAM control |
| 138 | file as "/etc/pam.d/sshd" (or wherever your system prefers to keep |
| 139 | them). Note that the service name used to start PAM is __progname, |
| 140 | which is the basename of the path of your sshd (e.g., the service name |
| 141 | for /usr/sbin/osshd will be osshd). If you have renamed your sshd |
| 142 | executable, your PAM configuration may need to be modified. |
| 143 | |
| 144 | A generic PAM configuration is included as "contrib/sshd.pam.generic", |
| 145 | you may need to edit it before using it on your system. If you are |
| 146 | using a recent version of Red Hat Linux, the config file in |
| 147 | contrib/redhat/sshd.pam should be more useful. Failure to install a |
| 148 | valid PAM file may result in an inability to use password |
| 149 | authentication. On HP-UX 11 and Solaris, the standard /etc/pam.conf |
| 150 | configuration will work with sshd (sshd will match the other service |
Kevin Steves | df4a7ae | 2000-11-07 14:47:51 +0000 | [diff] [blame] | 151 | name). |
Damien Miller | 755c90c | 1999-11-22 16:12:31 +1100 | [diff] [blame] | 152 | |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 153 | There are a few other options to the configure script: |
| 154 | |
Darren Tucker | 83bbb03 | 2006-09-17 22:55:52 +1000 | [diff] [blame] | 155 | --with-audit=[module] enable additional auditing via the specified module. |
| 156 | Currently, drivers for "debug" (additional info via syslog) and "bsm" |
| 157 | (Sun's Basic Security Module) are supported. |
| 158 | |
Damien Miller | 5c3a558 | 2003-09-23 22:12:38 +1000 | [diff] [blame] | 159 | --with-pam enables PAM support. If PAM support is compiled in, it must |
| 160 | also be enabled in sshd_config (refer to the UsePAM directive). |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 161 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 162 | --with-prngd-socket=/some/file allows you to enable EGD or PRNGD |
| 163 | support and to specify a PRNGd socket. Use this if your Unix lacks |
| 164 | /dev/random and you don't want to use OpenSSH's builtin entropy |
Damien Miller | d0ccb98 | 2001-03-04 00:29:20 +1100 | [diff] [blame] | 165 | collection support. |
| 166 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 167 | --with-prngd-port=portnum allows you to enable EGD or PRNGD support |
| 168 | and to specify a EGD localhost TCP port. Use this if your Unix lacks |
| 169 | /dev/random and you don't want to use OpenSSH's builtin entropy |
Damien Miller | 0736c4d | 2001-01-25 10:51:46 +1100 | [diff] [blame] | 170 | collection support. |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 171 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 172 | --with-lastlog=FILE will specify the location of the lastlog file. |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 173 | ./configure searches a few locations for lastlog, but may not find |
| 174 | it if lastlog is installed in a different place. |
| 175 | |
| 176 | --without-lastlog will disable lastlog support entirely. |
| 177 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 178 | --with-osfsia, --without-osfsia will enable or disable OSF1's Security |
Ben Lindstrom | 72af2ef | 2001-05-08 20:42:28 +0000 | [diff] [blame] | 179 | Integration Architecture. The default for OSF1 machines is enable. |
| 180 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 181 | --with-skey=PATH will enable S/Key one time password support. You will |
Ben Lindstrom | 305fb00 | 2000-11-10 02:41:30 +0000 | [diff] [blame] | 182 | need the S/Key libraries and header files installed for this to work. |
Damien Miller | c096727 | 1999-11-19 15:53:50 +1100 | [diff] [blame] | 183 | |
Damien Miller | c096727 | 1999-11-19 15:53:50 +1100 | [diff] [blame] | 184 | --with-md5-passwords will enable the use of MD5 passwords. Enable this |
Darren Tucker | 0d37b5c | 2003-10-21 12:41:14 +1000 | [diff] [blame] | 185 | if your operating system uses MD5 passwords and the system crypt() does |
| 186 | not support them directly (see the crypt(3/3c) man page). If enabled, the |
| 187 | resulting binary will support both MD5 and traditional crypt passwords. |
Damien Miller | 3d1b22c | 1999-11-12 15:46:08 +1100 | [diff] [blame] | 188 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 189 | --with-utmpx enables utmpx support. utmpx support is automatic for |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 190 | some platforms. |
| 191 | |
| 192 | --without-shadow disables shadow password support. |
| 193 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 194 | --with-ipaddr-display forces the use of a numeric IP address in the |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 195 | $DISPLAY environment variable. Some broken systems need this. |
| 196 | |
| 197 | --with-default-path=PATH allows you to specify a default $PATH for sessions |
Damien Miller | 29ea30d | 2000-03-17 10:54:15 +1100 | [diff] [blame] | 198 | started by sshd. This replaces the standard path entirely. |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 199 | |
Darren Tucker | ea43c49 | 2007-08-17 22:10:10 +1000 | [diff] [blame] | 200 | --with-pid-dir=PATH specifies the directory in which the sshd.pid file is |
Damien Miller | 5eed6a2 | 2000-01-16 12:05:18 +1100 | [diff] [blame] | 201 | created. |
| 202 | |
| 203 | --with-xauth=PATH specifies the location of the xauth binary |
| 204 | |
Damien Miller | ad01394 | 2014-08-26 09:27:28 +1000 | [diff] [blame] | 205 | --with-ssl-dir=DIR allows you to specify where your Libre/OpenSSL |
| 206 | libraries |
Damien Miller | 0c0e4bf | 2000-02-03 13:58:51 +1100 | [diff] [blame] | 207 | are installed. |
| 208 | |
Damien Miller | ad01394 | 2014-08-26 09:27:28 +1000 | [diff] [blame] | 209 | --with-ssl-engine enables Libre/OpenSSL's (hardware) ENGINE support |
Darren Tucker | fabdb6c | 2006-02-20 20:17:35 +1100 | [diff] [blame] | 210 | |
Damien Miller | fd26368 | 2000-03-16 11:51:09 +1100 | [diff] [blame] | 211 | --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to |
| 212 | real (AF_INET) IPv4 addresses. Works around some quirks on Linux. |
| 213 | |
Damien Miller | beb4ba5 | 1999-12-28 15:09:35 +1100 | [diff] [blame] | 214 | If you need to pass special options to the compiler or linker, you |
Damien Miller | 615f939 | 2000-05-17 22:53:33 +1000 | [diff] [blame] | 215 | can specify these as environment variables before running ./configure. |
Damien Miller | beb4ba5 | 1999-12-28 15:09:35 +1100 | [diff] [blame] | 216 | For example: |
| 217 | |
Damien Miller | b5c42d9 | 2000-08-31 11:13:10 +1100 | [diff] [blame] | 218 | CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 219 | |
| 220 | 3. Configuration |
| 221 | ---------------- |
| 222 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 223 | The runtime configuration files are installed by in ${prefix}/etc or |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 224 | whatever you specified as your --sysconfdir (/usr/local/etc by default). |
| 225 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 226 | The default configuration should be instantly usable, though you should |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 227 | review it to ensure that it matches your security requirements. |
| 228 | |
Damien Miller | 4095f89 | 2000-03-03 22:13:52 +1100 | [diff] [blame] | 229 | To generate a host key, run "make host-key". Alternately you can do so |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 230 | manually using the following commands: |
Damien Miller | 2a9d9f6 | 1999-11-15 23:34:11 +1100 | [diff] [blame] | 231 | |
Damien Miller | 8609332 | 2001-02-18 12:58:24 +1100 | [diff] [blame] | 232 | ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N "" |
| 233 | ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N "" |
| 234 | ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N "" |
Damien Miller | 2a9d9f6 | 1999-11-15 23:34:11 +1100 | [diff] [blame] | 235 | |
Damien Miller | 6ae00d6 | 1999-12-14 15:43:03 +1100 | [diff] [blame] | 236 | Replacing /etc/ssh with the correct path to the configuration directory. |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 237 | (${prefix}/etc or whatever you specified with --sysconfdir during |
Damien Miller | 6ae00d6 | 1999-12-14 15:43:03 +1100 | [diff] [blame] | 238 | configuration) |
| 239 | |
Damien Miller | ab8a4da | 1999-12-16 13:05:30 +1100 | [diff] [blame] | 240 | If you have configured OpenSSH with EGD support, ensure that EGD is |
| 241 | running and has collected some Entropy. |
| 242 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 243 | For more information on configuration, please refer to the manual pages |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 244 | for sshd, ssh and ssh-agent. |
| 245 | |
Darren Tucker | 72c025d | 2005-01-18 12:05:18 +1100 | [diff] [blame] | 246 | 4. (Optional) Send survey |
| 247 | ------------------------- |
| 248 | |
| 249 | $ make survey |
Darren Tucker | 3eb4834 | 2006-06-23 21:05:12 +1000 | [diff] [blame] | 250 | [check the contents of the file "survey" to ensure there's no information |
| 251 | that you consider sensitive] |
Darren Tucker | 72c025d | 2005-01-18 12:05:18 +1100 | [diff] [blame] | 252 | $ make send-survey |
| 253 | |
| 254 | This will send configuration information for the currently configured |
| 255 | host to a survey address. This will help determine which configurations |
| 256 | are actually in use, and what valid combinations of configure options |
| 257 | exist. The raw data is available only to the OpenSSH developers, however |
| 258 | summary data may be published. |
| 259 | |
| 260 | 5. Problems? |
Damien Miller | 6ae00d6 | 1999-12-14 15:43:03 +1100 | [diff] [blame] | 261 | ------------ |
| 262 | |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 263 | If you experience problems compiling, installing or running OpenSSH. |
Damien Miller | 6ae00d6 | 1999-12-14 15:43:03 +1100 | [diff] [blame] | 264 | Please refer to the "reporting bugs" section of the webpage at |
Damien Miller | 615f939 | 2000-05-17 22:53:33 +1000 | [diff] [blame] | 265 | http://www.openssh.com/ |
Damien Miller | 6ae00d6 | 1999-12-14 15:43:03 +1100 | [diff] [blame] | 266 | |
Damien Miller | e9cf357 | 2001-02-09 12:55:35 +1100 | [diff] [blame] | 267 | |
Darren Tucker | ad7d23d | 2014-09-09 12:23:10 +1000 | [diff] [blame] | 268 | $Id: INSTALL,v 1.91 2014/09/09 02:23:11 dtucker Exp $ |