AutoIt

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

Local $bSuccess = 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.
$oKey = ObjCreate("Chilkat.SshKey")
$oKey.Password = "key_password"

$bSuccess = $oKey.FromOpenSshPrivateKey($oKey.LoadText("qa_data/my_private_key_file"))
If ($bSuccess = False) Then
    ConsoleWrite($oKey.LastErrorText & @CRLF)
    Exit
EndIf

$oSftp = ObjCreate("Chilkat.SFtp")

$bSuccess = $oSftp.Connect("sftp.example.com",22)
If ($bSuccess = False) Then
    ConsoleWrite($oSftp.LastErrorText & @CRLF)
    Exit
EndIf

; Authenticate using both a password and private key.
$bSuccess = $oSftp.AuthenticatePwPk("myLogin","myPassword",$oKey)
If ($bSuccess = True) Then
    ConsoleWrite("Authentication is successful!" & @CRLF)
    Exit
EndIf

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

$oJson = ObjCreate("Chilkat.JsonObject")
$oSftp.GetLastJsonData $oJson

$oJson.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:
ConsoleWrite("authResult: " & $oJson.StringOf("authResult") & @CRLF)
ConsoleWrite("authFailReason: " & $oJson.StringOf("authFailReason") & @CRLF)