Return to CURLOPT_SSH_KEYDATA.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSH_KEYDATA.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
        !             9: .\" *
        !            10: .\" * This software is licensed as described in the file COPYING, which
        !            11: .\" * you should have received as part of this distribution. The terms
        !            12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
        !            13: .\" *
        !            14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
        !            15: .\" * copies of the Software, and permit persons to whom the Software is
        !            16: .\" * furnished to do so, under the terms of the COPYING file.
        !            17: .\" *
        !            18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
        !            19: .\" * KIND, either express or implied.
        !            20: .\" *
        !            21: .\" **************************************************************************
        !            22: .\"
        !            23: .TH CURLOPT_SSH_KEYDATA 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_SSH_KEYDATA \- pointer to pass to the SSH key callback
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_KEYDATA, void *pointer);
        !            31: .SH DESCRIPTION
        !            32: Pass a void * as parameter. This \fIpointer\fP will be passed along verbatim
        !            33: to the callback set with \fICURLOPT_SSH_KEYFUNCTION(3)\fP.
        !            34: .SH DEFAULT
        !            35: NULL
        !            36: .SH PROTOCOLS
        !            37: SFTP and SCP
        !            38: .SH EXAMPLE
        !            39: .nf
        !            40: static int keycb(CURL *easy,
        !            41:                  const struct curl_khkey *knownkey,
        !            42:                  const struct curl_khkey *foundkey,
        !            43:                  enum curl_khmatch,
        !            44:                  void *clientp)
        !            45: {
        !            46:   /* 'clientp' points to the callback_data struct */
        !            47:   /* investigate the situation and return the correct value */
        !            48:   return CURLKHSTAT_FINE_ADD_TO_FILE;
        !            49: }
        !            50: {
        !            51:   curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/thisfile.txt");
        !            52:   curl_easy_setopt(curl, CURLOPT_SSH_KEYFUNCTION, keycb);
        !            53:   curl_easy_setopt(curl, CURLOPT_SSH_KEYDATA, &callback_data);
        !            54:   curl_easy_setopt(curl, CURLOPT_SSH_KNOWNHOSTS, "/home/user/known_hosts");
        !            55: 
        !            56:   curl_easy_perform(curl);
        !            57: }
        !            58: .fi
        !            59: .SH AVAILABILITY
        !            60: Added in 7.19.6
        !            61: .SH RETURN VALUE
        !            62: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            63: .SH "SEE ALSO"
        !            64: .BR CURLOPT_SSH_KEYDATA "(3), " CURLOPT_SSH_KNOWNHOSTS "(3), "