(Objective-C) SSH Exec (Execute Command Line)

Shows how to execute a command on an SSH server and retrieve the command output.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoSsh.h>
#import <NSString.h>

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

CkoSsh *ssh = [[CkoSsh alloc] init];

// Connect to an SSH server:
NSString *hostname = 0;
int port;

// Hostname may be an IP address or hostname:
hostname = @"192.168.1.108";
port = 22;

BOOL success = [ssh Connect: hostname port: [NSNumber numberWithInt: port]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = [NSNumber numberWithInt:5000];

// Authenticate using login/password:
success = [ssh AuthenticatePw: @"myLogin" password: @"myPassword"];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Open a session channel.  (It is possible to have multiple
// session channels open simultaneously.)
int channelNum;
channelNum = [[ssh OpenSessionChannel] intValue];
if (channelNum < 0) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// The SendReqExec method starts a command on the remote
// server.   The syntax of the command string depends on the
// default shell used on the remote server to run the command.
// On Windows systems it is CMD.EXE.  On UNIX/Linux
// systems the user's default shell is typically defined in /etc/password.

// Here are some examples of command lines for <b>Windows SSH servers</b>:

// Get a directory listing:
NSString *cmd1 = @"dir";

// Do a nameserver lookup:
NSString *cmd2 = @"nslookup chilkatsoft.com";

// List a specific directory.  Given that the shell is CMD.EXE, backslashes must
// be used:
NSString *cmd3 = @"dir \\temp";

// Execute a sequence of commands.  The syntax for CMD.EXE may be found
// here: http://technet.microsoft.com/en-us/library/bb490880.aspx.  Notice how the commands
// are separated by "&&" and the entire command must be enclosed in quotes:
NSString *cmd4 = @"\"cd \\temp&&dir\"";

// Here are two examples of command lines for <b>Linux/UNIX SSH servers</b>:

// Get a directory listing:
NSString *cmd5 = @"ls -l /tmp";

// Run a series of commands (syntax may depend on your default shell):
NSString *cmd6 = @"cd /etc; ls -la";

// Request a directory listing on the remote server:
// If your server is Windows, change the string from "ls" to "dir"
success = [ssh SendReqExec: [NSNumber numberWithInt: channelNum] command: @"ls"];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Call ChannelReceiveToClose to read 
// output until the server's corresponding "channel close" is received.
success = [ssh ChannelReceiveToClose: [NSNumber numberWithInt: channelNum]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Let's pickup the accumulated output of the command:
NSString *cmdOutput = [ssh GetReceivedText: [NSNumber numberWithInt: channelNum] charset: @"ansi"];
if (ssh.LastMethodSuccess != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Display the remote shell's command output:
NSLog(@"%@",cmdOutput);

// Disconnect
[ssh Disconnect];