DataFlex

SSH Tunnel Per-Client Logging and Client Identifier

Demonstrates the ClientLogDir and ClientIdentifier properties. When ClientLogDir is set, a separate log file is created for each tunnel client; ClientIdentifier is the SSH client-identification string sent during the handshake.

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

Background: When many clients share one tunnel, a single combined log is hard to follow, so ClientLogDir gives each connection its own file — the fastest way to diagnose one misbehaving client. ClientIdentifier sets the version string the server sees; overriding the default is occasionally needed for compatibility with servers that key behavior off the client identification, or simply to label your application in server logs.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoTunnel
    Integer iSshPort
    String sPassword
    Integer iListenPort
    Boolean iWaitForThreadExit
    String sTemp1

    Move False To iSuccess

    //  Demonstrates the SshTunnel per-client logging properties ClientLogDir and ClientIdentifier.

    Get Create (RefClass(cComChilkatSshTunnel)) To hoTunnel
    If (Not(IsComObjectCreated(hoTunnel))) Begin
        Send CreateComObject of hoTunnel
    End

    //  When ClientLogDir is set, a separate log file is created for each tunnel client in this
    //  directory, which is useful for troubleshooting individual connections.
    Set ComClientLogDir Of hoTunnel To "qa_output/client_logs"

    //  The SSH client-identification string sent to the SSH server during the handshake.
    Set ComClientIdentifier Of hoTunnel To "SSH-2.0-MyTunnelApp_1.0"

    Set ComDestHostname Of hoTunnel To "db.internal.example.com"
    Set ComDestPort Of hoTunnel To 5432

    Move 22 To iSshPort
    Get ComConnect Of hoTunnel "ssh.example.com" iSshPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    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.
    Move "mySshPassword" To sPassword

    Get ComAuthenticatePw Of hoTunnel "mySshLogin" sPassword To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Move 1080 To iListenPort
    Get ComBeginAccepting Of hoTunnel iListenPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComClientLogDir Of hoTunnel To sTemp1
    Showln "Tunnel running; each client is logged in " sTemp1

    Move True To iWaitForThreadExit
    Get ComCloseTunnel Of hoTunnel iWaitForThreadExit To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoTunnel To sTemp1
        Showln sTemp1
        Procedure_Return
    End



End_Procedure