Differences
This shows you the differences between the selected revisions of the page.
| library_session_scanfingerprint 2018-06-12 | library_session_scanfingerprint 2023-05-24 (current) | ||
| Line 1: | Line 1: | ||
| ====== Session.ScanFingerprint Method ====== | ====== Session.ScanFingerprint Method ====== | ||
| - | Scans a fingerprint of [[ssh_verifying_the_host_key|SSH server public key (host key)]] or [[tls#certificate|FTPS/WebDAVS TLS certificate]]. | + | Scans a fingerprint of [[ssh_verifying_the_host_key|SSH server public key (host key)]] or [[tls#certificate|FTPS/WebDAVS/S3 TLS certificate]]. |
| ===== Syntax ===== | ===== Syntax ===== | ||
| Line 19: | Line 19: | ||
| ==== [[parameters]] Parameters ==== | ==== [[parameters]] Parameters ==== | ||
| ^ Name ^ Description ^ | ^ Name ^ Description ^ | ||
| - | | [[library_sessionoptions|SessionOptions]] ==sessionOptions== | Defines a server to scan the fingerprint of. \\ The ''[[library_sessionoptions#protocol|Protocol]]'' property must be ''Protocol.Sftp'' or ''Protocol.Scp'', or ''Protocol.Ftp'' with ''[[library_sessionoptions#ftpsecure|FtpSecure]]'' being ''FtpSecure.Implicit'' or ''FtpSecure.Explicit'', or ''Protocol.Webdav'' with ''[[library_sessionoptions#webdavsecure|WebdavSecure]]'' being true. Other than that only the ''[[library_sessionoptions#hostname|HostName]]'' needs to be set. The ''[[library_sessionoptions#portnumber|PortNumber]]'', ''[[library_sessionoptions#timeout|Timeout]]'' and few [[rawsettings|raw session settings]] can be set, if necessary. The other properties are ignored. | | + | | [[library_sessionoptions|SessionOptions]] ==sessionOptions== | Defines a server to scan the fingerprint of. \\ The ''[[library_sessionoptions#protocol|Protocol]]'' property must be ''Protocol.Sftp'' or ''Protocol.Scp'', or ''Protocol.Ftp'' with ''[[library_sessionoptions#ftpsecure|FtpSecure]]'' being ''FtpSecure.Implicit'' or ''FtpSecure.Explicit'', or ''Protocol.Webdav'' or ''%%Protocol.S3%%'' with ''[[library_sessionoptions#secure|Secure]]'' being true (default for ''%%S3%%''). Other than that only the ''[[library_sessionoptions#hostname|HostName]]'' needs to be set. The ''[[library_sessionoptions#portnumber|PortNumber]]'', ''[[library_sessionoptions#timeout|Timeout]]'' and few [[rawsettings|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 [[webdav|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. &recent Older versions lack the parameter and use ''%%MD5%%'' algorithm.// | | + | | string ==algorithm== | Fingerprint algorithm to use. \\ The recommended algorithm is ''SHA-256''. You can also use obsolete ''MD5'' for SSH ([[SFTP]] and [[SCP]] protocols) and ''SHA-1'' for TLS/SSL ([[ftps|FTPS]], [[webdav|WebDAVS]] and [[S3]]). | |
| ==== Return Value ==== | ==== Return Value ==== | ||
| - | A fingerprint of the [[ssh_verifying_the_host_key|SSH server public key (hostkey)]] for [[sftp|SFTP]] and [[scp|SCP]] protocols. A fingerprint of [[tls#certificate|server's TLS certificate]] for [[ftps|FTPS]] and [[webdav|WebDAVS]] protocols. | + | A fingerprint of the [[ssh_verifying_the_host_key|SSH server public key (hostkey)]] for [[sftp|SFTP]] and [[scp|SCP]] protocols. A fingerprint of [[tls#certificate|server's TLS certificate]] for [[ftps|FTPS]], [[webdav|WebDAVS]] and [[S3]] protocols. |
| ===== Exceptions ===== | ===== Exceptions ===== | ||
| Line 34: | Line 34: | ||
| ===== [[example]] Examples ===== | ===== [[example]] Examples ===== | ||
| + | |||
| ==== Real-Life Examples ==== | ==== Real-Life Examples ==== | ||
| - | * [[library_example_known_hosts|Implementing SSH host key cache (known hosts)]]. | + | * [[library_example_known_hosts|*]]. |