(Go) 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 Go Downloads Go Package for Windows, MacOS, Linux, Alpine Linux, Solaris

    // 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 := chilkat.NewSshKey()
    key.SetPassword("key_password")

    success := key.FromOpenSshPrivateKey(*key.LoadText("qa_data/my_private_key_file"))
    if success != true {
        fmt.Println(key.LastErrorText())
        key.DisposeSshKey()
        return
    }

    sftp := chilkat.NewSFtp()

    success = sftp.Connect("sftp.example.com",22)
    if success != true {
        fmt.Println(sftp.LastErrorText())
        key.DisposeSshKey()
        sftp.DisposeSFtp()
        return
    }

    // Authenticate using both a password and private key.
    success = sftp.AuthenticatePwPk("myLogin","myPassword",key)
    if success == true {
        fmt.Println("Authentication is successful!")
        key.DisposeSshKey()
        sftp.DisposeSFtp()
        return
    }

    // 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 := sftp.LastJsonData()
    json.SetEmitCompact(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:
    fmt.Println("authResult: ", *json.StringOf("authResult"))
    fmt.Println("authFailReason: ", *json.StringOf("authFailReason"))

    json.DisposeJsonObject()

    key.DisposeSshKey()
    sftp.DisposeSFtp()