C++

Get the Type of an Active SSH Channel

Demonstrates the Chilkat Ssh.GetChannelType method, which returns the type of the channel at a zero-based enumeration index. The only argument is the index — an enumeration position, not a channel number. Values include session, x11, forwarded-tcpip, and direct-tcpip.

Background: Paired with GetChannelNumber, this turns the channel collection into a readable inventory of what a connection is currently doing — which channels are running commands (session) versus tunneling TCP traffic (direct-tcpip). That is valuable for diagnostics and for application code that manages several channel kinds at once. An out-of-range index causes the string-returning method to report failure.

Chilkat C++ Downloads

Download Chilkat for C++

C++

#include <CkSsh.h>

void ChilkatSample(void)
    {
    bool success = false;

    //  Demonstrates the Ssh.GetChannelType method, which returns the type of the channel at a
    //  zero-based enumeration index.  The only argument is the index, which is an enumeration
    //  position and not a channel number.  Values include "session" and "direct-tcpip".

    CkSsh ssh;

    int sshPort = 22;
    success = ssh.Connect("ssh.example.com",sshPort);
    if (success == false) {
        std::cout << ssh.lastErrorText() << "\r\n";
        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.
    const char *password = "mySshPassword";

    success = ssh.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        std::cout << ssh.lastErrorText() << "\r\n";
        return;
    }

    int channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        std::cout << ssh.lastErrorText() << "\r\n";
        return;
    }

    //  Enumerate the active channels and report each one's number and type.
    int n = ssh.get_NumOpenChannels();
    int i;
    for (i = 0; i <= n - 1; i++) {
        int chNum = ssh.GetChannelNumber(i);
        const char *chType = ssh.getChannelType(i);
        if (ssh.get_LastMethodSuccess() == false) {
            std::cout << ssh.lastErrorText() << "\r\n";
            return;
        }

        std::cout << "Channel " << chNum << " is of type " << chType << "\r\n";
    }

    ssh.Disconnect();
    }