ElSimpleSSHClient class

Navigation

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

Description ElSimpleSSHClient 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 which returns after SSH connection is established or error happens. When there are encrypted data to be sent to the socket, ElSimpleSSHClient will fire OnSend event. When ElSimpleSSHClient needs data from the socket, it fires OnReceive event. By default, ElSimpleSSHClient 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 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. To use external socket class set UseInternalSocket property to False and use OnSend/OnReceive events. To let ElSimpleSSHClient use internal socket just set values of Address and Port properties.

Properties Active Address AuthAttempts AuthenticationTypes AuthTypePriorities AutoAdjustCiphers ClientHostName ClientUserName Command Commands CompressionAlgorithms CompressionAlgorithmPriorities CompressionAlgorithmClientToServer CompressionAlgorithmServerToClient CompressionLevel CryptoProviderManager DefaultWindowSize DNS EncryptionAlgorithms EncryptionAlgorithmPriorities EncryptionAlgorithmClientToServer EncryptionAlgorithmServerToClient Environment ExitMessage ExitSignal ExitStatus ExtendedDataType ForceCompression IncomingSpeedLimit KbdIntName KbdIntInstruction KexAlgorithm KexAlgorithmPriorities KexAlgorithms KeyStorage LocalAddress LocalPort MacAlgorithms MacAlgorithmPriorities MacAlgorithmClientToServer MacAlgorithmServerToClient MaxSSHPacketSize MinWindowSize OutgoingSpeedLimit Password Port ProxyResult PublicKeyAlgorithm PublicKeyAlgorithmPriorities PublicKeyAlgorithms RequestPasswordChange RequestTerminal ServerCloseReason ServerSoftwareName ServerKey SoftwareName SSHAuthOrder TerminalInfo TotalBytesReceived TotalBytesSent TrustedKeys UseInternalSocket UseIPv6 UsingIPv6 SocksUseIPv6 UseUTF8 UserName Version Versions SocketBinding SocketTimeout SocksAuthentication SocksPassword SocksPort SocksResolveAddress SocksServer SocksUserCode SocksVersion UseSocks UseWebTunneling WebTunnelAddress WebTunnelAuthentication WebTunnelPassword WebTunnelPort WebTunnelRequestHeaders WebTunnelUserId

Methods Constructor Destructor CanReceive Close ExecuteCommand Open SendData ReceiveData SendText RenegotiateCiphers ReceiveText SendKeepAlive

Events OnAuthenticationAttempt OnAuthenticationFailed OnAuthenticationKeyboard OnAuthenticationStart OnAuthenticationSuccess OnBanner OnCiphersNegotiated OnCloseConnection OnDNSKeyNeeded OnDNSKeyValidate OnDNSResolve OnError OnKeyValidate MessageLoop OnPasswordChangeRequest OnPrivateKeyNeeded OnReceive OnSend OnSendCommandRequest

Declared in .NET: Namespace: SBSimpleSSH Assembly: SecureBlackbox.SSHClient VCL: Unit: SBSimpleSSH 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