(Objective-C) SFTP Auth Failure Reason (AuthenticatePwPk)

This example demonstrates how to determine the failure reason for the case where both a password and private key are required for authentication. If authentication fails, was it because of an invalid private key, or an invalid password?

Note: This example requires a feature introduced in Chilkat v9.5.0.79

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

#import <CkoSshKey.h>
#import <CkoSFtp.h>
#import <CkoJsonObject.h>

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

// Load a private key to be used for SSH authentication.
CkoSshKey *key = [[CkoSshKey alloc] init];
key.Password = @"key_password";

BOOL success = [key FromOpenSshPrivateKey: [key LoadText: @"qa_data/my_private_key_file"]];
if (success != YES) {
    NSLog(@"%@",key.LastErrorText);
    return;
}

CkoSFtp *sftp = [[CkoSFtp alloc] init];

success = [sftp Connect: @"sftp.example.com" port: [NSNumber numberWithInt: 22]];
if (success != YES) {
    NSLog(@"%@",sftp.LastErrorText);
    return;
}

// Authenticate using both a password and private key.
success = [sftp AuthenticatePwPk: @"myLogin" password: @"myPassword" privateKey: key];
if (success == YES) {
    NSLog(@"%@",@"Authentication is successful!");
    return;
}

// If we get here, it means the authentication failed.
// To find out why, get the LastJsonData
// This is a feature added in Chilkat v9.5.0.79

CkoJsonObject *json = [sftp LastJsonData];
json.EmitCompact = NO;

// This is the JSON if the key is correct, but the password is incorrect:

// {
//   "public_key_type": "rsa",
//   "partialAuthResult": "publickey success. continue to authenticate with password...",
//   "authResult": "failed",
//   "authFailReason": "Password is incorrect"
// }

// This is the JSON if the key is incorrect.  We won't know if the password is also incorrect until
// the key is made correct so that authentication proceeds to check the password.

// {
//   "public_key_type": "rsa",
//   "authResult": "failed",
//   "authFailReason": "Key is incorrect"
// }

// To get the authResult anbd authFailReason:
NSLog(@"%@%@",@"authResult: ",[json StringOf: @"authResult"]);
NSLog(@"%@%@",@"authFailReason: ",[json StringOf: @"authFailReason"]);