blob: 576fca085065582be28601909f46f6dc1d2e4bd5 [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:
7http://www.cdrom.com/pub/infozip/zlib/
8
9OpenSSL:
10http://www.openssl.org/
11
12OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
13supports it. PAM is standard on Redhat and Debian Linux and on Solaris.
14
15PAM:
16http://www.kernel.org/pub/linux/libs/pam/
17
Damien Miller780b3761999-12-26 13:36:11 +110018If you wish to build the GNOME passphrase requester, you will need the GNOME
Damien Millerb5f89271999-11-12 14:35:58 +110019libraries and headers.
20
21GNOME:
22http://www.gnome.org/
23
Damien Miller7d7c60d2000-01-26 14:37:48 +110024Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11
25passphrase requester. This is maintained separately at:
Damien Miller780b3761999-12-26 13:36:11 +110026
Damien Miller0e1cf7c2000-01-26 12:15:30 +110027http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
Damien Miller780b3761999-12-26 13:36:11 +110028
Damien Millerb5f89271999-11-12 14:35:58 +110029If you are planning to use OpenSSH on a Unix which lacks a Kernel random
30number generator (/dev/urandom), you will need to install the Entropy
31Gathering Daemon (or similar). You will also need to specify the
32--with-egd-pool option to ./configure.
33
34EGD:
35http://www.lothar.com/tech/crypto/
36
Damien Miller4d2f15f1999-11-23 12:36:29 +110037GNU Make:
38ftp://ftp.gnu.org/gnu/make/
39
40OpenSSH has only been tested with GNU make. It may work with other
41'make' programs, but you are on your own.
Damien Millerb5f89271999-11-12 14:35:58 +110042
432. Building / Installation
44--------------------------
45
46To install OpenSSH with default options:
47
48./configure
49make
50make install
51
52This will install the OpenSSH binaries in /usr/local/bin, configuration files
53in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
54installation prefix, use the --prefix option to configure:
55
56./configure --prefix=/opt
57make
58make install
59
60Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
61specific paths, for example:
62
63./configure --prefix=/opt --sysconfdir=/etc/ssh
64make
65make install
66
67This will install the binaries in /opt/{bin,lib,sbin}, but will place the
68configuration files in /etc/ssh.
69
Damien Millerfd263682000-03-16 11:51:09 +110070If you are using PAM, you will need to manually install a PAM
71control file as "/etc/pam.d/sshd" (or wherever your system
72prefers to keep them). A generic PAM configuration is included as
73"contrib/sshd.pam.generic", you may need to edit it before using it on
74your system. If you are using a recent version of Redhat Linux, the
75config file in contrib/redhat/sshd.pam should be more useful.
Damien Miller755c90c1999-11-22 16:12:31 +110076
Damien Millerb5f89271999-11-12 14:35:58 +110077There are a few other options to the configure script:
78
Damien Miller8bdeee21999-12-30 15:50:54 +110079--with-rsh=PATH allows you to specify the path to your rsh program.
80Normally ./configure will search the current $PATH for 'rsh'. You
81may need to specify this option if rsh is not in your path or has a
82different name.
83
84--without-pam will disable PAM support. PAM is automatically detected
85and switched on if found.
86
Damien Millerc0967271999-11-19 15:53:50 +110087--enable-gnome-askpass will build the GNOME passphrase dialog. You
88need a working installation of GNOME, including the development
89headers, for this to work.
Damien Millerb5f89271999-11-12 14:35:58 +110090
Damien Millerc0967271999-11-19 15:53:50 +110091--with-random=/some/file allows you to specify an alternate source of
92random numbers (the default is /dev/urandom). Unless you are absolutly
Damien Millerb5f89271999-11-12 14:35:58 +110093sure of what you are doing, it is best to leave this alone.
94
Damien Millerc0967271999-11-19 15:53:50 +110095--with-egd-pool=/some/file allows you to enable Entropy Gathering
96Daemon support and to specify a EGD pool socket. You will need to
97use this if your Unix does not support the /dev/urandom device (or
Damien Millerab8a4da1999-12-16 13:05:30 +110098similar). The file argument refers to the EGD pool file, not the
99EGD program itself. Please refer to the EGD documentation.
Damien Millerb5f89271999-11-12 14:35:58 +1100100
Damien Miller8bdeee21999-12-30 15:50:54 +1100101--with-lastlog=FILE will specify the location of the lastlog file.
102./configure searches a few locations for lastlog, but may not find
103it if lastlog is installed in a different place.
104
105--without-lastlog will disable lastlog support entirely.
106
Damien Miller105b7f02000-01-07 08:45:55 +1100107--with-kerberos4=PATH will enable Kerberos IV support. You will need
108to have the Kerberos libraries and header files installed for this
109to work. Use the optional PATH argument to specify the root of your
110Kerberos installation.
Damien Millerc0967271999-11-19 15:53:50 +1100111
Damien Miller105b7f02000-01-07 08:45:55 +1100112--with-afs=PATH will enable AFS support. You will need to have the
113Kerberos IV and the AFS libraries and header files installed for this
114to work. Use the optional PATH argument to specify the root of your
115AFS installation. AFS requires Kerberos support to be enabled.
Damien Millerc0967271999-11-19 15:53:50 +1100116
117--with-skey will enable S/Key one time password support. You will need
118the S/Key libraries and header files installed for this to work.
119
120--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
121support. You will need libwrap.a and tcpd.h installed.
122
123--with-md5-passwords will enable the use of MD5 passwords. Enable this
124if your operating system uses MD5 passwords without using PAM.
Damien Miller3d1b22c1999-11-12 15:46:08 +1100125
Damien Miller8bdeee21999-12-30 15:50:54 +1100126--with-utmpx enables utmpx support. utmpx support is automatic for
127some platforms.
128
129--without-shadow disables shadow password support.
130
131--with-ipaddr-display forces the use of a numeric IP address in the
132$DISPLAY environment variable. Some broken systems need this.
133
134--with-default-path=PATH allows you to specify a default $PATH for sessions
Damien Miller29ea30d2000-03-17 10:54:15 +1100135started by sshd. This replaces the standard path entirely.
Damien Miller8bdeee21999-12-30 15:50:54 +1100136
Damien Miller5eed6a22000-01-16 12:05:18 +1100137--with-pid-dir=PATH specifies the directory in which the ssh.pid file is
138created.
139
140--with-xauth=PATH specifies the location of the xauth binary
141
Damien Miller7d80e342000-01-19 14:36:49 +1100142--with-ipv4-default instructs OpenSSH to use IPv4 by default for new
143connections. Normally OpenSSH will try attempt to lookup both IPv6 and
144IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
145resolution. If this option is specified, you can still attempt to
146connect to IPv6 addresses using the command line option '-6'.
147
Damien Miller0c0e4bf2000-02-03 13:58:51 +1100148--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
149are installed.
150
Damien Millerfd263682000-03-16 11:51:09 +1100151--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
152real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
153
Damien Millerbeb4ba51999-12-28 15:09:35 +1100154If you need to pass special options to the compiler or linker, you
155can specify these as enviornment variables before running ./configure.
156For example:
157
Damien Millerfd263682000-03-16 11:51:09 +1100158CFLAGS="-O -m486" LFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
Damien Millerb5f89271999-11-12 14:35:58 +1100159
1603. Configuration
161----------------
162
163The runtime configuration files are installed by in ${prefix}/etc or
164whatever you specified as your --sysconfdir (/usr/local/etc by default).
165
166The default configuration should be instantly usable, though you should
167review it to ensure that it matches your security requirements.
168
Damien Miller4095f892000-03-03 22:13:52 +1100169To generate a host key, run "make host-key". Alternately you can do so
170manually using the following command:
Damien Miller2a9d9f61999-11-15 23:34:11 +1100171
172/usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ''
173
Damien Miller6ae00d61999-12-14 15:43:03 +1100174Replacing /etc/ssh with the correct path to the configuration directory.
175(${prefix}/etc or whatever you specified with --sysconfdir during
176configuration)
177
Damien Millerab8a4da1999-12-16 13:05:30 +1100178If you have configured OpenSSH with EGD support, ensure that EGD is
179running and has collected some Entropy.
180
Damien Millerb5f89271999-11-12 14:35:58 +1100181For more information on configuration, please refer to the manual pages
182for sshd, ssh and ssh-agent.
183
Damien Miller6ae00d61999-12-14 15:43:03 +11001844. Problems?
185------------
186
187If you experience problems compiling, installing or running OpenSSH.
188Please refer to the "reporting bugs" section of the webpage at
189http://violet.ibs.com.au/openssh/
190