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.jmknoble.net/software/x11-ssh-askpass/
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. If PAM support is compiled in, it must
105 also be enabled in sshd_config (refer to the UsePAM directive).
107 --with-prngd-socket=/some/file allows you to enable EGD or PRNGD
108 support and to specify a PRNGd socket. Use this if your Unix lacks
109 /dev/random and you don't want to use OpenSSH's builtin entropy
112 --with-prngd-port=portnum allows you to enable EGD or PRNGD support
113 and to specify a EGD localhost TCP port. Use this if your Unix lacks
114 /dev/random and you don't want to use OpenSSH's builtin entropy
117 --with-lastlog=FILE will specify the location of the lastlog file.
118 ./configure searches a few locations for lastlog, but may not find
119 it if lastlog is installed in a different place.
121 --without-lastlog will disable lastlog support entirely.
123 --with-osfsia, --without-osfsia will enable or disable OSF1's Security
124 Integration Architecture. The default for OSF1 machines is enable.
126 --with-skey=PATH will enable S/Key one time password support. You will
127 need the S/Key libraries and header files installed for this to work.
129 --with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
130 support. You will need libwrap.a and tcpd.h installed.
132 --with-md5-passwords will enable the use of MD5 passwords. Enable this
133 if your operating system uses MD5 passwords and the system crypt() does
134 not support them directly (see the crypt(3/3c) man page). If enabled, the
135 resulting binary will support both MD5 and traditional crypt passwords.
137 --with-utmpx enables utmpx support. utmpx support is automatic for
140 --without-shadow disables shadow password support.
142 --with-ipaddr-display forces the use of a numeric IP address in the
143 $DISPLAY environment variable. Some broken systems need this.
145 --with-default-path=PATH allows you to specify a default $PATH for sessions
146 started by sshd. This replaces the standard path entirely.
148 --with-pid-dir=PATH specifies the directory in which the ssh.pid file is
151 --with-xauth=PATH specifies the location of the xauth binary
153 --with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
156 --with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
157 real (AF_INET) IPv4 addresses. Works around some quirks on Linux.
160 --with-sectok=DIR allows for OpenSC or sectok smartcard libraries to
161 be used with OpenSSH. See 'README.smartcard' for more details.
163 If you need to pass special options to the compiler or linker, you
164 can specify these as environment variables before running ./configure.
167 CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure
172 The runtime configuration files are installed by in ${prefix}/etc or
173 whatever you specified as your --sysconfdir (/usr/local/etc by default).
175 The default configuration should be instantly usable, though you should
176 review it to ensure that it matches your security requirements.
178 To generate a host key, run "make host-key". Alternately you can do so
179 manually using the following commands:
181 ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
182 ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
183 ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""
185 Replacing /etc/ssh with the correct path to the configuration directory.
186 (${prefix}/etc or whatever you specified with --sysconfdir during
189 If you have configured OpenSSH with EGD support, ensure that EGD is
190 running and has collected some Entropy.
192 For more information on configuration, please refer to the manual pages
193 for sshd, ssh and ssh-agent.
198 If you experience problems compiling, installing or running OpenSSH.
199 Please refer to the "reporting bugs" section of the webpage at
200 http://www.openssh.com/