11. Prerequisites 2---------------- 3 4You will need working installations of Zlib and OpenSSL. 5 6Zlib 1.1.4 or 1.2.1.2 or greater (ealier 1.2.x versions have problems): 7http://www.gzip.org/zlib/ 8 9OpenSSL 0.9.6 or greater: 10http://www.openssl.org/ 11 12(OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1 13Blowfish) do not work correctly.) 14 15The remaining items are optional. 16 17NB. If you operating system supports /dev/random, you should configure 18OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of 19/dev/random, or failing that, either prngd or egd 20 21PRNGD: 22 23If your system lacks kernel-based random collection, the use of Lutz 24Jaenicke's PRNGd is recommended. 25 26http://prngd.sourceforge.net/ 27 28EGD: 29 30The Entropy Gathering Daemon (EGD) is supported if you have a system which 31lacks /dev/random and don't want to use OpenSSH's internal entropy collection. 32 33http://www.lothar.com/tech/crypto/ 34 35PAM: 36 37OpenSSH can utilise Pluggable Authentication Modules (PAM) if your 38system supports it. PAM is standard most Linux distributions, Solaris, 39HP-UX 11, AIX >= 5.2, FreeBSD and NetBSD. 40 41Information about the various PAM implementations are available: 42 43Solaris PAM: http://www.sun.com/software/solaris/pam/ 44Linux PAM: http://www.kernel.org/pub/linux/libs/pam/ 45OpenPAM: http://www.openpam.org/ 46 47If you wish to build the GNOME passphrase requester, you will need the GNOME 48libraries and headers. 49 50GNOME: 51http://www.gnome.org/ 52 53Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11 54passphrase requester. This is maintained separately at: 55 56http://www.jmknoble.net/software/x11-ssh-askpass/ 57 58TCP Wrappers: 59 60If you wish to use the TCP wrappers functionality you will need at least 61tcpd.h and libwrap.a, either in the standard include and library paths, 62or in the directory specified by --with-tcp-wrappers. Version 7.6 is 63known to work. 64 65http://ftp.porcupine.org/pub/security/index.html 66 67S/Key Libraries: 68 69If you wish to use --with-skey then you will need the library below 70installed. No other S/Key library is currently known to be supported. 71 72http://www.sparc.spb.su/solaris/skey/ 73 74LibEdit: 75 76sftp supports command-line editing via NetBSD's libedit. If your platform 77has it available natively you can use that, alternatively you might try 78these multi-platform ports: 79 80http://www.thrysoee.dk/editline/ 81http://sourceforge.net/projects/libedit/ 82 83LDNS: 84 85LDNS is a DNS BSD-licensed resolver library which supports DNSSEC. 86 87http://nlnetlabs.nl/projects/ldns/ 88 89Autoconf: 90 91If you modify configure.ac or configure doesn't exist (eg if you checked 92the code out of CVS yourself) then you will need autoconf-2.68 to rebuild 93the automatically generated files by running "autoreconf". Earlier 94versions may also work but this is not guaranteed. 95 96http://www.gnu.org/software/autoconf/ 97 98Basic Security Module (BSM): 99 100Native BSM support is know to exist in Solaris from at least 2.5.1, 101FreeBSD 6.1 and OS X. Alternatively, you may use the OpenBSM 102implementation (http://www.openbsm.org). 103 104 1052. Building / Installation 106-------------------------- 107 108To install OpenSSH with default options: 109 110./configure 111make 112make install 113 114This will install the OpenSSH binaries in /usr/local/bin, configuration files 115in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different 116installation prefix, use the --prefix option to configure: 117 118./configure --prefix=/opt 119make 120make install 121 122Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override 123specific paths, for example: 124 125./configure --prefix=/opt --sysconfdir=/etc/ssh 126make 127make install 128 129This will install the binaries in /opt/{bin,lib,sbin}, but will place the 130configuration files in /etc/ssh. 131 132If you are using Privilege Separation (which is enabled by default) 133then you will also need to create the user, group and directory used by 134sshd for privilege separation. See README.privsep for details. 135 136If you are using PAM, you may need to manually install a PAM control 137file as "/etc/pam.d/sshd" (or wherever your system prefers to keep 138them). Note that the service name used to start PAM is __progname, 139which is the basename of the path of your sshd (e.g., the service name 140for /usr/sbin/osshd will be osshd). If you have renamed your sshd 141executable, your PAM configuration may need to be modified. 142 143A generic PAM configuration is included as "contrib/sshd.pam.generic", 144you may need to edit it before using it on your system. If you are 145using a recent version of Red Hat Linux, the config file in 146contrib/redhat/sshd.pam should be more useful. Failure to install a 147valid PAM file may result in an inability to use password 148authentication. On HP-UX 11 and Solaris, the standard /etc/pam.conf 149configuration will work with sshd (sshd will match the other service 150name). 151 152There are a few other options to the configure script: 153 154--with-audit=[module] enable additional auditing via the specified module. 155Currently, drivers for "debug" (additional info via syslog) and "bsm" 156(Sun's Basic Security Module) are supported. 157 158--with-pam enables PAM support. If PAM support is compiled in, it must 159also be enabled in sshd_config (refer to the UsePAM directive). 160 161--with-prngd-socket=/some/file allows you to enable EGD or PRNGD 162support and to specify a PRNGd socket. Use this if your Unix lacks 163/dev/random and you don't want to use OpenSSH's builtin entropy 164collection support. 165 166--with-prngd-port=portnum allows you to enable EGD or PRNGD support 167and to specify a EGD localhost TCP port. Use this if your Unix lacks 168/dev/random and you don't want to use OpenSSH's builtin entropy 169collection support. 170 171--with-lastlog=FILE will specify the location of the lastlog file. 172./configure searches a few locations for lastlog, but may not find 173it if lastlog is installed in a different place. 174 175--without-lastlog will disable lastlog support entirely. 176 177--with-osfsia, --without-osfsia will enable or disable OSF1's Security 178Integration Architecture. The default for OSF1 machines is enable. 179 180--with-skey=PATH will enable S/Key one time password support. You will 181need the S/Key libraries and header files installed for this to work. 182 183--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny) 184support. 185 186--with-md5-passwords will enable the use of MD5 passwords. Enable this 187if your operating system uses MD5 passwords and the system crypt() does 188not support them directly (see the crypt(3/3c) man page). If enabled, the 189resulting binary will support both MD5 and traditional crypt passwords. 190 191--with-utmpx enables utmpx support. utmpx support is automatic for 192some platforms. 193 194--without-shadow disables shadow password support. 195 196--with-ipaddr-display forces the use of a numeric IP address in the 197$DISPLAY environment variable. Some broken systems need this. 198 199--with-default-path=PATH allows you to specify a default $PATH for sessions 200started by sshd. This replaces the standard path entirely. 201 202--with-pid-dir=PATH specifies the directory in which the sshd.pid file is 203created. 204 205--with-xauth=PATH specifies the location of the xauth binary 206 207--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries 208are installed. 209 210--with-ssl-engine enables OpenSSL's (hardware) ENGINE support 211 212--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to 213real (AF_INET) IPv4 addresses. Works around some quirks on Linux. 214 215If you need to pass special options to the compiler or linker, you 216can specify these as environment variables before running ./configure. 217For example: 218 219CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure 220 2213. Configuration 222---------------- 223 224The runtime configuration files are installed by in ${prefix}/etc or 225whatever you specified as your --sysconfdir (/usr/local/etc by default). 226 227The default configuration should be instantly usable, though you should 228review it to ensure that it matches your security requirements. 229 230To generate a host key, run "make host-key". Alternately you can do so 231manually using the following commands: 232 233 ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N "" 234 ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N "" 235 ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N "" 236 237Replacing /etc/ssh with the correct path to the configuration directory. 238(${prefix}/etc or whatever you specified with --sysconfdir during 239configuration) 240 241If you have configured OpenSSH with EGD support, ensure that EGD is 242running and has collected some Entropy. 243 244For more information on configuration, please refer to the manual pages 245for sshd, ssh and ssh-agent. 246 2474. (Optional) Send survey 248------------------------- 249 250$ make survey 251[check the contents of the file "survey" to ensure there's no information 252that you consider sensitive] 253$ make send-survey 254 255This will send configuration information for the currently configured 256host to a survey address. This will help determine which configurations 257are actually in use, and what valid combinations of configure options 258exist. The raw data is available only to the OpenSSH developers, however 259summary data may be published. 260 2615. Problems? 262------------ 263 264If you experience problems compiling, installing or running OpenSSH. 265Please refer to the "reporting bugs" section of the webpage at 266http://www.openssh.com/ 267 268 269$Id: INSTALL,v 1.88 2013/03/07 01:33:35 dtucker Exp $ 270