4 You will need working installations of Zlib and OpenSSL.
7 http://www.gzip.org/zlib/
9 OpenSSL 0.9.6 or greater:
10 http://www.openssl.org/
12 (OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1
13 Blowfish) do not work correctly.)
15 OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
16 supports it. PAM is standard on Redhat and Debian Linux, Solaris and
19 NB. If you operating system supports /dev/random, you should configure
20 OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of
21 /dev/random. If you don't you will have to rely on ssh-rand-helper, which
22 is inferior to a good kernel-based solution.
25 http://www.kernel.org/pub/linux/libs/pam/
27 If you wish to build the GNOME passphrase requester, you will need the GNOME
28 libraries and headers.
33 Alternatively, Jim Knoble <jmknoble@jmknoble.cx> has written an excellent X11
34 passphrase requester. This is maintained separately at:
36 http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
40 If your system lacks Kernel based random collection, the use of Lutz
41 Jaenicke's PRNGd is recommended.
43 http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
47 The Entropy Gathering Daemon (EGD) is supported if you have a system which
48 lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
50 http://www.lothar.com/tech/crypto/
53 http://www.sparc.spb.su/solaris/skey/
55 If you wish to use --with-skey then you will need the above library
56 installed. No other current S/Key library is currently known to be
59 2. Building / Installation
60 --------------------------
62 To install OpenSSH with default options:
68 This will install the OpenSSH binaries in /usr/local/bin, configuration files
69 in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
70 installation prefix, use the --prefix option to configure:
72 ./configure --prefix=/opt
76 Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
77 specific paths, for example:
79 ./configure --prefix=/opt --sysconfdir=/etc/ssh
83 This will install the binaries in /opt/{bin,lib,sbin}, but will place the
84 configuration files in /etc/ssh.
86 If you are using PAM, you may need to manually install a PAM control
87 file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
88 them). Note that the service name used to start PAM is __progname,
89 which is the basename of the path of your sshd (e.g., the service name
90 for /usr/sbin/osshd will be osshd). If you have renamed your sshd
91 executable, your PAM configuration may need to be modified.
93 A generic PAM configuration is included as "contrib/sshd.pam.generic",
94 you may need to edit it before using it on your system. If you are
95 using a recent version of Red Hat Linux, the config file in
96 contrib/redhat/sshd.pam should be more useful. Failure to install a
97 valid PAM file may result in an inability to use password
98 authentication. On HP-UX 11 and Solaris, the standard /etc/pam.conf
99 configuration will work with sshd (sshd will match the other service
102 There are a few other options to the configure script:
104 --with-pam enables PAM support.
106 --enable-gnome-askpass will build the GNOME passphrase dialog. You
107 need a working installation of GNOME, including the development
108 headers, for this to work.
110 --with-prngd-socket=/some/file allows you to enable EGD or PRNGD
111 support and to specify a PRNGd socket. Use this if your Unix lacks
112 /dev/random and you don't want to use OpenSSH's builtin entropy
115 --with-prngd-port=portnum allows you to enable EGD or PRNGD support
116 and to specify a EGD localhost TCP port. Use this if your Unix lacks
117 /dev/random and you don't want to use OpenSSH's builtin entropy
120 --with-lastlog=FILE will specify the location of the lastlog file.
121 ./configure searches a few locations for lastlog, but may not find
122 it if lastlog is installed in a different place.
124 --without-lastlog will disable lastlog support entirely.
126 --with-sia, --without-sia will enable or disable OSF1's Security
127 Integration Architecture. The default for OSF1 machines is enable.
129 --with-kerberos4=PATH will enable Kerberos IV support. You will need
130 to have the Kerberos libraries and header files installed for this
131 to work. Use the optional PATH argument to specify the root of your
132 Kerberos installation.
134 --with-afs=PATH will enable AFS support. You will need to have the
135 Kerberos IV and the AFS libraries and header files installed for this
136 to work. Use the optional PATH argument to specify the root of your
137 AFS installation. AFS requires Kerberos support to be enabled.
139 --with-skey=PATH will enable S/Key one time password support. You will
140 need the S/Key libraries and header files installed for this to work.
142 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
143 support. You will need libwrap.a and tcpd.h installed.
145 --with-md5-passwords will enable the use of MD5 passwords. Enable this
146 if your operating system uses MD5 passwords without using PAM.
148 --with-utmpx enables utmpx support. utmpx support is automatic for
151 --without-shadow disables shadow password support.
153 --with-ipaddr-display forces the use of a numeric IP address in the
154 $DISPLAY environment variable. Some broken systems need this.
156 --with-default-path=PATH allows you to specify a default $PATH for sessions
157 started by sshd. This replaces the standard path entirely.
159 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
162 --with-xauth=PATH specifies the location of the xauth binary
164 --with-ipv4-default instructs OpenSSH to use IPv4 by default for new
165 connections. Normally OpenSSH will try attempt to lookup both IPv6 and
166 IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
167 resolution. If this option is specified, you can still attempt to
168 connect to IPv6 addresses using the command line option '-6'.
170 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
173 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
174 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
177 --with-sectok=DIR allows for OpenSC or sectok smartcard libraries to
178 be used with OpenSSH. See 'README.smartcard' for more details.
180 If you need to pass special options to the compiler or linker, you
181 can specify these as environment variables before running ./configure.
184 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
189 The runtime configuration files are installed by in ${prefix}/etc or
190 whatever you specified as your --sysconfdir (/usr/local/etc by default).
192 The default configuration should be instantly usable, though you should
193 review it to ensure that it matches your security requirements.
195 To generate a host key, run "make host-key". Alternately you can do so
196 manually using the following commands:
198 ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
199 ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
200 ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
202 Replacing /etc/ssh with the correct path to the configuration directory.
203 (${prefix}/etc or whatever you specified with --sysconfdir during
206 If you have configured OpenSSH with EGD support, ensure that EGD is
207 running and has collected some Entropy.
209 For more information on configuration, please refer to the manual pages
210 for sshd, ssh and ssh-agent.
215 If you experience problems compiling, installing or running OpenSSH.
216 Please refer to the "reporting bugs" section of the webpage at
217 http://www.openssh.com/