C

Setting Environment Variables for SCP Transfers

See more SCP Examples

Demonstrates how to set remote environment variables for an SCP transfer.

Note 1: This example requires Chilkat v9.5.0.79 or greater.

Note 2: Setting environment variables for SCP is only supported by some SSH servers.

C

#include <C_CkSsh.h>
#include <C_CkScp.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSsh ssh;
    HCkScp scp;
    HCkJsonObject jsonEnvVars;
    const char *strEnvVars;
    const char *remotePath;
    const char *localPath;

    success = FALSE;

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

    ssh = CkSsh_Create();

    // First connect to an SSH server.
    success = CkSsh_Connect(ssh,"example.com",22);
    if (success != TRUE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_Dispose(ssh);
        return;
    }

    // Wait a max of 5 seconds when reading responses..
    CkSsh_putIdleTimeoutMs(ssh,5000);

    // Authenticate..
    success = CkSsh_AuthenticatePw(ssh,"myLogin","myPassword");
    if (success != TRUE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_Dispose(ssh);
        return;
    }

    // After the SSH object is connected and authenticated, we use it
    // as the underlying transport in our SCP object.
    scp = CkScp_Create();

    success = CkScp_UseSsh(scp,ssh);
    if (success != TRUE) {
        printf("%s\n",CkScp_lastErrorText(scp));
        CkSsh_Dispose(ssh);
        CkScp_Dispose(scp);
        return;
    }

    // Specify the environment variables to be set in JSON as follows.
    // This example sets two environment variables.  One is named "LCS_PASSWORD" and the other "MY_TEST_NAME".
    jsonEnvVars = CkJsonObject_Create();
    CkJsonObject_putEmitCompact(jsonEnvVars,FALSE);
    CkJsonObject_UpdateString(jsonEnvVars,"LCS_PASSWORD","secret");
    CkJsonObject_UpdateString(jsonEnvVars,"MY_TEST_NAME","abc");
    strEnvVars = CkJsonObject_emit(jsonEnvVars);

    printf("%s\n",strEnvVars);

    // Setting the SendEnv property causes Chilkat to set each environment variable on the SSH server
    // prior to doing the upload or download.
    CkScp_putSendEnv(scp,strEnvVars);

    // Do the upload..
    remotePath = "starfish.jpg";
    localPath = "qa_data/jpg/starfish.jpg";
    success = CkScp_UploadFile(scp,localPath,remotePath);
    if (success != TRUE) {
        printf("%s\n",CkScp_lastErrorText(scp));
        CkSsh_Dispose(ssh);
        CkScp_Dispose(scp);
        CkJsonObject_Dispose(jsonEnvVars);
        return;
    }

    printf("SCP upload file success.\n");

    // Disconnect
    CkSsh_Disconnect(ssh);


    CkSsh_Dispose(ssh);
    CkScp_Dispose(scp);
    CkJsonObject_Dispose(jsonEnvVars);

    }