PowerBuilder

REST through SSH Tunnel

See more REST Examples

Demonstrates how to connect through an SSH Tunnel (via port-forwarding) to make REST API calls. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Tunnel
string ls_SshHostname
integer li_SshPort
oleobject loo_Rest
integer li_BTls
integer li_Port
integer li_MaxWaitMs
oleobject loo_Channel
oleobject loo_AuthAws
string ls_ResponseXml
oleobject loo_Xml

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.
//  (Any number of channels may be created from the same SSH tunnel.
//  Multiple channels may coexist at the same time.)

// This example connects to a REST server through the SSH tunnel.
// It will connect to the Amazon AWS service for this example.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")

li_BTls = 1
li_Port = 443
li_MaxWaitMs = 5000

// This returns a socket object that is a single channel within the SSH tunnel.
loo_Channel = create oleobject
li_rc = loo_Channel.ConnectToNewObject("Chilkat.Socket")

li_Success = loo_Tunnel.SshNewChannel("s3.amazonaws.com",li_Port,li_BTls,li_MaxWaitMs,loo_Channel)
if li_Success = 0 then
    Write-Debug loo_Tunnel.LastErrorText
    destroy loo_Tunnel
    destroy loo_Rest
    destroy loo_Channel
    return
end if

// Use the connection.  (This connection is a TLS running on an SSH channel through an SSH tunnel.
// In other words, TLS is wrapped within the SSH tunnel.)
li_Success = loo_Rest.UseConnection(loo_Channel,1)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Tunnel
    destroy loo_Rest
    destroy loo_Channel
    return
end if

// Provide AWS credentials for the REST call.
loo_AuthAws = create oleobject
li_rc = loo_AuthAws.ConnectToNewObject("Chilkat.AuthAws")

loo_AuthAws.AccessKey = "AWS_ACCESS_KEY"
loo_AuthAws.SecretKey = "AWS_SECRET_KEY"
loo_AuthAws.ServiceName = "s3"
li_Success = loo_Rest.SetAuthAws(loo_AuthAws)

// List all buckets for the account...
ls_ResponseXml = loo_Rest.FullRequestNoBody("GET","/")
if loo_Rest.LastMethodSuccess <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Tunnel
    destroy loo_Rest
    destroy loo_Channel
    destroy loo_AuthAws
    return
end if

loo_Xml = create oleobject
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

li_Success = loo_Xml.LoadXml(ls_ResponseXml)

// Show the full XML returned.
Write-Debug loo_Xml.GetXml()

// Iterate over the buckets, showing each bucket name.
li_Success = loo_Xml.FindChild2("Buckets")
if loo_Xml.FirstChild2() = 1 then
    Write-Debug loo_Xml.GetChildContent("Name")
    do while (loo_Xml.NextSibling2() = 1)
        Write-Debug loo_Xml.GetChildContent("Name")
    loop
end if

// Move the internal pointer back to the root node.
loo_Xml.GetRoot2()


destroy loo_Tunnel
destroy loo_Rest
destroy loo_Channel
destroy loo_AuthAws
destroy loo_Xml