curl / libcurl / API / curl_easy_setopt / CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256

CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 explained

Name

CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 - SHA256 hash of SSH server public key

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256,
                          char *sha256);

Description

Pass a char * pointing to a string containing a Base64-encoded SHA256 hash of the remote host's public key. The transfer will fail if the given hash does not match the hash the remote host provides.

Default

NULL

Protocols

SCP and SFTP

Example

CURL *curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
  curl_easy_setopt(curl, CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256,
                   "NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ=");
  ret = curl_easy_perform(curl);
  curl_easy_cleanup(curl);
}

Availability

Added in 7.80.0 Requires the libssh2 backend.

Return value

Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.