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

This functionality affects 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) {
    CURLcode result;
    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);
    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

Notes

Works only with the libssh2 backend.

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).

Releases

3 releases since Debian 12 (Bookworm); the text changed 2 times.

  1. 12
  2. 13
  3. Arch

Availability

Added in curl 7.84.0

From curl 8.23.0-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.