(Tcl) SSH Tunnel with Dynamic Port Forwarding

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# Starting in v9.5.0.49, all Chilkat classes can be unlocked at once at the beginning of a program
# by calling UnlockBundle.  It requires a Bundle unlock code.
set chilkatGlob [new_CkGlobal]

set success [CkGlobal_UnlockBundle $chilkatGlob "Anything for 30-day trial."]
if {$success != 1} then {
    puts [CkGlobal_lastErrorText $chilkatGlob]
    delete_CkGlobal $chilkatGlob
    exit
}

# This example requires Chilkat version 9.5.0.50 or greater.
set tunnel [new_CkSshTunnel]

set sshHostname "sftp.example.com"
set sshPort 22

# Connect to an SSH server and establish the SSH tunnel:
set success [CkSshTunnel_Connect $tunnel $sshHostname $sshPort]
if {$success != 1} then {
    puts [CkSshTunnel_lastErrorText $tunnel]
    delete_CkGlobal $chilkatGlob
    delete_CkSshTunnel $tunnel
    exit
}

# Authenticate with the SSH server via a login/password
# or with a public key.  
# This example demonstrates SSH password authentication.
set success [CkSshTunnel_AuthenticatePw $tunnel "mySshLogin" "mySshPassword"]
if {$success != 1} then {
    puts [CkSshTunnel_lastErrorText $tunnel]
    delete_CkGlobal $chilkatGlob
    delete_CkSshTunnel $tunnel
    exit
}

# Indicate that the background SSH tunnel thread will behave as a SOCKS proxy server
# with dynamic port forwarding:
CkSshTunnel_put_DynamicPortForwarding $tunnel 1

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

CkSshTunnel_put_InboundSocksUsername $tunnel "chilkat123"
CkSshTunnel_put_InboundSocksPassword $tunnel "password123"

# Start the listen/accept thread to begin accepting SOCKS proxy client connections.
# Listen on port 1080.
set success [CkSshTunnel_BeginAccepting $tunnel 1080]
if {$success != 1} then {
    puts [CkSshTunnel_lastErrorText $tunnel]
    delete_CkGlobal $chilkatGlob
    delete_CkSshTunnel $tunnel
    exit
}

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

# For this example, let's do a simple HTTPS request:
set url "https://www.ethereum.org/"

set http [new_CkHttp]

# Indicate that the HTTP object is to use our portable SOCKS proxy/SSH tunnel running in our background thread.
CkHttp_put_SocksHostname $http "localhost"
CkHttp_put_SocksPort $http 1080
CkHttp_put_SocksVersion $http 5
CkHttp_put_SocksUsername $http "chilkat123"
CkHttp_put_SocksPassword $http "password123"

CkHttp_put_SendCookies $http 1
CkHttp_put_SaveCookies $http 1
CkHttp_put_CookieDir $http "memory"

# Do the HTTPS page fetch (through the SSH tunnel)
set html [CkHttp_quickGetStr $http $url]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkGlobal $chilkatGlob
    delete_CkSshTunnel $tunnel
    delete_CkHttp $http
    exit
}

# Stop the background listen/accept thread:
set waitForThreadExit 1
set success [CkSshTunnel_StopAccepting $tunnel $waitForThreadExit]
if {$success != 1} then {
    puts [CkSshTunnel_lastErrorText $tunnel]
    delete_CkGlobal $chilkatGlob
    delete_CkSshTunnel $tunnel
    delete_CkHttp $http
    exit
}

# Close the SSH tunnel (would also kick any remaining connected clients).
set success [CkSshTunnel_CloseTunnel $tunnel $waitForThreadExit]
if {$success != 1} then {
    puts [CkSshTunnel_lastErrorText $tunnel]
    delete_CkGlobal $chilkatGlob
    delete_CkSshTunnel $tunnel
    delete_CkHttp $http
    exit
}


delete_CkGlobal $chilkatGlob
delete_CkSshTunnel $tunnel
delete_CkHttp $http