Package jssh

Provides the classes and interfaces for the JSSH Secure Shell Client protocol handler (for SSH protocol v1.5).

See:
          Description

Interface Summary
IInteractivePacket This interface tags all the packets that can be received during the interactive phase.
IPacketConstants Defines the various types of SSH packets.
IProtocolHandler This interface specifies methods that must be provided by the SSH protocol handler in order to handle received packets.
ITrueRandom Defines the interface of an object that supplies truly random bits, suitable for session keys.
 

Class Summary
Channel This class represents an SSH channel that implements local-to-remote port-forwarding.
ChannelManager This class manages a set of encrypted SSH channels.
ClientProtocolHandler This class performs all the SSH client protocol handling on a specified network connection.
CMSG_AUTH_PASSWORD The client sends this message containing the password.
CMSG_AUTH_RSA The client sends this message containing the client's public key, in order to initiate RSA authentication.
CMSG_AUTH_RSA_RESPONSE The client sends this message in response to an SSH_SMSG_AUTH_RSA_CHALLENGE.
CMSG_EOF This message is sent by the client to indicate that EOF has been reached on the input.
CMSG_EXEC_CMD The client sends this message to ask the server to execute the specified command.
CMSG_EXEC_SHELL This message starts a shell (command interpreter) for the user, and moves into interactive session mode.
CMSG_EXIT_CONFIRMATION This message is sent by the client in response to SSH_SMSG_EXITSTATUS.
CMSG_PORT_FORWARD_REQUEST Sent by the client in the preparatory phase, this message requests that server_port_ on the server machine be forwarded over the secure channel to the client machine, and from there to the specified host and port.
CMSG_REQUEST_COMPRESSION This message can be sent by the client in the preparatory operations phase.
CMSG_REQUEST_PTY This message is sent by the client to request that a pseudo-terminal device be allocated for this session.
CMSG_SESSION_KEY This message is sent by the client as the first message in the session.
CMSG_STDIN_DATA This message delivers data from the client to be supplied as input to the shell or program running on the server side.
CMSG_USER Sent by the client to begin authentication.
DevRandom For use on systems such as Linux which provide a "/dev/random" device; obtains truly random bits from "/dev/random" for use as a session key.
GZDeflater This class provides support for compression using the GZIP compression algorithm.
GZInflater This class provides support for uncompression using the GZIP compression algorithm.
KnownHostsFile This class provides methods for checking whether a server's public key is in a known_hosts file, and for adding a key to the file.
MSG_CHANNEL_CLOSE When a channel is closed at one side of the connection, that side sends this message.
MSG_CHANNEL_CLOSE_CONFIRMATION This is sent in response to a SSH_MSG_CHANNEL_CLOSE unless the channel was already closed.
MSG_CHANNEL_DATA Data is transmitted in a channel in these messages.
MSG_CHANNEL_OPEN_CONFIRMATION This is sent in response to any channel open request if the channel has been successfully opened.
MSG_CHANNEL_OPEN_FAILURE This message indicates that an earlier channel open request by the other side has failed or has been denied.
MSG_DEBUG This message can be sent by either party at any time; it is used to send debugging messages that may be informative to the user in solving various problems.
MSG_DISCONNECT This message can be sent by either party at any time; it causes the immediate disconnection of the connection.
MSG_IGNORE This message may be sent by either part at any time (though this client implementation never sends it).
MSG_PORT_OPEN Sent by either party in interactive mode, this message indicates that a connection has been opened to a forwarded TCP/IP port.
OpenChannel This class represents an open SSH channel.
Options This class encapsulates all the options that can be specified on the command-line for the SSH client.
Packet This is the superclass for all the various types of SSH protocol packets
PacketQueue This class queues SSH protocol packets.
PortForwarding This class encapsulates the specifications of an SSH tunnel.
RSAAlgorithm This class provides static methods that implement RSA encryption.
RSAPrivateKey This class represents an SSH RSA private key.
RSAPrivateKeyFile This class encapsulates the properties and behaviour of an SSH RSA private-key file.
RSAPublicKey This class represents an RSA public key.
SMSG_AUTH_RSA_CHALLENGE Sent by the server in response to a SSH_CMSG_AUTH_RSA message from the client.
SMSG_EXITSTATUS Returns the exit status of the shell or program after it has exited.
SMSG_FAILURE Sent by the server in response to a failed authentication operation to indicate that the user has not yet been successfuly authenticated, and in response to a failed preparatory operation.
SMSG_PUBLIC_KEY Sent as the first message by the server.
SMSG_STDERR_DATA Delivers data from the server that was read from the standard error stream of the shell or program running on the server side.
SMSG_STDOUT_DATA Delivers data from the server that was read from the standard output of the shell or program running on the server side.
SMSG_SUCCESS This message is sent by the server in response to the session key, a successful authentication request, and a successfully completed preparatory operation.
SSHClient This is an example of a program that uses the JSSH library to connect to a remote host using the SSH protocol (version 1.5).
SSHInputStream This class allows the application to read SSH packets from a network socket.
SSHMisc This class provides miscellaneous static methods for use in the Java SSH Client.
SSHOutputStream This class allows the application to write SSH packets to a network socket.
STDIN_OutputStream This class provides an "OutputStream" interface for writing keystrokes from the terminal keyboard, and puts them onto a queue from which they are read by the SSH protocol handler.
STDOUT_InputStream This class receives SSH_SMSG_STDOUT_DATA packets on its input queue, and makes the received data available via an InputStream interface.
 

Exception Summary
SSHAuthFailedException This exception is thrown when the server refuses to authenticate the client.
SSHProtocolException This exception is thrown when an unexpected packet-type is received, or some other protocol error occurs.
SSHSetupException This exception is thrown when the client and server cannot agree on the connection parameters.
 

Package jssh Description

Provides the classes and interfaces for the JSSH Secure Shell Client protocol handler (for SSH protocol v1.5).

The ClientProtocolHandler class uses all the other classes of the package to implement the SSH client protocol.