AutoIt

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.

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 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.
$oFtp = ObjCreate("Chilkat.Ftp2")

$oFtp.Hostname = "ftp.example.com"
$oFtp.Username = "login"
$oFtp.Password = "password"

; Indicate that the FTP2 object is to use our portable SOCKS proxy/SSH tunnel running in our background thread.
$oFtp.SocksHostname = "localhost"
$oFtp.SocksPort = 1080
$oFtp.SocksVersion = 5
$oFtp.SocksUsername = "chilkat123"
$oFtp.SocksPassword = "password123"

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

; Authenticate with the FTP server.
$bSuccess = $oFtp.LoginAfterConnectOnly()
If ($bSuccess <> True) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

; Change to the remote directory where the file will be uploaded.
$bSuccess = $oFtp.ChangeRemoteDir("junk")
If ($bSuccess <> True) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

; Upload a file.
Local $sLocalPath = "/temp/hamlet.xml"
Local $sRemoteFilename = "hamlet.xml"

$bSuccess = $oFtp.PutFile($sLocalPath,$sRemoteFilename)
If ($bSuccess <> True) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

; This closes the SSH channel within the SSH tunnel,
; and thus closes the connection with the FTP server.
$bSuccess = $oFtp.Disconnect()

ConsoleWrite("File Uploaded!" & @CRLF)

; 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