PureBasic

SSH Host Key Fingerprint

Demonstrates getting the SSH server's host key fingerprint after connecting. The HostKeyFingerprint property returns the classic MD5 form, while GetHostKeyFP returns a fingerprint using a chosen hash algorithm, with optional inclusion of the key type and hash name.

Background: The host key fingerprint identifies the server, and comparing it against a known-good value is how a client implements host-key pinning — detecting a man-in-the-middle or a server whose key has changed. This is the same fingerprint an SSH client shows on first connection when it asks whether to trust the host. Prefer SHA256, which is the modern standard; MD5 fingerprints still appear in older tooling but are cryptographically weak.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkSsh.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 getting the SSH server's host key fingerprint after connecting.

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

    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

    ;  The classic MD5 fingerprint is available as a property.
    md5_fingerprint.s = CkSsh::ckHostKeyFingerprint(ssh)
    Debug md5_fingerprint
    ;  For example:  ssh-rsa 3072 21:b0:d8:41:4e:ef:78:10:20:af:01:b7:71:5d:eb:94

    ;  GetHostKeyFP returns a fingerprint using the hash algorithm of your choice, such as SHA256,
    ;  SHA384, or SHA512.  The 2nd and 3rd arguments control whether the key type and the hash name
    ;  are included in the returned string.
    includeKeyType.i = 1
    includeHashName.i = 1
    sha256_fingerprint.s = CkSsh::ckGetHostKeyFP(ssh,"SHA256",includeKeyType,includeHashName)
    If CkSsh::ckLastMethodSuccess(ssh) = 0
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    Debug sha256_fingerprint
    ;  ssh-rsa SHA256:Ufgj480OsdsCZRjj9sSNM6fpgIcSJ61RsIG8usndUIY=

    includeKeyType = 0
    includeHashName = 1
    sha256_fingerprint = CkSsh::ckGetHostKeyFP(ssh,"SHA256",includeKeyType,includeHashName)
    If CkSsh::ckLastMethodSuccess(ssh) = 0
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    Debug sha256_fingerprint
    ;  SHA256:Ufgj480OsdsCZRjj9sSNM6fpgIcSJ61RsIG8usndUIY=

    includeKeyType = 1
    includeHashName = 0
    sha256_fingerprint = CkSsh::ckGetHostKeyFP(ssh,"SHA256",includeKeyType,includeHashName)
    If CkSsh::ckLastMethodSuccess(ssh) = 0
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    Debug sha256_fingerprint
    ;  ssh-rsa Ufgj480OsdsCZRjj9sSNM6fpgIcSJ61RsIG8usndUIY=

    includeKeyType = 0
    includeHashName = 0
    sha256_fingerprint = CkSsh::ckGetHostKeyFP(ssh,"SHA256",includeKeyType,includeHashName)
    If CkSsh::ckLastMethodSuccess(ssh) = 0
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    Debug sha256_fingerprint
    ;  Ufgj480OsdsCZRjj9sSNM6fpgIcSJ61RsIG8usndUIY=

    CkSsh::ckDisconnect(ssh)


    CkSsh::ckDispose(ssh)


    ProcedureReturn
EndProcedure