Visual FoxPro

TLS Connection within SSH Tunnel (Port Forwarding)

See more Socket/SSL/TLS Examples

Demonstrates using Chilkat Socket to communicate to a TLS service through an SSH tunnel. This example will connect (through a port-forwarded SSH tunnel) to the GMAIL IMAP server via TLS and will receive the greeting.

Note: The Chilkat IMAP API provides direct support for using SSH tunneling with the IMAP protocol. This example serves only to demonstrate that, in general, TLS connections can be tunneled through SSH.

Visual FoxPro

LOCAL lnSuccess
LOCAL loTunnel
LOCAL lcSshHostname
LOCAL lnSshPort
LOCAL loChannel
LOCAL lnMaxWaitMs
LOCAL lnUseTls
LOCAL lcImapGreeting

lnSuccess = 0

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

loTunnel = CreateObject('Chilkat.Socket')

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

* Connect to an SSH server and establish the SSH tunnel:
lnSuccess = loTunnel.SshOpenTunnel(lcSshHostname,lnSshPort)
IF (lnSuccess = 0) THEN
    ? loTunnel.LastErrorText
    RELEASE loTunnel
    CANCEL
ENDIF

* Authenticate with the SSH server via a login/password
* or with a public key.
* This example demonstrates SSH password authentication.
lnSuccess = loTunnel.SshAuthenticatePw("mySshLogin","mySshPassword")
IF (lnSuccess = 0) THEN
    ? loTunnel.LastErrorText
    RELEASE loTunnel
    CANCEL
ENDIF

*  OK, the SSH tunnel is setup.  Now open a channel within the tunnel.
*  Once the channel is obtained, the Socket API may
*  be used exactly the same as usual, except all communications
*  are sent through the channel in the SSH tunnel.
*  Any number of channels may be created from the same SSH tunnel.
*  Multiple channels may coexist at the same time.

* Connect to the GMAIL IMAP server via TLS (through the port-forwarded SSH tunnel)
loChannel = CreateObject('Chilkat.Socket')
lnMaxWaitMs = 4000
lnUseTls = 1
lnSuccess = loTunnel.SshNewChannel("imap.gmail.com",993,lnUseTls,lnMaxWaitMs,loChannel)
IF (lnSuccess = 0) THEN
    ? loTunnel.LastErrorText
    RELEASE loTunnel
    RELEASE loChannel
    CANCEL
ENDIF

* If desired, visually inspect the LastErrorText to see that indeed the TLS
* protocol was run inside the SSH tunnel:
? loTunnel.LastErrorText

* The first thing an IMAP server does is to send a greeting terminated with a CRLF.
lcImapGreeting = loChannel.ReceiveToCRLF()
IF (loChannel.LastMethodSuccess <> 1) THEN
    ? loChannel.LastErrorText
    RELEASE loTunnel
    RELEASE loChannel
    CANCEL
ENDIF

? lcImapGreeting

* Close the connection to imap.gmail.com.  This is actually closing our channel
* within the SSH tunnel, but keeps the tunnel open for the next port-forwarded connection.
lnSuccess = loChannel.Close(lnMaxWaitMs)
IF (lnSuccess = 0) THEN
    ? loChannel.LastErrorText
    RELEASE loTunnel
    RELEASE loChannel
    CANCEL
ENDIF

* Finally, close the SSH tunnel.
lnSuccess = loTunnel.SshCloseTunnel()
IF (lnSuccess = 0) THEN
    ? loTunnel.LastErrorText
    RELEASE loTunnel
    RELEASE loChannel
    CANCEL
ENDIF

? "TLS SSH tunneling example completed."

RELEASE loTunnel
RELEASE loChannel