PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Tunnel
string ls_SshHostname
integer li_SshPort
oleobject loo_Channel
integer li_MaxWaitMs
integer li_UseTls
string ls_ImapGreeting

li_Success = 0

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

loo_Tunnel = create oleobject
li_rc = loo_Tunnel.ConnectToNewObject("Chilkat.Socket")
if li_rc < 0 then
    destroy loo_Tunnel
    MessageBox("Error","Connecting to COM object failed")
    return
end if

ls_SshHostname = "sftp.example.com"
li_SshPort = 22

// Connect to an SSH server and establish the SSH tunnel:
li_Success = loo_Tunnel.SshOpenTunnel(ls_SshHostname,li_SshPort)
if li_Success = 0 then
    Write-Debug loo_Tunnel.LastErrorText
    destroy loo_Tunnel
    return
end if

// Authenticate with the SSH server via a login/password
// or with a public key.
// This example demonstrates SSH password authentication.
li_Success = loo_Tunnel.SshAuthenticatePw("mySshLogin","mySshPassword")
if li_Success = 0 then
    Write-Debug loo_Tunnel.LastErrorText
    destroy loo_Tunnel
    return
end if

//  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)
loo_Channel = create oleobject
li_rc = loo_Channel.ConnectToNewObject("Chilkat.Socket")

li_MaxWaitMs = 4000
li_UseTls = 1
li_Success = loo_Tunnel.SshNewChannel("imap.gmail.com",993,li_UseTls,li_MaxWaitMs,loo_Channel)
if li_Success = 0 then
    Write-Debug loo_Tunnel.LastErrorText
    destroy loo_Tunnel
    destroy loo_Channel
    return
end if

// If desired, visually inspect the LastErrorText to see that indeed the TLS
// protocol was run inside the SSH tunnel:
Write-Debug loo_Tunnel.LastErrorText

// The first thing an IMAP server does is to send a greeting terminated with a CRLF.
ls_ImapGreeting = loo_Channel.ReceiveToCRLF()
if loo_Channel.LastMethodSuccess <> 1 then
    Write-Debug loo_Channel.LastErrorText
    destroy loo_Tunnel
    destroy loo_Channel
    return
end if

Write-Debug ls_ImapGreeting

// 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.
li_Success = loo_Channel.Close(li_MaxWaitMs)
if li_Success = 0 then
    Write-Debug loo_Channel.LastErrorText
    destroy loo_Tunnel
    destroy loo_Channel
    return
end if

// Finally, close the SSH tunnel.
li_Success = loo_Tunnel.SshCloseTunnel()
if li_Success = 0 then
    Write-Debug loo_Tunnel.LastErrorText
    destroy loo_Tunnel
    destroy loo_Channel
    return
end if

Write-Debug "TLS SSH tunneling example completed."


destroy loo_Tunnel
destroy loo_Channel