Xojo Plugin

SSH Tunnel Authenticate with a Private Key

Demonstrates the Chilkat SshTunnel.AuthenticatePk method, which authenticates the SSH connection using public-key authentication. The first argument is the username and the second is an SshKey private key. The matching public key must already be installed for the account on the SSH server.

Note: The private-key path is relative to the application's current working directory. Absolute paths may also be used. Supply the path to your own key file.

Background: Public-key authentication suits tunnels especially well because they typically run unattended for long periods: the private key stays on the client, the server trusts the corresponding public key, and no reusable password crosses the wire. The SshKey object imports several formats; for an encrypted key, set its Password before importing.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SshTunnel.AuthenticatePk method, which authenticates the SSH connection using
//  public-key authentication.  The 1st argument is the username and the 2nd is an SshKey private
//  key.  The matching public key must already be installed for the account on the SSH server.

Dim tunnel As New Chilkat.SshTunnel

//  The tunnel forwards accepted local connections to this destination through the SSH server.
tunnel.DestHostname = "db.internal.example.com"
tunnel.DestPort = 5432

//  Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
//  does not authenticate yet.
Dim sshPort As Int32
sshPort = 22
success = tunnel.Connect("ssh.example.com",sshPort)
If (success = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
Dim privKey As New Chilkat.SshKey
Dim keyText As String
keyText = privKey.LoadText("qa_data/id_rsa")
If (privKey.LastMethodSuccess = False) Then
    System.DebugLog(privKey.LastErrorText)
    Return
End If

success = privKey.FromOpenSshPrivateKey(keyText)
If (success = False) Then
    System.DebugLog(privKey.LastErrorText)
    Return
End If

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

System.DebugLog("Authenticated with a private key.")

//  After authenticating, call BeginAccepting to start listening for local connections to forward.

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