Dart

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  final ssh = CkSsh();

  // Hostname may be an IP address or hostname:
  final hostname = 'www.some-ssh-server.com';
  final port = 22;

  // Connect to an SSH server:
  try {
    ssh.connect(hostname, port);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Wait a max of 5 seconds when reading responses..
  ssh.idleTimeoutMs = 5000;

  // Authenticate using login/password:
  try {
    ssh.authenticatePw('myLogin', 'myPassword');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Once the SSH object is connected and authenticated, we use it
  // in our SCP object.
  final scp = CkScp();

  try {
    scp.useSsh(ssh);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
  final remotePath = 'repository/xml/hamlet.xml';

  // The byte representation of the remote text file (i.e. the charset) must be
  // indicated to allow the receiving software to correctly interpret the incoming
  // bytes as the correct chars.
  // See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
  final charset = 'utf-8';

  final String fileContents;
  try {
    fileContents = scp.downloadString(remotePath, charset);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('Received file:');
  print(fileContents);

  print('SCP download string success.');

  // Disconnect
  ssh.disconnect();
}