Lianja

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? Lianja

llSuccess = .F.

// 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.
loKey = createobject("CkSshKey")
loKey.Password = "key_password"

llSuccess = loKey.FromOpenSshPrivateKey(loKey.LoadText("qa_data/my_private_key_file"))
if (llSuccess = .F.) then
    ? loKey.LastErrorText
    release loKey
    return
endif

loSftp = createobject("CkSFtp")

llSuccess = loSftp.Connect("sftp.example.com",22)
if (llSuccess = .F.) then
    ? loSftp.LastErrorText
    release loKey
    release loSftp
    return
endif

// Authenticate using both a password and private key.
llSuccess = loSftp.AuthenticatePwPk("myLogin","myPassword",loKey)
if (llSuccess = .T.) then
    ? "Authentication is successful!"
    release loKey
    release loSftp
    return
endif

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

loJson = createobject("CkJsonObject")
loSftp.GetLastJsonData(loJson)

loJson.EmitCompact = .F.

// 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 loKey
release loSftp
release loJson