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.

load ./chilkat.dll

set 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.

set ssh [new_CkSsh]

#  LoadText is a convenience method that reads any text file into a string.  It does not itself
#  load the key.
set puttyKey [new_CkSshKey]

set ppkText [CkSshKey_loadText $puttyKey "qa_data/ppk/putty_private_secret.ppk"]
if {[CkSshKey_get_LastMethodSuccess $puttyKey] == 0} then {
    puts [CkSshKey_lastErrorText $puttyKey]
    delete_CkSsh $ssh
    delete_CkSshKey $puttyKey
    exit
}

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

set success [CkSshKey_FromPuttyPrivateKey $puttyKey $ppkText]
if {$success == 0} then {
    puts [CkSshKey_lastErrorText $puttyKey]
    delete_CkSsh $ssh
    delete_CkSshKey $puttyKey
    exit
}

set sshHostname "ssh.example.com"
set sshPort 22
set success [CkSsh_Connect $ssh $sshHostname $sshPort]
if {$success == 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    delete_CkSshKey $puttyKey
    exit
}

#  The corresponding public key must already be installed on the SSH server for the account.
set success [CkSsh_AuthenticatePk $ssh "mySshLogin" $puttyKey]
if {$success == 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    delete_CkSshKey $puttyKey
    exit
}

puts "Connection and authentication with the SSH server completed."

CkSsh_Disconnect $ssh

delete_CkSsh $ssh
delete_CkSshKey $puttyKey