(Objective-C) SCP Download Text File to String Variable

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable.

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

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

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

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

// Hostname may be an IP address or hostname:
NSString *hostname = @"www.some-ssh-server.com";
int port = 22;

// Connect to an SSH server:
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;
}

// Once the SSH object is connected and authenticated, we use it
// in our SCP object.
CkoScp *scp = [[CkoScp alloc] init];

success = [scp UseSsh: ssh];
if (success != YES) {
    NSLog(@"%@",scp.LastErrorText);
    return;
}

// This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
NSString *remotePath = @"repository/xml/hamlet.xml";

// The byte representation of the remote text file (i.e. the charset) must be
// indicated to allow the receiving software to correctly interpret the incoming
// bytes as the correct chars.
// See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
NSString *charset = @"utf-8";

NSString *fileContents = [scp DownloadString: remotePath charset: charset];
if (scp.LastMethodSuccess != YES) {
    NSLog(@"%@",scp.LastErrorText);
    return;
}

NSLog(@"%@",@"Received file:");
NSLog(@"%@",fileContents);

NSLog(@"%@",@"SCP download string success.");

// Disconnect
[ssh Disconnect];