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 Long
success = 0

'  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 ChilkatSsh

'  LoadText is a convenience method that reads any text file into a string.  It does not itself
'  load the key.
Dim puttyKey As New ChilkatSshKey
Dim ppkText As String
ppkText = puttyKey.LoadText("qa_data/ppk/putty_private_secret.ppk")
If (puttyKey.LastMethodSuccess = 0) Then
    Debug.Print puttyKey.LastErrorText
    Exit Sub
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 = 0) Then
    Debug.Print puttyKey.LastErrorText
    Exit Sub
End If

Dim sshHostname As String
sshHostname = "ssh.example.com"
Dim sshPort As Long
sshPort = 22
success = ssh.Connect(sshHostname,sshPort)
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  The corresponding public key must already be installed on the SSH server for the account.
success = ssh.AuthenticatePk("mySshLogin",puttyKey)
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

Debug.Print "Connection and authentication with the SSH server completed."

ssh.Disconnect