Lua

SSH Tunnel Authenticate with a Password

Demonstrates the Chilkat SshTunnel.AuthenticatePw method, which authenticates the SSH connection with a login name and password. The first argument is the login and the second is the password. Connect first, and call BeginAccepting afterward.

Background: Password authentication is the simplest option, but the password is a secret and should never be a hard-coded literal — obtain it from an interactive prompt, an environment variable, or a secrets vault. Public-key authentication is generally preferred for the unattended, long-running services that tunnels often are.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the SshTunnel.AuthenticatePw method, which authenticates the SSH connection with
-- a login name and password.  The 1st argument is the login and the 2nd is the password.

local tunnel = chilkat.SshTunnel.new()

-- The tunnel forwards accepted local connections to this destination through the SSH server.
tunnel.dest_hostname = "db.internal.example.com"
tunnel.dest_port = 5432

-- Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
-- does not authenticate yet.
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

print("Authenticated.")

-- After authenticating, call BeginAccepting to start listening for local connections to forward.

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