(Visual FoxPro) 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

LOCAL loKey
LOCAL lnSuccess
LOCAL loSftp
LOCAL loJson

* 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 CreateObject('Chilkat_9_5_0.SshKey')
loKey = CreateObject('Chilkat.SshKey')
loKey.Password = "key_password"

lnSuccess = loKey.FromOpenSshPrivateKey(loKey.LoadText("qa_data/my_private_key_file"))
IF (lnSuccess <> 1) THEN
    ? loKey.LastErrorText
    RELEASE loKey
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.SFtp')
loSftp = CreateObject('Chilkat.SFtp')

lnSuccess = loSftp.Connect("sftp.example.com",22)
IF (lnSuccess <> 1) THEN
    ? loSftp.LastErrorText
    RELEASE loKey
    RELEASE loSftp
    CANCEL
ENDIF

* Authenticate using both a password and private key.
lnSuccess = loSftp.AuthenticatePwPk("myLogin","myPassword",loKey)
IF (lnSuccess = 1) THEN
    ? "Authentication is successful!"
    RELEASE loKey
    RELEASE loSftp
    CANCEL
ENDIF

* 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

loJson = loSftp.LastJsonData()
loJson.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:
? "authResult: " + loJson.StringOf("authResult")
? "authFailReason: " + loJson.StringOf("authFailReason")

RELEASE loJson

RELEASE loKey
RELEASE loSftp