PHP

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. Chilkat2 PHP

<?php

use Chilkat2\Scp;
use Chilkat2\Ssh;

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

$ssh = new Ssh();

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

// Connect to an SSH server:
try {
    $ssh->Connect($hostname, $port);

    // Wait a max of 5 seconds when reading responses..
    $ssh->IdleTimeoutMs = 5000;

    // Authenticate using login/password:
    $ssh->AuthenticatePw('myLogin', 'myPassword');

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

    $scp->UseSsh($ssh);

    // This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).
    $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.
    $charset = 'utf-8';

    $fileContents = $scp->DownloadString($remotePath, $charset);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Received file:\n";
echo $fileContents, "\n";

echo "SCP download string success.\n";

// Disconnect
$ssh->Disconnect();