PureBasic

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 PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkSshTunnel.pb"

Procedure ChilkatExample()

    success.i = 0

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

    tunnel.i = CkSshTunnel::ckCreate()
    If tunnel.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  Retain the SSH tunnel-thread activity in memory so it can be read from the TunnelLog property.
    CkSshTunnel::setCkKeepTunnelLog(tunnel, 1)

    ;  Optionally also write the tunnel-thread activity to a file (separate from the in-memory log).
    CkSshTunnel::setCkTunnelLogPath(tunnel, "qa_output/tunnel.log")

    CkSshTunnel::setCkDestHostname(tunnel, "db.internal.example.com")
    CkSshTunnel::setCkDestPort(tunnel, 5432)

    sshPort.i = 22
    success = CkSshTunnel::ckConnect(tunnel,"ssh.example.com",sshPort)
    If success = 0
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    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.
    password.s = "mySshPassword"

    success = CkSshTunnel::ckAuthenticatePw(tunnel,"mySshLogin",password)
    If success = 0
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    EndIf

    listenPort.i = 1080
    success = CkSshTunnel::ckBeginAccepting(tunnel,listenPort)
    If success = 0
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    EndIf

    ;  ... clients transfer data through the tunnel ...

    ;  Read the accumulated in-memory tunnel log.
    Debug CkSshTunnel::ckTunnelLog(tunnel)

    waitForThreadExit.i = 1
    success = CkSshTunnel::ckCloseTunnel(tunnel,waitForThreadExit)
    If success = 0
        Debug CkSshTunnel::ckLastErrorText(tunnel)
        CkSshTunnel::ckDispose(tunnel)
        ProcedureReturn
    EndIf



    CkSshTunnel::ckDispose(tunnel)


    ProcedureReturn
EndProcedure