(PHP ActiveX) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// 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.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.SshKey')
$key = new COM("Chilkat.SshKey");
$key->Password = 'key_password';

$success = $key->FromOpenSshPrivateKey($key->loadText('qa_data/my_private_key_file'));
if ($success != 1) {
    print $key->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.SFtp')
$sftp = new COM("Chilkat.SFtp");

$success = $sftp->Connect('sftp.example.com',22);
if ($success != 1) {
    print $sftp->LastErrorText . "\n";
    exit;
}

// Authenticate using both a password and private key.
$success = $sftp->AuthenticatePwPk('myLogin','myPassword',$key);
if ($success == 1) {
    print 'Authentication is successful!' . "\n";
    exit;
}

// 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

// json is a Chilkat.JsonObject
$json = $sftp->LastJsonData();
$json->EmitCompact = 0;

// 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:
print 'authResult: ' . $json->stringOf('authResult') . "\n";
print 'authFailReason: ' . $json->stringOf('authFailReason') . "\n";


?>