C

REST through SSH Tunnel

See more REST Examples

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

#include <C_CkSocket.h>
#include <C_CkRest.h>
#include <C_CkAuthAws.h>
#include <C_CkXml.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSocket tunnel;
    const char *sshHostname;
    int sshPort;
    HCkRest rest;
    BOOL bTls;
    int port;
    int maxWaitMs;
    HCkSocket channel;
    HCkAuthAws authAws;
    const char *responseXml;
    HCkXml xml;

    success = FALSE;

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

    tunnel = CkSocket_Create();

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

    // Connect to an SSH server and establish the SSH tunnel:
    success = CkSocket_SshOpenTunnel(tunnel,sshHostname,sshPort);
    if (success == FALSE) {
        printf("%s\n",CkSocket_lastErrorText(tunnel));
        CkSocket_Dispose(tunnel);
        return;
    }

    // Authenticate with the SSH server via a login/password
    // or with a public key.
    // This example demonstrates SSH password authentication.
    success = CkSocket_SshAuthenticatePw(tunnel,"mySshLogin","mySshPassword");
    if (success == FALSE) {
        printf("%s\n",CkSocket_lastErrorText(tunnel));
        CkSocket_Dispose(tunnel);
        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.
    rest = CkRest_Create();

    bTls = TRUE;
    port = 443;
    maxWaitMs = 5000;

    // This returns a socket object that is a single channel within the SSH tunnel.
    channel = CkSocket_Create();
    success = CkSocket_SshNewChannel(tunnel,"s3.amazonaws.com",port,bTls,maxWaitMs,channel);
    if (success == FALSE) {
        printf("%s\n",CkSocket_lastErrorText(tunnel));
        CkSocket_Dispose(tunnel);
        CkRest_Dispose(rest);
        CkSocket_Dispose(channel);
        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 = CkRest_UseConnection(rest,channel,TRUE);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkSocket_Dispose(tunnel);
        CkRest_Dispose(rest);
        CkSocket_Dispose(channel);
        return;
    }

    // Provide AWS credentials for the REST call.
    authAws = CkAuthAws_Create();
    CkAuthAws_putAccessKey(authAws,"AWS_ACCESS_KEY");
    CkAuthAws_putSecretKey(authAws,"AWS_SECRET_KEY");
    CkAuthAws_putServiceName(authAws,"s3");
    success = CkRest_SetAuthAws(rest,authAws);

    // List all buckets for the account...
    responseXml = CkRest_fullRequestNoBody(rest,"GET","/");
    if (CkRest_getLastMethodSuccess(rest) != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkSocket_Dispose(tunnel);
        CkRest_Dispose(rest);
        CkSocket_Dispose(channel);
        CkAuthAws_Dispose(authAws);
        return;
    }

    xml = CkXml_Create();
    success = CkXml_LoadXml(xml,responseXml);

    // Show the full XML returned.
    printf("%s\n",CkXml_getXml(xml));

    // Iterate over the buckets, showing each bucket name.
    success = CkXml_FindChild2(xml,"Buckets");
    if (CkXml_FirstChild2(xml) == TRUE) {
        printf("%s\n",CkXml_getChildContent(xml,"Name"));
        while ((CkXml_NextSibling2(xml) == TRUE)) {
            printf("%s\n",CkXml_getChildContent(xml,"Name"));
        }

    }

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


    CkSocket_Dispose(tunnel);
    CkRest_Dispose(rest);
    CkSocket_Dispose(channel);
    CkAuthAws_Dispose(authAws);
    CkXml_Dispose(xml);

    }