PHP

Set a TTY Mode for an SSH PTY Request

Demonstrates the Chilkat Ssh.SetTtyMode method, which adds or updates one TTY mode to be included in a later SendReqPty request. The first argument is the mode name and the second is its integer value. Call it once per mode, before requesting the PTY.

Background: TTY modes are the terminal settings a PTY is created with — the same knobs stty exposes. The classic use is SetTtyMode("ECHO", 0), which stops the terminal from echoing input; that is how a password prompt keeps typed characters off the screen. Modes accumulate on the object and are sent with the next PTY request.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Ssh;

// Demonstrates the Ssh.SetTtyMode method, which adds or updates one TTY mode to be included in
// a later SendReqPty request.  The 1st argument is the mode name and the 2nd is its integer
// value.  Call it once per mode, before SendReqPty.

$ssh = new Ssh();

$sshPort = 22;
try {
    $ssh->Connect('ssh.example.com', $sshPort);

    // 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.
    $password = 'mySshPassword';

    $ssh->AuthenticatePw('mySshLogin', $password);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Open a session channel.  A negative return value indicates failure.
$channelNum = $ssh->OpenSessionChannel();
if ($channelNum < 0) {
    echo $ssh->LastErrorText, "\n";
    exit;
}

// Request that the allocated terminal not echo input.
try {
    $ssh->SetTtyMode('ECHO', 0);

    // The modes set above are included in the PTY request.
    $ssh->SendReqPty($channelNum, 'xterm', 80, 24, 0, 0);

    $ssh->SendReqShell($channelNum);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

$ssh->Disconnect();