Lua

SCP Download/Upload Binary Files as Encoded Strings

See more SCP Examples

Demonstrates how to upload and download binary files as encoded strings (base64, hex, etc.) using the SCP protocol (Secure Copy Protocol over SSH). 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

local remotePath = "images/starfish.jpg"

-- Download the binary file and return as a base64 string.
-- See <a href="http://www.cknotes.com/chilkat-binary-encoding-list/">List of Encodings</a> for a list of possible encodings.
local encodedJpg = scp:download_binary_encoded(remotePath, "base64")
if not scp.last_method_success then
    print(scp.last_error_text)
    return
end

remotePath = "images/starfish2.jpg"

-- Now upload from the base64 string to the SSH server.
-- Insided the call to UploadBinaryEncoded, the base64 string is decoded,
-- and the decoded bytes are uploaded.  The resulting starfish2.jpg on the
-- server will be identical to the original starfish.jpg
success = scp:upload_binary_encoded(remotePath, encodedJpg, "base64")
if not success then
    print(scp.last_error_text)
    return
end

print("SCP download/upload binary encoded success.")

-- Disconnect
ssh:disconnect()