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. If you don't have 20any of these you will have to rely on ssh-rand-helper, which is inferior 21to a good kernel-based solution or prngd. 22 23PRNGD: 24 25If your system lacks kernel-based random collection, the use of Lutz 26Jaenicke's PRNGd is recommended. 27 28http://prngd.sourceforge.net/ 29 30EGD: 31 32The Entropy Gathering Daemon (EGD) is supported if you have a system which 33lacks /dev/random and don't want to use OpenSSH's internal entropy collection. 34 35http://www.lothar.com/tech/crypto/ 36 37PAM: 38 39OpenSSH can utilise Pluggable Authentication Modules (PAM) if your 40system supports it. PAM is standard most Linux distributions, Solaris, 41HP-UX 11, AIX >= 5.2, FreeBSD and NetBSD. 42 43Information about the various PAM implementations are available: 44 45Solaris PAM: http://www.sun.com/software/solaris/pam/ 46Linux PAM: http://www.kernel.org/pub/linux/libs/pam/ 47OpenPAM: http://www.openpam.org/ 48 49If you wish to build the GNOME passphrase requester, you will need the GNOME 50libraries and headers. 51 52GNOME: 53http://www.gnome.org/ 54 55Alternatively, Jim Knoble <jmknoble@pobox.com> has written an excellent X11 56passphrase requester. This is maintained separately at: 57 58http://www.jmknoble.net/software/x11-ssh-askpass/ 59 60TCP Wrappers: 61 62If you wish to use the TCP wrappers functionality you will need at least 63tcpd.h and libwrap.a, either in the standard include and library paths, 64or in the directory specified by --with-tcp-wrappers. Version 7.6 is 65known to work. 66 67http://ftp.porcupine.org/pub/security/index.html 68 69S/Key Libraries: 70 71If you wish to use --with-skey then you will need the library below 72installed. No other S/Key library is currently known to be supported. 73 74http://www.sparc.spb.su/solaris/skey/ 75 76LibEdit: 77 78sftp supports command-line editing via NetBSD's libedit. If your platform 79has it available natively you can use that, alternatively you might try 80these multi-platform ports: 81 82http://www.thrysoee.dk/editline/ 83http://sourceforge.net/projects/libedit/ 84 85Autoconf: 86 87If you modify configure.ac or configure doesn't exist (eg if you checked 88the code out of CVS yourself) then you will need autoconf-2.61 to rebuild 89the automatically generated files by running "autoreconf". Earlier 90versions may also work but this is not guaranteed. 91 92http://www.gnu.org/software/autoconf/ 93 94Basic Security Module (BSM): 95 96Native BSM support is know to exist in Solaris from at least 2.5.1, 97FreeBSD 6.1 and OS X. Alternatively, you may use the OpenBSM 98implementation (http://www.openbsm.org). 99 100 1012. Building / Installation 102-------------------------- 103 104To install OpenSSH with default options: 105 106./configure 107make 108make install 109 110This will install the OpenSSH binaries in /usr/local/bin, configuration files 111in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different 112installation prefix, use the --prefix option to configure: 113 114./configure --prefix=/opt 115make 116make install 117 118Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override 119specific paths, for example: 120 121./configure --prefix=/opt --sysconfdir=/etc/ssh 122make 123make install 124 125This will install the binaries in /opt/{bin,lib,sbin}, but will place the 126configuration files in /etc/ssh. 127 128If you are using Privilege Separation (which is enabled by default) 129then you will also need to create the user, group and directory used by 130sshd for privilege separation. See README.privsep for details. 131 132If you are using PAM, you may need to manually install a PAM control 133file as "/etc/pam.d/sshd" (or wherever your system prefers to keep 134them). Note that the service name used to start PAM is __progname, 135which is the basename of the path of your sshd (e.g., the service name 136for /usr/sbin/osshd will be osshd). If you have renamed your sshd 137executable, your PAM configuration may need to be modified. 138 139A generic PAM configuration is included as "contrib/sshd.pam.generic", 140you may need to edit it before using it on your system. If you are 141using a recent version of Red Hat Linux, the config file in 142contrib/redhat/sshd.pam should be more useful. Failure to install a 143valid PAM file may result in an inability to use password 144authentication. On HP-UX 11 and Solaris, the standard /etc/pam.conf 145configuration will work with sshd (sshd will match the other service 146name). 147 148There are a few other options to the configure script: 149 150--with-audit=[module] enable additional auditing via the specified module. 151Currently, drivers for "debug" (additional info via syslog) and "bsm" 152(Sun's Basic Security Module) are supported. 153 154--with-pam enables PAM support. If PAM support is compiled in, it must 155also be enabled in sshd_config (refer to the UsePAM directive). 156 157--with-prngd-socket=/some/file allows you to enable EGD or PRNGD 158support and to specify a PRNGd socket. Use this if your Unix lacks 159/dev/random and you don't want to use OpenSSH's builtin entropy 160collection support. 161 162--with-prngd-port=portnum allows you to enable EGD or PRNGD support 163and to specify a EGD localhost TCP port. Use this if your Unix lacks 164/dev/random and you don't want to use OpenSSH's builtin entropy 165collection support. 166 167--with-lastlog=FILE will specify the location of the lastlog file. 168./configure searches a few locations for lastlog, but may not find 169it if lastlog is installed in a different place. 170 171--without-lastlog will disable lastlog support entirely. 172 173--with-osfsia, --without-osfsia will enable or disable OSF1's Security 174Integration Architecture. The default for OSF1 machines is enable. 175 176--with-skey=PATH will enable S/Key one time password support. You will 177need the S/Key libraries and header files installed for this to work. 178 179--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny) 180support. 181 182--with-md5-passwords will enable the use of MD5 passwords. Enable this 183if your operating system uses MD5 passwords and the system crypt() does 184not support them directly (see the crypt(3/3c) man page). If enabled, the 185resulting binary will support both MD5 and traditional crypt passwords. 186 187--with-utmpx enables utmpx support. utmpx support is automatic for 188some platforms. 189 190--without-shadow disables shadow password support. 191 192--with-ipaddr-display forces the use of a numeric IP address in the 193$DISPLAY environment variable. Some broken systems need this. 194 195--with-default-path=PATH allows you to specify a default $PATH for sessions 196started by sshd. This replaces the standard path entirely. 197 198--with-pid-dir=PATH specifies the directory in which the sshd.pid file is 199created. 200 201--with-xauth=PATH specifies the location of the xauth binary 202 203--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries 204are installed. 205 206--with-ssl-engine enables OpenSSL's (hardware) ENGINE support 207 208--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to 209real (AF_INET) IPv4 addresses. Works around some quirks on Linux. 210 211--with-opensc=DIR 212--with-sectok=DIR allows for OpenSC or sectok smartcard libraries to 213be used with OpenSSH. See 'README.smartcard' for more details. 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.84 2007/08/17 12:52:05 dtucker Exp $ 270