Unicode C

FTP through SSH Tunnel

See more FTP Examples

Demonstrates how to FTP through an SSH tunnel.

The Chilkat SSH tunnel object is used to create a portable SSH tunnel w/ dynamic port forwarding on a background thread that the foreground thread can use for establishing connections through an SSH tunnel.

Unicode C

#include <C_CkSshTunnelW.h>
#include <C_CkFtp2W.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSshTunnelW tunnel;
    const wchar_t *sshHostname;
    int sshPort;
    HCkFtp2W ftp;
    const wchar_t *localPath;
    const wchar_t *remoteFilename;
    BOOL waitForThreadExit;

    success = FALSE;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    success = FALSE;

    tunnel = CkSshTunnelW_Create();

    sshHostname = L"sftp.example.com";
    sshPort = 22;

    // Connect to an SSH server and establish the SSH tunnel:
    success = CkSshTunnelW_Connect(tunnel,sshHostname,sshPort);
    if (success != TRUE) {
        wprintf(L"%s\n",CkSshTunnelW_lastErrorText(tunnel));
        CkSshTunnelW_Dispose(tunnel);
        return;
    }

    // Authenticate with the SSH server via a login/password
    // or with a public key.  
    // This example demonstrates SSH password authentication.
    success = CkSshTunnelW_AuthenticatePw(tunnel,L"mySshLogin",L"mySshPassword");
    if (success != TRUE) {
        wprintf(L"%s\n",CkSshTunnelW_lastErrorText(tunnel));
        CkSshTunnelW_Dispose(tunnel);
        return;
    }

    // Indicate that the background SSH tunnel thread will behave as a SOCKS proxy server
    // with dynamic port forwarding:
    CkSshTunnelW_putDynamicPortForwarding(tunnel,TRUE);

    // We may optionally require that connecting clients authenticate with our SOCKS proxy server.
    // To do this, set an inbound username/password.  Any connecting clients would be required to 
    // use SOCKS5 with the correct username/password.
    // If no inbound username/password is set, then our SOCKS proxy server will accept both
    // SOCKS4 and SOCKS5 unauthenticated connections.

    CkSshTunnelW_putInboundSocksUsername(tunnel,L"chilkat123");
    CkSshTunnelW_putInboundSocksPassword(tunnel,L"password123");

    // Start the listen/accept thread to begin accepting SOCKS proxy client connections.
    // Listen on port 1080.
    success = CkSshTunnelW_BeginAccepting(tunnel,1080);
    if (success != TRUE) {
        wprintf(L"%s\n",CkSshTunnelW_lastErrorText(tunnel));
        CkSshTunnelW_Dispose(tunnel);
        return;
    }

    // Now that a background thread is running a SOCKS proxy server that forwards connections
    // through an SSH tunnel, it is possible to use any Chilkat implemented protocol that is SOCKS capable,
    // such as Socket, HTTP, POP3, SMTP, IMAP, FTP, etc.  The protocol may use SSL/TLS because the SSL/TLS
    // will be passed through the SSH tunnel to the end-destination.  Also, any number of simultaneous
    // connections may be routed through the SSH tunnel.

    // Let's do an FTP upload through the SSH tunnel.  Both the control and data connections 
    // go through the tunnel.
    ftp = CkFtp2W_Create();

    CkFtp2W_putHostname(ftp,L"ftp.example.com");
    CkFtp2W_putUsername(ftp,L"login");
    CkFtp2W_putPassword(ftp,L"password");

    // Indicate that the FTP2 object is to use our portable SOCKS proxy/SSH tunnel running in our background thread.
    CkFtp2W_putSocksHostname(ftp,L"localhost");
    CkFtp2W_putSocksPort(ftp,1080);
    CkFtp2W_putSocksVersion(ftp,5);
    CkFtp2W_putSocksUsername(ftp,L"chilkat123");
    CkFtp2W_putSocksPassword(ftp,L"password123");

    // Connect to the FTP server
    success = CkFtp2W_ConnectOnly(ftp);
    if (success != TRUE) {
        wprintf(L"%s\n",CkFtp2W_lastErrorText(ftp));
        CkSshTunnelW_Dispose(tunnel);
        CkFtp2W_Dispose(ftp);
        return;
    }

    // Authenticate with the FTP server.
    success = CkFtp2W_LoginAfterConnectOnly(ftp);
    if (success != TRUE) {
        wprintf(L"%s\n",CkFtp2W_lastErrorText(ftp));
        CkSshTunnelW_Dispose(tunnel);
        CkFtp2W_Dispose(ftp);
        return;
    }

    // Change to the remote directory where the file will be uploaded.
    success = CkFtp2W_ChangeRemoteDir(ftp,L"junk");
    if (success != TRUE) {
        wprintf(L"%s\n",CkFtp2W_lastErrorText(ftp));
        CkSshTunnelW_Dispose(tunnel);
        CkFtp2W_Dispose(ftp);
        return;
    }

    // Upload a file.
    localPath = L"/temp/hamlet.xml";
    remoteFilename = L"hamlet.xml";

    success = CkFtp2W_PutFile(ftp,localPath,remoteFilename);
    if (success != TRUE) {
        wprintf(L"%s\n",CkFtp2W_lastErrorText(ftp));
        CkSshTunnelW_Dispose(tunnel);
        CkFtp2W_Dispose(ftp);
        return;
    }

    // This closes the SSH channel within the SSH tunnel,
    // and thus closes the connection with the FTP server.
    success = CkFtp2W_Disconnect(ftp);

    wprintf(L"File Uploaded!\n");

    // Stop the background listen/accept thread:
    waitForThreadExit = TRUE;
    success = CkSshTunnelW_StopAccepting(tunnel,waitForThreadExit);
    if (success != TRUE) {
        wprintf(L"%s\n",CkSshTunnelW_lastErrorText(tunnel));
        CkSshTunnelW_Dispose(tunnel);
        CkFtp2W_Dispose(ftp);
        return;
    }

    // Close the SSH tunnel (would also kick any remaining connected clients).
    success = CkSshTunnelW_CloseTunnel(tunnel,waitForThreadExit);
    if (success != TRUE) {
        wprintf(L"%s\n",CkSshTunnelW_lastErrorText(tunnel));
        CkSshTunnelW_Dispose(tunnel);
        CkFtp2W_Dispose(ftp);
        return;
    }



    CkSshTunnelW_Dispose(tunnel);
    CkFtp2W_Dispose(ftp);

    }