PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Key
oleobject loo_Sftp
oleobject loo_Json

li_Success = 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.
loo_Key = create oleobject
li_rc = loo_Key.ConnectToNewObject("Chilkat.SshKey")
if li_rc < 0 then
    destroy loo_Key
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_Key.Password = "key_password"

li_Success = loo_Key.FromOpenSshPrivateKey(loo_Key.LoadText("qa_data/my_private_key_file"))
if li_Success = 0 then
    Write-Debug loo_Key.LastErrorText
    destroy loo_Key
    return
end if

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")

li_Success = loo_Sftp.Connect("sftp.example.com",22)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Key
    destroy loo_Sftp
    return
end if

// Authenticate using both a password and private key.
li_Success = loo_Sftp.AuthenticatePwPk("myLogin","myPassword",loo_Key)
if li_Success = 1 then
    Write-Debug "Authentication is successful!"
    destroy loo_Key
    destroy loo_Sftp
    return
end if

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

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Sftp.GetLastJsonData(loo_Json)

loo_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:
Write-Debug "authResult: " + loo_Json.StringOf("authResult")
Write-Debug "authFailReason: " + loo_Json.StringOf("authFailReason")


destroy loo_Key
destroy loo_Sftp
destroy loo_Json