Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_SSH_PRIVATE_KEYFILE (3)

Name

CURLOPT_SSH_PRIVATE_KEYFILE - set private key file for SSH auth

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE,
char *filename);

Description

curl_easy_setopt options                        CURLOPT_SSH_PRIVATE_KEYFILE(3)



NAME
       CURLOPT_SSH_PRIVATE_KEYFILE - set private key file for SSH auth

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE,
                                 char *filename);

DESCRIPTION
       Pass a char * pointing to a filename for your private key. If not used,
       libcurl defaults to $HOME/.ssh/id_dsa if the HOME environment  variable
       is set, and just "id_dsa" in the current directory if HOME is not set.

       If  the  file is password-protected, set the password with CURLOPT_KEY-
       PASSWD(3).

       The application does not have to keep the string around  after  setting
       this option.

DEFAULT
       As explained above

PROTOCOLS
       SFTP and SCP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
         curl_easy_setopt(curl, CURLOPT_SSH_PRIVATE_KEYFILE,
                          "/home/clarkkent/.ssh/id_rsa");
         curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "password");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.16.1

RETURN VALUE
       Returns  CURLE_OK  if  the option is supported, CURLE_UNKNOWN_OPTION if
       not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_SSH_PUBLIC_KEYFILE(3), CURLOPT_SSH_AUTH_TYPES(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014
                                                CURLOPT_SSH_PRIVATE_KEYFILE(3)