README

J2SSH Maverick
Version 1.2.12

Contents

Important Notice

The API requires activation through the installation of a license key. If you would like to evaluate the functionality of the software you can obtain a free 21-day evaluation license from 3SP. You can do this by following the links from this URL: http://3sp.com/showMaverick.do

 

Once you have obtained your license key, please follow the instructions in the email for the correct procedure to include it within your source code.

Introduction

Thank you for downloading this release of the J2SSH Maverick API.  J2SSH Maverick is a development library for creating SSH enabled applications, applets, and components using the Java programming language.  The API supports both versions of the SSH protocol and where possible provides a common set of interfaces to both for protocol independent development. 

Installation Instructions

The API contains distributions for the following Java platforms.

      °  Java Development Kit (JDK) and Java 2 SDK (J2SE) - All Versions

      °  Java 2 Platform Micro Edition (J2ME) - All Versions
 
After extracting the release distribution, add the required JAR files to your classpath. For information relating to specific distribution files read the Contents section.

J2SSH Maverick Documentation

The J2SSH Maverick Documentation contains the API specifications with further articles and known issues located at http://3sp.com/kb

Release Notes

See the Release Notes on the web site for additional information pertaining to this release. The on-line release notes file will be updated as needed; so you should check it occasionally for the latest information.

Bug Reports, Support and Feedback

Please submit bug reports, support requests and feedback to support@3sp.com.  Please note:  You must hold a current and valid support contract or evaluation license in order to use the support services.

 

When submitting your support enquiry please be as detailed as possible, we need to know your version of Maverick, operating system, any relevant log files and the SSH server you are connecting to wherever appropriate.  The more information we receive from you, the sooner you are likely to obtain a resolution!

Contents of the J2SSH Maverick API

This section contains a general summary of the files and directories in the J2SSH Maverick API. 

 

Examples

(In the examples subdirectory.) A number of simple examples to demonstrate the standard methods of SSH connectivity using the API.
 

Java Distribution Files (JARs)

(In the dist/java subdirectory.)  JAR files containing the API for use with the Java Development Kit and Java 2 Standard Edition.

maverick-all.jar – Contains all the jar files listed here for convenience.

maverick.jar - The maverick cryptographic classes and general SSH interfaces. This is a REQUIRED file.
                                   
maverick-ssh1.jar - This jar file contains the SSH1 implementation, this file can be removed if you do not require SSH1 support.

maverick-ssh2.jar - This jar file contains the SSH2 implementation, this file can be removed if you do not require SSH2 support.

maverick-sftp.jar - This jar file contains the core SFTP implementation.

sshtools-net.jar - Utility classes for using java.net.Sockets with the Maverick API, HTTP and SOCKS proxy transports and a Port Forwarding class to manage forwarding connections and threads.
 
sshtools-publickey.jar - Known_hosts key verification and utilities to generate and read public/private key files..

sshtools-sftp.jar - A high level SFTP client implementation.

sshtools-scp.jar - A high level SCP client implementation.

sshtools-util.jar - General utility classes required by the above sshtools-* jar files.

sshtools-zlib.jar - Provides ZLIB compression for SSH2 connections

sshtools-cipher.jar – Optional cipher engines for SSH2 connections, AES, CAST and Twofish.

J2ME Distribution Files (JARs)
(In the dist/j2me subdirectory.)  JAR files containing the API for use with the Java 2 Platform Micro Edition. These files are standard JAR archives and must be pre-verified through your J2ME toolkit before use. An example ANT build script that will perform the pre-verification process is provided in the examples subdirectory.


       maverick.jar - The maverick cryptographic classes and general SSH interfaces. This is a REQUIRED file.    

 

       maverick-ssh1.jar - This jar file contains the SSH1 implementation, this file can be removed if you do not require SSH1 support.

       maverick-ssh2.jar - This jar file contains the SSH2 implementation, this file can be removed if you do not require SSH2 support.

 

       maverick-sftp.jar - This jar file contains the core SFTP implementation.

 

 

Documentation

(In the docs subdirectory.) Contains the API specifications.

 

Source Code (Requires an Enterprise License Purchase)

(In the src subdirectory.) Java programming language source files for all classes that make up the J2SSH Maverick API (that is, sources files for the com.maverick.* and com.sshtools.* packages). This source code is provided for informational purposes only, and no support is provided. 

 

Copyright © 2003-2004, 3SP Ltd.
The Manse, 2 Third Avenue, Nottingham, NG7 6JH.
All rights reserved.

The Java 2 SDK, Standard Edition, is a product of Sun MicrosystemsTM, Inc.