(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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.
    let key = CkoSshKey()!
    key.password = "key_password"

    var success: Bool = key.fromOpenSshPrivateKey(key.loadText("qa_data/my_private_key_file"))
    if success != true {
        print("\(key.lastErrorText!)")
        return
    }

    let sftp = CkoSFtp()!

    success = sftp.connect("sftp.example.com", port: 22)
    if success != true {
        print("\(sftp.lastErrorText!)")
        return
    }

    // Authenticate using both a password and private key.
    success = sftp.authenticatePwPk("myLogin", password: "myPassword", privateKey: key)
    if success == true {
        print("Authentication is successful!")
        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

    var json: CkoJsonObject? = sftp.lastJsonData()
    json.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:
    print("authResult: \(json!.string(of: "authResult")!)")
    print("authFailReason: \(json!.string(of: "authFailReason")!)")

    json = nil

}