All Classes

Class	Description
AbstractAuthMethod	This abstract class for AuthMethod implements common or default functionality.
AbstractChannel
AbstractChannel.TransportRunnable
AbstractDH
AbstractDHG	Base class for DHG key exchange algorithms.
AbstractDHGex
AbstractDirectChannel	Base class for direct channels whose open is initiated by the client.
AbstractFileTransfer
AbstractForwardedChannel	Base class for forwarded channels whose open is initiated by the server.
AbstractForwardedChannelOpener	Base class for ForwardedChannelOpener's.
AbstractSCPClient
AbstractService	An abstract class for Service that implements common or default functionality.
AbstractSignature	An abstract class for Signature that implements common functionality.
AbstractSignatureDSA
AccountResource
AES128CBC	Deprecated. Use BlockCiphers.AES128CBC()
AES128CBC.Factory	Named factory for AES128CBC Cipher
AES128CTR	Deprecated. Use BlockCiphers.AES128CTR()
AES128CTR.Factory	Named factory for AES128CTR Cipher
AES192CBC	Deprecated. Use BlockCiphers.AES192CBC()
AES192CBC.Factory	Named factory for AES192CBC Cipher
AES192CTR	Deprecated. Use BlockCiphers.AES192CTR()
AES192CTR.Factory	Named factory for AES192CTR Cipher
AES256CBC	Deprecated. Use BlockCiphers.AES256CBC()
AES256CBC.Factory	Named factory for AES256CBC Cipher
AES256CTR	Deprecated. Use BlockCiphers.AES256CTR()
AES256CTR.Factory	Named factory for AES256CTR Cipher
AlgorithmsVerifier
AndroidConfig	Registers SpongyCastle as JCE provider.
AuthGssApiWithMic	Implements authentication by GSS-API.
AuthHostbased	Implements the hostbased SSH authentication method.
AuthKeyboardInteractive	Implements the keyboard-interactive authentication method.
AuthKeyboardInteractive.CharArrWrap
AuthMethod	An authentication method of the SSH Authentication Protocol.
AuthNone	none auth.
AuthParams	The parameters available to authentication methods.
AuthPassword	Implements the password authentication method.
AuthPublickey	Implements the "publickey" SSH authentication method.
Base64Decoder	Wraps Base64.Decoder in order to wrap unchecked IllegalArgumentException thrown by the default Java Base64 decoder here and there.
Base64DecodingException	A checked wrapper for all IllegalArgumentException, thrown by Base64.Decoder.
BaseCipher	Base class for all Cipher implementations delegating to the JCE provider.
BaseDigest	Base class for Digest algorithms based on the JCE provider.
BaseFileKeyProvider
BaseKeyAlgorithm
BaseMAC	Base class for MAC implementations based on the JCE provider.
BCrypt	BCrypt implements OpenBSD-style Blowfish password hashing using the scheme described in "A Future-Adaptable Password Scheme" by Niels Provos and David Mazieres.
BlockCipher
BlockCiphers	All BlockCiphers supported by SSH according to the following RFCs: https://tools.ietf.org/html/rfc4344#section-3.1 https://tools.ietf.org/html/rfc4253#section-6.3 TODO: https://tools.ietf.org/html/rfc5647 Some of the Ciphers are still implemented in net.schmizz.sshj.transport.cipher.*.
BlockCiphers.Factory	Named factory for BlockCipher
BlowfishCBC	Deprecated. Use BlockCiphers.BlowfishCBC()
BlowfishCBC.Factory	Named factory for BlowfishCBC Cipher
BouncyCastleRandom	BouncyCastle Random.
BouncyCastleRandom.Factory	Named factory for the BouncyCastle Random
Buffer<T extends Buffer<T>>
Buffer.BufferException
Buffer.PlainBuffer
ByteArrayUtils	Utility functions for byte arrays.
Certificate<T extends java.security.PublicKey>	Certificate wrapper for public keys, created to help implement protocol described here: https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.certkeys?annotate=HEAD Consumed primarily by net.shmizz.sshj.common.KeyType
Certificate.Builder<T extends java.security.PublicKey>
ChachaPolyCipher
ChachaPolyCiphers
ChachaPolyCiphers.Factory
ChallengeResponseProvider
Channel	A channel is the basic medium for application-layer data on top of an SSH transport.
Channel.Direct	Direct channels are those that are initiated by us.
Channel.Forwarded	Forwarded channels are those that are initiated by the server.
ChannelInputStream	InputStream for channels.
ChannelOutputStream	OutputStream for channels.
Cipher	Wrapper for a cryptographic cipher, used either for encryption or decryption.
Cipher.Mode
CircularBuffer<T extends CircularBuffer<T>>
CircularBuffer.CircularBufferException
CircularBuffer.PlainCircularBuffer
Compression	Interface used to compress the stream of data between the SSH server and clients.
Compression.Mode	Enum identifying if this object will be used to compress or uncompress data.
Config	Holds configuration information and factories.
ConfigImpl
Connection	Connection layer of the SSH protocol.
ConnectionException	Connection-layer exception.
ConnectionImpl	Connection implementation.
ConnectListener	A connect listener is just that: it listens for new forwarded channels and can be delegated charge of them.
ConsoleKnownHostsVerifier
ConsolePasswordFinder	A PasswordFinder that reads a password from a console
Converter	Base class for Encoder and Decoder.
Curve25519DH	Key Exchange Method using Curve25519 as defined in RFC 8731
Curve25519SHA256
Curve25519SHA256.Factory	Named factory for Curve25519SHA256 key exchange
Curve25519SHA256.FactoryLibSsh	Named factory for Curve25519SHA256 key exchange
Decoder	Decodes packets from the SSH binary protocol per the current algorithms.
DefaultConfig	A Config that is initialized as follows.
DefaultSecurityProviderConfig	SSHJ Configuration that uses the default Security Provider configuration from java.security and disables Bouncy Castle registration
DelayedZlibCompression	ZLib delayed compression.
DelayedZlibCompression.Factory	Named factory for the ZLib Delayed Compression.
DH	Diffie-Hellman key generator.
DHBase
DHG
DHG1	Deprecated. Replaced by DHG with DHGroups
DHG1.Factory	Named factory for DHG1 key exchange
DHG14	Deprecated. Replaced by DHG with DHGroups
DHG14.Factory	Named factory for DHG14 key exchange
DHGexSHA1
DHGexSHA1.Factory	Named factory for DHGexSHA1 key exchange
DHGexSHA256
DHGexSHA256.Factory	Named factory for DHGexSHA256 key exchange
DHGroupData	Simple class holding the data for DH group key exchanges.
DHGroups	Factory methods for Diffie Hellman KEX algorithms based on MODP groups / Oakley Groups - https://tools.ietf.org/html/rfc4253 - https://tools.ietf.org/html/draft-ietf-curdle-ssh-modp-dh-sha2-01
DHGroups.Factory	Named factory for DHG1 key exchange
Digest	Interface used to compute digests, based on algorithms such as MD5 or SHA1.
DirectConnection	A channel for creating a direct TCP/IP connection from the server to a remote address.
DirectTCPIPChannel
DisconnectListener
DisconnectReason	Disconnect error codes
DSAPrivateKeyInfoKeyPairConverter	Key Pair Converter from DSA Private Key Information to PEM Key Pair
ECDH
ECDHNistP
ECDHNistP.Factory256	Named factory for ECDHNistP key exchange
ECDHNistP.Factory384	Named factory for ECDHNistP key exchange
ECDHNistP.Factory521	Named factory for ECDHNistP key exchange
ECDSAPrivateKeyInfoKeyPairConverter	Key Pair Converter from ECDSA Private Key Information to PEM Key Pair
ECDSAVariationsAdapter
Ed25519PublicKey	Our own extension of the EdDSAPublicKey that comes from ECC-25519, as that class does not implement equality.
Encoder	Encodes packets into the SSH binary protocol per the current algorithms.
ErrorDeliveryUtil
ErrorNotifiable	API for classes that are capable of being notified on an error so they can cleanup.
ErrorNotifiable.Util	Utility functions.
Event<T extends java.lang.Throwable>	An event can be set, cleared, or awaited, similar to Python's threading.event.
ExceptionChainer<Z extends java.lang.Throwable>	Chains an exception to desired type.
ExtendedBlockCiphers	Set of Block Ciphers that are (not yet) part of any of the official RFCs for SSH, but that are either supported by other SSH implementations, or are being pushed for to be included in a new RFC.
ExtendedDHGroups	Set of KEX methods that are not in official RFCs but are supported by some SSH servers.
ExtInfoClientFactory	Stub kex algorithm factory that indicates support for SSH2_MSG_EXT_INFO.
Factory<T>	A basic factory interface.
Factory.Named<T>	Interface for a named factory.
Factory.Named.Util	Utility functions
FileAttributes
FileAttributes.Builder
FileAttributes.Flag
FileKeyProvider	A file key provider is initialized with a location of
FileMode
FileMode.Type
FilePermission
FileSystemFile
FileTransfer
FingerprintVerifier
ForwardedChannelOpener	Takes care of handling SSH_MSG_CHANNEL_OPEN requests for forwarded channels of a specific type.
GcmCipher
GcmCipher.CounterGCMParameterSpec	Algorithm parameters for AES/GCM that assumes the IV uses an 8-byte counter field as its most significant bytes.
GcmCiphers
GcmCiphers.Factory	Named factory for BlockCipher
Heartbeater
HMACMD5	Deprecated. Use Macs.HMACMD5()
HMACMD5.Factory	Named factory for the HMACMD5 MAC
HMACMD596	Deprecated. Use Macs.HMACMD596()
HMACMD596.Factory	Named factory for the HMAC-MD5-96 MAC
HMACRIPEMD160	Deprecated. Use Macs.HMACRIPEMD160()
HMACRIPEMD160.Factory	Named factory for the HMAC-RIPEMD160 MAC
HMACSHA1	Deprecated. Use Macs.HMACSHA1()
HMACSHA1.Factory	Named factory for the HMAC-SHA1 MAC
HMACSHA196	Deprecated. Use Macs.HMACSHA196()
HMACSHA196.Factory	Named factory for the HMAC-SHA1-96 MAC
HMACSHA2256	Deprecated. Use Macs.HMACSHA2256()
HMACSHA2256.Factory	Named factory for the HMAC-SHA1 MAC
HMACSHA2512	Deprecated. Use Macs.HMACSHA2512()
HMACSHA2512.Factory	Named factory for the HMAC-SHA1 MAC
HostKeyVerifier	Host key verification interface.
IdentificationStringParser
InMemoryDestFile
InMemorySourceFile
IOUtils
JCERandom	A Random implementation using the built-in SecureRandom PRNG.
JCERandom.Factory	Named factory for the JCE Random
KeepAlive
KeepAliveProvider
KeepAliveRunner
KeyAlgorithm
KeyAlgorithm	In [RFC4252], the concept "public key algorithm" is used to establish a relationship between one algorithm name, and:
KeyAlgorithms
KeyAlgorithms.Factory
KeyDecryptionFailedException	Thrown when a key file could not be decrypted correctly, e.g.
KeyedAuthMethod
KeyExchange	Key exchange algorithm.
KeyExchangeBase
KeyExchanger	Algorithm negotiation and key exchange.
KeyExchanger.Expected
KeyFormat	Key File Formats
KeyPairConverter<T>	Converter from typed object to PEM Key Pair
KeyPairWrapper	A KeyProvider wrapper around KeyPair
KeyProvider	A KeyProvider is a container for a public-private keypair.
KeyProviderUtil
KeyType	Type of key e.g.
KeyType.CertUtils
KnownHostMatchers
KnownHostMatchers.AnyHostMatcher
KnownHostMatchers.EquiHostMatcher
KnownHostMatchers.HashedHostMatcher
KnownHostMatchers.HostMatcher
KnownHostMatchers.NegateHostMatcher
KnownHostMatchers.WildcardHostMatcher
LocalDestFile
LocalFileFilter
LocalPortForwarder
LocalPortForwarder.ForwardedChannel
LocalSourceFile
LoggerFactory
LoggingTransferListener
MAC	Message Authentication Code for use in SSH.
Macs
Macs.Factory
MD5	MD5 Digest.
MD5.Factory	Named factory for MD5 digest
Message	SSH message identifiers
NegotiatedAlgorithms
NoneCipher	Represents a no-op cipher.
NoneCipher.Factory	Named factory for the no-op Cipher
NoneCompression	No-op Compression.
NoneCompression.Factory	Named factory for the no-op Compression
OpenFailException
OpenFailException.Reason
OpenMode
OpenSSHKeyFile	Represents an OpenSSH identity that consists of a PKCS8-encoded private key file and an unencrypted public key file of the same name with the ".pub" extension.
OpenSSHKeyFile.Factory
OpenSSHKeyFileUtil
OpenSSHKeyFileUtil.ParsedPubKey
OpenSSHKeyV1KeyFile	Reads a key file in the new OpenSSH format.
OpenSSHKeyV1KeyFile.Factory
OpenSSHKnownHosts	A HostKeyVerifier implementation for a known_hosts file i.e.
OpenSSHKnownHosts.BadHostEntry
OpenSSHKnownHosts.CommentEntry
OpenSSHKnownHosts.HostEntry
OpenSSHKnownHosts.KnownHostEntry
OpenSSHKnownHosts.Marker
PacketReader
PacketType
Parameters
PasswordFinder	Services requests for plaintext passwords.
PasswordResponseProvider
PasswordUpdateProvider	Callback that can be implemented to allow an application to provide an updated password for the 'auth-password' authentication method.
PasswordUtils	Static utility method and factories
PathComponents
PathHelper
PathHelper.Canonicalizer
PKCS8KeyFile	Key File implementation supporting PEM-encoded PKCS8 and PKCS1 formats with or without password-based encryption
PKCS8KeyFile.Factory
PrivateKeyFileResource
PrivateKeyInfoKeyPairConverter	Key Pair Converter for Private Key Information using known Algorithm Object Identifiers
PrivateKeyReaderResource
PrivateKeyStringResource
PromiscuousVerifier
Promise<V,T extends java.lang.Throwable>	Represents promised data of the parameterized type V and allows waiting on it.
Proposal
PTYMode	Various modes for a psuedo-terminal.
PuTTYKeyFile	Sample PuTTY file format
PuTTYKeyFile.Factory
Random	A pseudo random number generator.
RandomAccessRemoteFile
Reader
RemoteAddressProvider
RemoteDirectory
RemoteFile
RemotePortForwarder	Handles remote port forwarding.
RemotePortForwarder.Forward	Represents a particular forwarding.
RemotePortForwarder.ForwardedTCPIPChannel	A forwarded-tcpip channel.
RemoteResource
RemoteResourceFilter
RemoteResourceFilterConverter
RemoteResourceInfo
RemoteResourceSelector
RemoteResourceSelector.Result
RenameFlags
Request
Requester
Resource<H>	A password-protected resource
Response
Response.StatusCode
RSAPrivateKeyInfoKeyPairConverter	Key Pair Converter from RSA Private Key Information to PEM Key Pair
ScpCommandLine	Command line to be sent to the remote SSH process to setup an SCP process in the correct mode.
ScpCommandLine.Arg
ScpCommandLine.EscapeMode
SCPDownloadClient	Support for downloading files over a connected link using SCP.
SCPEngine
SCPException
SCPFileTransfer
SCPRemoteException
SCPUploadClient	Support for uploading files over a connected link using SCP.
SecgUtils
SecurityUtils	Static utility method relating to security facilities.
Service	Represents a service running on top of the SSH transport layer.
Session	A session channel provides for execution of a remote command, shell or subsystem.
Session.Command	Command API.
Session.Shell	Shell API.
Session.Subsystem	Subsystem API.
SessionChannel	Session implementation.
SessionFactory	A factory interface for creating SSH session channels.
SFTPClient
SFTPEngine
SFTPException
SFTPFileTransfer
SFTPPacket<T extends SFTPPacket<T>>
SHA1	SHA1 Digest.
SHA1.Factory	Named factory for SHA1 digest
SHA256	SHA256 Digest.
SHA256.Factory	Named factory for SHA256 digest
SHA384
SHA384.Factory	Named factory for SHA384 digest
SHA512
SHA512.Factory	Named factory for SHA384 digest
Signal	Various signals that may be sent or received.
Signature	Signature interface for SSH used to sign or verify data.
SignatureDSA	DSA Signature
SignatureDSA.Factory	A named factory for DSA signature
SignatureECDSA	ECDSA Signature
SignatureECDSA.Factory256	A named factory for ECDSA-256 signature
SignatureECDSA.Factory384	A named factory for ECDSA-384 signature
SignatureECDSA.Factory521	A named factory for ECDSA-521 signature
SignatureEdDSA
SignatureEdDSA.Factory
SignatureRSA	RSA Signature
SignatureRSA.FactoryCERT	A named factory for RSA Signature
SignatureRSA.FactoryRSASHA256	A named factory for RSA Signature
SignatureRSA.FactoryRSASHA512	A named factory for RSA Signature
SignatureRSA.FactorySSHRSA	A named factory for RSA Signature
SingletonRandomFactory	A random factory wrapper that uses a single random instance.
SocketClient
SocketForwardingConnectListener	A ConnectListener that forwards what is received over the channel to a socket and vice-versa.
SocketStreamCopyMonitor
SSHClient	Secure SHell client API.
SSHException	Most exceptions in the net.schmizz.sshj package are instances of this class.
SSHPacket
SSHPacketHandler	An interface for classes to which packet handling may be delegated.
SSHRuntimeException	Represents unrecoverable exceptions in the net.schmizz.sshj package.
StatefulSFTPClient
StreamCipher
StreamCiphers	Implementations of the Stream Ciphers that are defined in the RFCs - https://tools.ietf.org/html/rfc4253#section-6.3 - https://tools.ietf.org/html/rfc4345
StreamCiphers.Factory	Named factory for BlockCipher
StreamCopier
StreamCopier.Listener
ThreadNameProvider
TransferListener
Transport	Transport layer of the SSH protocol.
TransportException	Transport-layer exception
TransportImpl	A thread-safe Transport implementation.
TransportImpl.ConnInfo
TransportImpl.NullService
TripleDESCBC	Deprecated. Use BlockCiphers.TripleDESCBC()
TripleDESCBC.Factory	Named factory for TripleDESCBC Cipher
UserAuth	User authentication API.
UserAuthException	User authentication exception
UserAuthImpl	UserAuth implementation.
Window
Window.Local	Controls how much data remote end can send before an adjustment notification from us is required.
Window.Remote	Controls how much data we can send before an adjustment notification from remote end is required.
X11Forwarder	Handles forwarded x11 channels.
X11Forwarder.X11Channel	An x11 forwarded channel.
ZlibCompression
ZlibCompression.Factory	Named factory for the ZLib Compression.