blob: 9ea5a2533fdb5ed3b4ea8e33825e82eed3f35d76 [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 Miller780b3761999-12-26 13:36:11 +110030Alternatly Jim Knoble <jmknoble@pobox.com> has written an excellent X11
31passphrase requester. This is maintained seperatly at:
32
33http://www.pobox.com/~jmknoble/jmk/
34
35
Damien Millerb5f89271999-11-12 14:35:58 +110036If you are planning to use OpenSSH on a Unix which lacks a Kernel random
37number generator (/dev/urandom), you will need to install the Entropy
38Gathering Daemon (or similar). You will also need to specify the
39--with-egd-pool option to ./configure.
40
41EGD:
42http://www.lothar.com/tech/crypto/
43
Damien Miller4d2f15f1999-11-23 12:36:29 +110044GNU Make:
45ftp://ftp.gnu.org/gnu/make/
46
47OpenSSH has only been tested with GNU make. It may work with other
48'make' programs, but you are on your own.
Damien Millerb5f89271999-11-12 14:35:58 +110049
502. Building / Installation
51--------------------------
52
53To install OpenSSH with default options:
54
55./configure
56make
57make install
58
59This will install the OpenSSH binaries in /usr/local/bin, configuration files
60in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
61installation prefix, use the --prefix option to configure:
62
63./configure --prefix=/opt
64make
65make install
66
67Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
68specific paths, for example:
69
70./configure --prefix=/opt --sysconfdir=/etc/ssh
71make
72make install
73
74This will install the binaries in /opt/{bin,lib,sbin}, but will place the
75configuration files in /etc/ssh.
76
Damien Miller294df781999-11-23 10:11:29 +110077If you are using PAM, you will need to manually install a PAM control
78file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
79them). A generic PAM configuration is included as "sshd.pam.generic",
Damien Millerf693d3b2000-01-17 11:56:27 +110080you may need to edit it before using it on your system. If you are
81using a recent version of Redhat Linux, the config file in
82packages/redhat/sshd.pam should be more useful.
Damien Miller755c90c1999-11-22 16:12:31 +110083
Damien Millerb5f89271999-11-12 14:35:58 +110084There are a few other options to the configure script:
85
Damien Miller8bdeee21999-12-30 15:50:54 +110086--with-rsh=PATH allows you to specify the path to your rsh program.
87Normally ./configure will search the current $PATH for 'rsh'. You
88may need to specify this option if rsh is not in your path or has a
89different name.
90
91--without-pam will disable PAM support. PAM is automatically detected
92and switched on if found.
93
Damien Millerc0967271999-11-19 15:53:50 +110094--enable-gnome-askpass will build the GNOME passphrase dialog. You
95need a working installation of GNOME, including the development
96headers, for this to work.
Damien Millerb5f89271999-11-12 14:35:58 +110097
Damien Millerc0967271999-11-19 15:53:50 +110098--with-random=/some/file allows you to specify an alternate source of
99random numbers (the default is /dev/urandom). Unless you are absolutly
Damien Millerb5f89271999-11-12 14:35:58 +1100100sure of what you are doing, it is best to leave this alone.
101
Damien Millerc0967271999-11-19 15:53:50 +1100102--with-egd-pool=/some/file allows you to enable Entropy Gathering
103Daemon support and to specify a EGD pool socket. You will need to
104use this if your Unix does not support the /dev/urandom device (or
Damien Millerab8a4da1999-12-16 13:05:30 +1100105similar). The file argument refers to the EGD pool file, not the
106EGD program itself. Please refer to the EGD documentation.
Damien Millerb5f89271999-11-12 14:35:58 +1100107
Damien Miller8bdeee21999-12-30 15:50:54 +1100108--with-lastlog=FILE will specify the location of the lastlog file.
109./configure searches a few locations for lastlog, but may not find
110it if lastlog is installed in a different place.
111
112--without-lastlog will disable lastlog support entirely.
113
Damien Miller105b7f02000-01-07 08:45:55 +1100114--with-kerberos4=PATH will enable Kerberos IV support. You will need
115to have the Kerberos libraries and header files installed for this
116to work. Use the optional PATH argument to specify the root of your
117Kerberos installation.
Damien Millerc0967271999-11-19 15:53:50 +1100118
Damien Miller105b7f02000-01-07 08:45:55 +1100119--with-afs=PATH will enable AFS support. You will need to have the
120Kerberos IV and the AFS libraries and header files installed for this
121to work. Use the optional PATH argument to specify the root of your
122AFS installation. AFS requires Kerberos support to be enabled.
Damien Millerc0967271999-11-19 15:53:50 +1100123
124--with-skey will enable S/Key one time password support. You will need
125the S/Key libraries and header files installed for this to work.
126
127--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
128support. You will need libwrap.a and tcpd.h installed.
129
130--with-md5-passwords will enable the use of MD5 passwords. Enable this
131if your operating system uses MD5 passwords without using PAM.
Damien Miller3d1b22c1999-11-12 15:46:08 +1100132
Damien Miller8bdeee21999-12-30 15:50:54 +1100133--with-utmpx enables utmpx support. utmpx support is automatic for
134some platforms.
135
136--without-shadow disables shadow password support.
137
138--with-ipaddr-display forces the use of a numeric IP address in the
139$DISPLAY environment variable. Some broken systems need this.
140
141--with-default-path=PATH allows you to specify a default $PATH for sessions
142started by sshd.
143
Damien Miller5eed6a22000-01-16 12:05:18 +1100144--with-pid-dir=PATH specifies the directory in which the ssh.pid file is
145created.
146
147--with-xauth=PATH specifies the location of the xauth binary
148
Damien Miller8bdeee21999-12-30 15:50:54 +1100149--with-dante[=DIR] will enable Dante SOCKS library support. If the Dante
150libsocks library isn't installed in a library searched by the compiler,
151add the directory name as the option.
152
Damien Millerbeb4ba51999-12-28 15:09:35 +1100153If you need to pass special options to the compiler or linker, you
154can specify these as enviornment variables before running ./configure.
155For example:
156
157CFLAGS="-O -m486" LFLAGS="-s" ./configure
Damien Millerb5f89271999-11-12 14:35:58 +1100158
1593. Configuration
160----------------
161
162The runtime configuration files are installed by in ${prefix}/etc or
163whatever you specified as your --sysconfdir (/usr/local/etc by default).
164
165The default configuration should be instantly usable, though you should
166review it to ensure that it matches your security requirements.
167
Damien Miller2a9d9f61999-11-15 23:34:11 +1100168To generate a host key, issue the following command: (replacing
169/etc/ssh/ssh_host_key with an appropriate path)
170
171/usr/bin/ssh-keygen -b 1024 -f /etc/ssh/ssh_host_key -N ''
172
Damien Miller6ae00d61999-12-14 15:43:03 +1100173Replacing /etc/ssh with the correct path to the configuration directory.
174(${prefix}/etc or whatever you specified with --sysconfdir during
175configuration)
176
Damien Millerab8a4da1999-12-16 13:05:30 +1100177If you have configured OpenSSH with EGD support, ensure that EGD is
178running and has collected some Entropy.
179
Damien Millerb5f89271999-11-12 14:35:58 +1100180For more information on configuration, please refer to the manual pages
181for sshd, ssh and ssh-agent.
182
Damien Miller6ae00d61999-12-14 15:43:03 +11001834. Problems?
184------------
185
186If you experience problems compiling, installing or running OpenSSH.
187Please refer to the "reporting bugs" section of the webpage at
188http://violet.ibs.com.au/openssh/
189