SSH Tunnel Per-Client Logging and Client Identifier

See more SSH Tunnel Examples

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 C# Downloads

Download Chilkat for C#

bool success = false;

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

Chilkat.SshTunnel tunnel = new Chilkat.SshTunnel();

//  When ClientLogDir is set, a separate log file is created for each tunnel client in this
//  directory, which is useful for troubleshooting individual connections.
tunnel.ClientLogDir = "qa_output/client_logs";

//  The SSH client-identification string sent to the SSH server during the handshake.
tunnel.ClientIdentifier = "SSH-2.0-MyTunnelApp_1.0";

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

int sshPort = 22;
success = tunnel.Connect("ssh.example.com",sshPort);
if (success == false) {
    Debug.WriteLine(tunnel.LastErrorText);
    return;
}

//  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.
string password = "mySshPassword";

success = tunnel.AuthenticatePw("mySshLogin",password);
if (success == false) {
    Debug.WriteLine(tunnel.LastErrorText);
    return;
}

int listenPort = 1080;
success = tunnel.BeginAccepting(listenPort);
if (success == false) {
    Debug.WriteLine(tunnel.LastErrorText);
    return;
}

Debug.WriteLine("Tunnel running; each client is logged in " + tunnel.ClientLogDir);

bool waitForThreadExit = true;
success = tunnel.CloseTunnel(waitForThreadExit);
if (success == false) {
    Debug.WriteLine(tunnel.LastErrorText);
    return;
}