Sample code for 30+ languages & platforms
Lua

Open an SSH Tunnel

See more Socket/SSL/TLS Examples

Demonstrates Socket.SshOpenTunnel, which connects to an SSH server and initializes an SSH tunneling session, then authenticates it.

Background. An SSH tunnel lets a socket reach a destination host through an SSH server using port forwarding. The sequence is: open the tunnel, authenticate, then open forwarded channels to destinations.

Chilkat Lua Downloads

Lua
local chilkat = require("chilkat")

local socket = chilkat.Socket.new()

-- Connect to the SSH server and initialize an SSH tunneling session.  Port 22 is conventional but
-- not required.
local success = socket:ssh_open_tunnel("ssh.example.com", 22)
if not success then
    print(socket.last_error_text)
    return
end

-- After the tunnel is open, authenticate before opening forwarded channels.
-- The SSH password should come from a secure source rather than being hard-coded.
local sshPassword = "mySshPassword"
success = socket:ssh_authenticate_pw("sshUser", sshPassword)
if not success then
    print(socket.last_error_text)
    return
end

print("SSH tunnel established and authenticated.")