PureBasic

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 PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkSsh.pb"
IncludeFile "CkSshKey.pb"

Procedure ChilkatExample()

    success.i = 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.

    ssh.i = CkSsh::ckCreate()
    If ssh.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  Timeouts, in milliseconds.
    CkSsh::setCkConnectTimeoutMs(ssh, 5000)
    CkSsh::setCkReadTimeoutMs(ssh, 15000)

    hostname.s = "ssh.example.com"
    port.i = 22
    success = CkSsh::ckConnect(ssh,hostname,port)
    If success = 0
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ;  LoadText is a convenience method that reads any text file into a string.  It does not itself
    ;  load the key.
    key.i = CkSshKey::ckCreate()
    If key.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    privKeyText.s = CkSshKey::ckLoadText(key,"qa_data/my_private_key.pem")
    If CkSshKey::ckLastMethodSuccess(key) = 0
        Debug CkSshKey::ckLastErrorText(key)
        CkSsh::ckDispose(ssh)
        CkSshKey::ckDispose(key)
        ProcedureReturn
    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.
    success = CkSshKey::ckFromOpenSshPrivateKey(key,privKeyText)
    If success = 0
        Debug CkSshKey::ckLastErrorText(key)
        CkSsh::ckDispose(ssh)
        CkSshKey::ckDispose(key)
        ProcedureReturn
    EndIf

    success = CkSsh::ckAuthenticatePk(ssh,"mySshLogin",key)
    If success = 0
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        CkSshKey::ckDispose(key)
        ProcedureReturn
    EndIf

    Debug "Public-key authentication successful."

    CkSsh::ckDisconnect(ssh)


    CkSsh::ckDispose(ssh)
    CkSshKey::ckDispose(key)


    ProcedureReturn
EndProcedure