(DataFlex) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Variant vKey
    Handle hoKey
    Boolean iSuccess
    Handle hoSftp
    Variant vJson
    Handle hoJson
    String sTemp1

    // 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.
    Get Create (RefClass(cComChilkatSshKey)) To hoKey
    If (Not(IsComObjectCreated(hoKey))) Begin
        Send CreateComObject of hoKey
    End
    Set ComPassword Of hoKey To "key_password"

    Get ComLoadText Of hoKey "qa_data/my_private_key_file" To sTemp1
    Get ComFromOpenSshPrivateKey Of hoKey sTemp1 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoKey To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    Get ComConnect Of hoSftp "sftp.example.com" 22 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate using both a password and private key.
    Get pvComObject of hoKey to vKey
    Get ComAuthenticatePwPk Of hoSftp "myLogin" "myPassword" vKey To iSuccess
    If (iSuccess = True) Begin
        Showln "Authentication is successful!"
        Procedure_Return
    End

    // 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

    Get ComLastJsonData Of hoSftp To vJson
    If (IsComObject(vJson)) Begin
        Get Create (RefClass(cComChilkatJsonObject)) To hoJson
        Set pvComObject Of hoJson To vJson
    End
    Set ComEmitCompact Of hoJson To 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:
    Get ComStringOf Of hoJson "authResult" To sTemp1
    Showln "authResult: " sTemp1
    Get ComStringOf Of hoJson "authFailReason" To sTemp1
    Showln "authFailReason: " sTemp1

    Send Destroy of hoJson


End_Procedure