Zig Requires Chilkat v11.0.0+

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

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // 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.
    const key = try chilkat.SshKey.init();
    defer key.deinit();
    key.setPassword("key_password");

    key.fromOpenSshPrivateKey(try key.loadText(alloc, "qa_data/my_private_key_file")) catch {
        std.debug.print("{s}\n", .{try key.getLastErrorText(alloc)});
        return;
    };

    const sftp = try chilkat.SFtp.init();
    defer sftp.deinit();

    sftp.connect("sftp.example.com", 22) catch {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    };

    // Authenticate using both a password and private key.
    if (sftp.authenticatePwPk("myLogin", "myPassword", key)) {
        std.debug.print("Authentication is successful!\n", .{});
        return;
    } else |_| {}

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

    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    sftp.getLastJsonData(json);

    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:
    std.debug.print("authResult: {s}\n", .{try json.stringOf(alloc, "authResult")});
    std.debug.print("authFailReason: {s}\n", .{try json.stringOf(alloc, "authFailReason")});
}