Ruby

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

Download Chilkat for Ruby

Ruby

require 'chilkat'

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.

mailman = Chilkat::CkMailMan.new()

#  Configure the POP3 server connection.  These connections will travel through the tunnel.
mailman.put_MailHost("pop.example.com")
mailman.put_MailPort(995)
mailman.put_PopSsl(true)
mailman.put_PopUsername("user@example.com")
mailman.put_PopPassword("myPassword")

#  Open the SSH tunnel first.
success = mailman.SshOpenTunnel("ssh.example.com",22)
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

#  Load the SSH private key from an OpenSSH-format key file.
sshKey = Chilkat::CkSshKey.new()
keyText = sshKey.loadText("qa_data/ssh/id_rsa")
if (sshKey.get_LastMethodSuccess() == false)
    print sshKey.lastErrorText() + "\n";
    exit
end

success = sshKey.FromOpenSshPrivateKey(keyText)
if (success == false)
    print sshKey.lastErrorText() + "\n";
    exit
end

#  Authenticate with the SSH server using the private key.
success = mailman.SshAuthenticatePk("sshUser",sshKey)
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

#  POP3 operations now travel through the SSH tunnel.
count = mailman.GetMailboxCount()
if (count < 0)
    print "Failed to get the mailbox count." + "\n";
else
    print "Mailbox count: " + count.to_s() + "\n";
end

success = mailman.SshCloseTunnel()
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

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