blob: 15ddffc17a4c3577c2b7e9900f5837fba26ff811 [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 Miller8bdeee21999-12-30 15:50:54 +110018Dante:
19http://www.inet.no/dante
20
21OpenSSH can also use the Dante SOCKS libraries, version 1.1.1pre1 or higher,
22if you have them installed on your system.
23
Damien Miller780b3761999-12-26 13:36:11 +110024If you wish to build the GNOME passphrase requester, you will need the GNOME
Damien Millerb5f89271999-11-12 14:35:58 +110025libraries and headers.
26
27GNOME:
28http://www.gnome.org/
29
Damien Miller7d7c60d2000-01-26 14:37:48 +110030Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11
31passphrase requester. This is maintained separately at:
Damien Miller780b3761999-12-26 13:36:11 +110032
Damien Miller0e1cf7c2000-01-26 12:15:30 +110033http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
Damien Miller780b3761999-12-26 13:36:11 +110034
Damien Millerb5f89271999-11-12 14:35:58 +110035If you are planning to use OpenSSH on a Unix which lacks a Kernel random
36number generator (/dev/urandom), you will need to install the Entropy
37Gathering Daemon (or similar). You will also need to specify the
38--with-egd-pool option to ./configure.
39
40EGD:
41http://www.lothar.com/tech/crypto/
42
Damien Miller4d2f15f1999-11-23 12:36:29 +110043GNU Make:
44ftp://ftp.gnu.org/gnu/make/
45
46OpenSSH has only been tested with GNU make. It may work with other
47'make' programs, but you are on your own.
Damien Millerb5f89271999-11-12 14:35:58 +110048
492. Building / Installation
50--------------------------
51
52To install OpenSSH with default options:
53
54./configure
55make
56make install
57
58This will install the OpenSSH binaries in /usr/local/bin, configuration files
59in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
60installation prefix, use the --prefix option to configure:
61
62./configure --prefix=/opt
63make
64make install
65
66Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
67specific paths, for example:
68
69./configure --prefix=/opt --sysconfdir=/etc/ssh
70make
71make install
72
73This will install the binaries in /opt/{bin,lib,sbin}, but will place the
74configuration files in /etc/ssh.
75
Damien Miller294df781999-11-23 10:11:29 +110076If you are using PAM, you will need to manually install a PAM control
77file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
78them). A generic PAM configuration is included as "sshd.pam.generic",
Damien Millerf693d3b2000-01-17 11:56:27 +110079you may need to edit it before using it on your system. If you are
80using a recent version of Redhat Linux, the config file in
81packages/redhat/sshd.pam should be more useful.
Damien Miller755c90c1999-11-22 16:12:31 +110082
Damien Millerb5f89271999-11-12 14:35:58 +110083There are a few other options to the configure script:
84
Damien Miller8bdeee21999-12-30 15:50:54 +110085--with-rsh=PATH allows you to specify the path to your rsh program.
86Normally ./configure will search the current $PATH for 'rsh'. You
87may need to specify this option if rsh is not in your path or has a
88different name.
89
90--without-pam will disable PAM support. PAM is automatically detected
91and switched on if found.
92
Damien Millerc0967271999-11-19 15:53:50 +110093--enable-gnome-askpass will build the GNOME passphrase dialog. You
94need a working installation of GNOME, including the development
95headers, for this to work.
Damien Millerb5f89271999-11-12 14:35:58 +110096
Damien Millerc0967271999-11-19 15:53:50 +110097--with-random=/some/file allows you to specify an alternate source of
98random numbers (the default is /dev/urandom). Unless you are absolutly
Damien Millerb5f89271999-11-12 14:35:58 +110099sure of what you are doing, it is best to leave this alone.
100
Damien Millerc0967271999-11-19 15:53:50 +1100101--with-egd-pool=/some/file allows you to enable Entropy Gathering
102Daemon support and to specify a EGD pool socket. You will need to
103use this if your Unix does not support the /dev/urandom device (or
Damien Millerab8a4da1999-12-16 13:05:30 +1100104similar). The file argument refers to the EGD pool file, not the
105EGD program itself. Please refer to the EGD documentation.
Damien Millerb5f89271999-11-12 14:35:58 +1100106
Damien Miller8bdeee21999-12-30 15:50:54 +1100107--with-lastlog=FILE will specify the location of the lastlog file.
108./configure searches a few locations for lastlog, but may not find
109it if lastlog is installed in a different place.
110
111--without-lastlog will disable lastlog support entirely.
112
Damien Miller105b7f02000-01-07 08:45:55 +1100113--with-kerberos4=PATH will enable Kerberos IV support. You will need
114to have the Kerberos libraries and header files installed for this
115to work. Use the optional PATH argument to specify the root of your
116Kerberos installation.
Damien Millerc0967271999-11-19 15:53:50 +1100117
Damien Miller105b7f02000-01-07 08:45:55 +1100118--with-afs=PATH will enable AFS support. You will need to have the
119Kerberos IV and the AFS libraries and header files installed for this
120to work. Use the optional PATH argument to specify the root of your
121AFS installation. AFS requires Kerberos support to be enabled.
Damien Millerc0967271999-11-19 15:53:50 +1100122
123--with-skey will enable S/Key one time password support. You will need
124the S/Key libraries and header files installed for this to work.
125
126--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
127support. You will need libwrap.a and tcpd.h installed.
128
129--with-md5-passwords will enable the use of MD5 passwords. Enable this
130if your operating system uses MD5 passwords without using PAM.
Damien Miller3d1b22c1999-11-12 15:46:08 +1100131
Damien Miller8bdeee21999-12-30 15:50:54 +1100132--with-utmpx enables utmpx support. utmpx support is automatic for
133some platforms.
134
135--without-shadow disables shadow password support.
136
137--with-ipaddr-display forces the use of a numeric IP address in the
138$DISPLAY environment variable. Some broken systems need this.
139
140--with-default-path=PATH allows you to specify a default $PATH for sessions
141started by sshd.
142
Damien Miller5eed6a22000-01-16 12:05:18 +1100143--with-pid-dir=PATH specifies the directory in which the ssh.pid file is
144created.
145
146--with-xauth=PATH specifies the location of the xauth binary
147
Damien Miller8bdeee21999-12-30 15:50:54 +1100148--with-dante[=DIR] will enable Dante SOCKS library support. If the Dante
149libsocks library isn't installed in a library searched by the compiler,
150add the directory name as the option.
151
Damien Miller7d80e342000-01-19 14:36:49 +1100152--with-ipv4-default instructs OpenSSH to use IPv4 by default for new
153connections. Normally OpenSSH will try attempt to lookup both IPv6 and
154IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
155resolution. If this option is specified, you can still attempt to
156connect to IPv6 addresses using the command line option '-6'.
157
Damien Miller0c0e4bf2000-02-03 13:58:51 +1100158--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
159are installed.
160
Damien Millerbeb4ba51999-12-28 15:09:35 +1100161If you need to pass special options to the compiler or linker, you
162can specify these as enviornment variables before running ./configure.
163For example:
164
165CFLAGS="-O -m486" LFLAGS="-s" ./configure
Damien Millerb5f89271999-11-12 14:35:58 +1100166
1673. Configuration
168----------------
169
170The runtime configuration files are installed by in ${prefix}/etc or
171whatever you specified as your --sysconfdir (/usr/local/etc by default).
172
173The default configuration should be instantly usable, though you should
174review it to ensure that it matches your security requirements.
175
Damien Miller2a9d9f61999-11-15 23:34:11 +1100176To generate a host key, issue the following command: (replacing
177/etc/ssh/ssh_host_key with an appropriate path)
178
179/usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ''
180
Damien Miller6ae00d61999-12-14 15:43:03 +1100181Replacing /etc/ssh with the correct path to the configuration directory.
182(${prefix}/etc or whatever you specified with --sysconfdir during
183configuration)
184
Damien Millerab8a4da1999-12-16 13:05:30 +1100185If you have configured OpenSSH with EGD support, ensure that EGD is
186running and has collected some Entropy.
187
Damien Millerb5f89271999-11-12 14:35:58 +1100188For more information on configuration, please refer to the manual pages
189for sshd, ssh and ssh-agent.
190
Damien Miller6ae00d61999-12-14 15:43:03 +11001914. Problems?
192------------
193
194If you experience problems compiling, installing or running OpenSSH.
195Please refer to the "reporting bugs" section of the webpage at
196http://violet.ibs.com.au/openssh/
197