Lua

SSH Tunnel Uncommon Options

Demonstrates the UncommonOptions property, which enables optional behavior for uncommon requirements. The default is an empty string; provide a comma-separated list of keywords to enable more than one option. Available keywords are listed in the reference documentation.

Background: This is a catch-all for narrow workarounds that do not warrant their own properties — forcing a specific signature algorithm, disabling the periodic keep-alive, removing weak MACs, bypassing a VPN on Android, and so on. Most applications never set it. When you do, it is usually to satisfy a particular server's quirk or a specific security requirement, and the exact keyword matters, so consult the documented list rather than guessing.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the SshTunnel.UncommonOptions property, which enables optional behavior for
-- uncommon requirements.  The default is an empty string, appropriate for most applications.
-- Provide a comma-separated list of keywords to enable more than one option.

local tunnel = chilkat.SshTunnel.new()

-- For example, disable the periodic keep-alive ignore message and remove weak MAC algorithms
-- from those offered.  Available keywords are listed in the reference documentation.
tunnel.uncommon_options = "NoKeepAliveIgnoreMsg,no-weak-mac-algs"

tunnel.dest_hostname = "db.internal.example.com"
tunnel.dest_port = 5432

local sshPort = 22
local success = tunnel:connect("ssh.example.com", sshPort)
if not success then
    print(tunnel.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 = tunnel:authenticate_pw("mySshLogin", password)
if not success then
    print(tunnel.last_error_text)
    return
end

local listenPort = 1080
success = tunnel:begin_accepting(listenPort)
if not success then
    print(tunnel.last_error_text)
    return
end

print("Tunnel established.")

local waitForThreadExit = true
success = tunnel:close_tunnel(waitForThreadExit)
if not success then
    print(tunnel.last_error_text)
    return
end