JavaScript

REST through SSH Tunnel

See more REST Examples

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

var success = false;

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

var tunnel = new CkSocket();

var sshHostname = "sftp.example.com";
var sshPort = 22;

// Connect to an SSH server and establish the SSH tunnel:
success = tunnel.SshOpenTunnel(sshHostname,sshPort);
if (success == false) {
    console.log(tunnel.LastErrorText);
    return;
}

// Authenticate with the SSH server via a login/password
// or with a public key.
// This example demonstrates SSH password authentication.
success = tunnel.SshAuthenticatePw("mySshLogin","mySshPassword");
if (success == false) {
    console.log(tunnel.LastErrorText);
    return;
}

//  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.
var rest = new CkRest();

var bTls = true;
var port = 443;
var maxWaitMs = 5000;

// This returns a socket object that is a single channel within the SSH tunnel.
var channel = new CkSocket();
success = tunnel.SshNewChannel("s3.amazonaws.com",port,bTls,maxWaitMs,channel);
if (success == false) {
    console.log(tunnel.LastErrorText);
    return;
}

// 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.)
success = rest.UseConnection(channel,true);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

// Provide AWS credentials for the REST call.
var authAws = new CkAuthAws();
authAws.AccessKey = "AWS_ACCESS_KEY";
authAws.SecretKey = "AWS_SECRET_KEY";
authAws.ServiceName = "s3";
success = rest.SetAuthAws(authAws);

// List all buckets for the account...
var responseXml = rest.FullRequestNoBody("GET","/");
if (rest.LastMethodSuccess !== true) {
    console.log(rest.LastErrorText);
    return;
}

var xml = new CkXml();
success = xml.LoadXml(responseXml);

// Show the full XML returned.
console.log(xml.GetXml());

// Iterate over the buckets, showing each bucket name.
success = xml.FindChild2("Buckets");
if (xml.FirstChild2() == true) {
    console.log(xml.GetChildContent("Name"));
    while ((xml.NextSibling2() == true)) {
        console.log(xml.GetChildContent("Name"));
    }

}

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