head	1.6;
access;
symbols
	RELENG_8_4:1.6.0.2
	RELENG_9_1_0_RELEASE:1.3
	RELENG_9_1:1.3.0.6
	RELENG_9_1_BP:1.3
	RELENG_8_3_0_RELEASE:1.2.2.1
	RELENG_8_3:1.2.2.1.0.6
	RELENG_8_3_BP:1.2.2.1
	RELENG_9_0_0_RELEASE:1.3
	RELENG_9_0:1.3.0.4
	RELENG_9_0_BP:1.3
	RELENG_9:1.3.0.2
	RELENG_9_BP:1.3
	RELENG_7_4_0_RELEASE:1.1.1.9.2.1
	RELENG_8_2_0_RELEASE:1.2.2.1
	RELENG_7_4:1.1.1.9.2.1.0.8
	RELENG_7_4_BP:1.1.1.9.2.1
	RELENG_8_2:1.2.2.1.0.4
	RELENG_8_2_BP:1.2.2.1
	RELENG_8_1_0_RELEASE:1.2.2.1
	RELENG_8_1:1.2.2.1.0.2
	RELENG_8_1_BP:1.2.2.1
	RELENG_7_3_0_RELEASE:1.1.1.9.2.1
	RELENG_7_3:1.1.1.9.2.1.0.6
	RELENG_7_3_BP:1.1.1.9.2.1
	RELENG_8_0_0_RELEASE:1.2
	RELENG_8_0:1.2.0.4
	RELENG_8_0_BP:1.2
	RELENG_8:1.2.0.2
	RELENG_8_BP:1.2
	RELENG_7_2_0_RELEASE:1.1.1.9.2.1
	RELENG_7_2:1.1.1.9.2.1.0.4
	RELENG_7_2_BP:1.1.1.9.2.1
	RELENG_7_1_0_RELEASE:1.1.1.9.2.1
	RELENG_6_4_0_RELEASE:1.1.1.8.2.1
	RELENG_7_1:1.1.1.9.2.1.0.2
	RELENG_7_1_BP:1.1.1.9.2.1
	RELENG_6_4:1.1.1.8.2.1.0.6
	RELENG_6_4_BP:1.1.1.8.2.1
	RELENG_7_0_0_RELEASE:1.1.1.9
	RELENG_6_3_0_RELEASE:1.1.1.8.2.1
	RELENG_7_0:1.1.1.9.0.4
	RELENG_7_0_BP:1.1.1.9
	RELENG_6_3:1.1.1.8.2.1.0.4
	RELENG_6_3_BP:1.1.1.8.2.1
	RELENG_7:1.1.1.9.0.2
	RELENG_7_BP:1.1.1.9
	RELENG_6_2_0_RELEASE:1.1.1.8.2.1
	RELENG_6_2:1.1.1.8.2.1.0.2
	RELENG_6_2_BP:1.1.1.8.2.1
	OpenSSH_4_5p1:1.1.1.9
	OpenSSH_4_4p1:1.1.1.9
	RELENG_5_5_0_RELEASE:1.1.1.5
	RELENG_5_5:1.1.1.5.0.8
	RELENG_5_5_BP:1.1.1.5
	RELENG_6_1_0_RELEASE:1.1.1.8
	RELENG_6_1:1.1.1.8.0.6
	RELENG_6_1_BP:1.1.1.8
	OpenSSH_4_3p1:1.1.1.8
	RELENG_6_0_0_RELEASE:1.1.1.8
	RELENG_6_0:1.1.1.8.0.4
	RELENG_6_0_BP:1.1.1.8
	OpenSSH_4_2p1:1.1.1.8
	RELENG_6:1.1.1.8.0.2
	RELENG_6_BP:1.1.1.8
	OpenSSH_4_1p1:1.1.1.8
	OpenSSH_4_0p1:1.1.1.7
	RELENG_5_4_0_RELEASE:1.1.1.5
	RELENG_5_4:1.1.1.5.0.6
	RELENG_5_4_BP:1.1.1.5
	RELENG_4_11_0_RELEASE:1.1.1.2.2.2
	RELENG_4_11:1.1.1.2.2.2.0.8
	RELENG_4_11_BP:1.1.1.2.2.2
	OpenSSH_3_9p1:1.1.1.6
	RELENG_5_3_0_RELEASE:1.1.1.5
	RELENG_5_3:1.1.1.5.0.4
	RELENG_5_3_BP:1.1.1.5
	RELENG_5:1.1.1.5.0.2
	RELENG_5_BP:1.1.1.5
	RELENG_4_10_0_RELEASE:1.1.1.2.2.2
	RELENG_4_10:1.1.1.2.2.2.0.6
	RELENG_4_10_BP:1.1.1.2.2.2
	OpenSSH_3_8_1p1:1.1.1.5
	OpenSSH_3_8p1:1.1.1.5
	RELENG_5_2_1_RELEASE:1.1.1.3
	RELENG_5_2_0_RELEASE:1.1.1.3
	OpenSSH_3_7_1p2:1.1.1.4
	RELENG_5_2:1.1.1.3.0.6
	RELENG_5_2_BP:1.1.1.3
	RELENG_4_9_0_RELEASE:1.1.1.2.2.2
	RELENG_4_9:1.1.1.2.2.2.0.4
	RELENG_4_9_BP:1.1.1.2.2.2
	RELENG_5_1_0_RELEASE:1.1.1.3
	RELENG_5_1:1.1.1.3.0.4
	RELENG_5_1_BP:1.1.1.3
	OpenSSH_3_6_1p1:1.1.1.3
	RELENG_4_8_0_RELEASE:1.1.1.2.2.2
	RELENG_4_8:1.1.1.2.2.2.0.2
	RELENG_4_8_BP:1.1.1.2.2.2
	RELENG_5_0_0_RELEASE:1.1.1.3
	RELENG_5_0:1.1.1.3.0.2
	RELENG_5_0_BP:1.1.1.3
	OpenSSH_3_5p1:1.1.1.3
	OPENSSH:1.1.1
	RELENG_4_7_0_RELEASE:1.1.1.2.2.1
	RELENG_4_7:1.1.1.2.2.1.0.2
	RELENG_4_7_BP:1.1.1.2.2.1
	RELENG_4_6_2_RELEASE:1.1.1.2.4.1
	RELENG_4_6_1_RELEASE:1.1.1.2.4.1
	RELENG_4_6:1.1.1.2.0.4
	RELENG_4:1.1.1.2.0.2
	OpenSSH_3_4p1:1.1.1.2
	OpenSSH_3_3p1:1.1.1.1
	OPENBSD:1.1.1;
locks; strict;
comment	@# @;


1.6
date	2013.03.23.02.26.25;	author svnexp;	state Exp;
branches
	1.6.2.1;
next	1.5;

1.5
date	2012.09.03.16.51.41;	author des;	state Exp;
branches;
next	1.4;

1.4
date	2011.10.05.22.08.17;	author des;	state Exp;
branches;
next	1.3;

1.3
date	2010.03.09.19.16.43;	author des;	state Exp;
branches
	1.3.2.1;
next	1.2;

1.2
date	2008.08.01.02.48.36;	author des;	state Exp;
branches
	1.2.2.1;
next	1.1;

1.1
date	2002.06.27.22.30.58;	author des;	state Exp;
branches
	1.1.1.1;
next	;

1.6.2.1
date	2013.03.23.02.26.25;	author svnexp;	state dead;
branches;
next	1.6.2.2;

1.6.2.2
date	2013.03.28.13.02.24;	author svnexp;	state Exp;
branches;
next	;

1.3.2.1
date	2013.02.28.18.51.25;	author svnexp;	state Exp;
branches;
next	1.3.2.2;

1.3.2.2
date	2013.05.30.13.02.57;	author svnexp;	state Exp;
branches;
next	;

1.2.2.1
date	2010.04.21.06.33.10;	author des;	state Exp;
branches;
next	1.2.2.2;

1.2.2.2
date	2013.03.01.02.23.11;	author svnexp;	state Exp;
branches;
next	;

1.1.1.1
date	2002.06.27.22.30.58;	author des;	state Exp;
branches;
next	1.1.1.2;

1.1.1.2
date	2002.06.29.11.33.56;	author des;	state Exp;
branches
	1.1.1.2.2.1
	1.1.1.2.4.1;
next	1.1.1.3;

1.1.1.3
date	2002.10.29.09.42.47;	author des;	state Exp;
branches;
next	1.1.1.4;

1.1.1.4
date	2004.01.07.11.10.00;	author des;	state Exp;
branches;
next	1.1.1.5;

1.1.1.5
date	2004.02.26.10.38.36;	author des;	state Exp;
branches;
next	1.1.1.6;

1.1.1.6
date	2004.10.28.16.03.45;	author des;	state Exp;
branches;
next	1.1.1.7;

1.1.1.7
date	2005.06.05.15.40.37;	author des;	state Exp;
branches;
next	1.1.1.8;

1.1.1.8
date	2005.06.05.15.41.45;	author des;	state Exp;
branches
	1.1.1.8.2.1;
next	1.1.1.9;

1.1.1.9
date	2006.09.30.13.29.49;	author des;	state Exp;
branches
	1.1.1.9.2.1;
next	;

1.1.1.2.2.1
date	2002.07.03.22.11.41;	author des;	state Exp;
branches;
next	1.1.1.2.2.2;

1.1.1.2.2.2
date	2003.02.03.17.31.06;	author des;	state Exp;
branches;
next	;

1.1.1.2.4.1
date	2002.07.16.12.27.05;	author des;	state Exp;
branches;
next	;

1.1.1.8.2.1
date	2006.10.06.14.07.11;	author des;	state Exp;
branches;
next	;

1.1.1.9.2.1
date	2008.09.01.20.03.13;	author des;	state Exp;
branches;
next	;


desc
@@


1.6
log
@## SVN ## Exported commit - http://svnweb.freebsd.org/changeset/base/248619
## SVN ## CVS IS DEPRECATED: http://wiki.freebsd.org/CvsIsDeprecated
@
text
@1. Prerequisites
----------------

You will need working installations of Zlib and OpenSSL.

Zlib 1.1.4 or 1.2.1.2 or greater (ealier 1.2.x versions have problems):
http://www.gzip.org/zlib/

OpenSSL 0.9.6 or greater:
http://www.openssl.org/

(OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1
Blowfish) do not work correctly.)

The remaining items are optional.

NB. If you operating system supports /dev/random, you should configure
OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of
/dev/random, or failing that, either prngd or egd

PRNGD:

If your system lacks kernel-based random collection, the use of Lutz
Jaenicke's PRNGd is recommended.

http://prngd.sourceforge.net/

EGD:

The Entropy Gathering Daemon (EGD) is supported if you have a system which
lacks /dev/random and don't want to use OpenSSH's internal entropy collection.

http://www.lothar.com/tech/crypto/

PAM:

OpenSSH can utilise Pluggable Authentication Modules (PAM) if your
system supports it. PAM is standard most Linux distributions, Solaris,
HP-UX 11, AIX >= 5.2, FreeBSD and NetBSD.

Information about the various PAM implementations are available:

Solaris PAM:	http://www.sun.com/software/solaris/pam/
Linux PAM:	http://www.kernel.org/pub/linux/libs/pam/
OpenPAM:	http://www.openpam.org/

If you wish to build the GNOME passphrase requester, you will need the GNOME
libraries and headers.

GNOME:
http://www.gnome.org/

Alternatively, Jim Knoble <jmknoble@@pobox.com> has written an excellent X11
passphrase requester. This is maintained separately at:

http://www.jmknoble.net/software/x11-ssh-askpass/

TCP Wrappers:

If you wish to use the TCP wrappers functionality you will need at least
tcpd.h and libwrap.a, either in the standard include and library paths,
or in the directory specified by --with-tcp-wrappers.  Version 7.6 is
known to work.

http://ftp.porcupine.org/pub/security/index.html

S/Key Libraries:

If you wish to use --with-skey then you will need the library below
installed.  No other S/Key library is currently known to be supported.

http://www.sparc.spb.su/solaris/skey/

LibEdit:

sftp supports command-line editing via NetBSD's libedit.  If your platform
has it available natively you can use that, alternatively you might try
these multi-platform ports:

http://www.thrysoee.dk/editline/
http://sourceforge.net/projects/libedit/

LDNS:

LDNS is a DNS BSD-licensed resolver library which supports DNSSEC.

http://nlnetlabs.nl/projects/ldns/

Autoconf:

If you modify configure.ac or configure doesn't exist (eg if you checked
the code out of CVS yourself) then you will need autoconf-2.68 to rebuild
the automatically generated files by running "autoreconf".  Earlier
versions may also work but this is not guaranteed.

http://www.gnu.org/software/autoconf/

Basic Security Module (BSM):

Native BSM support is know to exist in Solaris from at least 2.5.1,
FreeBSD 6.1 and OS X.  Alternatively, you may use the OpenBSM
implementation (http://www.openbsm.org).


2. Building / Installation
--------------------------

To install OpenSSH with default options:

./configure
make
make install

This will install the OpenSSH binaries in /usr/local/bin, configuration files
in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
installation prefix, use the --prefix option to configure:

./configure --prefix=/opt
make
make install

Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
specific paths, for example:

./configure --prefix=/opt --sysconfdir=/etc/ssh
make
make install

This will install the binaries in /opt/{bin,lib,sbin}, but will place the
configuration files in /etc/ssh.

If you are using Privilege Separation (which is enabled by default)
then you will also need to create the user, group and directory used by
sshd for privilege separation.  See README.privsep for details.

If you are using PAM, you may need to manually install a PAM control
file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
them).  Note that the service name used to start PAM is __progname,
which is the basename of the path of your sshd (e.g., the service name
for /usr/sbin/osshd will be osshd).  If you have renamed your sshd
executable, your PAM configuration may need to be modified.

A generic PAM configuration is included as "contrib/sshd.pam.generic",
you may need to edit it before using it on your system. If you are
using a recent version of Red Hat Linux, the config file in
contrib/redhat/sshd.pam should be more useful.  Failure to install a
valid PAM file may result in an inability to use password
authentication.  On HP-UX 11 and Solaris, the standard /etc/pam.conf
configuration will work with sshd (sshd will match the other service
name).

There are a few other options to the configure script:

--with-audit=[module] enable additional auditing via the specified module.
Currently, drivers for "debug" (additional info via syslog) and "bsm"
(Sun's Basic Security Module) are supported.

--with-pam enables PAM support. If PAM support is compiled in, it must
also be enabled in sshd_config (refer to the UsePAM directive).

--with-prngd-socket=/some/file allows you to enable EGD or PRNGD
support and to specify a PRNGd socket. Use this if your Unix lacks
/dev/random and you don't want to use OpenSSH's builtin entropy
collection support.

--with-prngd-port=portnum allows you to enable EGD or PRNGD support
and to specify a EGD localhost TCP port. Use this if your Unix lacks
/dev/random and you don't want to use OpenSSH's builtin entropy
collection support.

--with-lastlog=FILE will specify the location of the lastlog file.
./configure searches a few locations for lastlog, but may not find
it if lastlog is installed in a different place.

--without-lastlog will disable lastlog support entirely.

--with-osfsia, --without-osfsia will enable or disable OSF1's Security
Integration Architecture.  The default for OSF1 machines is enable.

--with-skey=PATH will enable S/Key one time password support. You will
need the S/Key libraries and header files installed for this to work.

--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
support.

--with-md5-passwords will enable the use of MD5 passwords. Enable this
if your operating system uses MD5 passwords and the system crypt() does
not support them directly (see the crypt(3/3c) man page). If enabled, the
resulting binary will support both MD5 and traditional crypt passwords.

--with-utmpx enables utmpx support. utmpx support is automatic for
some platforms.

--without-shadow disables shadow password support.

--with-ipaddr-display forces the use of a numeric IP address in the
$DISPLAY environment variable. Some broken systems need this.

--with-default-path=PATH allows you to specify a default $PATH for sessions
started by sshd. This replaces the standard path entirely.

--with-pid-dir=PATH specifies the directory in which the sshd.pid file is
created.

--with-xauth=PATH specifies the location of the xauth binary

--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
are installed.

--with-ssl-engine enables OpenSSL's (hardware) ENGINE support

--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
real (AF_INET) IPv4 addresses. Works around some quirks on Linux.

If you need to pass special options to the compiler or linker, you
can specify these as environment variables before running ./configure.
For example:

CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure

3. Configuration
----------------

The runtime configuration files are installed by in ${prefix}/etc or
whatever you specified as your --sysconfdir (/usr/local/etc by default).

The default configuration should be instantly usable, though you should
review it to ensure that it matches your security requirements.

To generate a host key, run "make host-key". Alternately you can do so
manually using the following commands:

    ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
    ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
    ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""

Replacing /etc/ssh with the correct path to the configuration directory.
(${prefix}/etc or whatever you specified with --sysconfdir during
configuration)

If you have configured OpenSSH with EGD support, ensure that EGD is
running and has collected some Entropy.

For more information on configuration, please refer to the manual pages
for sshd, ssh and ssh-agent.

4. (Optional) Send survey
-------------------------

$ make survey
[check the contents of the file "survey" to ensure there's no information
that you consider sensitive]
$ make send-survey

This will send configuration information for the currently configured
host to a survey address.  This will help determine which configurations
are actually in use, and what valid combinations of configure options
exist.  The raw data is available only to the OpenSSH developers, however
summary data may be published.

5. Problems?
------------

If you experience problems compiling, installing or running OpenSSH.
Please refer to the "reporting bugs" section of the webpage at
http://www.openssh.com/


$Id: INSTALL,v 1.88 2013/03/07 01:33:35 dtucker Exp $
@


1.6.2.1
log
@file INSTALL was added on branch RELENG_8_4 on 2013-03-28 13:02:24 +0000
@
text
@d1 269
@


1.6.2.2
log
@## SVN ## Exported commit - http://svnweb.freebsd.org/changeset/base/248810
## SVN ## CVS IS DEPRECATED: http://wiki.freebsd.org/CvsIsDeprecated
@
text
@a0 269
1. Prerequisites
----------------

You will need working installations of Zlib and OpenSSL.

Zlib 1.1.4 or 1.2.1.2 or greater (ealier 1.2.x versions have problems):
http://www.gzip.org/zlib/

OpenSSL 0.9.6 or greater:
http://www.openssl.org/

(OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1
Blowfish) do not work correctly.)

The remaining items are optional.

NB. If you operating system supports /dev/random, you should configure
OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of
/dev/random, or failing that, either prngd or egd

PRNGD:

If your system lacks kernel-based random collection, the use of Lutz
Jaenicke's PRNGd is recommended.

http://prngd.sourceforge.net/

EGD:

The Entropy Gathering Daemon (EGD) is supported if you have a system which
lacks /dev/random and don't want to use OpenSSH's internal entropy collection.

http://www.lothar.com/tech/crypto/

PAM:

OpenSSH can utilise Pluggable Authentication Modules (PAM) if your
system supports it. PAM is standard most Linux distributions, Solaris,
HP-UX 11, AIX >= 5.2, FreeBSD and NetBSD.

Information about the various PAM implementations are available:

Solaris PAM:	http://www.sun.com/software/solaris/pam/
Linux PAM:	http://www.kernel.org/pub/linux/libs/pam/
OpenPAM:	http://www.openpam.org/

If you wish to build the GNOME passphrase requester, you will need the GNOME
libraries and headers.

GNOME:
http://www.gnome.org/

Alternatively, Jim Knoble <jmknoble@@pobox.com> has written an excellent X11
passphrase requester. This is maintained separately at:

http://www.jmknoble.net/software/x11-ssh-askpass/

TCP Wrappers:

If you wish to use the TCP wrappers functionality you will need at least
tcpd.h and libwrap.a, either in the standard include and library paths,
or in the directory specified by --with-tcp-wrappers.  Version 7.6 is
known to work.

http://ftp.porcupine.org/pub/security/index.html

S/Key Libraries:

If you wish to use --with-skey then you will need the library below
installed.  No other S/Key library is currently known to be supported.

http://www.sparc.spb.su/solaris/skey/

LibEdit:

sftp supports command-line editing via NetBSD's libedit.  If your platform
has it available natively you can use that, alternatively you might try
these multi-platform ports:

http://www.thrysoee.dk/editline/
http://sourceforge.net/projects/libedit/

LDNS:

LDNS is a DNS BSD-licensed resolver library which supports DNSSEC.

http://nlnetlabs.nl/projects/ldns/

Autoconf:

If you modify configure.ac or configure doesn't exist (eg if you checked
the code out of CVS yourself) then you will need autoconf-2.61 to rebuild
the automatically generated files by running "autoreconf".  Earlier
versions may also work but this is not guaranteed.

http://www.gnu.org/software/autoconf/

Basic Security Module (BSM):

Native BSM support is know to exist in Solaris from at least 2.5.1,
FreeBSD 6.1 and OS X.  Alternatively, you may use the OpenBSM
implementation (http://www.openbsm.org).


2. Building / Installation
--------------------------

To install OpenSSH with default options:

./configure
make
make install

This will install the OpenSSH binaries in /usr/local/bin, configuration files
in /usr/local/etc, the server in /usr/local/sbin, etc. To specify a different
installation prefix, use the --prefix option to configure:

./configure --prefix=/opt
make
make install

Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
specific paths, for example:

./configure --prefix=/opt --sysconfdir=/etc/ssh
make
make install

This will install the binaries in /opt/{bin,lib,sbin}, but will place the
configuration files in /etc/ssh.

If you are using Privilege Separation (which is enabled by default)
then you will also need to create the user, group and directory used by
sshd for privilege separation.  See README.privsep for details.

If you are using PAM, you may need to manually install a PAM control
file as "/etc/pam.d/sshd" (or wherever your system prefers to keep
them).  Note that the service name used to start PAM is __progname,
which is the basename of the path of your sshd (e.g., the service name
for /usr/sbin/osshd will be osshd).  If you have renamed your sshd
executable, your PAM configuration may need to be modified.

A generic PAM configuration is included as "contrib/sshd.pam.generic",
you may need to edit it before using it on your system. If you are
using a recent version of Red Hat Linux, the config file in
contrib/redhat/sshd.pam should be more useful.  Failure to install a
valid PAM file may result in an inability to use password
authentication.  On HP-UX 11 and Solaris, the standard /etc/pam.conf
configuration will work with sshd (sshd will match the other service
name).

There are a few other options to the configure script:

--with-audit=[module] enable additional auditing via the specified module.
Currently, drivers for "debug" (additional info via syslog) and "bsm"
(Sun's Basic Security Module) are supported.

--with-pam enables PAM support. If PAM support is compiled in, it must
also be enabled in sshd_config (refer to the UsePAM directive).

--with-prngd-socket=/some/file allows you to enable EGD or PRNGD
support and to specify a PRNGd socket. Use this if your Unix lacks
/dev/random and you don't want to use OpenSSH's builtin entropy
collection support.

--with-prngd-port=portnum allows you to enable EGD or PRNGD support
and to specify a EGD localhost TCP port. Use this if your Unix lacks
/dev/random and you don't want to use OpenSSH's builtin entropy
collection support.

--with-lastlog=FILE will specify the location of the lastlog file.
./configure searches a few locations for lastlog, but may not find
it if lastlog is installed in a different place.

--without-lastlog will disable lastlog support entirely.

--with-osfsia, --without-osfsia will enable or disable OSF1's Security
Integration Architecture.  The default for OSF1 machines is enable.

--with-skey=PATH will enable S/Key one time password support. You will
need the S/Key libraries and header files installed for this to work.

--with-tcp-wrappers will enable TCP Wrappers (/etc/hosts.allow|deny)
support.

--with-md5-passwords will enable the use of MD5 passwords. Enable this
if your operating system uses MD5 passwords and the system crypt() does
not support them directly (see the crypt(3/3c) man page). If enabled, the
resulting binary will support both MD5 and traditional crypt passwords.

--with-utmpx enables utmpx support. utmpx support is automatic for
some platforms.

--without-shadow disables shadow password support.

--with-ipaddr-display forces the use of a numeric IP address in the
$DISPLAY environment variable. Some broken systems need this.

--with-default-path=PATH allows you to specify a default $PATH for sessions
started by sshd. This replaces the standard path entirely.

--with-pid-dir=PATH specifies the directory in which the sshd.pid file is
created.

--with-xauth=PATH specifies the location of the xauth binary

--with-ssl-dir=DIR allows you to specify where your OpenSSL libraries
are installed.

--with-ssl-engine enables OpenSSL's (hardware) ENGINE support

--with-4in6 Check for IPv4 in IPv6 mapped addresses and convert them to
real (AF_INET) IPv4 addresses. Works around some quirks on Linux.

If you need to pass special options to the compiler or linker, you
can specify these as environment variables before running ./configure.
For example:

CFLAGS="-O -m486" LDFLAGS="-s" LIBS="-lrubbish" LD="/usr/foo/ld" ./configure

3. Configuration
----------------

The runtime configuration files are installed by in ${prefix}/etc or
whatever you specified as your --sysconfdir (/usr/local/etc by default).

The default configuration should be instantly usable, though you should
review it to ensure that it matches your security requirements.

To generate a host key, run "make host-key". Alternately you can do so
manually using the following commands:

    ssh-keygen -t rsa1 -f /etc/ssh/ssh_host_key -N ""
    ssh-keygen -t rsa -f /etc/ssh/ssh_host_rsa_key -N ""
    ssh-keygen -t dsa -f /etc/ssh/ssh_host_dsa_key -N ""

Replacing /etc/ssh with the correct path to the configuration directory.
(${prefix}/etc or whatever you specified with --sysconfdir during
configuration)

If you have configured OpenSSH with EGD support, ensure that EGD is
running and has collected some Entropy.

For more information on configuration, please refer to the manual pages
for sshd, ssh and ssh-agent.

4. (Optional) Send survey
-------------------------

$ make survey
[check the contents of the file "survey" to ensure there's no information
that you consider sensitive]
$ make send-survey

This will send configuration information for the currently configured
host to a survey address.  This will help determine which configurations
are actually in use, and what valid combinations of configure options
exist.  The raw data is available only to the OpenSSH developers, however
summary data may be published.

5. Problems?
------------

If you experience problems compiling, installing or running OpenSSH.
Please refer to the "reporting bugs" section of the webpage at
http://www.openssh.com/


$Id: INSTALL,v 1.87 2011/11/04 00:25:25 dtucker Exp $
@


1.5
log
@SVN rev 240075 on 2012-09-03 16:51:41Z by des

Upgrade OpenSSH to 6.1p1.
@
text
@d92 1
a92 1
the code out of CVS yourself) then you will need autoconf-2.61 to rebuild
d269 1
a269 1
$Id: INSTALL,v 1.87 2011/11/04 00:25:25 dtucker Exp $
@


1.4
log
@SVN rev 226046 on 2011-10-05 22:08:17Z by des

Upgrade to OpenSSH 5.9p1.

MFC after:	3 months
@
text
@d83 6
d269 1
a269 1
$Id: INSTALL,v 1.86 2011/05/05 03:48:37 djm Exp $
@


1.3
log
@SVN rev 204917 on 2010-03-09 19:16:43Z by des

Upgrade to OpenSSH 5.4p1.

MFC after:	1 month
@
text
@d19 1
a19 3
/dev/random, or failing that, either prngd or egd.  If you don't have
any of these you will have to rely on ssh-rand-helper, which is inferior
to a good kernel-based solution or prngd.
d263 1
a263 1
$Id: INSTALL,v 1.85 2010/02/11 22:34:22 djm Exp $
@


1.3.2.1
log
@## SVN ## Exported commit - http://svnweb.freebsd.org/changeset/base/247485
## SVN ## CVS IS DEPRECATED: http://wiki.freebsd.org/CvsIsDeprecated
@
text
@d19 3
a21 1
/dev/random, or failing that, either prngd or egd
a84 6
LDNS:

LDNS is a DNS BSD-licensed resolver library which supports DNSSEC.

http://nlnetlabs.nl/projects/ldns/

d265 1
a265 1
$Id: INSTALL,v 1.87 2011/11/04 00:25:25 dtucker Exp $
@


1.3.2.2
log
@## SVN ## Exported commit - http://svnweb.freebsd.org/changeset/base/251135
## SVN ## CVS IS DEPRECATED: http://wiki.freebsd.org/CvsIsDeprecated
@
text
@d92 1
a92 1
the code out of CVS yourself) then you will need autoconf-2.68 to rebuild
d269 1
a269 1
$Id: INSTALL,v 1.88 2013/03/07 01:33:35 dtucker Exp $
@


1.2
log
@SVN rev 181111 on 2008-08-01 02:48:36Z by des

Upgrade to OpenSSH 5.1p1.

I have worked hard to reduce diffs against the vendor branch.  One
notable change in that respect is that we no longer prefer DSA over
RSA - the reasons for doing so went away years ago.  This may cause
some surprises, as ssh will warn about unknown host keys even for
hosts whose keys haven't changed.

MFC after:	6 weeks
@
text
@a210 4
--with-opensc=DIR
--with-sectok=DIR allows for OpenSC or sectok smartcard libraries to
be used with OpenSSH.  See 'README.smartcard' for more details.

d265 1
a265 1
$Id: INSTALL,v 1.84 2007/08/17 12:52:05 dtucker Exp $
@


1.2.2.1
log
@SVN rev 206984 on 2010-04-21 06:33:10Z by des

MFH OpenSSH 5.4p1
@
text
@d211 4
d269 1
a269 1
$Id: INSTALL,v 1.85 2010/02/11 22:34:22 djm Exp $
@


1.2.2.2
log
@## SVN ## Exported commit - http://svnweb.freebsd.org/changeset/base/247521
## SVN ## CVS IS DEPRECATED: http://wiki.freebsd.org/CvsIsDeprecated
@
text
@d19 3
a21 1
/dev/random, or failing that, either prngd or egd
a84 6
LDNS:

LDNS is a DNS BSD-licensed resolver library which supports DNSSEC.

http://nlnetlabs.nl/projects/ldns/

d265 1
a265 1
$Id: INSTALL,v 1.87 2011/11/04 00:25:25 dtucker Exp $
@


1.1
log
@Initial revision
@
text
@d6 2
a7 2
Zlib:
http://www.gzip.org/zlib/ 
d12 2
a13 2
(OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1 
Blowfish included) do not work correctly.)
d15 21
a35 12
RPMs of OpenSSL are available at http://violet.ibs.com.au/openssh/files/support.
For Red Hat Linux 6.2, they have been released as errata.  RHL7 includes
these.

OpenSSH can utilise Pluggable Authentication Modules (PAM) if your system
supports it. PAM is standard on Redhat and Debian Linux, Solaris and
HP-UX 11.

NB. If you operating system supports /dev/random, you should configure 
OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of 
/dev/random. If you don't you will have to rely on ssh-rand-helper, which 
is inferior to a good kernel-based solution.
d38 10
a47 1
http://www.kernel.org/pub/linux/libs/pam/
d55 1
a55 1
Alternatively, Jim Knoble <jmknoble@@jmknoble.cx> has written an excellent X11
d58 12
a69 1
http://www.ntrnet.net/~jmknoble/software/x11-ssh-askpass/index.html
d71 10
a80 1
PRNGD:
d82 2
a83 2
If your system lacks Kernel based random collection, the use of Lutz 
Jaenicke's PRNGd is recommended.
d85 1
a85 1
http://www.aet.tu-cottbus.de/personen/jaenicke/postfix_tls/prngd.html
d87 4
a90 1
EGD:
d92 1
a92 2
The Entropy Gathering Daemon (EGD) is supported if you have a system which
lacks /dev/random and don't want to use OpenSSH's internal entropy collection.
d94 1
a94 1
http://www.lothar.com/tech/crypto/
d96 3
a98 2
S/Key Libraries:
http://www.sparc.spb.su/solaris/skey/
a99 3
If you wish to use --with-skey then you will need the above library
installed.  No other current S/Key library is currently known to be
supported. 
d118 1
a118 1
Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override 
d128 4
d150 10
a159 14
--with-rsh=PATH allows you to specify the path to your rsh program. 
Normally ./configure will search the current $PATH for 'rsh'. You 
may need to specify this option if rsh is not in your path or has a
different name.

--with-pam enables PAM support.

--enable-gnome-askpass will build the GNOME passphrase dialog. You
need a working installation of GNOME, including the development
headers, for this to work.

--with-prngd-socket=/some/file allows you to enable EGD or PRNGD 
support and to specify a PRNGd socket. Use this if your Unix lacks 
/dev/random and you don't want to use OpenSSH's builtin entropy 
d162 3
a164 3
--with-prngd-port=portnum allows you to enable EGD or PRNGD support 
and to specify a EGD localhost TCP port. Use this if your Unix lacks 
/dev/random and you don't want to use OpenSSH's builtin entropy 
d167 1
a167 1
--with-lastlog=FILE will specify the location of the lastlog file. 
d173 1
a173 1
--with-sia, --without-sia will enable or disable OSF1's Security 
d176 1
a176 11
--with-kerberos4=PATH will enable Kerberos IV support. You will need
to have the Kerberos libraries and header files installed for this
to work. Use the optional PATH argument to specify the root of your
Kerberos installation.

--with-afs=PATH will enable AFS support. You will need to have the
Kerberos IV and the AFS libraries and header files installed for this
to work.  Use the optional PATH argument to specify the root of your
AFS installation. AFS requires Kerberos support to be enabled.

--with-skey=PATH will enable S/Key one time password support. You will 
d180 1
a180 1
support. You will need libwrap.a and tcpd.h installed.
d183 3
a185 1
if your operating system uses MD5 passwords without using PAM.
d187 1
a187 1
--with-utmpx enables utmpx support. utmpx support is automatic for 
d192 1
a192 1
--with-ipaddr-display forces the use of a numeric IP address in the 
d198 1
a198 1
--with-pid-dir=PATH specifies the directory in which the ssh.pid file is
a202 6
--with-ipv4-default instructs OpenSSH to use IPv4 by default for new
connections. Normally OpenSSH will try attempt to lookup both IPv6 and
IPv4 addresses. On Linux/glibc-2.1.2 this causes long delays in name
resolution. If this option is specified, you can still attempt to 
connect to IPv6 addresses using the command line option '-6'.

d206 2
d224 1
a224 1
The runtime configuration files are installed by in ${prefix}/etc or 
d227 1
a227 1
The default configuration should be instantly usable, though you should 
d231 1
a231 1
manually using the following commands: 
d238 1
a238 1
(${prefix}/etc or whatever you specified with --sysconfdir during 
d244 1
a244 1
For more information on configuration, please refer to the manual pages 
d247 15
a261 1
4. Problems?
d264 1
a264 1
If you experience problems compiling, installing or running OpenSSH. 
d269 1
a269 1
$Id: INSTALL,v 1.53 2002/05/13 05:22:21 djm Exp $
@


1.1.1.1
log
@Vendor import of OpenSSH 3.3p1.
@
text
@@


1.1.1.2
log
@Vendor import of OpenSSH 3.4p1.
@
text
@d108 5
d229 1
a229 1
$Id: INSTALL,v 1.54 2002/06/24 16:26:49 stevesk Exp $
@


1.1.1.3
log
@Vendor import of OpenSSH-portable 3.5p1.
@
text
@d13 5
a17 1
Blowfish) do not work correctly.)
d224 1
a224 1
$Id: INSTALL,v 1.55 2002/07/25 04:36:25 djm Exp $
@


1.1.1.4
log
@Vendor import of OpenSSH 3.7.1p2.
@
text
@d6 1
a6 1
Zlib 1.1.4 or greater:
d36 1
a36 1
http://www.jmknoble.net/software/x11-ssh-askpass/
d104 5
a108 2
--with-pam enables PAM support. If PAM support is compiled in, it must
also be enabled in sshd_config (refer to the UsePAM directive).
d126 1
a126 1
--with-osfsia, --without-osfsia will enable or disable OSF1's Security 
d129 10
d164 6
d220 1
a220 1
$Id: INSTALL,v 1.56.2.4 2003/09/23 09:24:21 djm Exp $
@


1.1.1.5
log
@Vendor import of OpenSSH 3.8p1.
@
text
@d7 1
a7 1
http://www.gzip.org/zlib/
d12 1
a12 1
(OpenSSL 0.9.5a is partially supported, but some ciphers (SSH protocol 1
d19 3
a21 3
NB. If you operating system supports /dev/random, you should configure
OpenSSL to use it. OpenSSH relies on OpenSSL's direct support of
/dev/random. If you don't you will have to rely on ssh-rand-helper, which
d40 1
a40 1
If your system lacks Kernel based random collection, the use of Lutz
d57 1
a57 1
supported.
d76 1
a76 1
Will install OpenSSH in /opt/{bin,etc,lib,sbin}. You can also override
d107 3
a109 3
--with-prngd-socket=/some/file allows you to enable EGD or PRNGD
support and to specify a PRNGd socket. Use this if your Unix lacks
/dev/random and you don't want to use OpenSSH's builtin entropy
d112 3
a114 3
--with-prngd-port=portnum allows you to enable EGD or PRNGD support
and to specify a EGD localhost TCP port. Use this if your Unix lacks
/dev/random and you don't want to use OpenSSH's builtin entropy
d117 1
a117 1
--with-lastlog=FILE will specify the location of the lastlog file.
d123 1
a123 1
--with-osfsia, --without-osfsia will enable or disable OSF1's Security
d126 1
a126 1
--with-skey=PATH will enable S/Key one time password support. You will
d133 1
a133 3
if your operating system uses MD5 passwords and the system crypt() does
not support them directly (see the crypt(3/3c) man page). If enabled, the
resulting binary will support both MD5 and traditional crypt passwords.
d135 1
a135 1
--with-utmpx enables utmpx support. utmpx support is automatic for
d140 1
a140 1
--with-ipaddr-display forces the use of a numeric IP address in the
d170 1
a170 1
The runtime configuration files are installed by in ${prefix}/etc or
d173 1
a173 1
The default configuration should be instantly usable, though you should
d177 1
a177 1
manually using the following commands:
d184 1
a184 1
(${prefix}/etc or whatever you specified with --sysconfdir during
d190 1
a190 1
For more information on configuration, please refer to the manual pages
d196 1
a196 1
If you experience problems compiling, installing or running OpenSSH.
d201 1
a201 1
$Id: INSTALL,v 1.63 2003/11/21 12:48:55 djm Exp $
@


1.1.1.6
log
@Vendor import of OpenSSH 3.9p1.
@
text
@d33 1
a33 1
Alternatively, Jim Knoble <jmknoble@@pobox.com> has written an excellent X11
d203 1
a203 1
$Id: INSTALL,v 1.64 2004/05/26 23:59:31 dtucker Exp $
@


1.1.1.7
log
@Vendor import of OpenSSH 4.0p1.
@
text
@a54 8
LibEdit:

sftp now supports command-line editing via NetBSD's libedit.  If your
platform has it available natively you can use that, alternatively
you might try these multi-platform ports:
http://www.thrysoee.dk/editline/
http://sourceforge.net/projects/libedit/

d195 1
a195 14
4. (Optional) Send survey
-------------------------

$ make survey
[check the contents and make sure there's no sensitive information]
$ make send-survey

This will send configuration information for the currently configured
host to a survey address.  This will help determine which configurations
are actually in use, and what valid combinations of configure options
exist.  The raw data is available only to the OpenSSH developers, however
summary data may be published.

5. Problems?
d203 1
a203 1
$Id: INSTALL,v 1.66 2005/01/18 01:05:18 dtucker Exp $
@


1.1.1.8
log
@Vendor import of OpenSSH 4.1p1.
@
text
@d6 1
a6 1
Zlib 1.1.4 or 1.2.1.2 or greater (ealier 1.2.x versions have problems):
a52 4

If you wish to use --with-skey then you will need the library below
installed.  No other S/Key library is currently known to be supported.

d56 1
a59 1

d63 4
a93 4
If you are using Privilege Separation (which is enabled by default)
then you will also need to create the user, group and directory used by
sshd for privilege separation.  See README.privsep for details.

d224 1
a224 1
$Id: INSTALL,v 1.70 2005/04/24 07:52:23 dtucker Exp $
@


1.1.1.8.2.1
log
@MFC: OpenSSH 4.4p1.

Approved by:	re (kensmith)
@
text
@a14 2
The remaining items are optional.

d60 3
a62 4

sftp supports command-line editing via NetBSD's libedit.  If your platform
has it available natively you can use that, alternatively you might try
these multi-platform ports:
a66 15
Autoconf:

If you modify configure.ac or configure doesn't exist (eg if you checked
the code out of CVS yourself) then you will need autoconf-2.60 to rebuild
the automatically generated files by running "autoreconf".

http://www.gnu.org/software/autoconf/

Basic Security Module (BSM):

Native BSM support is know to exist in Solaris from at least 2.5.1,
FreeBSD 6.1 and OS X.  Alternatively, you may use the OpenBSM
implementation (http://www.openbsm.org).


a115 4
--with-audit=[module] enable additional auditing via the specified module.
Currently, drivers for "debug" (additional info via syslog) and "bsm"
(Sun's Basic Security Module) are supported.

a167 2
--with-ssl-engine enables OpenSSL's (hardware) ENGINE support

d211 1
a211 2
[check the contents of the file "survey" to ensure there's no information
that you consider sensitive]
d228 1
a228 1
$Id: INSTALL,v 1.76 2006/09/17 12:55:52 dtucker Exp $
@


1.1.1.9
log
@Vendor import of OpenSSH 4.4p1.
@
text
@a14 2
The remaining items are optional.

d60 3
a62 4

sftp supports command-line editing via NetBSD's libedit.  If your platform
has it available natively you can use that, alternatively you might try
these multi-platform ports:
a66 15
Autoconf:

If you modify configure.ac or configure doesn't exist (eg if you checked
the code out of CVS yourself) then you will need autoconf-2.60 to rebuild
the automatically generated files by running "autoreconf".

http://www.gnu.org/software/autoconf/

Basic Security Module (BSM):

Native BSM support is know to exist in Solaris from at least 2.5.1,
FreeBSD 6.1 and OS X.  Alternatively, you may use the OpenBSM
implementation (http://www.openbsm.org).


a115 4
--with-audit=[module] enable additional auditing via the specified module.
Currently, drivers for "debug" (additional info via syslog) and "bsm"
(Sun's Basic Security Module) are supported.

a167 2
--with-ssl-engine enables OpenSSL's (hardware) ENGINE support

d211 1
a211 2
[check the contents of the file "survey" to ensure there's no information
that you consider sensitive]
d228 1
a228 1
$Id: INSTALL,v 1.76 2006/09/17 12:55:52 dtucker Exp $
@


1.1.1.9.2.1
log
@SVN rev 182634 on 2008-09-01 20:03:13Z by des

MFH OpenSSH 5.1p1
@
text
@d17 4
d23 2
a24 17
/dev/random, or failing that, either prngd or egd.  If you don't have
any of these you will have to rely on ssh-rand-helper, which is inferior
to a good kernel-based solution or prngd.

PRNGD:

If your system lacks kernel-based random collection, the use of Lutz
Jaenicke's PRNGd is recommended.

http://prngd.sourceforge.net/

EGD:

The Entropy Gathering Daemon (EGD) is supported if you have a system which
lacks /dev/random and don't want to use OpenSSH's internal entropy collection.

http://www.lothar.com/tech/crypto/
d27 1
a27 10

OpenSSH can utilise Pluggable Authentication Modules (PAM) if your
system supports it. PAM is standard most Linux distributions, Solaris,
HP-UX 11, AIX >= 5.2, FreeBSD and NetBSD.

Information about the various PAM implementations are available:

Solaris PAM:	http://www.sun.com/software/solaris/pam/
Linux PAM:	http://www.kernel.org/pub/linux/libs/pam/
OpenPAM:	http://www.openpam.org/
d40 4
a43 1
TCP Wrappers:
d45 1
a45 4
If you wish to use the TCP wrappers functionality you will need at least
tcpd.h and libwrap.a, either in the standard include and library paths,
or in the directory specified by --with-tcp-wrappers.  Version 7.6 is
known to work.
d47 6
a52 1
http://ftp.porcupine.org/pub/security/index.html
d73 2
a74 3
the code out of CVS yourself) then you will need autoconf-2.61 to rebuild
the automatically generated files by running "autoreconf".  Earlier
versions may also work but this is not guaranteed.
d164 1
a164 1
support.
d182 1
a182 1
--with-pid-dir=PATH specifies the directory in which the sshd.pid file is
d253 1
a253 1
$Id: INSTALL,v 1.84 2007/08/17 12:52:05 dtucker Exp $
@


1.1.1.2.4.1
log
@Merge OpenSSH, OPIE, PAM and a number of dependencies from -STABLE.
@
text
@@


1.1.1.2.2.1
log
@Synch up to OpenSSH 3.4p1 - very nearly the same sources as in -CURRENT,
with a slightly different config.h to account for differences between
-CURRENT and -STABLE.

Privilege separation defaults to off for now as it breaks some aspects
of Kerberos authentication.

Sponsored by:	DARPA, NAI Labs
@
text
@@


1.1.1.2.2.2
log
@MFC: OpenSSH 3.5p1, with all FreeBSD patches.
@
text
@d13 5
a17 1
Blowfish) do not work correctly.)
d224 1
a224 1
$Id: INSTALL,v 1.55 2002/07/25 04:36:25 djm Exp $
@


