curl-w32/docs/libcurl/opts/CURLOPT_SSH_KEYDATA.md

76 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

---
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_SSH_KEYDATA
Section: 3
Source: libcurl
See-also:
- CURLOPT_SSH_KEYDATA (3)
- CURLOPT_SSH_KNOWNHOSTS (3)
---
# NAME
CURLOPT_SSH_KEYDATA - pointer passed to the SSH key callback
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_KEYDATA, void *pointer);
~~~
# DESCRIPTION
Pass a void * as parameter. This *pointer* is passed along verbatim to the
callback set with CURLOPT_SSH_KEYFUNCTION(3).
# DEFAULT
NULL
# PROTOCOLS
SFTP and SCP
# EXAMPLE
~~~c
struct mine {
void *custom;
};
static int keycb(CURL *easy,
const struct curl_khkey *knownkey,
const struct curl_khkey *foundkey,
enum curl_khmatch match,
void *clientp)
{
/* 'clientp' points to the callback_data struct */
/* investigate the situation and return the correct value */
return CURLKHSTAT_FINE_ADD_TO_FILE;
}
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_KEYFUNCTION, keycb);
curl_easy_setopt(curl, CURLOPT_SSH_KEYDATA, &callback_data);
curl_easy_setopt(curl, CURLOPT_SSH_KNOWNHOSTS, "/home/user/known_hosts");
curl_easy_perform(curl);
}
}
~~~
# AVAILABILITY
Added in 7.19.6
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.