CURLOPT_SSH_HOSTKEYDATA(3)

CURLOPT_SSH_HOSTKEYDATA3

Pointer to pass to the ssh host key callback

Usage

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

Overview

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

Default

NULL

Protocols

SCP and SFTP

Examples

struct mine {
  void *custom;
};
static int hostkeycb(void *clientp,   /* 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;
}
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    struct mine callback_data;
    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);
  }
}

Return value

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

Releases

25 releases since macOS 13.1; the text changed 6 times.

  1. 13.1
  2. 13.2
  3. 13.3
  4. 13.4
  5. 13.5–14.1
  6. 14.2–14.4
  7. 14.5–26.5

Availability

Added in 7.84.0, works only with libssh2 backend.

From curl 166.0.0.0.1 in macOS 26.5. Parsed by carta from the page's man source.