Return to CURLOPT_SSH_PRIVATE_KEYFILE.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSH_PRIVATE_KEYFILE.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2014, 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_PRIVATE_KEYFILE 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_SSH_PRIVATE_KEYFILE \- set private key file for SSH auth
                     27: .SH SYNOPSIS
                     28: .nf
                     29: #include <curl/curl.h>
                     30: 
                     31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE,
                     32:                           char *filename);
                     33: .SH DESCRIPTION
                     34: Pass a char * pointing to a \fIfilename\fP for your private key. If not used,
                     35: libcurl defaults to \fB$HOME/.ssh/id_dsa\fP if the HOME environment variable
                     36: is set, and just "id_dsa" in the current directory if HOME is not set.
                     37: 
                     38: If the file is password-protected, set the password with
                     39: \fICURLOPT_KEYPASSWD(3)\fP.
                     40: 
                     41: The application does not have to keep the string around after setting this
                     42: option.
                     43: .SH DEFAULT
                     44: As explained above
                     45: .SH PROTOCOLS
                     46: SFTP and SCP
                     47: .SH EXAMPLE
                     48: .nf
                     49: CURL *curl = curl_easy_init();
                     50: if(curl) {
                     51:   curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
                     52:   curl_easy_setopt(curl, CURLOPT_SSH_PRIVATE_KEYFILE,
                     53:                    "/home/clarkkent/.ssh/id_rsa");
                     54:   curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "password");
                     55:   ret = curl_easy_perform(curl);
                     56:   curl_easy_cleanup(curl);
                     57: }
                     58: .fi
                     59: .SH AVAILABILITY
                     60: Added in 7.16.1
                     61: .SH RETURN VALUE
                     62: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
                     63: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
                     64: .SH "SEE ALSO"
                     65: .BR CURLOPT_SSH_PUBLIC_KEYFILE "(3), " CURLOPT_SSH_AUTH_TYPES "(3), "