PHP

Send EOF on an SSH Channel

Demonstrates the Chilkat Ssh.ChannelSendEof method, which sends an SSH EOF message on a channel. The only argument is the channel number. EOF closes only the client-to-server direction; the application may still receive stdout, stderr, exit status, EOF, and CLOSE from the server.

Background: Many remote commands read standard input until it ends — wc, sort, cat and friends. Sending EOF is the SSH equivalent of pressing Ctrl+D: it tells the remote process no more input is coming so it can finish and emit results. After sending EOF, do not send more data on that channel; a later send may return true even though nothing is delivered.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Ssh;

// Demonstrates the Ssh.ChannelSendEof method, which sends an SSH EOF message on a channel.  The
// only argument is the channel number.  EOF closes only the client-to-server direction; output
// may still be received from the server.

$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;
}

$channelNum = $ssh->OpenSessionChannel();
if ($channelNum < 0) {
    echo $ssh->LastErrorText, "\n";
    exit;
}

try {
    $ssh->SendReqExec($channelNum, 'wc -l');

    // Send input to the remote command.
    $ssh->ChannelSendString($channelNum, "line one\nline two\nline three\n", 'utf-8');

    // Signal that no more input will be sent.  Do not send more data on this channel afterward.
    $ssh->ChannelSendEof($channelNum);

    // IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
    // it, this call waits forever if the server never sends channel close.
    $ssh->ReadTimeoutMs = 15000;

    // Output can still be received after EOF is sent.
    $ssh->ChannelReceiveToClose($channelNum);

    $output = $ssh->GetReceivedText($channelNum, 'utf-8');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo $output, "\n";

$ssh->Disconnect();