Ganymed SSH2 for Java
A C D E F G H I K L O P R S V W

A

addHostkey(String[], String, byte[]) - Method in class ch.ethz.ssh2.KnownHosts
Adds a single public key entry to the database.
addHostkeyToFile(File, String[], String, byte[]) - Static method in class ch.ethz.ssh2.KnownHosts
Adds a single public key entry to the a known_hosts file.
addHostkeys(char[]) - Method in class ch.ethz.ssh2.KnownHosts
Parses the given known_hosts data and adds entries to the database.
addHostkeys(File) - Method in class ch.ethz.ssh2.KnownHosts
Parses the given known_hosts file and adds entries to the database.
authenticateWithDSA(String, String, String) - Method in class ch.ethz.ssh2.Connection
Deprecated. You should use one of the authenticateWithPublicKey methods, this method is just a wrapper for it and will disappear in future builds.
authenticateWithKeyboardInteractive(String, InteractiveCallback) - Method in class ch.ethz.ssh2.Connection
A wrapper that calls authenticateWithKeyboardInteractive() with a null submethod list.
authenticateWithKeyboardInteractive(String, String[], InteractiveCallback) - Method in class ch.ethz.ssh2.Connection
After a successful connect, one has to authenticate oneself.
authenticateWithPassword(String, String) - Method in class ch.ethz.ssh2.Connection
After a successfull connect, one has to authenticate oneself.
authenticateWithPublicKey(String, char[], String) - Method in class ch.ethz.ssh2.Connection
After a successful connect, one has to authenticate oneself.
authenticateWithPublicKey(String, File, String) - Method in class ch.ethz.ssh2.Connection
A convenience wrapper function which reads in a private key (PEM format, either DSA or RSA) and then calls authenticateWithPublicKey(String, char[], String).
available() - Method in class ch.ethz.ssh2.StreamGobbler
 

C

Connection - class ch.ethz.ssh2.Connection.
A Connection is used to establish an encrypted TCP/IP connection to a SSH2 server.
Connection(String) - Constructor for class ch.ethz.ssh2.Connection
Same as Connection(hostname, 22).
Connection(String, int) - Constructor for class ch.ethz.ssh2.Connection
Prepares a fresh Connection object which can then be used to establish a connection to the specified SSH2 server.
ConnectionInfo - class ch.ethz.ssh2.ConnectionInfo.
In most cases you probably do not need the information contained in here.
ConnectionInfo() - Constructor for class ch.ethz.ssh2.ConnectionInfo
 
ch.ethz.ssh2 - package ch.ethz.ssh2
 
clientToServerCryptoAlgorithm - Variable in class ch.ethz.ssh2.ConnectionInfo
The currently used crypto algorithm for packets from to the client to the server.
clientToServerMACAlgorithm - Variable in class ch.ethz.ssh2.ConnectionInfo
The currently used MAC algorithm for packets from to the client to the server.
close() - Method in class ch.ethz.ssh2.Connection
Close the connection to the SSH2 server.
close() - Method in class ch.ethz.ssh2.LocalPortForwarder
Stop TCP/IP forwarding of newly arriving connections.
close() - Method in class ch.ethz.ssh2.LocalStreamForwarder
Close the underlying SSH forwarding channel.
close() - Method in class ch.ethz.ssh2.Session
Close this session.
close() - Method in class ch.ethz.ssh2.StreamGobbler
 
connect() - Method in class ch.ethz.ssh2.Connection
Same as connect(null).
connect(ServerHostKeyVerifier) - Method in class ch.ethz.ssh2.Connection
Connect to the SSH2 server and, as soon as the server has presented its host key, use the verifyServerHostKey method of the verifier to ask for permission to proceed.
createBubblebabbleFingerprint(String, byte[]) - Static method in class ch.ethz.ssh2.KnownHosts
Convert a ssh2 key-blob into a human readable bubblebabble fingerprint.
createHashedHostname(String) - Static method in class ch.ethz.ssh2.KnownHosts
Generate the hashed representation of the given hostname.
createHexFingerprint(String, byte[]) - Static method in class ch.ethz.ssh2.KnownHosts
Convert a ssh2 key-blob into a human readable hex fingerprint.
createLocalPortForwarder(int, String, int) - Method in class ch.ethz.ssh2.Connection
Creates a new LocalPortForwarder.
createLocalStreamForwarder(String, int) - Method in class ch.ethz.ssh2.Connection
Creates a new LocalStreamForwarder.
createSCPClient() - Method in class ch.ethz.ssh2.Connection
Create a very basic SCPClient that can be used to copy files from/to the SSH2 server.

D

DHGexParameters - class ch.ethz.ssh2.DHGexParameters.
A DHGexParameters object can be used to specify parameters for the diffie-hellman group exchange.
DHGexParameters() - Constructor for class ch.ethz.ssh2.DHGexParameters
 
DHGexParameters(int, int, int) - Constructor for class ch.ethz.ssh2.DHGexParameters
 

E

execCommand(String) - Method in class ch.ethz.ssh2.Session
Execute a command on the remote machine.

F

forceKeyExchange() - Method in class ch.ethz.ssh2.Connection
Force an asynchronous key re-exchange (the call does not block).

G

get(String, String) - Method in class ch.ethz.ssh2.SCPClient
Download a file from the remote server to a local directory.
get(String[], String) - Method in class ch.ethz.ssh2.SCPClient
Download a set of files from the remote server to a local directory.
getAvailableCiphers() - Static method in class ch.ethz.ssh2.Connection
Unless you know what you are doing, you will never need this.
getAvailableMACs() - Static method in class ch.ethz.ssh2.Connection
Unless you know what you are doing, you will never need this.
getAvailableServerHostKeyAlgorithms() - Static method in class ch.ethz.ssh2.Connection
Unless you know what you are doing, you will never need this.
getConnectionInfo() - Method in class ch.ethz.ssh2.Connection
Returns a ConnectionInfo object containing the details of the connection.
getExitSignal() - Method in class ch.ethz.ssh2.Session
Get the name of the signal by which the process on the remote side was stopped - if available and applicable.
getExitStatus() - Method in class ch.ethz.ssh2.Session
Get the exit code/status from the remote command - if available.
getInputStream() - Method in class ch.ethz.ssh2.LocalStreamForwarder
 
getMax_group_len() - Method in class ch.ethz.ssh2.DHGexParameters
 
getMin_group_len() - Method in class ch.ethz.ssh2.DHGexParameters
 
getOutputStream() - Method in class ch.ethz.ssh2.LocalStreamForwarder
Get the OutputStream.
getPref_group_len() - Method in class ch.ethz.ssh2.DHGexParameters
 
getPreferredServerHostkeyAlgorithmOrder(String) - Method in class ch.ethz.ssh2.KnownHosts
Try to find the preferred order of hostkey algorithms for the given hostname.
getRemainingAuthMethods(String) - Method in class ch.ethz.ssh2.Connection
After a successful connect, one has to authenticate oneself.
getStderr() - Method in class ch.ethz.ssh2.Session
 
getStdin() - Method in class ch.ethz.ssh2.Session
 
getStdout() - Method in class ch.ethz.ssh2.Session
 

H

HOSTKEY_HAS_CHANGED - Static variable in class ch.ethz.ssh2.KnownHosts
 
HOSTKEY_IS_NEW - Static variable in class ch.ethz.ssh2.KnownHosts
 
HOSTKEY_IS_OK - Static variable in class ch.ethz.ssh2.KnownHosts
 

I

InteractiveCallback - interface ch.ethz.ssh2.InteractiveCallback.
An InteractiveCallback is used to respond to challenges sent by the server if authentication mode "keyboard-interactive" is selected.
identification - Static variable in class ch.ethz.ssh2.Connection
 
isAuthMethodAvailable(String, String) - Method in class ch.ethz.ssh2.Connection
Checks if a specified authentication method is available.
isAuthenticationComplete() - Method in class ch.ethz.ssh2.Connection
Determines if the authentication phase is complete.
isAuthenticationPartialSuccess() - Method in class ch.ethz.ssh2.Connection
Returns true if there was at least on failed authentication request and the last failed authentication request was marked with "partial success" by the server.

K

KnownHosts - class ch.ethz.ssh2.KnownHosts.
The KnownHosts class is a handy tool to verify received server hostkeys based on the information in known_hosts files (the ones used by OpenSSH).
KnownHosts() - Constructor for class ch.ethz.ssh2.KnownHosts
 
KnownHosts(char[]) - Constructor for class ch.ethz.ssh2.KnownHosts
 
KnownHosts(File) - Constructor for class ch.ethz.ssh2.KnownHosts
 
keyExchangeAlgorithm - Variable in class ch.ethz.ssh2.ConnectionInfo
The used key exchange (KEX) algorithm in the latest key exchange.
keyExchangeCounter - Variable in class ch.ethz.ssh2.ConnectionInfo
Number of kex exchanges performed on this connection so far.

L

LocalPortForwarder - class ch.ethz.ssh2.LocalPortForwarder.
A LocalPortForwarder forwards TCP/IP connections to a local port via the secure tunnel to another host (which may or may not be identical to the remote SSH2 server).
LocalStreamForwarder - class ch.ethz.ssh2.LocalStreamForwarder.
A LocalStreamForwarder forwards an Input- and Outputstream pair via the secure tunnel to another host (which may or may not be identical to the remote SSH2 server).

O

openSession() - Method in class ch.ethz.ssh2.Connection
Open a new session on this connection.

P

put(String, String) - Method in class ch.ethz.ssh2.SCPClient
Copy a local file to a remote directory, uses mode 0600 when creating the file on the remote side.
put(String[], String) - Method in class ch.ethz.ssh2.SCPClient
Copy a set of local files to a remote directory, uses mode 0600 when creating files on the remote side.
put(String, String, String) - Method in class ch.ethz.ssh2.SCPClient
Copy a local file to a remote directory, uses the specified mode when creating the file on the remote side.
put(String[], String, String) - Method in class ch.ethz.ssh2.SCPClient
Copy a set of local files to a remote directory, uses the specified mode when creating the files on the remote side.

R

read() - Method in class ch.ethz.ssh2.StreamGobbler
 
read(byte[]) - Method in class ch.ethz.ssh2.StreamGobbler
 
read(byte[], int, int) - Method in class ch.ethz.ssh2.StreamGobbler
 
replyToChallenge(String, String, int, String[], boolean[]) - Method in interface ch.ethz.ssh2.InteractiveCallback
This callback interface is used during a "keyboard-interactive" authentication.
requestDumbPTY() - Method in class ch.ethz.ssh2.Session
Basically just a wrapper for lazy people - identical to calling requestPTY("dumb", 0, 0, 0, 0, null).
requestPTY(String) - Method in class ch.ethz.ssh2.Session
Basically just another wrapper for lazy people - identical to calling requestPTY(term, 0, 0, 0, 0, null).
requestPTY(String, int, int, int, int, byte[]) - Method in class ch.ethz.ssh2.Session
Allocate a pseudo-terminal for this session.

S

SCPClient - class ch.ethz.ssh2.SCPClient.
A very basic SCPClient that can be used to copy files from/to the SSH2 server.
ServerHostKeyVerifier - interface ch.ethz.ssh2.ServerHostKeyVerifier.
A callback interface used to implement a client specific method of checking server host keys.
Session - class ch.ethz.ssh2.Session.
A Session is a remote execution of a program.
StreamGobbler - class ch.ethz.ssh2.StreamGobbler.
A StreamGobbler is an InputStream that uses an internal worker thread to constantly consume input from another InputStream.
StreamGobbler(InputStream) - Constructor for class ch.ethz.ssh2.StreamGobbler
 
serverHostKey - Variable in class ch.ethz.ssh2.ConnectionInfo
The server host key that was sent during the latest key exchange.
serverHostKeyAlgorithm - Variable in class ch.ethz.ssh2.ConnectionInfo
The type of the server host key (currently either "ssh-dss" or "ssh-rsa").
serverToClientCryptoAlgorithm - Variable in class ch.ethz.ssh2.ConnectionInfo
The currently used crypto algorithm for packets from to the server to the client.
serverToClientMACAlgorithm - Variable in class ch.ethz.ssh2.ConnectionInfo
The currently used MAC algorithm for packets from to the server to the client.
setClient2ServerCiphers(String[]) - Method in class ch.ethz.ssh2.Connection
Unless you know what you are doing, you will never need this.
setClient2ServerMACs(String[]) - Method in class ch.ethz.ssh2.Connection
Unless you know what you are doing, you will never need this.
setDHGexParameters(DHGexParameters) - Method in class ch.ethz.ssh2.Connection
Sets the parameters for the diffie-hellman group exchange.
setServer2ClientCiphers(String[]) - Method in class ch.ethz.ssh2.Connection
Unless you know what you are doing, you will never need this.
setServer2ClientMACs(String[]) - Method in class ch.ethz.ssh2.Connection
Unless you know what you are doing, you will never need this.
setServerHostKeyAlgorithms(String[]) - Method in class ch.ethz.ssh2.Connection
Define the set of allowed server host key algorithms to be used for the following key exchange operations.
startShell() - Method in class ch.ethz.ssh2.Session
Start a shell on the remote machine.

V

verifyHostkey(String, String, byte[]) - Method in class ch.ethz.ssh2.KnownHosts
Checks the internal hostkey database for the given hostkey.
verifyServerHostKey(String, int, String, byte[]) - Method in interface ch.ethz.ssh2.ServerHostKeyVerifier
The actual verifier method, it will be called by the key exchange code on EVERY key exchange - this can happen several times during the lifetime of a connection.

W

waitUntilDataAvailable(long) - Method in class ch.ethz.ssh2.Session
This method blocks until there is more data available on either the stdout or stderr InputStream of this Session.

A C D E F G H I K L O P R S V W
Ganymed SSH2 for Java