Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.SSH.Client Assembly / Xceed.SSH.Client Namespace / SSHClient Class


In This Topic
    SSHClient Class
    In This Topic
    Represents the SSH client that will be used for the SFTP operations.
    Object Model
    SSHClient ClassSSHAlgorithmList ClassSSHClientConnectionManager ClassSSHConnectionProtocol ClassSSHAlgorithmList ClassSSHAlgorithmList ClassSSHAlgorithmList ClassSSHAlgorithmList ClassISSHIOProvider InterfaceSSHAlgorithmList ClassSSHAlgorithmList ClassProxyClient ClassSSHAlgorithmList ClassISSHTcpIPIOProvider InterfaceSSHTransportLayerProtocol Class
    Syntax
    'Declaration
 

    Public Class SSHClient 
   Implements System.IDisposable 
    'Usage
 

    Dim instance As SSHClient
    public class SSHClient : System.IDisposable
    Remarks

    SSHClient is the

    SSHClient contains properties and methods to connect and disconnect from a remote SSH server. Perform user authentication. Handle events that are global to a SSH connection.

    A SSHClient object is used as a parameter in the creation of SSH services like SFtp.

    The SSH specification allows for a single physical SSH connection to establish multiple logical channels for services like SFtp to the same SSH server. So, a single SSHClient object can be used as a parameter to multiple instances of SSH services (like SFtp for example) to the same server. Each time, a logical "channel" will be managed by SSHClient with the server.

    Inheritance Hierarchy

    System.Object
       Xceed.SSH.Client.SSHClient

    Public Constructors
     NameDescription
    Public ConstructorSSHClient ConstructorOverloaded. Initializes a new instance of the SSHClient class.  
    Top
    Protected Fields
     NameDescription
    Protected FieldCompressionAlgorithmListInternal  
    Protected FieldConnectionManagerInternalThe SSHClientConnectionManager that the SSHClient uses.  
    Protected FieldDataIntegrityAlgorithmListInternal  
    Protected FieldEncryptionAlgorithmListInternal  
    Protected FieldHostNameStringInternal  
    Protected FieldIOProviderInternalThe SocketIOProvider that the SSHClient uses.  
    Protected FieldLanguagesAlgorithmListInternal  
    Protected FieldProtocolProviderInternalThe SSHProtocolsProvider that the SSHClient uses.  
    Top
    Public Properties
     NameDescription
    Public PropertyActiveDataIntegrityAlgorithmClientToServerStringTODODOC Gets a string that indicates the currently active encryption algorithm for data that goes from the client to the server.  
    Public PropertyActiveDataIntegrityAlgorithmServerToClientStringTODODOC Gets a string that indicates the currently active encryption algorithm for data that goes from the server to the client.  
    Public PropertyActiveEncryptionAlgorithmClientToServerStringTODODOC Gets a string that indicates the currently active encryption algorithm for data that goes from the client to the server.  
    Public PropertyActiveEncryptionAlgorithmServerToClientStringTODODOC Gets a string that indicates the currently active encryption algorithm for data that goes from the server to the client.  
    Public PropertyActiveKeyExchangeAlgorithmStringTODODOC Gets a string that indicates the currently active key exchange algorithm.  
    Public PropertyActivePublicKeyAlgorithmStringTODODOC Gets a string that indicates the currently active public key algorithm.  
    Public PropertyAllowTraceWriterClosureGet or sets a Boolean value that indicates whether SSHClient can close its assigned TraceWriter as part of its cleanup.  
    Public PropertyAuthenticatedGets a System.Boolean value that indicates if the SSHClient object is authenticated to a server or not.  
    Public PropertyCompressionAlgorithmList  
    Public PropertyConnectedGets a System.Boolean value that indicates if the SSHClient object is connected to a server or not.  
    Public PropertyConnectionManager  
    Public PropertyConnectionProtocolGets the SSHClient's SSH connection protocol.  
    Public PropertyDataIntegrityAlgorithmList  
    Public PropertyEncryptionAlgorithmList  
    Public PropertyEncryptionAlgorithmListClientToServer  
    Public PropertyEncryptionAlgorithmListServerToClient  
    Public PropertyHostNameGets the host name used to connect, or an empty string if not connected.  
    Public PropertyIOProvider  
    Public PropertyKeyExchangeAlgorithmList  
    Public PropertyLanguagesAlgorithmList  
    Public PropertyLocalAddress

    Gets or sets the local IP address and port from which the SSH client will be or is connected from.

     
    Public PropertyPortGets the port being used by the SSH client.  
    Public PropertyProxyClientGets or sets the proxy client to use for connecting and/or logging in via a proxy server.  
    Public PropertyPublicKeyAlgorithmList  
    Public PropertyServerEndPointGets the host name used to connect expressed as a System.Net.IPEndPoint object or null if the client is not connected.  
    Public PropertyServerIdentificationComments  
    Public PropertyServerIdentificationSoftwareVersion  
    Public PropertyServerIdentificationSoftwareVersionAndComments  
    Public PropertyState  
    Public PropertyTcpIpIOProvider  
    Public PropertyTimeoutGets or sets a value, in seconds, indicating after what period of time an SSH operation should timeout.  
    Public PropertyTimeoutSecondsTODODOC Gets or sets a value, in seconds, indicating after what period of time an SSH operation should timeout.  
    Public PropertyTraceWriterGets or sets the System.IO.TextWriter which will trace the connection/deconnection process as well as the commands and replies sent to and received from the SSH server.  
    Public PropertyTraceWriterTimestampFormatGets or sets the format used to generate textual timestamps for logs written to the TraceWriter.  
    Public PropertyTraceWriterTimestampFormatProviderGets or sets a format provider object used to generate textual timestamps for logs written to the TraceWriter.  
    Public PropertyTraceWriterTimestampUTCGets or sets a boolean value that indicates whether the timestamps for logs written to the TraceWriter use UTC time or local time.  
    Public PropertyTransportLayerProtocol  
    Public PropertyWaitForChannelCloseMessage  
    Public PropertyWaitForServerKeysGets or sets a System.Boolean value that indicates whether, when connecting, the client should wait for the server to send its encryption keys.  
    Top
    Public Methods
     NameDescription
    Public MethodAuthenticateOverloaded. Performs authentication of the SSHClient's SSH connection using the provided username and password.  
    Public MethodCompleteConnect  
    Public MethodConnectOverloaded. Connects the SSHClient to an SSH server.  
    Public MethodDisconnectDisconnects the SSHClient from the SSH server.  
    Public MethodDisposeOverloaded. TODODOC Performs cleanup of unmanaged resources.  
    Public MethodGetSupportedAuthenticationMethods  
    Public MethodPrepareConnectOverloaded.   
    Public MethodReExchangeKeys  
    Public MethodTraceWriterTestTimestampOverloaded.   
    Top
    Protected Methods
     NameDescription
    Protected MethodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.  
    Protected MethodOnAlgorithmsNegotiated  
    Protected MethodOnAuthenticationBannerReceived  
    Protected MethodOnDisconnected  
    Protected MethodOnHostKeyReceived  
    Top
    Public Events
     NameDescription
    Public EventAlgorithmsNegotiatedTODODOC  
    Public EventAuthenticationBannerReceivedTODODOC  
    Public EventDisconnectedTODODOC  
    Public EventHostKeyReceivedThis event is triggered during connection sequence to a SSH server when the server's public key is received for authentication.  
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    SSHClient Members
    Xceed.SSH.Client Namespace

    Send Feedback