69 lines
2.4 KiB
Groff
69 lines
2.4 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_SSH_KEYDATA 3 "19 Jun 2014" libcurl libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_SSH_KEYDATA \- pointer passed to the SSH key callback
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_KEYDATA, void *pointer);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Pass a void * as parameter. This \fIpointer\fP is passed along verbatim to the
|
||
|
|
callback set with \fICURLOPT_SSH_KEYFUNCTION(3)\fP.
|
||
|
|
.SH DEFAULT
|
||
|
|
NULL
|
||
|
|
.SH PROTOCOLS
|
||
|
|
SFTP and SCP
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
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;
|
||
|
|
}
|
||
|
|
{
|
||
|
|
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);
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Added in 7.19.6
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR CURLOPT_SSH_KEYDATA (3),
|
||
|
|
.BR CURLOPT_SSH_KNOWNHOSTS (3)
|