Rebex SFTP

SFTP and SCP client .NET library

Download 30-day free trial Buy from $349
More .NET libraries

Back to feature list...

Proxies and custom sockets

On this page:

SOCKS4/SOCKS5 proxy servers 

To connect through SOCKET4, SOCKET4a or SOCKS5 proxy servers, set Sftp.Proxy properties before calling the Connect method. Use ProxyType property to specify the proxy type: 

// create SFTP client instance
var sftp = new Rebex.Net.Sftp();

// use SOCKS5 proxy
sftp.Proxy.ProxyType = ProxyType.Socks5;
sftp.Proxy.Host = proxyHost;
sftp.Proxy.Port = proxyPort;
sftp.Proxy.UserName = proxyUserName;

// connect to the server
sftp.Connect(hostname);

' create SFTP client instance
Dim sftp = New Rebex.Net.Sftp()

' use SOCKS5 proxy
sftp.Proxy.ProxyType = ProxyType.Socks5
sftp.Proxy.Host = proxyHost
sftp.Proxy.Port = proxyPort
sftp.Proxy.UserName = proxyUserName

' connect to the server
sftp.Connect(hostname)

HTTP CONNECT proxy servers 

To connect through a HTTP proxy server, set Sftp.Proxy properties before calling the Connect method. Make sure the proxy server supports HTTP CONNECT method, and set the ProxyType property to HttpConnect: 

// create SFTP client instance
var sftp = new Rebex.Net.Sftp();

// use HTTP CONNECT proxy
sftp.Proxy.ProxyType = ProxyType.HttpConnect;
sftp.Proxy.Host = proxyHost;
sftp.Proxy.Port = proxyPort;
sftp.Proxy.UserName = proxyUserName;
sftp.Proxy.Password = proxyPassword;

// connect to the server
sftp.Connect(hostname);

' create SFTP client instance
Dim sftp = New Rebex.Net.Sftp()

' use HTTP CONNECT proxy
sftp.Proxy.ProxyType = ProxyType.HttpConnect
sftp.Proxy.Host = proxyHost
sftp.Proxy.Port = proxyPort
sftp.Proxy.UserName = proxyUserName
sftp.Proxy.Password = proxyPassword

' connect to the server
sftp.Connect(hostname)

Proxies with single sign-on 

Some HTTP CONNECT proxies support NTLM authentication with single sign-on. To take advantage of this feature, set the AuthenticationMethod property to ProxyAuthentication.Ntlm.

Learn how to use single sign-on to authenticate to an SFTP server. 
// create SFTP client instance
var sftp = new Rebex.Net.Sftp();

// use HTTP CONNECT proxy
sftp.Proxy.ProxyType = ProxyType.HttpConnect;
sftp.Proxy.Host = proxyHost;
sftp.Proxy.Port = proxyPort;

// use single sign-on
sftp.Proxy.AuthenticationMethod = ProxyAuthentication.Ntlm;

// connect to the server
sftp.Connect(hostname);

' create SFTP client instance
Dim sftp = New Rebex.Net.Sftp()

' use HTTP CONNECT proxy
sftp.Proxy.ProxyType = ProxyType.HttpConnect
sftp.Proxy.Host = proxyHost
sftp.Proxy.Port = proxyPort

' use single sign-on
sftp.Proxy.AuthenticationMethod = ProxyAuthentication.Ntlm

' connect to the server
sftp.Connect(hostname)

SSH server as proxy 

It's possible to tunnel SFTP sessions through an SSH server, essentially using it as a proxy server. See Tunneling for more information and sample code.

Custom transport layer - ISocket 

Rebex libraries make it possible to implement a custom transport layer, giving you full control over the network communication. All you need to do is implement a custom ISocketFactory and ISocket interfaces and instruct the Sftp object to use them. 

// create SFTP client instance
var sftp = new Rebex.Net.Sftp();

// initialize factory
SimpleSocketFactory factory = new SimpleSocketFactory();
factory.SocketConnecting += factory_SocketConnecting;

// use the factory
sftp.SetSocketFactory(factory);

// connect to the server
sftp.Connect(hostname);

' create SFTP client instance
Dim sftp = New Rebex.Net.Sftp()

' initialize factory
Dim factory = New SimpleSocketFactory()
AddHandler factory.SocketConnecting, AddressOf factory_SocketConnecting

' use the factory
sftp.SetSocketFactory(factory)

' connect to the server
sftp.Connect(hostname)

Custom transport layer (ISocket/ISocketFactory) implementation

/// <summary>
/// Exposes SocketConnected event which is raised
/// when a socket successfully connects to a remote end.
/// </summary>
public class SimpleSocketFactory : ISocketFactory
{
    /// <summary>
    /// Occurs when a socket successfully connects to a remote end.
    /// </summary>
    public event EventHandler SocketConnecting;

    // creates custom ISocket implementation
    ISocket ISocketFactory.CreateSocket()
    {
        return new SimpleSocket(this);
    }

    // raises event
    private void OnSocketConnecting()
    {
        EventHandler h = SocketConnecting;
        if (h != null)
            h(this, EventArgs.Empty);
    }

    // simple ISocket implementation
    // (core functionality is taken from ProxySocket)
    private class SimpleSocket : ProxySocket, ISocket
    {
        // creator object
        private readonly SimpleSocketFactory _factory;

        public SimpleSocket(SimpleSocketFactory factory)
        {
            _factory = factory;
        }

        // connects to a server and raises SocketConnected event
        void ISocket.Connect(string serverName, int serverPort)
        {
            _factory.OnSocketConnecting();
            base.Connect(serverName, serverPort);
        }

        // connects to a server and raises SocketConnected event
        void ISocket.Connect(EndPoint endpoint)
        {
            _factory.OnSocketConnecting();
            base.Connect(endpoint);
        }
    }
}

''' <summary>
''' Exposes SocketConnected event which is raised
''' when a socket successfully connects to a remote end.
''' </summary>
Public Class SimpleSocketFactory
    Implements ISocketFactory

    ''' <summary>
    ''' Occurs when a socket successfully connects to a remote end.
    ''' </summary>
    Public Event SocketConnecting As EventHandler

    ' creates custom ISocket implementation
    Function CreateSocket() As ISocket Implements ISocketFactory.CreateSocket
        Return New SimpleSocket(Me)
    End Function

    ' raises event
    Private Sub OnSocketConnecting()
        RaiseEvent SocketConnecting(Me, EventArgs.Empty)
    End Sub

    ' simple ISocket implementation
    ' (core functionality is taken from ProxySocket)
    Private Class SimpleSocket
        Inherits ProxySocket
        Implements ISocket

        ' creator object
        Dim _factory As SimpleSocketFactory

        Public Sub New(ByVal factory As SimpleSocketFactory)
            _factory = factory
        End Sub

        ' connects to a server and raises SocketConnected event
        Overloads Sub Connect(ByVal serverName As String, ByVal serverPort As Integer) Implements ISocket.Connect
            _factory.OnSocketConnecting()
            MyBase.Connect(serverName, serverPort)
        End Sub

        ' connects to a server and raises SocketConnected event
        Overloads Sub Connect(ByVal endpoint As EndPoint) Implements ISocket.Connect
            _factory.OnSocketConnecting()
            MyBase.Connect(endpoint)
        End Sub

    End Class

End Class

Please note that custom communication layer and proxy support are mutually exclusive - it's not possible to use both at the same time.

Back to feature list...