SFTP Object

GetHostKeyFP

 
Syntax
 
SFTP.HardLink(oldPath As String, newPath As String) As Long
 
Description
Returns the host key fingerprint of the server, which is automatically set after connecting to an SSH/SFTP server. The hashAlg can be any hash algorithm supported by Chilkat, such as "SHA256", "SHA384", "SHA512", "SHA1", "MD5", "SHA3-224", "SHA3-256", "SHA3-384", "SHA3-512", etc.
 
If both includeKeyType and includeHashName are 1, then the fingerprint string is formatted like this:
ssh-rsa SHA256:L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...
 
If includeKeyType is 1 and includeHashName is 0:
ssh-rsa L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...
 
If includeKeyType is 0 and includeHashName is 1:
SHA256:L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...
 
f includeKeyType is 0 and includeHashName is 0:
L7sQgnpnoBwRoyIYXAFBs8SdSnwtyYmhXs1p/mQDK...
 
SSH host key types can be: ssh-rsa, ecdsa-*-* (such as ecdsa-sha2-nistp256), ssh-ed25519, and ssh-dss.
 
Returns Nothing on failure
See Also

Example
Sub Main
 
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
 
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
 
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.SFtp")
set sftp = CreateObject("Chilkat.SFtp")
 
hostname = "sftp.example.com"
port = 22
success = sftp.Connect(hostname,port)
If (success <> 1) Then
    outFile.WriteLine(sftp.LastErrorText)
    WScript.Quit
End If
 
' Get the classic MD5 fingeprint
md5_fingerprint = sftp.HostKeyFingerprint
outFile.WriteLine(md5_fingerprint)
 
' Sample output:
' ssh-rsa 3072 21:b0:d8:41:4e:ef:78:10:20:af:01:b7:71:5d:eb:94
 
' Starting in Chilkat v9.5.0.92, we can also get the SHA256 fingerprint.
' (it is also possible to get fingerprints using other hash algorithms such as SHA384, SHA512, etc.)
 
includeKeyType = 1
includeHashName = 1
sha256_fingerprint = sftp.GetHostKeyFP("SHA256",includeKeyType,includeHashName)
outFile.WriteLine(sha256_fingerprint)
 
' Sample output:
' ssh-rsa SHA256:Ufgj480OsdsCZRjj9sSNM6fpgIcSJ61RsIG8usndUIY=
 
' The key type and hash name can be optionally included or not.
includeKeyType = 0
includeHashName = 1
sha256_fingerprint = sftp.GetHostKeyFP("SHA256",includeKeyType,includeHashName)
outFile.WriteLine(sha256_fingerprint)
 
' SHA256:Ufgj480OsdsCZRjj9sSNM6fpgIcSJ61RsIG8usndUIY=
 
includeKeyType = 1
includeHashName = 0
sha256_fingerprint = sftp.GetHostKeyFP("SHA256",includeKeyType,includeHashName)
outFile.WriteLine(sha256_fingerprint)
 
' ssh-rsa Ufgj480OsdsCZRjj9sSNM6fpgIcSJ61RsIG8usndUIY=
 
includeKeyType = 0
includeHashName = 0
sha256_fingerprint = sftp.GetHostKeyFP("SHA256",includeKeyType,includeHashName)
outFile.WriteLine(sha256_fingerprint)
 
' Ufgj480OsdsCZRjj9sSNM6fpgIcSJ61RsIG8usndUIY=
 
outFile.Close
End Sub