Use a PuTTY Key for SSH Authentication

See more SSH Examples

Demonstrates authenticating with an SSH server using a username and a PuTTY (.ppk) private key. The key is imported with FromPuttyPrivateKey — setting Password first if it is encrypted — and passed to AuthenticatePk.

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

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 a username and a PuTTY (.ppk) private
//  key.  The private key serves as the credential; the username identifies the account on the
//  server.

Dim ssh As New Chilkat.Ssh

//  LoadText is a convenience method that reads any text file into a string.  It does not itself
//  load the key.
Dim puttyKey As New Chilkat.SshKey
Dim ppkText As String
ppkText = puttyKey.LoadText("qa_data/ppk/putty_private_secret.ppk")
If (puttyKey.LastMethodSuccess = False) Then
    System.DebugLog(puttyKey.LastErrorText)
    Return
End If

//  Set the password before importing an encrypted .ppk.  This should come from a secure source
//  rather than being hard-coded.
puttyKey.Password = "myKeyPassword"

success = puttyKey.FromPuttyPrivateKey(ppkText)
If (success = False) Then
    System.DebugLog(puttyKey.LastErrorText)
    Return
End If

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

//  The corresponding public key must already be installed on the SSH server for the account.
success = ssh.AuthenticatePk("mySshLogin",puttyKey)
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

System.DebugLog("Connection and authentication with the SSH server completed.")

ssh.Disconnect