DataFlex

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.

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoTunnel
    String sSshHostname
    Integer iSshPort
    Handle hoFtp
    String sLocalPath
    String sRemoteFilename
    Boolean iWaitForThreadExit
    String sTemp1

    Move False To iSuccess

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

    Move False To iSuccess

    Get Create (RefClass(cComChilkatSshTunnel)) To hoTunnel
    If (Not(IsComObjectCreated(hoTunnel))) Begin
        Send CreateComObject of hoTunnel
    End

    Move "sftp.example.com" To sSshHostname
    Move 22 To iSshPort

    // Connect to an SSH server and establish the SSH tunnel:
    Get ComConnect Of hoTunnel sSshHostname iSshPort To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate with the SSH server via a login/password
    // or with a public key.  
    // This example demonstrates SSH password authentication.
    Get ComAuthenticatePw Of hoTunnel "mySshLogin" "mySshPassword" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Indicate that the background SSH tunnel thread will behave as a SOCKS proxy server
    // with dynamic port forwarding:
    Set ComDynamicPortForwarding Of hoTunnel To 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.

    Set ComInboundSocksUsername Of hoTunnel To "chilkat123"
    Set ComInboundSocksPassword Of hoTunnel To "password123"

    // Start the listen/accept thread to begin accepting SOCKS proxy client connections.
    // Listen on port 1080.
    Get ComBeginAccepting Of hoTunnel 1080 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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.
    Get Create (RefClass(cComChilkatFtp2)) To hoFtp
    If (Not(IsComObjectCreated(hoFtp))) Begin
        Send CreateComObject of hoFtp
    End

    Set ComHostname Of hoFtp To "ftp.example.com"
    Set ComUsername Of hoFtp To "login"
    Set ComPassword Of hoFtp To "password"

    // Indicate that the FTP2 object is to use our portable SOCKS proxy/SSH tunnel running in our background thread.
    Set ComSocksHostname Of hoFtp To "localhost"
    Set ComSocksPort Of hoFtp To 1080
    Set ComSocksVersion Of hoFtp To 5
    Set ComSocksUsername Of hoFtp To "chilkat123"
    Set ComSocksPassword Of hoFtp To "password123"

    // Connect to the FTP server
    Get ComConnectOnly Of hoFtp To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoFtp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate with the FTP server.
    Get ComLoginAfterConnectOnly Of hoFtp To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoFtp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Change to the remote directory where the file will be uploaded.
    Get ComChangeRemoteDir Of hoFtp "junk" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoFtp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Upload a file.
    Move "/temp/hamlet.xml" To sLocalPath
    Move "hamlet.xml" To sRemoteFilename

    Get ComPutFile Of hoFtp sLocalPath sRemoteFilename To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoFtp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // This closes the SSH channel within the SSH tunnel,
    // and thus closes the connection with the FTP server.
    Get ComDisconnect Of hoFtp To iSuccess

    Showln "File Uploaded!"

    // Stop the background listen/accept thread:
    Move True To iWaitForThreadExit
    Get ComStopAccepting Of hoTunnel iWaitForThreadExit To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Close the SSH tunnel (would also kick any remaining connected clients).
    Get ComCloseTunnel Of hoTunnel iWaitForThreadExit To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    End



End_Procedure