PHP Requires Chilkat v11.0.0+

SFTP Auth Failure Reason (AuthenticatePwPk)

See more SFTP Examples

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? Chilkat2 PHP

<?php

use Chilkat2\JsonObject;
use Chilkat2\SFtp;
use Chilkat2\SshKey;

$success = false;

// 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.
$key = new SshKey();
$key->Password = 'key_password';

try {
    $key->FromOpenSshPrivateKey($key->LoadText('qa_data/my_private_key_file'));

    $sftp = new SFtp();

    $sftp->Connect('sftp.example.com', 22);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Authenticate using both a password and private key.
try {
    $sftp->AuthenticatePwPk('myLogin', 'myPassword', $key);
    $success = true;
} catch (\Chilkat2\Exception $e) {
    $success = false;
}
if ($success) {
    echo "Authentication is successful!\n";
    exit;
}

// If we get here, it means the authentication failed.
// Examine the last JSON data..

$json = new JsonObject();
$sftp->GetLastJsonData($json);

$json->EmitCompact = false;

// 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:
echo 'authResult: ', $json->StringOf('authResult'), "\n";
echo 'authFailReason: ', $json->StringOf('authFailReason'), "\n";