blob: 6778a288121df9aebecc4c9f5ae2afac92a91075 [file] [log] [blame]
Damien Millerb5f89271999-11-12 14:35:58 +110011. Prerequisites
2----------------
3
4You will need working installations of Zlib and OpenSSL.
5
6Zlib:
Damien Miller615f9392000-05-17 22:53:33 +10007http://www.freesoftware.com/pub/infozip/zlib/
Damien Millerb5f89271999-11-12 14:35:58 +11008
Damien Millerc998f9e2000-04-30 09:43:41 +10009OpenSSL 0.9.5a or greater:
Damien Millerb5f89271999-11-12 14:35:58 +110010http://www.openssl.org/
11
Damien Miller86093322001-02-18 12:58:24 +110012RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support.
13For Red Hat Linux 6.2, they have been released as errata. RHL7 includes
14these.
Damien Millere71eb912000-04-13 12:19:32 +100015
Damien Millerb5f89271999-11-12 14:35:58 +110016OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
Kevin Stevesdf4a7ae2000-11-07 14:47:51 +000017supports it. PAM is standard on Redhat and Debian Linux, Solaris and
18HP-UX 11.
Damien Millerb5f89271999-11-12 14:35:58 +110019
20PAM:
21http://www.kernel.org/pub/linux/libs/pam/
22
Damien Miller780b3761999-12-26 13:36:11 +110023If you wish to build the GNOME passphrase requester, you will need the GNOME
Damien Millerb5f89271999-11-12 14:35:58 +110024libraries and headers.
25
26GNOME:
27http://www.gnome.org/
28
Damien Millerf1aa21f2001-01-05 09:30:32 +110029Alternatively, Jim Knoble <jmknoble@jmknoble.cx> has written an excellent X11
Damien Miller7d7c60d2000-01-26 14:37:48 +110030passphrase requester. This is maintained separately at:
Damien Miller780b3761999-12-26 13:36:11 +110031
Damien Miller0e1cf7c2000-01-26 12:15:30 +110032http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
Damien Miller780b3761999-12-26 13:36:11 +110033
Damien Miller0736c4d2001-01-25 10:51:46 +110034PRNGD:
35
36If your system lacks Kernel based random collection, the use of Lutz
37Jaenicke's PRNGd is recommended.
38
39http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
40
41EGD:
42
Damien Miller54057c22000-05-09 15:03:37 +100043The Entropy Gathering Daemon (EGD) is supported if you have a system which
44lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
Damien Millerb5f89271999-11-12 14:35:58 +110045
Damien Millerb5f89271999-11-12 14:35:58 +110046http://www.lothar.com/tech/crypto/
47
Damien Miller4d2f15f1999-11-23 12:36:29 +110048GNU Make:
49ftp://ftp.gnu.org/gnu/make/
50
51OpenSSH has only been tested with GNU make. It may work with other
52'make' programs, but you are on your own.
Damien Millerb5f89271999-11-12 14:35:58 +110053
Damien Millerf1720202001-02-12 11:15:41 +110054PCRE (PERL-compatible Regular Expression library):
Ben Lindstromb5628642000-10-18 00:02:25 +000055ftp://ftp.cus.cam.ac.uk/pub/software/programs/pcre/
Ben Lindstromca1c2a02000-10-14 21:33:19 +000056
Damien Millerf1720202001-02-12 11:15:41 +110057Most platforms do not require this. However older Unices may not have a
58posix regex library. PCRE provides a POSIX interface.
Ben Lindstromca1c2a02000-10-14 21:33:19 +000059
Ben Lindstrom305fb002000-11-10 02:41:30 +000060S/Key Libraries:
61http://www.sparc.spb.su/solaris/skey/
62
63If you wish to use --with-skey then you will need the above library
64installed. No other current S/Key library is currently known to be
Ben Lindstromdcca9812000-11-10 03:28:31 +000065supported.
Ben Lindstromca1c2a02000-10-14 21:33:19 +000066
Damien Millerb5f89271999-11-12 14:35:58 +1100672. Building / Installation
68--------------------------
69
70To install OpenSSH with default options:
71
72./configure
73make
74make install
75
76This will install the OpenSSH binaries in /usr/local/bin, configuration files
77in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
78installation prefix, use the --prefix option to configure:
79
80./configure --prefix=/opt
81make
82make install
83
84Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
85specific paths, for example:
86
87./configure --prefix=/opt --sysconfdir=/etc/ssh
88make
89make install
90
91This will install the binaries in /opt/{bin,lib,sbin}, but will place the
92configuration files in /etc/ssh.
93
Kevin Stevesdf4a7ae2000-11-07 14:47:51 +000094If you are using PAM, you may need to manually install a PAM
Damien Millerfd263682000-03-16 11:51:09 +110095control file as "/etc/pam.d/sshd" (or wherever your system
96prefers to keep them). A generic PAM configuration is included as
97"contrib/sshd.pam.generic", you may need to edit it before using it on
Damien Miller86093322001-02-18 12:58:24 +110098your system. If you are using a recent version of Red Hat Linux, the
Damien Millerc601a752000-06-10 08:33:38 +100099config file in contrib/redhat/sshd.pam should be more useful.
100Failure to install a valid PAM file may result in an inability to
Kevin Stevesdf4a7ae2000-11-07 14:47:51 +0000101use password authentication. On HP-UX 11, the standard /etc/pam.conf
102configuration will work with sshd (sshd will match the OTHER service
103name).
Damien Miller755c90c1999-11-22 16:12:31 +1100104
Damien Millerb5f89271999-11-12 14:35:58 +1100105There are a few other options to the configure script:
106
Damien Miller8bdeee21999-12-30 15:50:54 +1100107--with-rsh=PATH allows you to specify the path to your rsh program.
108Normally ./configure will search the current $PATH for 'rsh'. You
109may need to specify this option if rsh is not in your path or has a
110different name.
111
Damien Miller86093322001-02-18 12:58:24 +1100112--with-pam enables PAM support.
Damien Miller8bdeee21999-12-30 15:50:54 +1100113
Damien Millerc0967271999-11-19 15:53:50 +1100114--enable-gnome-askpass will build the GNOME passphrase dialog. You
115need a working installation of GNOME, including the development
116headers, for this to work.
Damien Millerb5f89271999-11-12 14:35:58 +1100117
Damien Millerc0967271999-11-19 15:53:50 +1100118--with-random=/some/file allows you to specify an alternate source of
Damien Miller615f9392000-05-17 22:53:33 +1000119random numbers (the default is /dev/urandom). Unless you are absolutely
Damien Millerb5f89271999-11-12 14:35:58 +1100120sure of what you are doing, it is best to leave this alone.
121
Damien Millerd0ccb982001-03-04 00:29:20 +1100122--with-prngd-socket=/some/file allows you to enable EGD or PRNGD
123support and to specify a PRNGd socket. Use this if your Unix lacks
124/dev/random and you don't want to use OpenSSH's builtin entropy
125collection support.
126
127--with-prngd-port=portnum allows you to enable EGD or PRNGD support
128and to specify a EGD localhost TCP port. Use this if your Unix lacks
Damien Miller0736c4d2001-01-25 10:51:46 +1100129/dev/random and you don't want to use OpenSSH's builtin entropy
130collection support.
Damien Millerb5f89271999-11-12 14:35:58 +1100131
Damien Miller8bdeee21999-12-30 15:50:54 +1100132--with-lastlog=FILE will specify the location of the lastlog file.
133./configure searches a few locations for lastlog, but may not find
134it if lastlog is installed in a different place.
135
136--without-lastlog will disable lastlog support entirely.
137
Damien Miller105b7f02000-01-07 08:45:55 +1100138--with-kerberos4=PATH will enable Kerberos IV support. You will need
139to have the Kerberos libraries and header files installed for this
140to work. Use the optional PATH argument to specify the root of your
141Kerberos installation.
Damien Millerc0967271999-11-19 15:53:50 +1100142
Damien Miller105b7f02000-01-07 08:45:55 +1100143--with-afs=PATH will enable AFS support. You will need to have the
144Kerberos IV and the AFS libraries and header files installed for this
145to work. Use the optional PATH argument to specify the root of your
146AFS installation. AFS requires Kerberos support to be enabled.
Damien Millerc0967271999-11-19 15:53:50 +1100147
Ben Lindstrom305fb002000-11-10 02:41:30 +0000148--with-skey=PATH will enable S/Key one time password support. You will
149need the S/Key libraries and header files installed for this to work.
Damien Millerc0967271999-11-19 15:53:50 +1100150
151--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
152support. You will need libwrap.a and tcpd.h installed.
153
154--with-md5-passwords will enable the use of MD5 passwords. Enable this
155if your operating system uses MD5 passwords without using PAM.
Damien Miller3d1b22c1999-11-12 15:46:08 +1100156
Damien Miller8bdeee21999-12-30 15:50:54 +1100157--with-utmpx enables utmpx support. utmpx support is automatic for
158some 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 Miller29ea30d2000-03-17 10:54:15 +1100166started by sshd. This replaces the standard path entirely.
Damien Miller8bdeee21999-12-30 15:50:54 +1100167
Damien Miller5eed6a22000-01-16 12:05:18 +1100168--with-pid-dir=PATH specifies the directory in which the ssh.pid file is
169created.
170
171--with-xauth=PATH specifies the location of the xauth binary
172
Damien Miller7d80e342000-01-19 14:36:49 +1100173--with-ipv4-default instructs OpenSSH to use IPv4 by default for new
174connections. Normally OpenSSH will try attempt to lookup both IPv6 and
175IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
176resolution. If this option is specified, you can still attempt to
177connect to IPv6 addresses using the command line option '-6'.
178
Damien Miller0c0e4bf2000-02-03 13:58:51 +1100179--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
180are installed.
181
Damien Millerfd263682000-03-16 11:51:09 +1100182--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
183real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
184
Damien Millerbeb4ba51999-12-28 15:09:35 +1100185If you need to pass special options to the compiler or linker, you
Damien Miller615f9392000-05-17 22:53:33 +1000186can specify these as environment variables before running ./configure.
Damien Millerbeb4ba51999-12-28 15:09:35 +1100187For example:
188
Damien Millerb5c42d92000-08-31 11:13:10 +1100189CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
Damien Millerb5f89271999-11-12 14:35:58 +1100190
1913. Configuration
192----------------
193
194The runtime configuration files are installed by in ${prefix}/etc or
195whatever you specified as your --sysconfdir (/usr/local/etc by default).
196
197The default configuration should be instantly usable, though you should
198review it to ensure that it matches your security requirements.
199
Damien Miller4095f892000-03-03 22:13:52 +1100200To generate a host key, run "make host-key". Alternately you can do so
Damien Millerc601a752000-06-10 08:33:38 +1000201manually using the following commands:
Damien Miller2a9d9f61999-11-15 23:34:11 +1100202
Damien Miller86093322001-02-18 12:58:24 +1100203 ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
204 ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
205 ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
Damien Miller2a9d9f61999-11-15 23:34:11 +1100206
Damien Miller6ae00d61999-12-14 15:43:03 +1100207Replacing /etc/ssh with the correct path to the configuration directory.
208(${prefix}/etc or whatever you specified with --sysconfdir during
209configuration)
210
Damien Millerab8a4da1999-12-16 13:05:30 +1100211If you have configured OpenSSH with EGD support, ensure that EGD is
212running and has collected some Entropy.
213
Damien Millerb5f89271999-11-12 14:35:58 +1100214For more information on configuration, please refer to the manual pages
215for sshd, ssh and ssh-agent.
216
Damien Miller6ae00d61999-12-14 15:43:03 +11002174. Problems?
218------------
219
220If you experience problems compiling, installing or running OpenSSH.
221Please refer to the "reporting bugs" section of the webpage at
Damien Miller615f9392000-05-17 22:53:33 +1000222http://www.openssh.com/
Damien Miller6ae00d61999-12-14 15:43:03 +1100223
Damien Millere9cf3572001-02-09 12:55:35 +1100224
Damien Millerd0ccb982001-03-04 00:29:20 +1100225$Id: INSTALL,v 1.42 2001/03/03 13:29:21 djm Exp $