Package com.sshtools.client

Class SshClientContext

java.lang.Object

com.sshtools.synergy.nio.ProtocolContext

com.sshtools.synergy.ssh.SshContext

com.sshtools.client.SshClientContext

All Implemented Interfaces:

Context, ExecutorServiceProvider

public class SshClientContext
extends SshContext

Holds the configuration for an SSH connection.

Field Summary

Fields

Modifier and Type	Field	Description
protected TransportProtocolClient	transport

Fields inherited from class com.sshtools.synergy.ssh.SshContext

byteBufferPool, CIPHER_AES_GCM_128, CIPHER_AES_GCM_256, CIPHER_AES128_CBC, CIPHER_AES128_CTR, CIPHER_AES192_CBC, CIPHER_AES192_CTR, CIPHER_AES256_CBC, CIPHER_AES256_CTR, CIPHER_ARCFOUR, CIPHER_ARCFOUR_128, CIPHER_ARCFOUR_256, CIPHER_BLOWFISH_CBC, CIPHER_TRIPLEDES_CBC, CIPHER_TRIPLEDES_CTR, ciphersCS, ciphersSC, componentManager, COMPRESSION_NONE, COMPRESSION_ZLIB, compressionLevel, compressionsCS, compressionsSC, daemon, executor, extendedIdentificationSanitization, HMAC_MD5, HMAC_MD5_96, HMAC_MD5_ETM, HMAC_RIPEMD160, HMAC_RIPEMD160_ETM, HMAC_SHA1, HMAC_SHA1_96, HMAC_SHA1_ETM, HMAC_SHA256, HMAC_SHA256_96, HMAC_SHA256_ETM, HMAC_SHA512, HMAC_SHA512_96, HMAC_SHA512_ETM, idleAuthenticationTimeoutSeconds, idleConnectionTimeout, keepAliveDataMaxLength, keepAliveInterval, KEX_DIFFIE_HELLMAN_ECDH_NISTP_256, KEX_DIFFIE_HELLMAN_ECDH_NISTP_384, KEX_DIFFIE_HELLMAN_ECDH_NISTP_521, KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1, KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256, KEX_DIFFIE_HELLMAN_GROUP1_SHA1, KEX_DIFFIE_HELLMAN_GROUP14_SHA1, KEX_DIFFIE_HELLMAN_GROUP14_SHA256, KEX_DIFFIE_HELLMAN_GROUP15_SHA512, KEX_DIFFIE_HELLMAN_GROUP16_SHA512, KEX_DIFFIE_HELLMAN_GROUP17_SHA512, KEX_DIFFIE_HELLMAN_GROUP18_SHA512, KEYBOARD_INTERACTIVE_AUTHENTICATION, keyExchanges, killTunnelsOnRemoteForwardingCancel, locale, macCS, macSC, MAX_NUM_BYTES_BEFORE_REKEY, MAX_NUM_PACKETS_BEFORE_REKEY, maxChannels, maxDHGroupExchangeKeySize, maximumPacketLength, maximumSocketsBacklogPerRemotelyForwardedConnection, minDHGroupExchangeKeySize, PASSWORD_AUTHENTICATION, prefCipherCS, prefCipherSC, prefCompressionCS, prefCompressionSC, preferredDHGroupExchangeKeySize, prefKeyExchange, prefMacCS, prefMacSC, prefPublicKey, PUBLIC_KEY_ECDSA_SHA2_NISPTP_256, PUBLIC_KEY_ECDSA_SHA2_NISPTP_384, PUBLIC_KEY_ECDSA_SHA2_NISPTP_521, PUBLIC_KEY_ED25519, PUBLIC_KEY_ED448, PUBLIC_KEY_RSA_SHA256, PUBLIC_KEY_RSA_SHA512, PUBLIC_KEY_SSHDSS, PUBLIC_KEY_SSHRSA, PUBLICKEY_AUTHENTICATION, publicKeys, sendIgnorePacketOnIdle, signatures, softwareVersionComments

Fields inherited from class com.sshtools.synergy.nio.ProtocolContext

keepAlive, receiveBufferSize, reuseAddress, sendBufferSize, tcpNoDelay

Constructor Summary

Constructors

Constructor	Description
SshClientContext()
SshClientContext(SecurityLevel securityLevel)
SshClientContext(SshEngine daemon)
SshClientContext(SshEngine daemon, ComponentManager componentManager, SecurityLevel securityLevel)
SshClientContext(SshEngine daemon, SecurityLevel securityLevel)

Method Summary

Modifier and Type	Method	Description
SshClientContext	addAuthenticator(ClientAuthenticator auth)
SshClientContext	addGlobalRequestHandler(GlobalRequestHandler<SshClientContext> handler)
SshClientContext	addStateListener(ClientStateListener stateListener)
protected void	configureKeyExchanges()
ProtocolEngine	createEngine(ConnectRequestFuture connectFuture)
AuthenticationProtocolClient	getAuthenticationClient()
List<ClientAuthenticator>	getAuthenticators()
BannerDisplay	getBannerDisplay()
ChannelFactory<SshClientContext>	getChannelFactory()
ConnectionManager<SshClientContext>	getConnectionManager()
SshEngineContext	getDaemonContext()
final SshEngine	getEngine()
ForwardingManager<SshClientContext>	getForwardingManager()
GlobalRequestHandler<SshClientContext>	getGlobalRequestHandler(String name)
HostKeyVerification	getHostKeyVerification()
boolean	getPreferKeyboardInteractiveOverPassword()
String	getPreferredPublicKey()
SocketConnectionFactory	getSocketConnectionFactory()
Collection<ClientStateListener>	getStateListeners()
int	getSubsystemCacheSize()
String	getSupportedPublicKeys()
String	getUsername()	Get the username of this connection.
void	keysExchanged(boolean first)
SshClientContext	setBannerDisplay(BannerDisplay bannerDisplay)
void	setChannelFactory(ChannelFactory<SshClientContext> channelFactory)
SshClientContext	setConnectionManager(ConnectionManager<SshClientContext> connectionManager)
SshClientContext	setForwardingManager(ForwardingManager<SshClientContext> forwardingManager)
SshClientContext	setHostKeyVerification(HostKeyVerification hkv)
void	setPreferKeyboardInteractiveOverPassword(boolean preferKeyboardInteractiveOverPassword)
void	setPreferredPublicKey(String prefPublicKey)
SshClientContext	setSubsystemCacheSize(int subsystemCacheSize)
SshClientContext	setUsername(String username)	Set the username for this connection.
ComponentFactory<SshKeyExchange<?>>	supportedKeyExchanges()
boolean	testClientKeyExchangeAlgorithm(SshKeyExchangeClientFactory<? extends SshKeyExchangeClient> cls)

Methods inherited from class com.sshtools.synergy.ssh.SshContext

addOperationListener, enableFIPSMode, getByteBufferPool, getChannelLimit, getCiphersCS, getCiphersSC, getComponentManager, getCompressionLevel, getExecutorListeners, getExecutorService, getForwardingPolicy, getHttpRedirectUrl, getIdleAuthenticationTimeoutSeconds, getIdleConnectionTimeoutSeconds, getKeepAliveDataMaxLength, getKeepAliveInterval, getKeyExchangePacketLimit, getKeyExchanges, getKeyExchangeTransferLimit, getLocale, getMacsCS, getMacsSC, getMaxDHGroupExchangeKeySize, getMaximumPacketLength, getMaximumSocketsBacklogPerRemotelyForwardedConnection, getMinDHGroupExchangeKeySize, getPolicy, getPolicy, getPreferredCipherCS, getPreferredCipherSC, getPreferredCompressionCS, getPreferredCompressionSC, getPreferredDHGroupExchangeKeySize, getPreferredKeyExchange, getPreferredMacCS, getPreferredMacSC, getPublicKeys, getRemoteForwardingCancelKillsTunnels, getSoftwareVersionComments, getSupportedSignatures, hasPolicy, init, isExtendedIdentificationSanitization, isHttpRedirect, isSendIgnorePacketOnIdle, isSHA1SignaturesSupported, listPublicKeys, removeOperationListener, setChannelLimit, setCipherPreferredPositionCS, setCipherPreferredPositionSC, setCompressionLevel, setExtendedIdentificationSanitization, setHttpRedirect, setHttpRedirectUrl, setIdleAuthenticationTimeoutSeconds, setIdleConnectionTimeoutSeconds, setKeepAliveDataMaxLength, setKeepAliveInterval, setKeyExchangePacketLimit, setKeyExchangePreferredPosition, setKeyExchangeTransferLimit, setLocale, setMacPreferredPositionCS, setMacPreferredPositionSC, setMaxDHGroupExchangeKeySize, setMaximumPacketLength, setMaximumSocketsBacklogPerRemotelyForwardedConnection, setMinDHGroupExchangeKeySize, setPolicy, setPreferredCipherCS, setPreferredCipherCS, setPreferredCipherCS, setPreferredCipherSC, setPreferredCipherSC, setPreferredCipherSC, setPreferredCompressionCS, setPreferredCompressionSC, setPreferredDHGroupExchangeKeySize, setPreferredKeyExchange, setPreferredKeyExchange, setPreferredMacCS, setPreferredMacCS, setPreferredMacCS, setPreferredMacSC, setPreferredMacSC, setPreferredMacSC, setPublicKeyPreferredPosition, setRemoteForwardingCancelKillsTunnels, setSendIgnorePacketOnIdle, setSHA1SignaturesSupported, setSocketConnectionFactory, setSoftwareVersionComments, shutdown, supportedCiphersCS, supportedCiphersSC, supportedCompressionsCS, supportedCompressionsSC, supportedMacsCS, supportedMacsSC, supportedPublicKeys

Methods inherited from class com.sshtools.synergy.nio.ProtocolContext

enableHTTPProxy, enableHTTPProxy, enableHTTPProxy, enableHTTPProxy, enableSocks4Proxy, enableSocks5Proxy, getOptionalHeaders, getProxyHostname, getProxyPassword, getProxyPort, getProxyType, getProxyUsername, getReceiveBufferSize, getSendBufferSize, getSocketOptionKeepAlive, getSocketOptionReuseAddress, getSocketOptionTcpNoDelay, getUserAgent, isProxyEnabled, isResolveLocally, setReceiveBufferSize, setSendBufferSize, setSocketOptionKeepAlive, setSocketOptionReuseAddress, setSocketOptionTcpNoDelay

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

transport

protected TransportProtocolClient transport

Constructor Details

SshClientContext

public SshClientContext()
                 throws IOException,
SshException

Throws:

IOException

SshException

SshClientContext

public SshClientContext(SshEngine daemon,
 ComponentManager componentManager,
 SecurityLevel securityLevel)
                 throws IOException,
SshException

Throws:

IOException

SshException

SshClientContext

public SshClientContext(SshEngine daemon)
                 throws IOException,
SshException

Throws:

IOException

SshException

SshClientContext

public SshClientContext(SshEngine daemon,
 SecurityLevel securityLevel)
                 throws IOException,
SshException

Throws:

IOException

SshException

SshClientContext

public SshClientContext(SecurityLevel securityLevel)
                 throws IOException,
SshException

Throws:

IOException

SshException

Method Details

createEngine

public ProtocolEngine createEngine(ConnectRequestFuture connectFuture)
                            throws IOException

Specified by:

createEngine in class SshContext

Throws:

IOException

getEngine

public final SshEngine getEngine()

Overrides:

getEngine in class SshContext

setUsername

public SshClientContext setUsername(String username)

Set the username for this connection.

Parameters:

username -

getUsername

public String getUsername()

Get the username of this connection.

Returns:

addStateListener

public SshClientContext addStateListener(ClientStateListener stateListener)

getStateListeners

public Collection<ClientStateListener> getStateListeners()

getForwardingManager

public ForwardingManager<SshClientContext> getForwardingManager()

Specified by:

getForwardingManager in class SshContext

setForwardingManager

public SshClientContext setForwardingManager(ForwardingManager<SshClientContext> forwardingManager)

keysExchanged

public void keysExchanged(boolean first)

getAuthenticationClient

public AuthenticationProtocolClient getAuthenticationClient()

configureKeyExchanges

protected void configureKeyExchanges()

Specified by:

configureKeyExchanges in class SshContext

testClientKeyExchangeAlgorithm

public boolean testClientKeyExchangeAlgorithm(SshKeyExchangeClientFactory<? extends SshKeyExchangeClient> cls)

getSupportedPublicKeys

public String getSupportedPublicKeys()

Specified by:

getSupportedPublicKeys in class SshContext

supportedKeyExchanges

public ComponentFactory<SshKeyExchange<?>> supportedKeyExchanges()

Overrides:

supportedKeyExchanges in class SshContext

getPreferredPublicKey

public String getPreferredPublicKey()

Specified by:

getPreferredPublicKey in class SshContext

setPreferredPublicKey

public void setPreferredPublicKey(String prefPublicKey)

getConnectionManager

public ConnectionManager<SshClientContext> getConnectionManager()

Specified by:

getConnectionManager in class SshContext

setConnectionManager

public SshClientContext setConnectionManager(ConnectionManager<SshClientContext> connectionManager)

addAuthenticator

public SshClientContext addAuthenticator(ClientAuthenticator auth)

getAuthenticators

public List<ClientAuthenticator> getAuthenticators()

getBannerDisplay

public BannerDisplay getBannerDisplay()

setBannerDisplay

public SshClientContext setBannerDisplay(BannerDisplay bannerDisplay)

getSubsystemCacheSize

public int getSubsystemCacheSize()

setSubsystemCacheSize

public SshClientContext setSubsystemCacheSize(int subsystemCacheSize)

getChannelFactory

public ChannelFactory<SshClientContext> getChannelFactory()

Specified by:

getChannelFactory in class SshContext

setChannelFactory

public void setChannelFactory(ChannelFactory<SshClientContext> channelFactory)

getDaemonContext

public SshEngineContext getDaemonContext()

Overrides:

getDaemonContext in class SshContext

addGlobalRequestHandler

public SshClientContext addGlobalRequestHandler(GlobalRequestHandler<SshClientContext> handler)

getGlobalRequestHandler

public GlobalRequestHandler<SshClientContext> getGlobalRequestHandler(String name)

Specified by:

getGlobalRequestHandler in class SshContext

getSocketConnectionFactory

public SocketConnectionFactory getSocketConnectionFactory()

Overrides:

getSocketConnectionFactory in class SshContext

getHostKeyVerification

public HostKeyVerification getHostKeyVerification()

setHostKeyVerification

public SshClientContext setHostKeyVerification(HostKeyVerification hkv)

getPreferKeyboardInteractiveOverPassword

public boolean getPreferKeyboardInteractiveOverPassword()

setPreferKeyboardInteractiveOverPassword

public void setPreferKeyboardInteractiveOverPassword(boolean preferKeyboardInteractiveOverPassword)