Node.js

Request SSH X11 Forwarding

Demonstrates the Chilkat Ssh.SendReqX11Forwarding method, which sends an X11-forwarding request on a session channel. The arguments are the channel number, whether forwarding is limited to a single connection, and the X11 authentication protocol, cookie, and screen number.

Background: X11 forwarding lets a graphical program running on the remote host display its window on your local machine, tunneled over SSH. This is a low-level method that only sends the protocol request — your application is still responsible for the local X server side of the arrangement. The authentication cookie guards the forwarded display, so it should be a freshly generated value rather than a fixed constant.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates the Ssh.SendReqX11Forwarding method, which sends an SSH X11-forwarding request
    //  on a session channel.  The 1st argument is the channel number, the 2nd limits forwarding to a
    //  single connection, and the 3rd through 5th supply the X11 authentication protocol, cookie,
    //  and screen number.

    var ssh = new chilkat.Ssh();

    var sshPort = 22;
    success = ssh.Connect("ssh.example.com",sshPort);
    if (success == false) {
        console.log(ssh.LastErrorText);
        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.
    var password = "mySshPassword";

    success = ssh.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Open a session channel.  A negative return value indicates failure.
    var channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Request X11 forwarding.  Named variables make each argument's meaning clear.
    var singleConnection = false;
    var authProt = "MIT-MAGIC-COOKIE-1";
    var authCookie = "d92f5e1a7c8b4306af17c2e5b9d43081";
    var screenNum = 0;
    success = ssh.SendReqX11Forwarding(channelNum,singleConnection,authProt,authCookie,screenNum);
    if (success == false) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log("X11 forwarding requested.");

    ssh.Disconnect();

}

chilkatExample();