CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256(3) Introduction to Library Functions

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 pointer pointing to a string containing a Base64-encoded
SHA256 hash of the remote host's public key. The transfer fails if
the given hash does not match the hash the remote host provides.

The application does not have to keep the string around after setting
this option.

Using this option multiple times makes the last set string override
the previous ones. Set it to NULL to disable its use again.

DEFAULT

NULL

PROTOCOLS

This functionality affects scp and sftp

EXAMPLE

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

NOTES

Requires the libssh2 backend.

AVAILABILITY

Added in curl 7.80.0

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error
occurred, see libcurl-errors(3).

SEE ALSO

CURLOPT_SSH_AUTH_TYPES(3), CURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3),
CURLOPT_SSH_PUBLIC_KEYFILE(3)

libcurl 2025-02-25
CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256(3)