Xojo Plugin

Authenticate an SSH Tunnel with a Private Key

Demonstrates the Chilkat MailMan.SshAuthenticatePk method, which authenticates with the SSH server using public-key authentication after an SSH tunnel has been opened. The first argument is the SSH account name and the second is the SSH private key (an SshKey object). This example opens a tunnel, loads an OpenSSH private key, authenticates with it, and runs a POP3 operation through the tunnel.

Background: SSH public-key authentication replaces a password with a key pair: the public key is installed on the SSH server, and the client proves it holds the matching private key without ever transmitting a secret. This is the preferred method for automated systems — there is no password to embed or rotate, and the key can be revoked server-side. Chilkat reads the key with an SshKey object, which understands common formats such as OpenSSH and PuTTY.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the MailMan.SshAuthenticatePk method, which authenticates with the SSH server
//  using public-key authentication after an SSH tunnel has been opened.  The 1st argument is
//  the SSH account name and the 2nd is the SSH private key.

Dim mailman As New Chilkat.MailMan

//  Configure the POP3 server connection.  These connections will travel through the tunnel.
mailman.MailHost = "pop.example.com"
mailman.MailPort = 995
mailman.PopSsl = True
mailman.PopUsername = "user@example.com"
mailman.PopPassword = "myPassword"

//  Open the SSH tunnel first.
success = mailman.SshOpenTunnel("ssh.example.com",22)
If (success = False) Then
    System.DebugLog(mailman.LastErrorText)
    Return
End If

//  Load the SSH private key from an OpenSSH-format key file.
Dim sshKey As New Chilkat.SshKey
Dim keyText As String
keyText = sshKey.LoadText("qa_data/ssh/id_rsa")
If (sshKey.LastMethodSuccess = False) Then
    System.DebugLog(sshKey.LastErrorText)
    Return
End If

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

//  Authenticate with the SSH server using the private key.
success = mailman.SshAuthenticatePk("sshUser",sshKey)
If (success = False) Then
    System.DebugLog(mailman.LastErrorText)
    Return
End If

//  POP3 operations now travel through the SSH tunnel.
Dim count As Int32
count = mailman.GetMailboxCount()
If (count < 0) Then
    System.DebugLog("Failed to get the mailbox count.")
Else
    System.DebugLog("Mailbox count: " + Str(count))
End If

success = mailman.SshCloseTunnel()
If (success = False) Then
    System.DebugLog(mailman.LastErrorText)
    Return
End If

//  Note: The path "qa_data/ssh/id_rsa" is a relative local filesystem path,
//  relative to the current working directory of the running application.