Xbase++

SSH Public Key Authentication

Demonstrates authenticating with an SSH server using public-key authentication. A private key is loaded into an SshKey object and passed to AuthenticatePk. The matching public key must already be installed on the server for the account.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

Background: Public-key authentication is the standard for unattended and automated SSH: the private key never leaves the client, the server merely trusts the corresponding public key, and no reusable password crosses the wire. SshKey imports several formats — OpenSSH PEM keys via FromOpenSshPrivateKey and PuTTY .ppk files via FromPuttyPrivateKey — encrypted or not. For an encrypted key, set the Password property before importing. Note that LoadText is only a convenience for reading a text file into a string; it does not itself load the key.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSsh
LOCAL cHostname
LOCAL nPort
LOCAL oKey
LOCAL cPrivKeyText

nSuccess := 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 public-key authentication.  The matching
//  public key must already be installed on the SSH server for the account.

oSsh := CreateObject("Chilkat.Ssh")

//  Timeouts, in milliseconds.
oSsh:ConnectTimeoutMs := 5000
oSsh:ReadTimeoutMs := 15000

cHostname := "ssh.example.com"
nPort := 22
nSuccess := oSsh:Connect(cHostname, nPort)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  LoadText is a convenience method that reads any text file into a string.  It does not itself
//  load the key.
oKey := CreateObject("Chilkat.SshKey")
cPrivKeyText := oKey:LoadText("qa_data/my_private_key.pem")
IF (oKey:LastMethodSuccess == 0)
    ? oKey:LastErrorText
    oSsh:destroy()
    oKey:destroy()
    RETURN
ENDIF

//  Import the private key.  Both OpenSSH and PuTTY formats are supported, encrypted or not.
//  This example loads an unencrypted OpenSSH-format key; for a PuTTY .ppk file, call
//  FromPuttyPrivateKey instead.  For an encrypted key, set key.Password before importing.
nSuccess := oKey:FromOpenSshPrivateKey(cPrivKeyText)
IF (nSuccess == 0)
    ? oKey:LastErrorText
    oSsh:destroy()
    oKey:destroy()
    RETURN
ENDIF

nSuccess := oSsh:AuthenticatePk("mySshLogin", oKey)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    oKey:destroy()
    RETURN
ENDIF

? "Public-key authentication successful."

oSsh:Disconnect()

oSsh:destroy()
oKey:destroy()