Ruby

Check if the SSH Tunnel's Transport is Connected

Demonstrates the Chilkat SshTunnel.IsSshConnected method, which returns whether the SSH transport used by the tunnel is connected. It takes no arguments.

Background: A tunnel has two independent parts: the SSH transport to the server and the local listener that accepts connections to forward. This method reports only the first. The distinction matters because the listener can keep accepting local connections even after the SSH transport has dropped — those connections would then fail to forward — so a health check on a long-running tunnel should verify the SSH side explicitly.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the SshTunnel.IsSshConnected method, which returns whether the SSH transport used
#  by the tunnel is connected.  It takes no arguments.

tunnel = Chilkat::CkSshTunnel.new()

#  The tunnel forwards accepted local connections to this destination through the SSH server.
tunnel.put_DestHostname("db.internal.example.com")
tunnel.put_DestPort(5432)

#  Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
#  does not authenticate yet.
sshPort = 22
success = tunnel.Connect("ssh.example.com",sshPort)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
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.
password = "mySshPassword"

success = tunnel.AuthenticatePw("mySshLogin",password)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end

#  Check whether the SSH transport is connected.  This is independent of the local listener
#  state -- the listener can still be accepting local connections even when this is false,
#  though those connections would fail to forward.
if (tunnel.IsSshConnected())
    print "The SSH transport is connected." + "\n";
else
    print "The SSH transport is not connected." + "\n";
end

waitForThreadExit = true
success = tunnel.CloseTunnel(waitForThreadExit)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end