Lianja

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.

Lianja

llSuccess = .F.

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

llSuccess = .F.

loTunnel = createobject("CkSshTunnel")

lcSshHostname = "sftp.example.com"
lnSshPort = 22

// Connect to an SSH server and establish the SSH tunnel:
llSuccess = loTunnel.Connect(lcSshHostname,lnSshPort)
if (llSuccess <> .T.) then
    ? loTunnel.LastErrorText
    release loTunnel
    return
endif

// Authenticate with the SSH server via a login/password
// or with a public key.  
// This example demonstrates SSH password authentication.
llSuccess = loTunnel.AuthenticatePw("mySshLogin","mySshPassword")
if (llSuccess <> .T.) then
    ? loTunnel.LastErrorText
    release loTunnel
    return
endif

// Indicate that the background SSH tunnel thread will behave as a SOCKS proxy server
// with dynamic port forwarding:
loTunnel.DynamicPortForwarding = .T.

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

loTunnel.InboundSocksUsername = "chilkat123"
loTunnel.InboundSocksPassword = "password123"

// Start the listen/accept thread to begin accepting SOCKS proxy client connections.
// Listen on port 1080.
llSuccess = loTunnel.BeginAccepting(1080)
if (llSuccess <> .T.) then
    ? loTunnel.LastErrorText
    release loTunnel
    return
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.
loFtp = createobject("CkFtp2")

loFtp.Hostname = "ftp.example.com"
loFtp.Username = "login"
loFtp.Password = "password"

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

// Connect to the FTP server
llSuccess = loFtp.ConnectOnly()
if (llSuccess <> .T.) then
    ? loFtp.LastErrorText
    release loTunnel
    release loFtp
    return
endif

// Authenticate with the FTP server.
llSuccess = loFtp.LoginAfterConnectOnly()
if (llSuccess <> .T.) then
    ? loFtp.LastErrorText
    release loTunnel
    release loFtp
    return
endif

// Change to the remote directory where the file will be uploaded.
llSuccess = loFtp.ChangeRemoteDir("junk")
if (llSuccess <> .T.) then
    ? loFtp.LastErrorText
    release loTunnel
    release loFtp
    return
endif

// Upload a file.
lcLocalPath = "/temp/hamlet.xml"
lcRemoteFilename = "hamlet.xml"

llSuccess = loFtp.PutFile(lcLocalPath,lcRemoteFilename)
if (llSuccess <> .T.) then
    ? loFtp.LastErrorText
    release loTunnel
    release loFtp
    return
endif

// This closes the SSH channel within the SSH tunnel,
// and thus closes the connection with the FTP server.
llSuccess = loFtp.Disconnect()

? "File Uploaded!"

// Stop the background listen/accept thread:
llWaitForThreadExit = .T.
llSuccess = loTunnel.StopAccepting(llWaitForThreadExit)
if (llSuccess <> .T.) then
    ? loTunnel.LastErrorText
    release loTunnel
    release loFtp
    return
endif

// Close the SSH tunnel (would also kick any remaining connected clients).
llSuccess = loTunnel.CloseTunnel(llWaitForThreadExit)
if (llSuccess <> .T.) then
    ? loTunnel.LastErrorText
    release loTunnel
    release loFtp
    return
endif



release loTunnel
release loFtp