Session.ScanFingerprint Method

Scans a fingerprint of SSH server public key (host key) or FTPS/WebDAVS TLS certificate.

Syntax
- Parameters
- Return Value
Exceptions
Examples
- Real-Life Examples

Syntax

public string ScanFingerprint(
    SessionOptions sessionOptions,
    string algorithm
)

VB.NET

Public Function ScanFingerprint(
    sessionOptions As SessionOptions,
    algorithm As String
) As String

Parameters

Name Description

SessionOptions sessionOptions Defines a server to scan the fingerprint of.
The Protocol property must be Protocol.Sftp or Protocol.Scp, or Protocol.Ftp with FtpSecure being FtpSecure.Implicit or FtpSecure.Explicit, or Protocol.Webdav with WebdavSecure being true. Other than that only the HostName needs to be set. The PortNumber, Timeout and few raw session settings can be set, if necessary. The other properties are ignored.

string algorithm Fingerprint algorithm to use.
Supported algorithms are SHA-256 (recommended with SFTP and SCP protocols) and MD5 (the only supported option with FTPS and WebDAVS. With SFTP and SCP protocols, it should be used only for backward compatibility with previous versions).
This parameter is present since version 5.13 only. Older versions lack the parameter and use MD5 algorithm.

Name	Description
SessionOptions sessionOptions	Defines a server to scan the fingerprint of. The `Protocol` property must be `Protocol.Sftp` or `Protocol.Scp`, or `Protocol.Ftp` with `FtpSecure` being `FtpSecure.Implicit` or `FtpSecure.Explicit`, or `Protocol.Webdav` with `WebdavSecure` being true. Other than that only the `HostName` needs to be set. The `PortNumber`, `Timeout` and few raw session settings can be set, if necessary. The other properties are ignored.
string algorithm	Fingerprint algorithm to use. Supported algorithms are `SHA-256` (recommended with SFTP and SCP protocols) and `MD5` (the only supported option with FTPS and WebDAVS. With `SFTP` and `SCP` protocols, it should be used only for backward compatibility with previous versions). This parameter is present since version 5.13 only. Older versions lack the parameter and use `MD5` algorithm.

Return Value

A fingerprint of the SSH server public key (hostkey) for SFTP and SCP protocols. A fingerprint of server’s TLS certificate for FTPS and WebDAVS protocols.

Exceptions

Exception	Condition
InvalidOperationException	Session is already opened.
ArgumentException ArgumentOutOfRangeException	Invalid combination of values of `SessionOptions` properties.
SessionLocalException	Error communicating with `winscp.com`. See the exception documentation for details.
SessionRemoteException	Connection has failed. See the exception documentation for details.
TimeoutException	Timeout waiting for `winscp.com` to respond.