Lua

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. Lua

local chilkat = require("chilkat")

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

local ssh = chilkat.Ssh.new()

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

-- Connect to an SSH server:
local success = ssh:connect(hostname, port)
if not success then
    print(ssh.last_error_text)
    return
end

-- Wait a max of 5 seconds when reading responses..
ssh.idle_timeout_ms = 5000

-- Authenticate using login/password:
success = ssh:authenticate_pw("myLogin", "myPassword")
if not success then
    print(ssh.last_error_text)
    return
end

-- Once the SSH object is connected and authenticated, we use it
-- in our SCP object.
local scp = chilkat.Scp.new()

success = scp:use_ssh(ssh)
if not success then
    print(scp.last_error_text)
    return
end

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

local fileContents = scp:download_string(remotePath, charset)
if not scp.last_method_success then
    print(scp.last_error_text)
    return
end

print("Received file:")
print(fileContents)

print("SCP download string success.")

-- Disconnect
ssh:disconnect()