Unicode C

SSH Remote Shell with Multiple Commands

Demonstrates running several commands one after another in a single remote shell session, retrieving each command's output separately. No PTY is requested, so each command is followed by an echoed marker that signals where its output ends.

Background: Interleaving commands and reads in one shell requires a way to know where each command's output stops. An interactive session would use the shell prompt, but without a PTY the shell is non-interactive and never prints one — so the dependable technique is to append echo SOME_MARKER to each command and read up to that marker. Retrieving the text also clears the receive buffer, which matters here: if a marker were left buffered, the next receive would match it immediately and return the wrong output.

Chilkat Unicode C Downloads

Download Chilkat for Unicode C

Unicode C

#include <C_CkSshW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSshW ssh;
    const wchar_t *hostname;
    int port;
    const wchar_t *password;
    int channelNum;
    BOOL caseSensitive;
    const wchar_t *cmdOutput;

    success = FALSE;

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

    //  Demonstrates running several commands one after another in a single remote shell session,
    //  retrieving each command's output separately.
    //  
    //  No PTY is requested, so the shell runs non-interactively and never prints a command prompt.
    //  Because there is no prompt to synchronize on, each command is followed by an "echo" of a
    //  unique marker, and the output is read up to that marker.

    ssh = CkSshW_Create();

    hostname = L"ssh.example.com";
    port = 22;
    success = CkSshW_Connect(ssh,hostname,port);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    password = L"mySshPassword";

    success = CkSshW_AuthenticatePw(ssh,L"mySshLogin",password);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    channelNum = CkSshW_OpenSessionChannel(ssh);
    if (channelNum < 0) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    //  Start a shell WITHOUT requesting a PTY.  Without a PTY the shell sees it is connected to a
    //  raw data pipe and enters non-interactive mode: it suppresses the command prompt, does not
    //  echo typed commands back, and skips interactive login scripts.  The output is therefore
    //  clean and easily parseable -- but because no prompt is ever sent, code must not wait for
    //  one.  Instead, have each command print a predictable marker, or wait for EOF / channel close.
    success = CkSshW_SendReqShell(ssh,channelNum);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    //  IMPORTANT: Set a read timeout before receiving until a match.  ReadTimeoutMs defaults to 0,
    //  which means no limit -- without it, this call waits forever if the received data never
    //  contains a match.
    CkSshW_putReadTimeoutMs(ssh,15000);

    caseSensitive = TRUE;

    //  ---- 1st command: change directory ----
    success = CkSshW_ChannelSendString(ssh,channelNum,L"cd /tmp; echo END_OF_CMD_1\n",L"utf-8");
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    success = CkSshW_ChannelReceiveUntilMatch(ssh,channelNum,L"END_OF_CMD_1",L"utf-8",caseSensitive);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    //  Retrieving the text also clears the receive buffer, which matters: if the next marker were
    //  left in the buffer, the following receive would match immediately.
    cmdOutput = CkSshW_getReceivedText(ssh,channelNum,L"utf-8");
    if (CkSshW_getLastMethodSuccess(ssh) == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    wprintf(L"%s\n",cmdOutput);

    //  ---- 2nd command: directory listing ----
    success = CkSshW_ChannelSendString(ssh,channelNum,L"ls; echo END_OF_CMD_2\n",L"utf-8");
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    success = CkSshW_ChannelReceiveUntilMatch(ssh,channelNum,L"END_OF_CMD_2",L"utf-8",caseSensitive);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    cmdOutput = CkSshW_getReceivedText(ssh,channelNum,L"utf-8");
    if (CkSshW_getLastMethodSuccess(ssh) == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    wprintf(L"%s\n",cmdOutput);

    //  ---- 3rd command: long listing, then finish the session ----
    success = CkSshW_ChannelSendString(ssh,channelNum,L"ls -l\n",L"utf-8");
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    //  No more input will be sent.
    success = CkSshW_ChannelSendEof(ssh,channelNum);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    success = CkSshW_ChannelReceiveToClose(ssh,channelNum);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    cmdOutput = CkSshW_getReceivedText(ssh,channelNum,L"utf-8");
    if (CkSshW_getLastMethodSuccess(ssh) == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    wprintf(L"%s\n",cmdOutput);

    CkSshW_Disconnect(ssh);


    CkSshW_Dispose(ssh);

    }