Zig

Open a Custom SSH Channel Type

Demonstrates the Chilkat Ssh.OpenCustomChannel method, which requests a channel whose application-defined type is supplied as the only argument. It returns the channel number, or -1 if the server rejects the channel. The server must implement that channel type.

Background: The SSH protocol allows vendor- and application-specific channel types beyond the standard session and direct-tcpip kinds; by convention these carry an @domain suffix to avoid name collisions. This method is the escape hatch for talking to a server that implements such a type. On rejection, inspect ChannelOpenFailCode to learn why.

Chilkat Zig Downloads

Download Chilkat for Zig

Zig

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

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

    // Demonstrates the Ssh.OpenCustomChannel method, which requests a custom SSH channel whose
    // application-defined type is supplied as the only argument.  It returns the channel number,
    // or -1 if the server rejects the channel.  The server must implement that channel type.

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

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

    // Normally you would not hard-code the password in source.  You should instead obtain it
    // from an interactive prompt, environment variable, or a secrets vault.
    const password = "mySshPassword";

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

    // Request an application-defined channel type.  The server must support it.
    const channel_type = "my-custom-channel@example.com";
    const channel_num = ssh.openCustomChannel(channel_type);
    if (channel_num < 0) {
        std.debug.print("{s}\n", .{try ssh.getLastErrorText(alloc)});
        return;
    }

    std.debug.print("Opened custom channel: {d}\n", .{channel_num});

    // The channel is used with the normal channel send, receive, EOF, CLOSE, and release methods.

    ssh.disconnect();
}