aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.365
1 files changed, 0 insertions, 65 deletions
diff --git a/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3 b/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3
deleted file mode 100644
index ac13dc6a2..000000000
--- a/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3
+++ /dev/null
@@ -1,65 +0,0 @@
-.\" **************************************************************************
-.\" * _ _ ____ _
-.\" * 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 "4 Nov 2021" libcurl libcurl
-.SH NAME
-CURLOPT_SSH_HOSTKEYDATA \- pointer to pass to the SSH host key callback
-.SH SYNOPSIS
-.nf
-#include <curl/curl.h>
-
-CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOSTKEYDATA, void *pointer);
-.fi
-.SH DESCRIPTION
-Pass a void * as parameter. This \fIpointer\fP is passed along untouched to
-the callback set with \fICURLOPT_SSH_HOSTKEYFUNCTION(3)\fP.
-.SH DEFAULT
-NULL
-.SH PROTOCOLS
-SCP and SFTP
-.SH EXAMPLE
-.nf
-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);
-}
-.fi
-.SH AVAILABILITY
-Added in 7.84.0, works only with libssh2 backend.
-.SH RETURN VALUE
-Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
-.SH "SEE ALSO"
-.BR CURLOPT_SSH_HOSTKEYFUNCTION (3)