Sample code for 30+ languages & platforms
Xojo Plugin

SSH Authentication using an SSH Certificate

See more SSH Examples

Demonstrates authenticating with an SSH server using an SSH certificate. The private key is imported into an SshKey object, UseSshCertificate attaches the certificate, and AuthenticatePk performs the authentication. See Understanding SSH Certificates for background.

Note: The file paths are relative to the application's current working directory. Supply the paths to your own files.

Background: An SSH certificate is a public key signed by a certificate authority, and it solves the scaling problem of ordinary public-key authentication: instead of copying every user's public key into authorized_keys on every server, each server simply trusts the CA. Certificates also carry an expiration, so access lapses automatically rather than lingering until someone remembers to remove a key. Note this is distinct from X.509 certificates — the SSH certificate format is its own thing.

Chilkat Xojo Plugin Downloads

Xojo Plugin
Dim success As Boolean
success = False

//  This example requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  Demonstrates authenticating with an SSH server using an SSH certificate.  An SSH certificate
//  is a signed public key: the server trusts the certificate authority that signed it, rather
//  than holding a copy of each user's public key.

Dim sbSshCert As New Chilkat.StringBuilder
success = sbSshCert.LoadFile("qa_data/sshCert/user_ecdsa_key-cert.pub","utf-8")
If (success = False) Then
    System.DebugLog(sbSshCert.LastErrorText)
    Return
End If

Dim sbPrivKey As New Chilkat.StringBuilder
success = sbPrivKey.LoadFile("qa_data/sshKeys/user_ecdsa_key","utf-8")
If (success = False) Then
    System.DebugLog(sbPrivKey.LastErrorText)
    Return
End If

Dim key As New Chilkat.SshKey

//  Set the password if the private key file is stored encrypted.  This should come from a
//  secure source rather than being hard-coded.
key.Password = "myKeyPassword"

Dim privKeyText As String
privKeyText = sbPrivKey.GetAsString()
success = key.FromOpenSshPrivateKey(privKeyText)
If (success = False) Then
    System.DebugLog(key.LastErrorText)
    Return
End If

//  Indicate that the SSH certificate is to be used for authentication.
Dim sshCertText As String
sshCertText = sbSshCert.GetAsString()
success = key.UseSshCertificate(sshCertText)

Dim ssh As New Chilkat.Ssh

Dim hostname As String
hostname = "ssh.example.com"
Dim port As Int32
port = 22
success = ssh.Connect(hostname,port)
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

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

System.DebugLog("Public-key authentication using an SSH certificate was successful.")

ssh.Disconnect