TElSSHClient class

Navigation

TElSSHClient class Properties Methods Events Declared in Licensing
TElSSHClient provides client-side functionality for SSH connections.

Description TElSSHClient is used to add SSH support to client side of TCP connection (the client side is the side which initiates connection). To initiate connection call Open method. When there are encrypted data to be sent to the socket, TElSSHClient will fire OnSend event. When TElSSHClient needs data from the socket, it fires OnReceive event. If you use non-blocking mode, you can use DataAvailable method to tell TElSSHClient that there are some data in the socket that can be read. To transfer data over the secure SSH connection the Tunnel objects are used. Each tunnel represents a type of logical connection ( Shell, Command, Subsystem, TCP-IP local forwarding, TCP-IP remote forwarding, X11 forwarding). The Tunnel object may create a number of TunnelConnection class instances. Each TunnelConnection carries single logical connection. For example, if you want to forward the connections, accepted by remote port to your machine, you have to create one instance of TElRemotePortForwardSSHTunnel, and for each accepted connection on the server side one instance of TElSSHTunnelConnection class will be created. By default, TElSSHClient is allowed to work using both SSH1 and SSH2 versions and all encryption, public key, key exchange and MAC algorithms. You can disable or enable some of versions using Versions property and disable or enable security properties with EncryptionAlgorithms, PublicKeyAlgorithms, MacAlgorithms, KexAlgorithms and CompressionAlgorithms properties. When connection is established, connection version can be read from Version property. This component supports FIPS compliant mode. For more information, read the corresponding article.

Properties Active AuthAttempts AuthenticationTypes AuthTypePriorities AutoAdjustCiphers ClientHostName ClientUserName CompressionAlgorithmPriorities CompressionAlgorithms CompressionAlgorithmClientToServer CompressionAlgorithmServerToClient CompressionLevel CryptoProviderManager CustomEncoding DefaultWindowSize EncryptionAlgorithmPriorities EncryptionAlgorithms EncryptionAlgorithmClientToServer EncryptionAlgorithmServerToClient FIPSMode KbdIntName KbdIntInstruction KexAlgorithm KexAlgorithmPriorities KexAlgorithms KeyStorage MacAlgorithmPriorities MacAlgorithms MacAlgorithmClientToServer MacAlgorithmServerToClient MaxSSHPacketSize MinWindowSize NoCharacterEncoding Password PublicKeyAlgorithmPriorities PublicKeyAlgorithm PublicKeyAlgorithms RequestPasswordChange ServerCloseReason ServerKey ServerSoftwareName SoftwareName SSHAuthOrder ThreadSafe TotalBytesReceived TotalBytesSent TrustedKeys TunnelList ForceCompression UserName UseUTF8 Version Versions

Methods Constructor Destructor Close DataAvailable Open RenegotiateCiphers SendKeepAlive

Events OnAuthenticationAttempt OnAuthenticationFailed OnAuthenticationKeyboard OnAuthenticationStart OnAuthenticationSuccess OnCiphersNegotiated OnCloseConnection OnDebugData OnError OnKeyValidate OnOpenConnection OnPasswordChangeRequest OnPrivateKeyNeeded OnReceive OnSend OnSendCommandRequest

Declared in .NET: Namespace: SBSSHClient Assembly: SecureBlackbox.SSHClient VCL: Unit: SBSSHClient ActiveX/DLL: SBB 5 interface module: SSHBBoxCli.dll SBB 6 interface module: SSHBBoxCli6.dll

Licensing To use the component in development and distribution of your projects, you need to purchase one of the licenses: .NET: SSHBlackbox client-only OR SSHBlackbox client-server OR SFTPBlackbox client-only OR SFTPBlackbox client-server OR SecureBlackbox Transports OR SecureBlackbox Standard OR SecureBlackbox Professional VCL: SSHBlackbox client-only OR SSHBlackbox client-server OR SFTPBlackbox client-only OR SFTPBlackbox client-server OR SecureBlackbox Transports OR SecureBlackbox Standard OR SecureBlackbox Professional ActiveX/DLL: SSHBlackbox client-only OR SFTPBlackbox client-only OR SecureBlackbox Transports OR SecureBlackbox Standard