curl / libcurl / API / curl_easy_setopt / CURLOPT_SSH_HOSTKEYDATA

CURLOPT_SSH_HOSTKEYDATA explained

Name

CURLOPT_SSH_HOSTKEYDATA - pointer to pass to the SSH host key callback

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOSTKEYDATA, void *pointer);

Description

Pass a void * as parameter. This pointer is passed along untouched to the callback set with CURLOPT_SSH_HOSTKEYFUNCTION.

Default

NULL

Protocols

SCP and SFTP

Example

int hostkeycb(void *clientp,    /* passed with CURLOPT_SSH_HOSTKEYDATA */
              int keytype,      /* CURLKHTYPE */
              const char * key, /* host key to check */
              size_t keylen);   /* length of the key */
{
  /* 'clientp' points to the callback_data struct */
  /* investigate the situation and return the correct value */
  return CURLKHMATCH_OK;
}
{
  curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/thisfile.txt");
  curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYFUNCTION, hostkeycb);
  curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYDATA, &callback_data);
 
  curl_easy_perform(curl);
}

Availability

Added in 7.84.0, works only with libssh2 backend.

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.