Dart

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 Dart Downloads

Download Chilkat for Dart

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.

  final ssh = CkSsh();

  final sshPort = 22;
  try {
    ssh.connect('ssh.example.com', sshPort);
  } on ChilkatException catch (e) {
    print(e.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.
  final password = 'mySshPassword';

  try {
    ssh.authenticatePw('mySshLogin', password);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final channelNum = ssh.openSessionChannel();
  if (channelNum < 0) {
    print(ssh.lastErrorText);
    return;
  }

  try {
    ssh.sendReqExec(channelNum, 'wc -l');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Send input to the remote command.
  try {
    ssh.channelSendString(channelNum, 'line one\nline two\nline three\n', 'utf-8');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Signal that no more input will be sent.  Do not send more data on this channel afterward.
  try {
    ssh.channelSendEof(channelNum);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // 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.
  try {
    ssh.channelReceiveToClose(channelNum);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final String output;
  try {
    output = ssh.getReceivedText(channelNum, 'utf-8');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print(output);

  ssh.disconnect();
}