Objective-C

SSH Quick/Simple Shell Session

Demonstrates the simplified way to run multiple commands in a shell session using QuickShell, which combines OpenSessionChannel, SendReqPty, and SendReqShell into one call. The commands are built in a StringBuilder, sent together, and the output is read up to a marker echoed by the final command.

Background: Note that QuickShell does allocate a PTY, so the remote shell runs interactively: it prints a prompt and echoes back every command sent to it, and both the echo and the real output appear in what is received. That is what motivates the quoting trick on the final marker — writing echo THIS 'IS' THE END means the echoed command line contains the quotes while the command's actual output does not, so matching the unquoted text reliably matches the real output instead of the echo. For clean, prompt-free output, request a shell without a PTY instead.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

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

BOOL success = NO;

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

//  Demonstrates the simplified way to run multiple commands in a shell session using QuickShell.
//  
//  Note: QuickShell internally does OpenSessionChannel, SendReqPty, and SendReqShell, so it DOES
//  allocate a pseudo-terminal.  The remote shell therefore runs interactively: it prints a
//  command prompt and echoes back the commands that are sent to it.  Both the echoed input and
//  the real output appear in what is received.

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

int port = 22;
success = [ssh Connect: @"ssh.example.com" port: [NSNumber numberWithInt: port]];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    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.
NSString *password = @"mySshPassword";

success = [ssh AuthenticatePw: @"mySshLogin" password: password];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

//  Start the shell session.  A negative return value indicates failure.
int channelNum = [[ssh QuickShell] intValue];
if (channelNum < 0) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

//  Build the commands, one per line.  Line endings matter: Unix/Linux servers typically expect
//  a bare LF, while Windows servers may require CRLF.
CkoStringBuilder *sbCommands = [[CkoStringBuilder alloc] init];
[sbCommands Append: @"echo hello world\n"];
[sbCommands Append: @"date\n"];
[sbCommands Append: @"df\n"];

//  The final command echoes a marker used to detect the end of the output.  The single quotes
//  around 'IS' are a trick: the terminal echo of the typed command includes the quotes, while
//  the command's actual output does not.  Matching the unquoted form therefore matches the real
//  output rather than the echo.
[sbCommands Append: @"echo THIS 'IS' THE END OF THE SCRIPT\n"];

NSString *commands = [sbCommands GetAsString];
success = [ssh ChannelSendString: [NSNumber numberWithInt: channelNum] strData: commands charset: @"utf-8"];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    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.
ssh.ReadTimeoutMs = [NSNumber numberWithInt:15000];

BOOL caseSensitive = YES;
success = [ssh ChannelReceiveUntilMatch: [NSNumber numberWithInt: channelNum] matchPattern: @"THIS IS THE END OF THE SCRIPT" charset: @"utf-8" caseSensitive: caseSensitive];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

//  Indicate that no more commands will be sent, then close the channel.  Close only after the
//  desired output has been received.
success = [ssh ChannelSendEof: [NSNumber numberWithInt: channelNum]];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

success = [ssh ChannelSendClose: [NSNumber numberWithInt: channelNum]];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

//  Collect any remaining output.
success = [ssh ChannelReceiveToClose: [NSNumber numberWithInt: channelNum]];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

NSString *sessionOutput = [ssh GetReceivedText: [NSNumber numberWithInt: channelNum] charset: @"utf-8"];
if (ssh.LastMethodSuccess == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

NSLog(@"%@",@"--- output ----");
NSLog(@"%@",sessionOutput);

[ssh Disconnect];