blob: 340c6d6b7a3e4cb6fac2eaf205321162da14e280 [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 Miller7b63b0f2000-05-20 15:41:26 +100012RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support
Damien Millere71eb912000-04-13 12:19:32 +100013
Damien Millerb5f89271999-11-12 14:35:58 +110014OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
Kevin Stevesdf4a7ae2000-11-07 14:47:51 +000015supports it. PAM is standard on Redhat and Debian Linux, Solaris and
16HP-UX 11.
Damien Millerb5f89271999-11-12 14:35:58 +110017
18PAM:
19http://www.kernel.org/pub/linux/libs/pam/
20
Damien Miller780b3761999-12-26 13:36:11 +110021If you wish to build the GNOME passphrase requester, you will need the GNOME
Damien Millerb5f89271999-11-12 14:35:58 +110022libraries and headers.
23
24GNOME:
25http://www.gnome.org/
26
Damien Miller7d7c60d2000-01-26 14:37:48 +110027Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11
28passphrase requester. This is maintained separately at:
Damien Miller780b3761999-12-26 13:36:11 +110029
Damien Miller0e1cf7c2000-01-26 12:15:30 +110030http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
Damien Miller780b3761999-12-26 13:36:11 +110031
Damien Miller54057c22000-05-09 15:03:37 +100032The Entropy Gathering Daemon (EGD) is supported if you have a system which
33lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
Damien Millerb5f89271999-11-12 14:35:58 +110034
35EGD:
36http://www.lothar.com/tech/crypto/
37
Damien Miller4d2f15f1999-11-23 12:36:29 +110038GNU Make:
39ftp://ftp.gnu.org/gnu/make/
40
41OpenSSH has only been tested with GNU make. It may work with other
42'make' programs, but you are on your own.
Damien Millerb5f89271999-11-12 14:35:58 +110043
Ben Lindstromb5628642000-10-18 00:02:25 +000044pcre (POSIX Regular Expression library):
45ftp://ftp.cus.cam.ac.uk/pub/software/programs/pcre/
Ben Lindstromca1c2a02000-10-14 21:33:19 +000046
47Most platforms do not required this. However older 4.3 BSD do not
48have a posix regex library.
49
Ben Lindstrom305fb002000-11-10 02:41:30 +000050S/Key Libraries:
51http://www.sparc.spb.su/solaris/skey/
52
53If you wish to use --with-skey then you will need the above library
54installed. No other current S/Key library is currently known to be
Ben Lindstromdcca9812000-11-10 03:28:31 +000055supported.
Ben Lindstromca1c2a02000-10-14 21:33:19 +000056
Damien Millerb5f89271999-11-12 14:35:58 +1100572. Building / Installation
58--------------------------
59
60To install OpenSSH with default options:
61
62./configure
63make
64make install
65
66This will install the OpenSSH binaries in /usr/local/bin, configuration files
67in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
68installation prefix, use the --prefix option to configure:
69
70./configure --prefix=/opt
71make
72make install
73
74Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
75specific paths, for example:
76
77./configure --prefix=/opt --sysconfdir=/etc/ssh
78make
79make install
80
81This will install the binaries in /opt/{bin,lib,sbin}, but will place the
82configuration files in /etc/ssh.
83
Kevin Stevesdf4a7ae2000-11-07 14:47:51 +000084If you are using PAM, you may need to manually install a PAM
Damien Millerfd263682000-03-16 11:51:09 +110085control file as "/etc/pam.d/sshd" (or wherever your system
86prefers to keep them). A generic PAM configuration is included as
87"contrib/sshd.pam.generic", you may need to edit it before using it on
88your system. If you are using a recent version of Redhat Linux, the
Damien Millerc601a752000-06-10 08:33:38 +100089config file in contrib/redhat/sshd.pam should be more useful.
90Failure to install a valid PAM file may result in an inability to
Kevin Stevesdf4a7ae2000-11-07 14:47:51 +000091use password authentication. On HP-UX 11, the standard /etc/pam.conf
92configuration will work with sshd (sshd will match the OTHER service
93name).
Damien Miller755c90c1999-11-22 16:12:31 +110094
Damien Millerb5f89271999-11-12 14:35:58 +110095There are a few other options to the configure script:
96
Damien Miller8bdeee21999-12-30 15:50:54 +110097--with-rsh=PATH allows you to specify the path to your rsh program.
98Normally ./configure will search the current $PATH for 'rsh'. You
99may need to specify this option if rsh is not in your path or has a
100different name.
101
102--without-pam will disable PAM support. PAM is automatically detected
103and switched on if found.
104
Damien Millerc0967271999-11-19 15:53:50 +1100105--enable-gnome-askpass will build the GNOME passphrase dialog. You
106need a working installation of GNOME, including the development
107headers, for this to work.
Damien Millerb5f89271999-11-12 14:35:58 +1100108
Damien Millerc0967271999-11-19 15:53:50 +1100109--with-random=/some/file allows you to specify an alternate source of
Damien Miller615f9392000-05-17 22:53:33 +1000110random numbers (the default is /dev/urandom). Unless you are absolutely
Damien Millerb5f89271999-11-12 14:35:58 +1100111sure of what you are doing, it is best to leave this alone.
112
Damien Millerc0967271999-11-19 15:53:50 +1100113--with-egd-pool=/some/file allows you to enable Entropy Gathering
Damien Miller54057c22000-05-09 15:03:37 +1000114Daemon support and to specify a EGD pool socket. Use this if your
115Unix lacks /dev/random and you don't want to use OpenSSH's builtin
116entropy collection support.
Damien Millerb5f89271999-11-12 14:35:58 +1100117
Damien Miller8bdeee21999-12-30 15:50:54 +1100118--with-lastlog=FILE will specify the location of the lastlog file.
119./configure searches a few locations for lastlog, but may not find
120it if lastlog is installed in a different place.
121
122--without-lastlog will disable lastlog support entirely.
123
Damien Miller105b7f02000-01-07 08:45:55 +1100124--with-kerberos4=PATH will enable Kerberos IV support. You will need
125to have the Kerberos libraries and header files installed for this
126to work. Use the optional PATH argument to specify the root of your
127Kerberos installation.
Damien Millerc0967271999-11-19 15:53:50 +1100128
Damien Miller105b7f02000-01-07 08:45:55 +1100129--with-afs=PATH will enable AFS support. You will need to have the
130Kerberos IV and the AFS libraries and header files installed for this
131to work. Use the optional PATH argument to specify the root of your
132AFS installation. AFS requires Kerberos support to be enabled.
Damien Millerc0967271999-11-19 15:53:50 +1100133
Ben Lindstrom305fb002000-11-10 02:41:30 +0000134--with-skey=PATH will enable S/Key one time password support. You will
135need the S/Key libraries and header files installed for this to work.
Damien Millerc0967271999-11-19 15:53:50 +1100136
137--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
138support. You will need libwrap.a and tcpd.h installed.
139
140--with-md5-passwords will enable the use of MD5 passwords. Enable this
141if your operating system uses MD5 passwords without using PAM.
Damien Miller3d1b22c1999-11-12 15:46:08 +1100142
Damien Miller8bdeee21999-12-30 15:50:54 +1100143--with-utmpx enables utmpx support. utmpx support is automatic for
144some platforms.
145
146--without-shadow disables shadow password support.
147
148--with-ipaddr-display forces the use of a numeric IP address in the
149$DISPLAY environment variable. Some broken systems need this.
150
151--with-default-path=PATH allows you to specify a default $PATH for sessions
Damien Miller29ea30d2000-03-17 10:54:15 +1100152started by sshd. This replaces the standard path entirely.
Damien Miller8bdeee21999-12-30 15:50:54 +1100153
Damien Miller5eed6a22000-01-16 12:05:18 +1100154--with-pid-dir=PATH specifies the directory in which the ssh.pid file is
155created.
156
157--with-xauth=PATH specifies the location of the xauth binary
158
Damien Miller7d80e342000-01-19 14:36:49 +1100159--with-ipv4-default instructs OpenSSH to use IPv4 by default for new
160connections. Normally OpenSSH will try attempt to lookup both IPv6 and
161IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
162resolution. If this option is specified, you can still attempt to
163connect to IPv6 addresses using the command line option '-6'.
164
Damien Miller0c0e4bf2000-02-03 13:58:51 +1100165--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
166are installed.
167
Damien Millerfd263682000-03-16 11:51:09 +1100168--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
169real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
170
Damien Millerbeb4ba51999-12-28 15:09:35 +1100171If you need to pass special options to the compiler or linker, you
Damien Miller615f9392000-05-17 22:53:33 +1000172can specify these as environment variables before running ./configure.
Damien Millerbeb4ba51999-12-28 15:09:35 +1100173For example:
174
Damien Millerb5c42d92000-08-31 11:13:10 +1100175CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
Damien Millerb5f89271999-11-12 14:35:58 +1100176
1773. Configuration
178----------------
179
180The runtime configuration files are installed by in ${prefix}/etc or
181whatever you specified as your --sysconfdir (/usr/local/etc by default).
182
183The default configuration should be instantly usable, though you should
184review it to ensure that it matches your security requirements.
185
Damien Miller4095f892000-03-03 22:13:52 +1100186To generate a host key, run "make host-key". Alternately you can do so
Damien Millerc601a752000-06-10 08:33:38 +1000187manually using the following commands:
Damien Miller2a9d9f61999-11-15 23:34:11 +1100188
Damien Millerc601a752000-06-10 08:33:38 +1000189 ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ""
190 ssh-keygen -d -f /etc/ssh/ssh_host_dsa_key -N ""
Damien Miller2a9d9f61999-11-15 23:34:11 +1100191
Damien Miller6ae00d61999-12-14 15:43:03 +1100192Replacing /etc/ssh with the correct path to the configuration directory.
193(${prefix}/etc or whatever you specified with --sysconfdir during
194configuration)
195
Damien Millerab8a4da1999-12-16 13:05:30 +1100196If you have configured OpenSSH with EGD support, ensure that EGD is
197running and has collected some Entropy.
198
Damien Millerb5f89271999-11-12 14:35:58 +1100199For more information on configuration, please refer to the manual pages
200for sshd, ssh and ssh-agent.
201
Damien Miller6ae00d61999-12-14 15:43:03 +11002024. Problems?
203------------
204
205If you experience problems compiling, installing or running OpenSSH.
206Please refer to the "reporting bugs" section of the webpage at
Damien Miller615f9392000-05-17 22:53:33 +1000207http://www.openssh.com/
Damien Miller6ae00d61999-12-14 15:43:03 +1100208