Objective-C

Setting Environment Variables for SCP Transfers

See more SCP Examples

Demonstrates how to set remote environment variables for an SCP transfer.

Note 1: This example requires Chilkat v9.5.0.79 or greater.

Note 2: Setting environment variables for SCP is only supported by some SSH servers.

Objective-C

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

BOOL success = NO;

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

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

// First connect to an SSH server.
success = [ssh Connect: @"example.com" port: [NSNumber numberWithInt: 22]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

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

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

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

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

// Specify the environment variables to be set in JSON as follows.
// This example sets two environment variables.  One is named "LCS_PASSWORD" and the other "MY_TEST_NAME".
CkoJsonObject *jsonEnvVars = [[CkoJsonObject alloc] init];
jsonEnvVars.EmitCompact = NO;
[jsonEnvVars UpdateString: @"LCS_PASSWORD" value: @"secret"];
[jsonEnvVars UpdateString: @"MY_TEST_NAME" value: @"abc"];
NSString *strEnvVars = [jsonEnvVars Emit];

NSLog(@"%@",strEnvVars);

// Setting the SendEnv property causes Chilkat to set each environment variable on the SSH server
// prior to doing the upload or download.
scp.SendEnv = strEnvVars;

// Do the upload..
NSString *remotePath = @"starfish.jpg";
NSString *localPath = @"qa_data/jpg/starfish.jpg";
success = [scp UploadFile: localPath remotePath: remotePath];
if (success != YES) {
    NSLog(@"%@",scp.LastErrorText);
    return;
}

NSLog(@"%@",@"SCP upload file success.");

// Disconnect
[ssh Disconnect];