Xbase++ 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? Xbase++

LOCAL nSuccess
LOCAL oKey
LOCAL oSftp
LOCAL oJson

nSuccess := 0

//  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.
oKey := CreateObject("Chilkat.SshKey")
oKey:Password := "key_password"

nSuccess := oKey:FromOpenSshPrivateKey(oKey:LoadText("qa_data/my_private_key_file"))
IF (nSuccess == 0)
    ? oKey:LastErrorText
    oKey:destroy()
    RETURN
ENDIF

oSftp := CreateObject("Chilkat.SFtp")

nSuccess := oSftp:Connect("sftp.example.com", 22)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oKey:destroy()
    oSftp:destroy()
    RETURN
ENDIF

//  Authenticate using both a password and private key.
nSuccess := oSftp:AuthenticatePwPk("myLogin", "myPassword", oKey)
IF (nSuccess == 1)
    ? "Authentication is successful!"
    oKey:destroy()
    oSftp:destroy()
    RETURN
ENDIF

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

oJson := CreateObject("Chilkat.JsonObject")
oSftp:GetLastJsonData(oJson)

oJson: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: " + oJson:StringOf("authResult")
? "authFailReason: " + oJson:StringOf("authFailReason")

oKey:destroy()
oSftp:destroy()
oJson:destroy()