(Perl) SCP Download Text File to String Variable

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.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$ssh = chilkat::CkSsh->new();

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

# Connect to an SSH server:
$success = $ssh->Connect($hostname,$port);
if ($success != 1) {
    print $ssh->lastErrorText() . "\r\n";
    exit;
}

# Wait a max of 5 seconds when reading responses..
$ssh->put_IdleTimeoutMs(5000);

# Authenticate using login/password:
$success = $ssh->AuthenticatePw("myLogin","myPassword");
if ($success != 1) {
    print $ssh->lastErrorText() . "\r\n";
    exit;
}

# Once the SSH object is connected and authenticated, we use it
# in our SCP object.
$scp = chilkat::CkScp->new();

$success = $scp->UseSsh($ssh);
if ($success != 1) {
    print $scp->lastErrorText() . "\r\n";
    exit;
}

# 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);
if ($scp->get_LastMethodSuccess() != 1) {
    print $scp->lastErrorText() . "\r\n";
    exit;
}

print "Received file:" . "\r\n";
print $fileContents . "\r\n";

print "SCP download string success." . "\r\n";

# Disconnect
$ssh->Disconnect();