Package com.jcraft.jsch

Java Secure Channel - main package.

See: Description

Interface Summary

Interface	Description
ChannelSftp.LsEntrySelector	Objects implementing this interface can be passed as an argument for ChannelSftp's ChannelSftp.ls(java.lang.String) method.
Cipher	Usually not to be used by applications.
Compression	Usually not to be used by applications.
ConfigRepository	A repository for host-specific configuration settings, retrievable by host name (or an alias).
ConfigRepository.Config	A configuration for connections to a remote host name (or alias).
DH	Usually not to be used by applications.
ECDH	Usually not to be used by applications.
ForwardedTCPIPDaemon	A local deamon process executed when a host connects to to a forwarded port at the remote side.
GSSContext	Usually not to be used by applications.
HASH	Usually not to be used by applications.
HostKeyRepository	A repository for known host keys.
Identity	A user identity for public-key authentication.
IdentityRepository	A repository for identities (basically key pairs usable for authentication to a server).
KeyPairGenDSA	Usually not to be used by applications.
KeyPairGenECDSA	Usually not to be used by applications.
KeyPairGenRSA	Usually not to be used by applications.
Logger	Provides logging abilities to the library.
MAC	Usually not to be used by applications.
PBKDF	The PBKDF2 algorithm for password-based key derivation.
Proxy	Allows routing connections through some proxy.
Random	A random number generator.
ServerSocketFactory	A factory for ServerSockets.
SftpProgressMonitor	A callback to get information about the progress of a file transfer operation.
Signature	Usually not to be used by applications.
SignatureDSA	Usually not to be used by applications.
SignatureECDSA	Usually not to be used by applications.
SignatureRSA	Usually not to be used by applications.
SocketFactory	A factory for (client) sockets.
UIKeyboardInteractive	Provides a way to prompt the user for keyboard-interactive authentication.
UserInfo	Allows user interaction.

Class Summary

Class	Description
Buffer	Usually not to be used by applications.
Channel	The abstract base class for the different types of channel which may be associated with a Session.
ChannelDirectTCPIP	A Channel which allows forwarding a pair of local streams to/from a TCP-connection to a server on the remote side.
ChannelExec	A channel connected to a remotely executing program.
ChannelForwardedTCPIP	A Channel created when a forwarded port at the remote side is connected.
ChannelSftp	A Channel connected to an sftp server (as a subsystem of the ssh server).
ChannelShell	A channel connected to a remote shell.
ChannelSubsystem	A channel connected to a subsystem of the server process.
CipherNone	Usually not to be used by applications.
DHEC256
DHEC384
DHEC521
DHECN
DHG1	Usually not to be used by applications.
DHG14	Usually not to be used by applications.
DHGEX	Usually not to be used by applications.
DHGEX256
HostKey	The public key of a SSH server.
IdentityRepository.Wrapper	JSch will accept ciphered keys, but some implementations of IdentityRepository can not.
IO	Usually not to be used by applications.
JSch	This class serves as a central configuration point, and as a factory for Session objects configured with these settings.
KeyExchange	Usually not to be used by applications.
KeyPair	Base class for a pair of public and private key.
KeyPairDSA	Usually not to be used by applications.
KeyPairECDSA	Usually not to be used by applications.
KeyPairPKCS8	Usually not to be used by an application.
KeyPairRSA	Usually not to be used by applications.
KnownHosts	Usually not to be used by applications.
OpenSSHConfig	This class implements ConfigRepository interface, and parses OpenSSH's configuration file.
Packet	Usually not to be used by applications.
ProxyHTTP	A Proxy implementation using a HTTP proxy.
ProxySOCKS4	A Proxy implementation using a SOCKS V5 proxy.
ProxySOCKS5	A Proxy implementation using a SOCKS V5 proxy.
RequestSftp	Usually not to be used by applications.
RequestSubsystem	Usually not to be used by applications.
Session	A Session represents a connection to a SSH server.
SftpATTRS	Attributes of a (remote) file manipulated via Sftp.
SftpStatVFS
UserAuth	Usually not to be used by applications.
UserAuthGSSAPIWithMIC	Usually not to be used by applications.

Exception Summary

Exception	Description
JSchException	Will be thrown if anything goes wrong with the SSH protocol.
SftpException	This exception will be thrown if anything goes wrong while using the SFTP protocol.

Package com.jcraft.jsch Description

Java Secure Channel - main package. This package contains all types applications using the library have to know (and lots they don't have to know).

Here is an overview about the most important ones:

JSch

The starting point, used to create sessions and manage identities.

Session

A connection to a SSH server. Used to configure settings, port forwardings and to open channels.

Channel

and its subclasses ChannelExec, ChannelShell, ChannelSubsystem for remote command execution.

ChannelSftp

for secure file transfer. You might then also need SftpATTRS and implement SftpProgressMonitor.

UserInfo and UIKeyboardInteractive

should be implemented to allow feedback to the user and/or password or keyboard-interactive authentication.

Most other classes are either for internal use (see next paragraph) or for special uses, and not necessary for a normal application.

The string Usually not to be used by applications. at the beginning of a class or interface description means that this type is used internally by the library, and normally there is no need for an application to directly use (or implement/extend) this type. It may be needed if you need to extend functionality, then you normally will also have to change some configuration options.