From 666ea5b8e6c222563383e7b48edef8c12abdb83c Mon Sep 17 00:00:00 2001 From: Shikhar Bhushan Date: Sun, 7 Mar 2010 02:22:59 +0100 Subject: [PATCH] more comprehensive readme --- README.rst | 63 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 52 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 9ac8ef68..df69d18d 100644 --- a/README.rst +++ b/README.rst @@ -1,28 +1,69 @@ sshj - SSHv2 library for Java ============================== +Features include: + +* reading known_hosts files for host key verification +* password and publickey authentication +* command, subsystem and shell channels +* local and remote port forwarding +* scp + complete SFTP version 3 implementation + +To get started, have a look at one of the examples. Hopefully you will find the API pleasant to work with :) + + +Algorithms +----------- + +ciphers + ``aes{128,192,256}-{cbc,ctr}``, ``blowfish-cbc``, ``3des-cbc`` + +key exchange + ``diffie-hellman-group1-sha1``, ``diffie-hellman-group14-sha1`` + +signatures + ``ssh-rsa``, ``ssh-dss`` signaures + +mac + ``hmac-md5``, ``hmac-md5-96``, ``hmac-sha1``, ``hmac-sha1-96`` + +compression + ``zlib`` and ``zlib@openssh.com`` (delayed zlib) + +private key files + ``pkcs8`` (what openssh uses) encoded, ``java.security.KeyPair`` + +If you need something that is not implemented, it shouldn't be too hard to add (do contribute it!) + + Building -------- -You will need `buildr `_. To see available tasks, run:: +You will need buildr_. To see available tasks, run:: $ buildr help:tasks Since there is no official release yet you can use the ``package`` task to create a jar. -Dependencies -------------- -Required: +Runtime dependencies +-------------------- -* slf4j +slf4j_ is required. bouncycastle_ is highly recommended and required for using some of the crypto algorithms. +jzlib_ is required for using zlib compression. -Optional: - -* bouncycastle for using high-strength ciphers and for reading openssh private key files -* jzlib for using zlib compression Contributing -------------- +------------ -Fork away! \ No newline at end of file +Fork away! + + + +.. _buildr: http://buildr.apache.org/installing.html + +.. _slf4j: http://www.slf4j.org/download.html + +.. _bouncycastle: http://www.bouncycastle.org/java.html + +.. _jzlib: http://www.jcraft.com/jzlib/ \ No newline at end of file