Skip to content

Commit

Permalink
docs: move INSTALL, AUTHORS, HACKING and TODO to docs/
Browse files Browse the repository at this point in the history
And with this, cleanup README to be shorter and mention the new source
code home.
  • Loading branch information
bagder committed Mar 7, 2015
1 parent 5fcbb16 commit 8bb6cf7
Showing 7 changed files with 332 additions and 87 deletions.
4 changes: 2 additions & 2 deletions Makefile.am
Original file line number Diff line number Diff line change
@@ -32,8 +32,8 @@ win32/libssh2_config.h win32/config.mk win32/rules.mk \
win32/Makefile.Watcom win32/libssh2.dsw win32/tests.dsp $(DSP) \
win32/msvcproj.head win32/msvcproj.foot win32/libssh2.rc

EXTRA_DIST = $(WIN32FILES) buildconf $(NETWAREFILES) get_ver.awk HACKING \
maketgz NMakefile TODO RELEASE-NOTES libssh2.pc.in $(VMSFILES) config.rpath
EXTRA_DIST = $(WIN32FILES) buildconf $(NETWAREFILES) get_ver.awk \
maketgz NMakefile RELEASE-NOTES libssh2.pc.in $(VMSFILES) config.rpath

ACLOCAL_AMFLAGS = -I m4

88 changes: 4 additions & 84 deletions README
Original file line number Diff line number Diff line change
@@ -8,90 +8,10 @@ Web site: http://www.libssh2.org/

Mailing list: http://cool.haxx.se/mailman/listinfo/libssh2-devel

Generic installation instructions are in INSTALL. Some ./configure
options deserve additional comments:
License: see COPYING

* --enable-crypt-none
Source code: https://github.com/bagder/libssh2

The SSH2 Transport allows for unencrypted data
transmission using the "none" cipher. Because this is
such a huge security hole, it is typically disabled on
SSH2 implementations and is disabled in libssh2 by
default as well.
Web site source code: https://github.com/bagder/libssh2-www

Enabling this option will allow for "none" as a
negotiable method, however it still requires that the
method be advertized by the remote end and that no
more-preferable methods are available.

* --enable-mac-none

The SSH2 Transport also allows implementations to
forego a message authentication code. While this is
less of a security risk than using a "none" cipher, it
is still not recommended as disabling MAC hashes
removes a layer of security.

Enabling this option will allow for "none" as a
negotiable method, however it still requires that the
method be advertized by the remote end and that no
more-preferable methods are available.

* --disable-gex-new

The diffie-hellman-group-exchange-sha1 (dh-gex) key
exchange method originally defined an exchange
negotiation using packet type 30 to request a
generation pair based on a single target value. Later
refinement of dh-gex provided for range and target
values. By default libssh2 will use the newer range
method.

If you experience trouble connecting to an old SSH
server using dh-gex, try this option to fallback on
the older more reliable method.

* --with-libgcrypt
* --without-libgcrypt
* --with-libgcrypt-prefix=DIR

libssh2 can use the Libgcrypt library
(http://www.gnupg.org/) for cryptographic operations.
Either Libgcrypt or OpenSSL is required.

Configure will attempt to locate Libgcrypt
automatically.

If your installation of Libgcrypt is in another
location, specify it using --with-libgcrypt-prefix.

* --with-openssl
* --without-openssl
* --with-libssl-prefix=[DIR]

libssh2 can use the OpenSSL library
(http://www.openssl.org) for cryptographic operations.
Either Libgcrypt or OpenSSL is required.

Configure will attempt to locate OpenSSL in the
default location.

If your installation of OpenSSL is in another
location, specify it using --with-libssl-prefix.

* --with-libz
* --without-libz
* --with-libz-prefix=[DIR]

If present, libssh2 will attempt to use the zlib
(http://www.zlib.org) for payload compression, however
zlib is not required.

If your installation of Libz is in another location,
specify it using --with-libz-prefix.

* --enable-debug

Will make the build use more pedantic and strict compiler
options as well as enable the libssh2_trace() function (for
showing debug traces).
Installation instructions are in docs/INSTALL
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 8bb6cf7

Please sign in to comment.