Java

Request a Pseudo-Terminal (PTY) over SSH

Demonstrates the Chilkat Ssh.SendReqPty method, which requests a pseudo-terminal for a session channel. The arguments are the channel number, the terminal type, the character width and height, and the pixel width and height. It must be sent before the primary exec or shell request.

Background: A PTY makes the remote side behave as though a real terminal is attached, which matters for programs that draw screens, prompt for passwords, or colorize output — many refuse to run interactively without one. The terminal type (such as xterm) tells the remote program what escape sequences it may use. Pixel dimensions are commonly 0, meaning unspecified.

Chilkat Java Downloads

Download Chilkat for Java

Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    //  Demonstrates the Ssh.SendReqPty method, which requests a pseudo-terminal for a session
    //  channel.  The 1st argument is the channel number, the 2nd is the terminal type, the 3rd and
    //  4th are the character width and height, and the 5th and 6th are the pixel width and height.
    //  It must be sent before the primary exec or shell request.

    CkSsh ssh = new CkSsh();

    int sshPort = 22;
    success = ssh.Connect("ssh.example.com",sshPort);
    if (success == false) {
        System.out.println(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.
    String password = "mySshPassword";

    success = ssh.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    //  Open a session channel.  A negative return value indicates failure.
    int channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    //  Request an 80x24 xterm.  Pixel dimensions of 0 mean unspecified.
    String termType = "xterm";
    int widthInChars = 80;
    int heightInChars = 24;
    int widthInPixels = 0;
    int heightInPixels = 0;
    success = ssh.SendReqPty(channelNum,termType,widthInChars,heightInChars,widthInPixels,heightInPixels);
    if (success == false) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    //  Start the shell now that the PTY is allocated.
    success = ssh.SendReqShell(channelNum);
    if (success == false) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    ssh.Disconnect();
  }
}