Xojo Plugin

SSH Tunnel Thread Activity Log

Demonstrates the tunnel-log properties KeepTunnelLog, TunnelLog, and TunnelLogPath, which record the activity of the SSH tunnel and client-manager threads.

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

Background: This is the counterpart to the accept log, covering the SSH side rather than the listener: the tunnel and client-manager threads that actually move data. As with the accept log, KeepTunnelLog enables the in-memory TunnelLog while TunnelLogPath writes a separate file. Together the two logs let you localize a problem to either the accepting side or the forwarding side.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SshTunnel tunnel-log properties KeepTunnelLog, TunnelLog, and TunnelLogPath.
//  
//  These log the activity of the SSH tunnel and client-manager threads.

Dim tunnel As New Chilkat.SshTunnel

//  Retain the SSH tunnel-thread activity in memory so it can be read from the TunnelLog property.
tunnel.KeepTunnelLog = True

//  Optionally also write the tunnel-thread activity to a file (separate from the in-memory log).
tunnel.TunnelLogPath = "qa_output/tunnel.log"

tunnel.DestHostname = "db.internal.example.com"
tunnel.DestPort = 5432

Dim sshPort As Int32
sshPort = 22
success = tunnel.Connect("ssh.example.com",sshPort)
If (success = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If

//  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.
Dim password As String
password = "mySshPassword"

success = tunnel.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If

Dim listenPort As Int32
listenPort = 1080
success = tunnel.BeginAccepting(listenPort)
If (success = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If

//  ... clients transfer data through the tunnel ...

//  Read the accumulated in-memory tunnel log.
System.DebugLog(tunnel.TunnelLog)

Dim waitForThreadExit As Boolean
waitForThreadExit = True
success = tunnel.CloseTunnel(waitForThreadExit)
If (success = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If