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.

llSuccess = .F.

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

loSsh = createobject("CkSsh")

//  LoadText is a convenience method that reads any text file into a string.  It does not itself
//  load the key.
loPuttyKey = createobject("CkSshKey")
lcPpkText = loPuttyKey.LoadText("qa_data/ppk/putty_private_secret.ppk")
if (loPuttyKey.LastMethodSuccess = .F.) then
    ? loPuttyKey.LastErrorText
    release loSsh
    release loPuttyKey
    return
endif

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

llSuccess = loPuttyKey.FromPuttyPrivateKey(lcPpkText)
if (llSuccess = .F.) then
    ? loPuttyKey.LastErrorText
    release loSsh
    release loPuttyKey
    return
endif

lcSshHostname = "ssh.example.com"
lnSshPort = 22
llSuccess = loSsh.Connect(lcSshHostname,lnSshPort)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    release loPuttyKey
    return
endif

//  The corresponding public key must already be installed on the SSH server for the account.
llSuccess = loSsh.AuthenticatePk("mySshLogin",loPuttyKey)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    release loPuttyKey
    return
endif

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

loSsh.Disconnect()


release loSsh
release loPuttyKey