(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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.
set key [new_CkSshKey]

CkSshKey_put_Password $key "key_password"

set success [CkSshKey_FromOpenSshPrivateKey $key [CkSshKey_loadText $key "qa_data/my_private_key_file"]]
if {$success != 1} then {
    puts [CkSshKey_lastErrorText $key]
    delete_CkSshKey $key
    exit
}

set sftp [new_CkSFtp]

set success [CkSFtp_Connect $sftp "sftp.example.com" 22]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSshKey $key
    delete_CkSFtp $sftp
    exit
}

# Authenticate using both a password and private key.
set success [CkSFtp_AuthenticatePwPk $sftp "myLogin" "myPassword" $key]
if {$success == 1} then {
    puts "Authentication is successful!"
    delete_CkSshKey $key
    delete_CkSFtp $sftp
    exit
}

# 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

# json is a CkJsonObject
set json [CkSFtp_LastJsonData $sftp]
CkJsonObject_put_EmitCompact $json 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:
puts "authResult: [CkJsonObject_stringOf $json authResult]"
puts "authFailReason: [CkJsonObject_stringOf $json authFailReason]"

delete_CkJsonObject $json


delete_CkSshKey $key
delete_CkSFtp $sftp