blob: 9159248cbc9fc3ad9133581e96880f5fa10422d3 [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:
Ben Lindstrom1cd6fef2001-06-29 12:39:23 +00007http://www.gzip.org/zlib/
Damien Millerb5f89271999-11-12 14:35:58 +11008
Ben Lindstromdc163542002-03-07 17:49:39 +00009OpenSSL 0.9.6 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
Ben Lindstrom305fb002000-11-10 02:41:30 +000048S/Key Libraries:
49http://www.sparc.spb.su/solaris/skey/
50
51If you wish to use --with-skey then you will need the above library
52installed. No other current S/Key library is currently known to be
Ben Lindstromdcca9812000-11-10 03:28:31 +000053supported.
Ben Lindstromca1c2a02000-10-14 21:33:19 +000054
Damien Millerb5f89271999-11-12 14:35:58 +1100552. Building / Installation
56--------------------------
57
58To install OpenSSH with default options:
59
60./configure
61make
62make install
63
64This will install the OpenSSH binaries in /usr/local/bin, configuration files
65in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
66installation prefix, use the --prefix option to configure:
67
68./configure --prefix=/opt
69make
70make install
71
72Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
73specific paths, for example:
74
75./configure --prefix=/opt --sysconfdir=/etc/ssh
76make
77make install
78
79This will install the binaries in /opt/{bin,lib,sbin}, but will place the
80configuration files in /etc/ssh.
81
Kevin Steves32c97c32001-04-20 20:56:21 +000082If you are using PAM, you may need to manually install a PAM control
83file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
84them). Note that the service name used to start PAM is __progname,
85which is the basename of the path of your sshd (e.g., the service name
86for /usr/sbin/osshd will be osshd). If you have renamed your sshd
87executable, your PAM configuration may need to be modified.
88
89A generic PAM configuration is included as "contrib/sshd.pam.generic",
90you may need to edit it before using it on your system. If you are
91using a recent version of Red Hat Linux, the config file in
92contrib/redhat/sshd.pam should be more useful. Failure to install a
93valid PAM file may result in an inability to use password
94authentication. On HP-UX 11 and Solaris, the standard /etc/pam.conf
95configuration will work with sshd (sshd will match the other service
Kevin Stevesdf4a7ae2000-11-07 14:47:51 +000096name).
Damien Miller755c90c1999-11-22 16:12:31 +110097
Damien Millerb5f89271999-11-12 14:35:58 +110098There are a few other options to the configure script:
99
Damien Miller8bdeee21999-12-30 15:50:54 +1100100--with-rsh=PATH allows you to specify the path to your rsh program.
101Normally ./configure will search the current $PATH for 'rsh'. You
102may need to specify this option if rsh is not in your path or has a
103different name.
104
Damien Miller86093322001-02-18 12:58:24 +1100105--with-pam enables PAM support.
Damien Miller8bdeee21999-12-30 15:50:54 +1100106
Damien Millerc0967271999-11-19 15:53:50 +1100107--enable-gnome-askpass will build the GNOME passphrase dialog. You
108need a working installation of GNOME, including the development
109headers, for this to work.
Damien Millerb5f89271999-11-12 14:35:58 +1100110
Damien Millerc0967271999-11-19 15:53:50 +1100111--with-random=/some/file allows you to specify an alternate source of
Damien Miller615f9392000-05-17 22:53:33 +1000112random numbers (the default is /dev/urandom). Unless you are absolutely
Damien Millerb5f89271999-11-12 14:35:58 +1100113sure of what you are doing, it is best to leave this alone.
114
Damien Millerd0ccb982001-03-04 00:29:20 +1100115--with-prngd-socket=/some/file allows you to enable EGD or PRNGD
116support and to specify a PRNGd socket. Use this if your Unix lacks
117/dev/random and you don't want to use OpenSSH's builtin entropy
118collection support.
119
120--with-prngd-port=portnum allows you to enable EGD or PRNGD support
121and to specify a EGD localhost TCP port. Use this if your Unix lacks
Damien Miller0736c4d2001-01-25 10:51:46 +1100122/dev/random and you don't want to use OpenSSH's builtin entropy
123collection support.
Damien Millerb5f89271999-11-12 14:35:58 +1100124
Damien Miller8bdeee21999-12-30 15:50:54 +1100125--with-lastlog=FILE will specify the location of the lastlog file.
126./configure searches a few locations for lastlog, but may not find
127it if lastlog is installed in a different place.
128
129--without-lastlog will disable lastlog support entirely.
130
Ben Lindstrom72af2ef2001-05-08 20:42:28 +0000131--with-sia, --without-sia will enable or disable OSF1's Security
132Integration Architecture. The default for OSF1 machines is enable.
133
Damien Miller105b7f02000-01-07 08:45:55 +1100134--with-kerberos4=PATH will enable Kerberos IV support. You will need
135to have the Kerberos libraries and header files installed for this
136to work. Use the optional PATH argument to specify the root of your
137Kerberos installation.
Damien Millerc0967271999-11-19 15:53:50 +1100138
Damien Miller105b7f02000-01-07 08:45:55 +1100139--with-afs=PATH will enable AFS support. You will need to have the
140Kerberos IV and the AFS libraries and header files installed for this
141to work. Use the optional PATH argument to specify the root of your
142AFS installation. AFS requires Kerberos support to be enabled.
Damien Millerc0967271999-11-19 15:53:50 +1100143
Ben Lindstrom305fb002000-11-10 02:41:30 +0000144--with-skey=PATH will enable S/Key one time password support. You will
145need the S/Key libraries and header files installed for this to work.
Damien Millerc0967271999-11-19 15:53:50 +1100146
147--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
148support. You will need libwrap.a and tcpd.h installed.
149
150--with-md5-passwords will enable the use of MD5 passwords. Enable this
151if your operating system uses MD5 passwords without using PAM.
Damien Miller3d1b22c1999-11-12 15:46:08 +1100152
Damien Miller8bdeee21999-12-30 15:50:54 +1100153--with-utmpx enables utmpx support. utmpx support is automatic for
154some platforms.
155
156--without-shadow disables shadow password support.
157
158--with-ipaddr-display forces the use of a numeric IP address in the
159$DISPLAY environment variable. Some broken systems need this.
160
161--with-default-path=PATH allows you to specify a default $PATH for sessions
Damien Miller29ea30d2000-03-17 10:54:15 +1100162started by sshd. This replaces the standard path entirely.
Damien Miller8bdeee21999-12-30 15:50:54 +1100163
Damien Miller5eed6a22000-01-16 12:05:18 +1100164--with-pid-dir=PATH specifies the directory in which the ssh.pid file is
165created.
166
167--with-xauth=PATH specifies the location of the xauth binary
168
Damien Miller7d80e342000-01-19 14:36:49 +1100169--with-ipv4-default instructs OpenSSH to use IPv4 by default for new
170connections. Normally OpenSSH will try attempt to lookup both IPv6 and
171IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
172resolution. If this option is specified, you can still attempt to
173connect to IPv6 addresses using the command line option '-6'.
174
Damien Miller0c0e4bf2000-02-03 13:58:51 +1100175--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
176are installed.
177
Damien Millerfd263682000-03-16 11:51:09 +1100178--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
179real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
180
Damien Millerbeb4ba51999-12-28 15:09:35 +1100181If you need to pass special options to the compiler or linker, you
Damien Miller615f9392000-05-17 22:53:33 +1000182can specify these as environment variables before running ./configure.
Damien Millerbeb4ba51999-12-28 15:09:35 +1100183For example:
184
Damien Millerb5c42d92000-08-31 11:13:10 +1100185CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
Damien Millerb5f89271999-11-12 14:35:58 +1100186
1873. Configuration
188----------------
189
190The runtime configuration files are installed by in ${prefix}/etc or
191whatever you specified as your --sysconfdir (/usr/local/etc by default).
192
193The default configuration should be instantly usable, though you should
194review it to ensure that it matches your security requirements.
195
Damien Miller4095f892000-03-03 22:13:52 +1100196To generate a host key, run "make host-key". Alternately you can do so
Damien Millerc601a752000-06-10 08:33:38 +1000197manually using the following commands:
Damien Miller2a9d9f61999-11-15 23:34:11 +1100198
Damien Miller86093322001-02-18 12:58:24 +1100199 ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
200 ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
201 ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
Damien Miller2a9d9f61999-11-15 23:34:11 +1100202
Damien Miller6ae00d61999-12-14 15:43:03 +1100203Replacing /etc/ssh with the correct path to the configuration directory.
204(${prefix}/etc or whatever you specified with --sysconfdir during
205configuration)
206
Damien Millerab8a4da1999-12-16 13:05:30 +1100207If you have configured OpenSSH with EGD support, ensure that EGD is
208running and has collected some Entropy.
209
Damien Millerb5f89271999-11-12 14:35:58 +1100210For more information on configuration, please refer to the manual pages
211for sshd, ssh and ssh-agent.
212
Damien Miller6ae00d61999-12-14 15:43:03 +11002134. Problems?
214------------
215
216If you experience problems compiling, installing or running OpenSSH.
217Please refer to the "reporting bugs" section of the webpage at
Damien Miller615f9392000-05-17 22:53:33 +1000218http://www.openssh.com/
Damien Miller6ae00d61999-12-14 15:43:03 +1100219
Damien Millere9cf3572001-02-09 12:55:35 +1100220
Ben Lindstromdc163542002-03-07 17:49:39 +0000221$Id: INSTALL,v 1.49 2002/03/07 17:49:40 mouring Exp $