Swift

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

func chilkatTest() {
    var success: Bool = false

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

    success = key.fromOpenSshPrivateKey(keyStr: key.loadText(path: "qa_data/my_private_key_file"))
    if success == false {
        print("\(key.lastErrorText!)")
        return
    }

    let sftp = CkoSFtp()!

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

    // Authenticate using both a password and private key.
    success = sftp.authenticatePwPk(username: "myLogin", password: "myPassword", privateKey: key)
    if success == true {
        print("Authentication is successful!")
        return
    }

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

    let json = CkoJsonObject()!
    sftp.getLastJsonData(json: json)

    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")!)")

}