openssh/README

[ A Japanese translation of this document is available at
[ http://www.unixuser.org/%7Eharuyama/security/openssh/index.html
[ Thanks to HARUYAMA Seigo <haruyama@nt.phys.s.u-tokyo.ac.jp>

******* IMPORTANT
* On systmes which lack a /dev/random driver, version of this port
* prior to 1.2.2 were not correctly seeding OpenSSL's random number
* pool. This resulted in lower quality RSA keys being generated. If
* you generated host or user keys with v1.2.2 or previous versions, 
* please generate new ones using a more recent version.

This is the port of OpenBSD's excellent OpenSSH to Linux and other
Unices.

OpenSSH is based on the last free version of Tatu Ylonen's SSH with
all patent-encumbered algorithms removed (to external libraries), all
known security bugs fixed, new features reintroduced and many other
clean-ups. More information about SSH itself can be found in the file
README.Ylonen. OpenSSH has been created by Aaron Campbell, Bob Beck,
Markus Friedl, Niels Provos, Theo de Raadt, and Dug Song. It has a
homepage at http://www.openssh.com/

This port consists of the re-introduction of autoconf support, PAM
support (for Linux and Solaris), EGD[1] support and replacements for 
OpenBSD library functions that are (regrettably) absent from other 
unices. This port has been best tested on Linux, Solaris, HPUX, NetBSD 
and Irix. Support for AIX, SCO, NeXT and other Unices is underway. 
This version actively tracks changes in the OpenBSD CVS repository.

The PAM support is now more functional than the popular packages of
commercial ssh-1.2.x. It checks "account" and "session" modules for
all logins, not just when using password authentication.

OpenSSH depends on Zlib[2], OpenSSL[3] and optionally PAM[4].

There is now several mailing lists for this port of OpenSSH. Please
refer to http://www.openssh.com/list.html for details on how to join.

Please send bug reports and patches to the mailing list
openssh-unix-dev@mindrot.org. The list is open to posting by
unsubscribed users.

If you are a citizen of the USA or another country which restricts 
export of cryptographic products, then please refrain from sending 
crypto-related code or patches to the list. We cannot accept them.
Other code contribution are accepted, but please follow the OpenBSD
style guidelines[5].

Please refer to the INSTALL document for information on how to install
OpenSSH on your system. The UPGRADING document details differences 
between this port of OpenSSH and F-Secure SSH 1.x.

Damien Miller <djm@mindrot.org>

Miscellania - 

This version of SSH is based upon code retrieved from the OpenBSD CVS
repository which in turn was based on the last free 
version of SSH released by Tatu Ylonen.

References -

[1] http://www.lothar.com/tech/crypto/
[2] ftp://ftp.freesoftware.com/pub/infozip/zlib/
[3] http://www.openssl.org/
[4] http://www.kernel.org/pub/linux/libs/pam/ (PAM is standard on Solaris)
[5] http://www.openbsd.org/cgi-bin/man.cgi?query=style&sektion=9&apropos=0&manpath=OpenBSD+Current
- Documentation fixes from HARUYAMA Seigo <haruyama@nt.phys.s.u-tokyo.ac.jp> - Added URLs to Japanese translations of documents by HARUYAMA Seigo <haruyama@nt.phys.s.u-tokyo.ac.jp> 2000-02-02 09:56:20 +00:00			`[ A Japanese translation of this document is available at`
			`[ http://www.unixuser.org/%7Eharuyama/security/openssh/index.html`
			`[ Thanks to HARUYAMA Seigo <haruyama@nt.phys.s.u-tokyo.ac.jp>`

add warning 2000-03-07 11:40:57 +00:00			`******* IMPORTANT`
- Doc updates 2000-05-09 05:03:37 +00:00			`* On systmes which lack a /dev/random driver, version of this port`
			`* prior to 1.2.2 were not correctly seeding OpenSSL's random number`
add warning 2000-03-07 11:40:57 +00:00			`* pool. This resulted in lower quality RSA keys being generated. If`
- Doc updates 2000-05-09 05:03:37 +00:00			`* you generated host or user keys with v1.2.2 or previous versions,`
			`* please generate new ones using a more recent version.`
add warning 2000-03-07 11:40:57 +00:00
- Merged PAM buffer overrun patch from Chip Salzenberg <chip@valinux.com> 1999-11-18 20:56:21 +00:00			`This is the port of OpenBSD's excellent OpenSSH to Linux and other`
			`Unices.`
Initial revision 1999-10-27 03:42:43 +00:00
Renamed README -> README.Ylonen Renamed README.openssh -> README Minor updated to new README 1999-10-30 01:30:35 +00:00			`OpenSSH is based on the last free version of Tatu Ylonen's SSH with`
Doc updates 2000-01-06 09:28:41 +00:00			`all patent-encumbered algorithms removed (to external libraries), all`
			`known security bugs fixed, new features reintroduced and many other`
			`clean-ups. More information about SSH itself can be found in the file`
			`README.Ylonen. OpenSSH has been created by Aaron Campbell, Bob Beck,`
			`Markus Friedl, Niels Provos, Theo de Raadt, and Dug Song. It has a`
			`homepage at http://www.openssh.com/`
Initial revision 1999-10-27 03:42:43 +00:00
Doc and spec updates 1999-11-10 23:50:04 +00:00			`This port consists of the re-introduction of autoconf support, PAM`
- Doc updates 2000-05-09 05:03:37 +00:00			`support (for Linux and Solaris), EGD[1] support and replacements for`
			`OpenBSD library functions that are (regrettably) absent from other`
			`unices. This port has been best tested on Linux, Solaris, HPUX, NetBSD`
			`and Irix. Support for AIX, SCO, NeXT and other Unices is underway.`
			`This version actively tracks changes in the OpenBSD CVS repository.`
Initial revision 1999-10-27 03:42:43 +00:00
Renamed README -> README.Ylonen Renamed README.openssh -> README Minor updated to new README 1999-10-30 01:30:35 +00:00			`The PAM support is now more functional than the popular packages of`
			`commercial ssh-1.2.x. It checks "account" and "session" modules for`
Documentation updates 1999-11-12 05:06:47 +00:00			`all logins, not just when using password authentication.`
Initial revision 1999-10-27 03:42:43 +00:00
- Doc updates 2000-05-09 05:03:37 +00:00			`OpenSSH depends on Zlib[2], OpenSSL[3] and optionally PAM[4].`
Doc updates 1999-11-09 04:03:01 +00:00
Doc updates 2000-01-06 09:28:41 +00:00			`There is now several mailing lists for this port of OpenSSH. Please`
- Doc cleanup 2000-05-20 05:41:26 +00:00			`refer to http://www.openssh.com/list.html for details on how to join.`
Added mailing list info 1999-11-12 03:11:10 +00:00
Doc updates 2000-01-06 09:28:41 +00:00			`Please send bug reports and patches to the mailing list`
- (djm) Make EGD failures non-fatal if OpenSSL's entropy pool is still OK based on patch from Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE> 2000-06-26 03:01:33 +00:00			`openssh-unix-dev@mindrot.org. The list is open to posting by`
Doc updates 2000-01-06 09:28:41 +00:00			`unsubscribed users.`
- Some older systems don't have poll.h, they use sys/poll.h instead - Doc updates 1999-12-14 04:43:03 +00:00
- (djm) Make EGD failures non-fatal if OpenSSL's entropy pool is still OK based on patch from Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE> 2000-06-26 03:01:33 +00:00			`If you are a citizen of the USA or another country which restricts`
			`export of cryptographic products, then please refrain from sending`
			`crypto-related code or patches to the list. We cannot accept them.`
			`Other code contribution are accepted, but please follow the OpenBSD`
			`style guidelines[5].`

Added INSTALL documentation Minor other doc updates 1999-11-12 03:35:58 +00:00			`Please refer to the INSTALL document for information on how to install`
Doc updates 2000-01-06 09:28:41 +00:00			`OpenSSH on your system. The UPGRADING document details differences`
			`between this port of OpenSSH and F-Secure SSH 1.x.`
Documentation updates 1999-11-12 05:06:47 +00:00
Change of employer :) 2000-10-28 02:22:06 +00:00			`Damien Miller <djm@mindrot.org>`
Initial revision 1999-10-27 03:42:43 +00:00
Renamed README -> README.Ylonen Renamed README.openssh -> README Minor updated to new README 1999-10-30 01:30:35 +00:00			`Miscellania -`
Initial revision 1999-10-27 03:42:43 +00:00
Renamed README -> README.Ylonen Renamed README.openssh -> README Minor updated to new README 1999-10-30 01:30:35 +00:00			`This version of SSH is based upon code retrieved from the OpenBSD CVS`
Doc updates 2000-01-06 09:28:41 +00:00			`repository which in turn was based on the last free`
doc updates 1999-11-09 04:05:11 +00:00			`version of SSH released by Tatu Ylonen.`
Initial revision 1999-10-27 03:42:43 +00:00
Lots of changes: - Removed lots of unnecessary checks from autoconf - Added support and autoconf test for openpty() function (Unix98 pty support) - Fix for scp not finding ssh if not installed as /usr/bin/ssh - Added TODO file - Merged parts of Debian patch From Phil Hands <phil@hands.com>: - Added ssh-askpass program - Added ssh-askpass support to ssh-add.c - Create symlinks for slogin on install - Fix "distclean" target in makefile - Added example for ssh-agent to manpage - Added support for PAM_TEXT_INFO messages - Disable internal /etc/nologin support if PAM enabled - Merged latest OpenBSD CVS changes: - [sshd.c] don't send fail-msg but disconnect if too many authentication failures - [sshd.c] replace assert() with error, fatal or packet_disconnect - [sshd.c] remove unused argument. ok dugsong - [sshd.c] typo - [rsa.c] clear buffers used for encryption. ok: niels - [rsa.c] replace assert() with error, fatal or packet_disconnect - Fixed coredump after merge of OpenBSD rsa.c patch 1999-11-08 04:30:59 +00:00			`References -`

Doc and spec updates 1999-11-10 23:50:04 +00:00			`[1] http://www.lothar.com/tech/crypto/`
fix linkrot 2000-06-07 22:48:24 +00:00			`[2] ftp://ftp.freesoftware.com/pub/infozip/zlib/`
Doc and spec updates 1999-11-10 23:50:04 +00:00			`[3] http://www.openssl.org/`
			`[4] http://www.kernel.org/pub/linux/libs/pam/ (PAM is standard on Solaris)`
- (djm) Make EGD failures non-fatal if OpenSSL's entropy pool is still OK based on patch from Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE> 2000-06-26 03:01:33 +00:00			`[5] http://www.openbsd.org/cgi-bin/man.cgi?query=style&sektion=9&apropos=0&manpath=OpenBSD+Current`
doc updates 1999-11-09 04:05:11 +00:00