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 | |
| 6 | Zlib: |
Ben Lindstrom | 1cd6fef | 2001-06-29 12:39:23 +0000 | [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 | 0572035 | 2002-05-13 15:22:21 +1000 | [diff] [blame^] | 12 | (OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1 |
| 13 | Blowfish included) do not work correctly.) |
| 14 | |
Damien Miller | 8609332 | 2001-02-18 12:58:24 +1100 | [diff] [blame] | 15 | RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support. |
| 16 | For Red Hat Linux 6.2, they have been released as errata. RHL7 includes |
| 17 | these. |
Damien Miller | e71eb91 | 2000-04-13 12:19:32 +1000 | [diff] [blame] | 18 | |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 19 | OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system |
Kevin Steves | df4a7ae | 2000-11-07 14:47:51 +0000 | [diff] [blame] | 20 | supports it. PAM is standard on Redhat and Debian Linux, Solaris and |
| 21 | HP-UX 11. |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 22 | |
Damien Miller | bd63874 | 2002-04-17 12:22:58 +1000 | [diff] [blame] | 23 | NB. If you operating system supports /dev/random, you should configure |
| 24 | OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of |
| 25 | /dev/random. If you don't you will have to rely on ssh-rand-helper, which |
| 26 | is inferior to a good kernel-based solution. |
| 27 | |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 28 | PAM: |
| 29 | http://www.kernel.org/pub/linux/libs/pam/ |
| 30 | |
Damien Miller | 780b376 | 1999-12-26 13:36:11 +1100 | [diff] [blame] | 31 | If you wish to build the GNOME passphrase requester, you will need the GNOME |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 32 | libraries and headers. |
| 33 | |
| 34 | GNOME: |
| 35 | http://www.gnome.org/ |
| 36 | |
Damien Miller | f1aa21f | 2001-01-05 09:30:32 +1100 | [diff] [blame] | 37 | Alternatively, Jim Knoble <jmknoble@jmknoble.cx> has written an excellent X11 |
Damien Miller | 7d7c60d | 2000-01-26 14:37:48 +1100 | [diff] [blame] | 38 | passphrase requester. This is maintained separately at: |
Damien Miller | 780b376 | 1999-12-26 13:36:11 +1100 | [diff] [blame] | 39 | |
Damien Miller | 0e1cf7c | 2000-01-26 12:15:30 +1100 | [diff] [blame] | 40 | http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html |
Damien Miller | 780b376 | 1999-12-26 13:36:11 +1100 | [diff] [blame] | 41 | |
Damien Miller | 0736c4d | 2001-01-25 10:51:46 +1100 | [diff] [blame] | 42 | PRNGD: |
| 43 | |
| 44 | If your system lacks Kernel based random collection, the use of Lutz |
| 45 | Jaenicke's PRNGd is recommended. |
| 46 | |
| 47 | http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html |
| 48 | |
| 49 | EGD: |
| 50 | |
Damien Miller | 54057c2 | 2000-05-09 15:03:37 +1000 | [diff] [blame] | 51 | The Entropy Gathering Daemon (EGD) is supported if you have a system which |
| 52 | 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] | 53 | |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 54 | http://www.lothar.com/tech/crypto/ |
| 55 | |
Ben Lindstrom | 305fb00 | 2000-11-10 02:41:30 +0000 | [diff] [blame] | 56 | S/Key Libraries: |
| 57 | http://www.sparc.spb.su/solaris/skey/ |
| 58 | |
| 59 | If you wish to use --with-skey then you will need the above library |
| 60 | installed. No other current S/Key library is currently known to be |
Ben Lindstrom | dcca981 | 2000-11-10 03:28:31 +0000 | [diff] [blame] | 61 | supported. |
Ben Lindstrom | ca1c2a0 | 2000-10-14 21:33:19 +0000 | [diff] [blame] | 62 | |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 63 | 2. Building / Installation |
| 64 | -------------------------- |
| 65 | |
| 66 | To install OpenSSH with default options: |
| 67 | |
| 68 | ./configure |
| 69 | make |
| 70 | make install |
| 71 | |
| 72 | This will install the OpenSSH binaries in /usr/local/bin, configuration files |
| 73 | in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different |
| 74 | installation prefix, use the --prefix option to configure: |
| 75 | |
| 76 | ./configure --prefix=/opt |
| 77 | make |
| 78 | make install |
| 79 | |
| 80 | Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override |
| 81 | specific paths, for example: |
| 82 | |
| 83 | ./configure --prefix=/opt --sysconfdir=/etc/ssh |
| 84 | make |
| 85 | make install |
| 86 | |
| 87 | This will install the binaries in /opt/{bin,lib,sbin}, but will place the |
| 88 | configuration files in /etc/ssh. |
| 89 | |
Kevin Steves | 32c97c3 | 2001-04-20 20:56:21 +0000 | [diff] [blame] | 90 | If you are using PAM, you may need to manually install a PAM control |
| 91 | file as "/etc/pam.d/sshd" (or wherever your system prefers to keep |
| 92 | them). Note that the service name used to start PAM is __progname, |
| 93 | which is the basename of the path of your sshd (e.g., the service name |
| 94 | for /usr/sbin/osshd will be osshd). If you have renamed your sshd |
| 95 | executable, your PAM configuration may need to be modified. |
| 96 | |
| 97 | A generic PAM configuration is included as "contrib/sshd.pam.generic", |
| 98 | you may need to edit it before using it on your system. If you are |
| 99 | using a recent version of Red Hat Linux, the config file in |
| 100 | contrib/redhat/sshd.pam should be more useful. Failure to install a |
| 101 | valid PAM file may result in an inability to use password |
| 102 | authentication. On HP-UX 11 and Solaris, the standard /etc/pam.conf |
| 103 | configuration will work with sshd (sshd will match the other service |
Kevin Steves | df4a7ae | 2000-11-07 14:47:51 +0000 | [diff] [blame] | 104 | name). |
Damien Miller | 755c90c | 1999-11-22 16:12:31 +1100 | [diff] [blame] | 105 | |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 106 | There are a few other options to the configure script: |
| 107 | |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 108 | --with-rsh=PATH allows you to specify the path to your rsh program. |
| 109 | Normally ./configure will search the current $PATH for 'rsh'. You |
| 110 | may need to specify this option if rsh is not in your path or has a |
| 111 | different name. |
| 112 | |
Damien Miller | 8609332 | 2001-02-18 12:58:24 +1100 | [diff] [blame] | 113 | --with-pam enables PAM support. |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 114 | |
Damien Miller | c096727 | 1999-11-19 15:53:50 +1100 | [diff] [blame] | 115 | --enable-gnome-askpass will build the GNOME passphrase dialog. You |
| 116 | need a working installation of GNOME, including the development |
| 117 | headers, for this to work. |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 118 | |
Damien Miller | d0ccb98 | 2001-03-04 00:29:20 +1100 | [diff] [blame] | 119 | --with-prngd-socket=/some/file allows you to enable EGD or PRNGD |
| 120 | support and to specify a PRNGd socket. Use this if your Unix lacks |
| 121 | /dev/random and you don't want to use OpenSSH's builtin entropy |
| 122 | collection support. |
| 123 | |
| 124 | --with-prngd-port=portnum allows you to enable EGD or PRNGD support |
| 125 | and to specify a EGD localhost TCP port. Use this if your Unix lacks |
Damien Miller | 0736c4d | 2001-01-25 10:51:46 +1100 | [diff] [blame] | 126 | /dev/random and you don't want to use OpenSSH's builtin entropy |
| 127 | collection support. |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 128 | |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 129 | --with-lastlog=FILE will specify the location of the lastlog file. |
| 130 | ./configure searches a few locations for lastlog, but may not find |
| 131 | it if lastlog is installed in a different place. |
| 132 | |
| 133 | --without-lastlog will disable lastlog support entirely. |
| 134 | |
Ben Lindstrom | 72af2ef | 2001-05-08 20:42:28 +0000 | [diff] [blame] | 135 | --with-sia, --without-sia will enable or disable OSF1's Security |
| 136 | Integration Architecture. The default for OSF1 machines is enable. |
| 137 | |
Damien Miller | 105b7f0 | 2000-01-07 08:45:55 +1100 | [diff] [blame] | 138 | --with-kerberos4=PATH will enable Kerberos IV support. You will need |
| 139 | to have the Kerberos libraries and header files installed for this |
| 140 | to work. Use the optional PATH argument to specify the root of your |
| 141 | Kerberos installation. |
Damien Miller | c096727 | 1999-11-19 15:53:50 +1100 | [diff] [blame] | 142 | |
Damien Miller | 105b7f0 | 2000-01-07 08:45:55 +1100 | [diff] [blame] | 143 | --with-afs=PATH will enable AFS support. You will need to have the |
| 144 | Kerberos IV and the AFS libraries and header files installed for this |
| 145 | to work. Use the optional PATH argument to specify the root of your |
| 146 | AFS installation. AFS requires Kerberos support to be enabled. |
Damien Miller | c096727 | 1999-11-19 15:53:50 +1100 | [diff] [blame] | 147 | |
Ben Lindstrom | 305fb00 | 2000-11-10 02:41:30 +0000 | [diff] [blame] | 148 | --with-skey=PATH will enable S/Key one time password support. You will |
| 149 | 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] | 150 | |
| 151 | --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny) |
| 152 | support. You will need libwrap.a and tcpd.h installed. |
| 153 | |
| 154 | --with-md5-passwords will enable the use of MD5 passwords. Enable this |
| 155 | if your operating system uses MD5 passwords without using PAM. |
Damien Miller | 3d1b22c | 1999-11-12 15:46:08 +1100 | [diff] [blame] | 156 | |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 157 | --with-utmpx enables utmpx support. utmpx support is automatic for |
| 158 | some platforms. |
| 159 | |
| 160 | --without-shadow disables shadow password support. |
| 161 | |
| 162 | --with-ipaddr-display forces the use of a numeric IP address in the |
| 163 | $DISPLAY environment variable. Some broken systems need this. |
| 164 | |
| 165 | --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] | 166 | started by sshd. This replaces the standard path entirely. |
Damien Miller | 8bdeee2 | 1999-12-30 15:50:54 +1100 | [diff] [blame] | 167 | |
Damien Miller | 5eed6a2 | 2000-01-16 12:05:18 +1100 | [diff] [blame] | 168 | --with-pid-dir=PATH specifies the directory in which the ssh.pid file is |
| 169 | created. |
| 170 | |
| 171 | --with-xauth=PATH specifies the location of the xauth binary |
| 172 | |
Damien Miller | 7d80e34 | 2000-01-19 14:36:49 +1100 | [diff] [blame] | 173 | --with-ipv4-default instructs OpenSSH to use IPv4 by default for new |
| 174 | connections. Normally OpenSSH will try attempt to lookup both IPv6 and |
| 175 | IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name |
| 176 | resolution. If this option is specified, you can still attempt to |
| 177 | connect to IPv6 addresses using the command line option '-6'. |
| 178 | |
Damien Miller | 0c0e4bf | 2000-02-03 13:58:51 +1100 | [diff] [blame] | 179 | --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries |
| 180 | are installed. |
| 181 | |
Damien Miller | fd26368 | 2000-03-16 11:51:09 +1100 | [diff] [blame] | 182 | --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to |
| 183 | real (AF_INET) IPv4 addresses. Works around some quirks on Linux. |
| 184 | |
Ben Lindstrom | a42694f | 2002-04-05 16:11:45 +0000 | [diff] [blame] | 185 | --with-opensc=DIR |
| 186 | --with-sectok=DIR allows for OpenSC or sectok smartcard libraries to |
| 187 | be used with OpenSSH. See 'README.smartcard' for more details. |
| 188 | |
Damien Miller | beb4ba5 | 1999-12-28 15:09:35 +1100 | [diff] [blame] | 189 | 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] | 190 | can specify these as environment variables before running ./configure. |
Damien Miller | beb4ba5 | 1999-12-28 15:09:35 +1100 | [diff] [blame] | 191 | For example: |
| 192 | |
Damien Miller | b5c42d9 | 2000-08-31 11:13:10 +1100 | [diff] [blame] | 193 | CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 194 | |
| 195 | 3. Configuration |
| 196 | ---------------- |
| 197 | |
| 198 | The runtime configuration files are installed by in ${prefix}/etc or |
| 199 | whatever you specified as your --sysconfdir (/usr/local/etc by default). |
| 200 | |
| 201 | The default configuration should be instantly usable, though you should |
| 202 | review it to ensure that it matches your security requirements. |
| 203 | |
Damien Miller | 4095f89 | 2000-03-03 22:13:52 +1100 | [diff] [blame] | 204 | To generate a host key, run "make host-key". Alternately you can do so |
Damien Miller | c601a75 | 2000-06-10 08:33:38 +1000 | [diff] [blame] | 205 | manually using the following commands: |
Damien Miller | 2a9d9f6 | 1999-11-15 23:34:11 +1100 | [diff] [blame] | 206 | |
Damien Miller | 8609332 | 2001-02-18 12:58:24 +1100 | [diff] [blame] | 207 | ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N "" |
| 208 | ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N "" |
| 209 | ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N "" |
Damien Miller | 2a9d9f6 | 1999-11-15 23:34:11 +1100 | [diff] [blame] | 210 | |
Damien Miller | 6ae00d6 | 1999-12-14 15:43:03 +1100 | [diff] [blame] | 211 | Replacing /etc/ssh with the correct path to the configuration directory. |
| 212 | (${prefix}/etc or whatever you specified with --sysconfdir during |
| 213 | configuration) |
| 214 | |
Damien Miller | ab8a4da | 1999-12-16 13:05:30 +1100 | [diff] [blame] | 215 | If you have configured OpenSSH with EGD support, ensure that EGD is |
| 216 | running and has collected some Entropy. |
| 217 | |
Damien Miller | b5f8927 | 1999-11-12 14:35:58 +1100 | [diff] [blame] | 218 | For more information on configuration, please refer to the manual pages |
| 219 | for sshd, ssh and ssh-agent. |
| 220 | |
Damien Miller | 6ae00d6 | 1999-12-14 15:43:03 +1100 | [diff] [blame] | 221 | 4. Problems? |
| 222 | ------------ |
| 223 | |
| 224 | If you experience problems compiling, installing or running OpenSSH. |
| 225 | Please refer to the "reporting bugs" section of the webpage at |
Damien Miller | 615f939 | 2000-05-17 22:53:33 +1000 | [diff] [blame] | 226 | http://www.openssh.com/ |
Damien Miller | 6ae00d6 | 1999-12-14 15:43:03 +1100 | [diff] [blame] | 227 | |
Damien Miller | e9cf357 | 2001-02-09 12:55:35 +1100 | [diff] [blame] | 228 | |
Damien Miller | 0572035 | 2002-05-13 15:22:21 +1000 | [diff] [blame^] | 229 | $Id: INSTALL,v 1.53 2002/05/13 05:22:21 djm Exp $ |