Ruby

SSH Tunnel Listener Activity Log

Demonstrates the listener-log properties KeepAcceptLog, AcceptLog, and AcceptLogPath, which record the activity of the background listener thread started by BeginAccepting.

Note: The log paths are relative to the application's current working directory. Absolute paths may also be used.

Background: Because the listener runs on a background thread, an activity log is often the only practical way to see what it is doing — which connections it accepted and when. KeepAcceptLog must be enabled for the in-memory AcceptLog to be populated; AcceptLogPath is an independent file-based log that persists across the run. This log covers the listener specifically, as distinct from the TunnelLog that records the SSH tunnel threads.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the SshTunnel listener-log properties KeepAcceptLog, AcceptLog, and AcceptLogPath.
#  
#  These log the activity of the background listener thread started by BeginAccepting.

tunnel = Chilkat::CkSshTunnel.new()

#  Retain the listener activity log in memory so it can be read from the AcceptLog property.
tunnel.put_KeepAcceptLog(true)

#  Optionally also write the listener activity to a file (separate from the in-memory log).
tunnel.put_AcceptLogPath("qa_output/accept.log")

tunnel.put_DestHostname("db.internal.example.com")
tunnel.put_DestPort(5432)

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

listenPort = 1080
success = tunnel.BeginAccepting(listenPort)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end

#  ... the listener accepts connections for a while ...

#  Read the accumulated in-memory listener log.
print tunnel.acceptLog() + "\n";

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