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