Go to file
Daniel Stenberg cc5e952fa0 A cleanup effort: libssh2_ prefixes only on external APIs. Use _libssh2_ prefix
for library-wide internal functions. Don't use any of those on static functions.
I also did some comments and whitespace changes.
2009-03-17 13:48:35 +00:00
docs Refer to the exact symbol name, which also is the exact file name of the man 2009-03-17 10:34:27 +00:00
example fixed to work quite similar to the sftp_nonblock example so that it waits 2009-03-14 09:40:57 +00:00
include bump packet default size to 32768 2009-03-17 12:09:53 +00:00
m4 Add more. 2008-11-18 17:00:57 +00:00
nw some minor Makefile tweaks. 2009-03-06 07:25:37 +00:00
src A cleanup effort: libssh2_ prefixes only on external APIs. Use _libssh2_ prefix 2009-03-17 13:48:35 +00:00
tests fixed compiler warnings, and stripped off "libssh2_" from static functions 2009-01-01 22:47:06 +00:00
win32 some minor Makefile tweaks. 2009-03-06 07:25:37 +00:00
.cvsignore *** empty log message *** 2007-04-05 10:21:09 +00:00
.cvsusers two new committers! 2008-10-02 09:42:09 +00:00
acinclude.m4 Peter O'Gorman pointed out (and fixed) that the non-blocking check in 2007-07-30 22:55:43 +00:00
AUTHORS mention Dan Fandrich and Guenter Knauf 2007-11-10 23:36:41 +00:00
buildconf create a private config.h file for the examples 2007-07-31 10:04:24 +00:00
config.rpath Use Bruno's M4 macros to search for libgcrypt. 2007-04-05 10:23:54 +00:00
configure.in Cygwin needs -lcrypto for -lssl. 2008-11-27 15:47:05 +00:00
COPYING Add, from LICENSE. 2007-03-27 12:24:35 +00:00
get_ver.awk fixed space detection 2007-06-13 22:20:13 +00:00
HACKING Metion the current code style in the new file called HACKING. In this, we 2007-07-14 21:28:02 +00:00
libssh2-style.el helper script for emacs users to get the code style done libssh2-style 2008-12-20 12:36:50 +00:00
Makefile.am Added 'TODO' file (again) with some fresh things I could think of right now 2008-12-26 07:54:08 +00:00
maketgz Added LIBSSH2_TIMESTAMP to the public header and it contains the timestamp of 2007-07-15 21:36:29 +00:00
NEWS Use libtool -export-symbols-regex to reduce numer of exported symbols. 2009-03-17 10:19:54 +00:00
NMakefile fixed NMakefile stuff to build at least the DLL again. 2007-07-15 20:06:19 +00:00
README mention web site and mailing list, as I think they're not mentioned anywhere 2008-12-22 23:39:46 +00:00
TODO I want to remove all those macros from the official API at next soname bump 2009-01-01 22:52:46 +00:00

libssh2 - SSH2 library
======================

libssh2 is a library implementing the SSH2 protocol, available under
the revised BSD license.

Web site: http://www.libssh2.org/

Mailing list: https://lists.sourceforge.net/lists/listinfo/libssh2-devel

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

	* --enable-crypt-none

		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.

		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).