blob: 3fa9378b1c7f2b24d6f0ed591c0e3b0d6103b6b5 [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 Lindstroma4c02d82001-04-28 16:32:10 +000055ftp://ftp.cus.cam.ac.uk/pub/software/programing/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 Steves32c97c32001-04-20 20:56:21 +000094If you are using PAM, you may need to manually install a PAM control
95file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
96them). Note that the service name used to start PAM is __progname,
97which is the basename of the path of your sshd (e.g., the service name
98for /usr/sbin/osshd will be osshd). If you have renamed your sshd
99executable, your PAM configuration may need to be modified.
100
101A generic PAM configuration is included as "contrib/sshd.pam.generic",
102you may need to edit it before using it on your system. If you are
103using a recent version of Red Hat Linux, the config file in
104contrib/redhat/sshd.pam should be more useful. Failure to install a
105valid PAM file may result in an inability to use password
106authentication. On HP-UX 11 and Solaris, the standard /etc/pam.conf
107configuration will work with sshd (sshd will match the other service
Kevin Stevesdf4a7ae2000-11-07 14:47:51 +0000108name).
Damien Miller755c90c1999-11-22 16:12:31 +1100109
Damien Millerb5f89271999-11-12 14:35:58 +1100110There are a few other options to the configure script:
111
Damien Miller8bdeee21999-12-30 15:50:54 +1100112--with-rsh=PATH allows you to specify the path to your rsh program.
113Normally ./configure will search the current $PATH for 'rsh'. You
114may need to specify this option if rsh is not in your path or has a
115different name.
116
Damien Miller86093322001-02-18 12:58:24 +1100117--with-pam enables PAM support.
Damien Miller8bdeee21999-12-30 15:50:54 +1100118
Damien Millerc0967271999-11-19 15:53:50 +1100119--enable-gnome-askpass will build the GNOME passphrase dialog. You
120need a working installation of GNOME, including the development
121headers, for this to work.
Damien Millerb5f89271999-11-12 14:35:58 +1100122
Damien Millerc0967271999-11-19 15:53:50 +1100123--with-random=/some/file allows you to specify an alternate source of
Damien Miller615f9392000-05-17 22:53:33 +1000124random numbers (the default is /dev/urandom). Unless you are absolutely
Damien Millerb5f89271999-11-12 14:35:58 +1100125sure of what you are doing, it is best to leave this alone.
126
Damien Millerd0ccb982001-03-04 00:29:20 +1100127--with-prngd-socket=/some/file allows you to enable EGD or PRNGD
128support and to specify a PRNGd socket. Use this if your Unix lacks
129/dev/random and you don't want to use OpenSSH's builtin entropy
130collection support.
131
132--with-prngd-port=portnum allows you to enable EGD or PRNGD support
133and to specify a EGD localhost TCP port. Use this if your Unix lacks
Damien Miller0736c4d2001-01-25 10:51:46 +1100134/dev/random and you don't want to use OpenSSH's builtin entropy
135collection support.
Damien Millerb5f89271999-11-12 14:35:58 +1100136
Damien Miller8bdeee21999-12-30 15:50:54 +1100137--with-lastlog=FILE will specify the location of the lastlog file.
138./configure searches a few locations for lastlog, but may not find
139it if lastlog is installed in a different place.
140
141--without-lastlog will disable lastlog support entirely.
142
Damien Miller105b7f02000-01-07 08:45:55 +1100143--with-kerberos4=PATH will enable Kerberos IV support. You will need
144to have the Kerberos libraries and header files installed for this
145to work. Use the optional PATH argument to specify the root of your
146Kerberos installation.
Damien Millerc0967271999-11-19 15:53:50 +1100147
Damien Miller105b7f02000-01-07 08:45:55 +1100148--with-afs=PATH will enable AFS support. You will need to have the
149Kerberos IV and the AFS libraries and header files installed for this
150to work. Use the optional PATH argument to specify the root of your
151AFS installation. AFS requires Kerberos support to be enabled.
Damien Millerc0967271999-11-19 15:53:50 +1100152
Ben Lindstrom305fb002000-11-10 02:41:30 +0000153--with-skey=PATH will enable S/Key one time password support. You will
154need the S/Key libraries and header files installed for this to work.
Damien Millerc0967271999-11-19 15:53:50 +1100155
156--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
157support. You will need libwrap.a and tcpd.h installed.
158
159--with-md5-passwords will enable the use of MD5 passwords. Enable this
160if your operating system uses MD5 passwords without using PAM.
Damien Miller3d1b22c1999-11-12 15:46:08 +1100161
Damien Miller8bdeee21999-12-30 15:50:54 +1100162--with-utmpx enables utmpx support. utmpx support is automatic for
163some platforms.
164
165--without-shadow disables shadow password support.
166
167--with-ipaddr-display forces the use of a numeric IP address in the
168$DISPLAY environment variable. Some broken systems need this.
169
170--with-default-path=PATH allows you to specify a default $PATH for sessions
Damien Miller29ea30d2000-03-17 10:54:15 +1100171started by sshd. This replaces the standard path entirely.
Damien Miller8bdeee21999-12-30 15:50:54 +1100172
Damien Miller5eed6a22000-01-16 12:05:18 +1100173--with-pid-dir=PATH specifies the directory in which the ssh.pid file is
174created.
175
176--with-xauth=PATH specifies the location of the xauth binary
177
Damien Miller7d80e342000-01-19 14:36:49 +1100178--with-ipv4-default instructs OpenSSH to use IPv4 by default for new
179connections. Normally OpenSSH will try attempt to lookup both IPv6 and
180IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
181resolution. If this option is specified, you can still attempt to
182connect to IPv6 addresses using the command line option '-6'.
183
Damien Miller0c0e4bf2000-02-03 13:58:51 +1100184--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
185are installed.
186
Damien Millerfd263682000-03-16 11:51:09 +1100187--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
188real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
189
Damien Millerbeb4ba51999-12-28 15:09:35 +1100190If you need to pass special options to the compiler or linker, you
Damien Miller615f9392000-05-17 22:53:33 +1000191can specify these as environment variables before running ./configure.
Damien Millerbeb4ba51999-12-28 15:09:35 +1100192For example:
193
Damien Millerb5c42d92000-08-31 11:13:10 +1100194CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
Damien Millerb5f89271999-11-12 14:35:58 +1100195
1963. Configuration
197----------------
198
199The runtime configuration files are installed by in ${prefix}/etc or
200whatever you specified as your --sysconfdir (/usr/local/etc by default).
201
202The default configuration should be instantly usable, though you should
203review it to ensure that it matches your security requirements.
204
Damien Miller4095f892000-03-03 22:13:52 +1100205To generate a host key, run "make host-key". Alternately you can do so
Damien Millerc601a752000-06-10 08:33:38 +1000206manually using the following commands:
Damien Miller2a9d9f61999-11-15 23:34:11 +1100207
Damien Miller86093322001-02-18 12:58:24 +1100208 ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
209 ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
210 ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
Damien Miller2a9d9f61999-11-15 23:34:11 +1100211
Damien Miller6ae00d61999-12-14 15:43:03 +1100212Replacing /etc/ssh with the correct path to the configuration directory.
213(${prefix}/etc or whatever you specified with --sysconfdir during
214configuration)
215
Damien Millerab8a4da1999-12-16 13:05:30 +1100216If you have configured OpenSSH with EGD support, ensure that EGD is
217running and has collected some Entropy.
218
Damien Millerb5f89271999-11-12 14:35:58 +1100219For more information on configuration, please refer to the manual pages
220for sshd, ssh and ssh-agent.
221
Damien Miller6ae00d61999-12-14 15:43:03 +11002224. Problems?
223------------
224
225If you experience problems compiling, installing or running OpenSSH.
226Please refer to the "reporting bugs" section of the webpage at
Damien Miller615f9392000-05-17 22:53:33 +1000227http://www.openssh.com/
Damien Miller6ae00d61999-12-14 15:43:03 +1100228
Damien Millere9cf3572001-02-09 12:55:35 +1100229
Ben Lindstroma4c02d82001-04-28 16:32:10 +0000230$Id: INSTALL,v 1.44 2001/04/28 16:32:11 mouring Exp $