Lua

Read Data from an SSH Channel

Demonstrates the Chilkat Ssh.ChannelRead method, which reads incoming SSH channel messages. The only argument is the channel number; the ReadTimeoutMs property limits how long it waits. Received data is appended to the channel's receive buffer, then retrieved with a GetReceived... method.

The integer return value is -1 on error, -2 if nothing arrived before the timeout, 0 if EOF or channel close was processed, or — when greater than 0 — the total bytes currently buffered for the channel (not the bytes newly received by this call).

Background: SSH reading is a two-step pattern that trips people up at first: the Channel* read/poll methods move bytes from the network into an internal per-channel buffer, and a separate GetReceived... call hands that buffer to your code. A positive return is therefore a buffer total, not a count of what this call fetched. Note that a 0 return means EOF or close — buffered data can still remain and should be drained.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Ssh.ChannelRead method, which reads incoming SSH channel messages.  The only
-- argument is the channel number.  The ReadTimeoutMs property limits how long it waits.

local ssh = chilkat.Ssh.new()

local sshPort = 22
local success = ssh:connect("ssh.example.com", sshPort)
if not success then
    print(ssh.last_error_text)
    return
end

-- Normally you would not hard-code the password in source.  You should instead obtain it
-- from an interactive prompt, environment variable, or a secrets vault.
local password = "mySshPassword"

success = ssh:authenticate_pw("mySshLogin", password)
if not success then
    print(ssh.last_error_text)
    return
end

local channelNum = ssh:open_session_channel()
if channelNum < 0 then
    print(ssh.last_error_text)
    return
end

-- Start a shell WITHOUT requesting a PTY.  Without a PTY the shell sees it is connected to a
-- raw data pipe and enters non-interactive mode: it suppresses the command prompt, does not
-- echo typed commands back, and skips interactive login scripts.  The output is therefore
-- clean and easily parseable -- but because no prompt is ever sent, code must not wait for
-- one.  Instead, have each command print a predictable marker, or wait for EOF / channel close.
success = ssh:send_req_shell(channelNum)
if not success then
    print(ssh.last_error_text)
    return
end

success = ssh:channel_send_string(channelNum, "uname -a\n", "utf-8")
if not success then
    print(ssh.last_error_text)
    return
end

-- The return value is: -1 on error, -2 if nothing arrived before the timeout, 0 if EOF or
-- channel close was processed, or the total number of buffered bytes when greater than 0.
local result = ssh:channel_read(channelNum)
if result == (-1) then
    print(ssh.last_error_text)
    return
end

if result == (-2) then
    print("No channel data arrived before the timeout.")
end

if result == 0 then
    print("EOF or channel close was processed.  Buffered data may still remain.")
end

if result > 0 then
    print("Total bytes buffered: " .. result)
end

local output = ssh:get_received_text(channelNum, "utf-8")
if not ssh.last_method_success then
    print(ssh.last_error_text)
    return
end

print(output)

ssh:disconnect()