Zig

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable. Zig

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

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

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    const ssh = try chilkat.Ssh.init();
    defer ssh.deinit();

    // Hostname may be an IP address or hostname:
    const hostname = "www.some-ssh-server.com";
    const port = 22;

    // Connect to an SSH server:
    ssh.connect(hostname, port) catch {
        std.debug.print("{s}\n", .{try ssh.getLastErrorText(alloc)});
        return;
    };

    // Wait a max of 5 seconds when reading responses..
    ssh.setIdleTimeoutMs(5000);

    // Authenticate using login/password:
    ssh.authenticatePw("myLogin", "myPassword") catch {
        std.debug.print("{s}\n", .{try ssh.getLastErrorText(alloc)});
        return;
    };

    // Once the SSH object is connected and authenticated, we use it
    // in our SCP object.
    const scp = try chilkat.Scp.init();
    defer scp.deinit();

    scp.useSsh(ssh) catch {
        std.debug.print("{s}\n", .{try scp.getLastErrorText(alloc)});
        return;
    };

    // This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).
    const remote_path = "repository/xml/hamlet.xml";

    // The byte representation of the remote text file (i.e. the charset) must be
    // indicated to allow the receiving software to correctly interpret the incoming
    // bytes as the correct chars.
    // See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
    const charset = "utf-8";

    const file_contents = scp.downloadString(alloc, remote_path, charset) catch {
        std.debug.print("{s}\n", .{try scp.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("Received file:\n", .{});
    std.debug.print("{s}\n", .{file_contents});

    std.debug.print("SCP download string success.\n", .{});

    // Disconnect
    ssh.disconnect();
}