Xbase++

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 Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oTunnel
LOCAL nSshPort
LOCAL cPassword
LOCAL nListenPort
LOCAL nWaitForThreadExit

nSuccess := 0

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

oTunnel := CreateObject("Chilkat.SshTunnel")

//  Retain the listener activity log in memory so it can be read from the AcceptLog property.
oTunnel:KeepAcceptLog := 1

//  Optionally also write the listener activity to a file (separate from the in-memory log).
oTunnel:AcceptLogPath := "qa_output/accept.log"

oTunnel:DestHostname := "db.internal.example.com"
oTunnel:DestPort := 5432

nSshPort := 22
nSuccess := oTunnel:Connect("ssh.example.com", nSshPort)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

//  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.
cPassword := "mySshPassword"

nSuccess := oTunnel:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

nListenPort := 1080
nSuccess := oTunnel:BeginAccepting(nListenPort)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

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

//  Read the accumulated in-memory listener log.
? oTunnel:AcceptLog

nWaitForThreadExit := 1
nSuccess := oTunnel:CloseTunnel(nWaitForThreadExit)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

oTunnel:destroy()