AutoIt

FTP through SSH Tunnel with Dynamic Port Forwarding

See more FTP Examples

Demonstrates how to start a background thread that runs a portable SSH tunnel w/ dynamic port forwarding that the foreground thread can be used for establishing FTP sessions through an SSH tunnel.

Note: Some developers may be accustomed to starting an stunnel.exe proxy from https://www.stunnel.org. The stunnel.exe is not necessary here. Chilkat's background thread fulfills the task of what the external stunnel.exe does. Therefore, your application is self-contained, meaning that it can run anywhere because the SSH tunnel proxy is built-in.

AutoIt

Local $bSuccess = False

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

$bSuccess = False

$oTunnel = ObjCreate("Chilkat.SshTunnel")

Local $sshHostname = "sftp.example.com"
Local $iSshPort = 22

; Connect to an SSH server and establish the SSH tunnel:
$bSuccess = $oTunnel.Connect($sshHostname,$iSshPort)
If ($bSuccess <> True) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf

; Authenticate with the SSH server via a login/password
; or with a public key.  
; This example demonstrates SSH password authentication.
$bSuccess = $oTunnel.AuthenticatePw("mySshLogin","mySshPassword")
If ($bSuccess <> True) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf

; Indicate that the background SSH tunnel thread will behave as a SOCKS proxy server
; with dynamic port forwarding:
$oTunnel.DynamicPortForwarding = 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.

$oTunnel.InboundSocksUsername = "chilkat123"
$oTunnel.InboundSocksPassword = "password123"

; Start the listen/accept thread to begin accepting SOCKS proxy client connections.
; Listen on port 1080.
$bSuccess = $oTunnel.BeginAccepting(1080)
If ($bSuccess <> True) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf

; 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 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.

$oFtp = ObjCreate("Chilkat.Ftp2")

; Indicate that the HTTP object is to use our portable SOCKS proxy/SSH tunnel running in our background thread.
$oFtp.SocksHostname = "localhost"
; The SocksPort must equal the port passed to BeginAccepting above.
$oFtp.SocksPort = 1080
$oFtp.SocksVersion = 5
; The SOCKS5 login/password set here must equal the InboundSocksUsername/Password set above.
$oFtp.SocksUsername = "chilkat123"
$oFtp.SocksPassword = "password123"

; This is the actual FTP server domain or IP address, and the login/password for the user account on the destination FTP server.
$oFtp.Hostname = "ftp.someFtpServer.com"
$oFtp.Username = "myLogin"
$oFtp.Password = "myPassword"
$oFtp.AuthTls = True

; Connect and login (via the SSH tunnel) to the FTP server.
$bSuccess = $oFtp.Connect()
If ($bSuccess <> True) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

; Change to the remote directory where the file is located.
; This step is only necessary if the file is not in the root directory
; for the FTP account.
$bSuccess = $oFtp.ChangeRemoteDir("junk")
If ($bSuccess <> True) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

Local $sLocalFilename = "c:/temp/hamlet.xml"
Local $sRemoteFilename = "hamlet.xml"

; Download a file.  (the data connection is also automatically established through the 
; SSH tunnel using dynamic port forwarding..)
$bSuccess = $oFtp.GetFile($sRemoteFilename,$sLocalFilename)
If ($bSuccess <> True) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

; The disconnect is disconnecting with the FTP server and closes the SSH tunnel.
; The background tunnel thread is still running, and may be used for subsequent FTP connections,
; or even connections for any other purpose, such as HTTP, IMAP, SMTP, POP3, etc.
$bSuccess = $oFtp.Disconnect()

; When the app is finished with the tunnel, it can cleanup..

; Stop the background listen/accept thread:
Local $bWaitForThreadExit = True
$bSuccess = $oTunnel.StopAccepting($bWaitForThreadExit)
If ($bSuccess <> True) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf

; Close the SSH tunnel (would also kick any remaining connected clients).
$bSuccess = $oTunnel.CloseTunnel($bWaitForThreadExit)
If ($bSuccess <> True) Then
    ConsoleWrite($oTunnel.LastErrorText & @CRLF)
    Exit
EndIf