openssh/README

See https://www.openssh.com/releasenotes.html#7.6p1 for the release notes.

Please read https://www.openssh.com/report.html for bug reporting
instructions and note that we do not use Github for bug reporting or
patch/pull-request management.

- A Japanese translation of this document and of the release notes is
- available at http://www.unixuser.org/~haruyama/security/openssh/index.html
- Thanks to HARUYAMA Seigo <haruyama@unixuser.org>

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

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

This port consists of the re-introduction of autoconf support, PAM
support, EGD[1]/PRNGD[2] support and replacements for OpenBSD library
functions that are (regrettably) absent from other unices. This port
has been best tested on AIX, Cygwin, HP-UX, Linux, MacOS/X,
NetBSD, OpenBSD, OpenServer, Solaris and UnixWare.

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[3], OpenSSL[4], and optionally PAM[5] and
libedit[6]

There is now several mailing lists for this port of OpenSSH. Please
refer to https://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.  Code contribution are welcomed, but please follow the OpenBSD
style guidelines[7].

Please refer to the INSTALL document for information on how to install
OpenSSH on your system.

Damien Miller <djm@mindrot.org>

Miscellania -

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

References -

[0] https://www.openssh.com/
[1] http://www.lothar.com/tech/crypto/
[2] http://prngd.sourceforge.net/
[3] http://www.gzip.org/zlib/
[4] http://www.openssl.org/
[5] http://www.openpam.org
    http://www.kernel.org/pub/linux/libs/pam/
    (PAM also is standard on Solaris and HP-UX 11)
[6] http://thrysoee.dk/editline/ (portable version)
[7] http://man.openbsd.org/style.9
sync release notes URL 2017-09-30 23:01:56 +00:00			`See https://www.openssh.com/releasenotes.html#7.6p1 for the release notes.`
- (dtucker) [README] Add pointer to release notes. ok djm@ 2004-02-24 05:13:24 +00:00
Update links. Make links to openssh.com HTTPS now that it's supported, point release notes link to the HTML release notes page, and update a couple of other links and bits of text. 2016-10-20 18:22:55 +00:00			`Please read https://www.openssh.com/report.html for bug reporting`
we don't use Github for issues/pull-requests 2015-08-21 04:49:03 +00:00			`instructions and note that we do not use Github for bug reporting or`
			`patch/pull-request management.`

Update links. Make links to openssh.com HTTPS now that it's supported, point release notes link to the HTML release notes page, and update a couple of other links and bits of text. 2016-10-20 18:22:55 +00:00			`- A Japanese translation of this document and of the release notes is`
Fix Haruyama-san's email address 2000-11-29 01:51:14 +00:00			`- available at http://www.unixuser.org/~haruyama/security/openssh/index.html`
HARUYAMA Seigo has changed address 2001-12-24 03:17:21 +00:00			`- Thanks to HARUYAMA Seigo <haruyama@unixuser.org>`
add warning 2000-03-07 11:40:57 +00:00
- (djm) Remove UPGRADING document in favour of a link to the better maintained FAQ on www.openssh.com 2000-11-06 01:48:54 +00:00			`This is the port of OpenBSD's excellent OpenSSH[0] to Linux and other`
- Merged PAM buffer overrun patch from Chip Salzenberg <chip@valinux.com> 1999-11-18 20:56:21 +00:00			`Unices.`
Initial revision 1999-10-27 03:42:43 +00:00
cleanups. 2001-02-24 09:00:23 +00:00			`OpenSSH is based on the last free version of Tatu Ylonen's sample`
			`implementation with all patent-encumbered algorithms removed (to`
			`external libraries), all known security bugs fixed, new features`
			`reintroduced and many other clean-ups. OpenSSH has been created by`
			`Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo de Raadt,`
Update links. Make links to openssh.com HTTPS now that it's supported, point release notes link to the HTML release notes page, and update a couple of other links and bits of text. 2016-10-20 18:22:55 +00:00			`and Dug Song. It has a homepage at https://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`
Minor updates to some README files. 2004-06-28 03:50:35 +00:00			`support, EGD[1]/PRNGD[2] support and replacements for OpenBSD library`
			`functions that are (regrettably) absent from other unices. This port`
			`has been best tested on AIX, Cygwin, HP-UX, Linux, MacOS/X,`
Remove references to UNICOS. 2018-02-15 11:22:38 +00:00			`NetBSD, OpenBSD, OpenServer, Solaris and UnixWare.`
Minor updates to some README files. 2004-06-28 03:50:35 +00:00
- Doc updates 2000-05-09 05:03:37 +00:00			`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
mention libedit 2017-07-21 04:24:26 +00:00			`OpenSSH depends on Zlib[3], OpenSSL[4], and optionally PAM[5] and`
			`libedit[6]`
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`
Update links. Make links to openssh.com HTTPS now that it's supported, point release notes link to the HTML release notes page, and update a couple of other links and bits of text. 2016-10-20 18:22:55 +00:00			`refer to https://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`
Fix formatting. 2016-10-20 22:46:46 +00:00			`openssh-unix-dev@mindrot.org. The list is open to posting by unsubscribed`
			`users. Code contribution are welcomed, but please follow the OpenBSD`
mention libedit 2017-07-21 04:24:26 +00:00			`style guidelines[7].`
- (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
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`
Update links. Make links to openssh.com HTTPS now that it's supported, point release notes link to the HTML release notes page, and update a couple of other links and bits of text. 2016-10-20 18:22:55 +00:00			`OpenSSH on your system.`
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
- djm@cvs.openbsd.org 2003/11/21 11:57:03 [everything] unexpand and delete whitespace at EOL; ok markus@ (done locally and RCS IDs synced) 2003-11-21 12:48:55 +00:00			`Miscellania -`
Initial revision 1999-10-27 03:42:43 +00:00
cleanups. 2001-02-24 09:00:23 +00:00			`This version of OpenSSH is based upon code retrieved from the OpenBSD`
			`CVS repository which in turn was based on the last free sample`
			`implementation 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 -`

Update links. Make links to openssh.com HTTPS now that it's supported, point release notes link to the HTML release notes page, and update a couple of other links and bits of text. 2016-10-20 18:22:55 +00:00			`[0] https://www.openssh.com/`
Doc and spec updates 1999-11-10 23:50:04 +00:00			`[1] http://www.lothar.com/tech/crypto/`
Update prngd link to point to sourceforge. 2018-02-15 11:26:16 +00:00			`[2] http://prngd.sourceforge.net/`
- (stevesk) README: zlib location is http://www.gzip.org/zlib/ 2001-10-28 18:10:22 +00:00			`[3] http://www.gzip.org/zlib/`
- (djm) Mention PRNGd in documentation, it is nicer than EGD - (djm) Automatically search for "well-known" EGD/PRNGd sockets in autoconf 2001-01-24 23:51:46 +00:00			`[4] http://www.openssl.org/`
- (djm) [README README.privsep] Mention FreeBSD and NetBSD as being supported by privsep. Requested by des AT des.no 2005-06-04 23:21:41 +00:00			`[5] http://www.openpam.org`
Update links. Make links to openssh.com HTTPS now that it's supported, point release notes link to the HTML release notes page, and update a couple of other links and bits of text. 2016-10-20 18:22:55 +00:00			`http://www.kernel.org/pub/linux/libs/pam/`
- (djm) [README README.privsep] Mention FreeBSD and NetBSD as being supported by privsep. Requested by des AT des.no 2005-06-04 23:21:41 +00:00			`(PAM also is standard on Solaris and HP-UX 11)`
mention libedit 2017-07-21 04:24:26 +00:00			`[6] http://thrysoee.dk/editline/ (portable version)`
			`[7] http://man.openbsd.org/style.9`