PureBasic

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

IncludeFile "CkSshKey.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

    success.i = 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.
    key.i = CkSshKey::ckCreate()
    If key.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkSshKey::setCkPassword(key, "key_password")

    success = CkSshKey::ckFromOpenSshPrivateKey(key,CkSshKey::ckLoadText(key,"qa_data/my_private_key_file"))
    If success = 0
        Debug CkSshKey::ckLastErrorText(key)
        CkSshKey::ckDispose(key)
        ProcedureReturn
    EndIf

    sftp.i = CkSFtp::ckCreate()
    If sftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkSFtp::ckConnect(sftp,"sftp.example.com",22)
    If success = 0
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSshKey::ckDispose(key)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; Authenticate using both a password and private key.
    success = CkSFtp::ckAuthenticatePwPk(sftp,"myLogin","myPassword",key)
    If success = 1
        Debug "Authentication is successful!"
        CkSshKey::ckDispose(key)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

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

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkSFtp::ckGetLastJsonData(sftp,json)

    CkJsonObject::setCkEmitCompact(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:
    Debug "authResult: " + CkJsonObject::ckStringOf(json,"authResult")
    Debug "authFailReason: " + CkJsonObject::ckStringOf(json,"authFailReason")


    CkSshKey::ckDispose(key)
    CkSFtp::ckDispose(sftp)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure