Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_SSH_KNOWNHOSTS (3)

Name

CURLOPT_SSH_KNOWNHOSTS - file name holding the SSH known hosts

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_SSH_KNOWNHOSTS, char
*fname);

Description

CURLOPT_SSH_KNOWNHOSTS(3)  curl_easy_setopt options  CURLOPT_SSH_KNOWNHOSTS(3)



NAME
       CURLOPT_SSH_KNOWNHOSTS - file name holding the SSH known hosts

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_SSH_KNOWNHOSTS, char
       *fname);

DESCRIPTION
       Pass a pointer to a zero terminated string holding the file name of the
       known_host  file  to  use.  The known_hosts file should use the OpenSSH
       file format as supported by libssh2. If this file is specified, libcurl
       will  only  accept connections with hosts that are known and present in
       that file, with a matching public key.  Use  CURLOPT_SSH_KEYFUNCTION(3)
       to alter the default behavior on host and key (mis)matching.

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

DEFAULT
       NULL

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_KNOWNHOSTS,
                          "/home/clarkkent/.ssh/known_hosts");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.19.6

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_AUTH_TYPES(3), CURLOPT_SSH_HOST_PUBLIC_KEY_MD5(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_KNOWNHOSTS(3)