Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_SSH_AUTH_TYPES (3)

Name

CURLOPT_SSH_AUTH_TYPES - set desired auth types for SFTP and SCP

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_SSH_AUTH_TYPES, long
bitmask);

Description

CURLOPT_SSH_AUTH_TYPES(3)  curl_easy_setopt options  CURLOPT_SSH_AUTH_TYPES(3)



NAME
       CURLOPT_SSH_AUTH_TYPES - set desired auth types for SFTP and SCP

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_SSH_AUTH_TYPES, long
       bitmask);

DESCRIPTION
       Pass  a  long  set  to  a  bitmask  consisting  of  one  or   more   of
       CURLSSH_AUTH_PUBLICKEY,    CURLSSH_AUTH_PASSWORD,    CURLSSH_AUTH_HOST,
       CURLSSH_AUTH_KEYBOARD and CURLSSH_AUTH_AGENT.

       Set CURLSSH_AUTH_ANY to let libcurl  pick  a  suitable  one.  Currently
       CURLSSH_AUTH_HOST has no effect. If CURLSSH_AUTH_AGENT is used, libcurl
       attempts to connect to ssh-agent or pageant and let the  agent  attempt
       the authentication.

DEFAULT
       None

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_AUTH_TYPES,
                          CURLSSH_AUTH_PUBLICKEY | CURLSSH_AUTH_KEYBOARD);
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       CURLSSH_AUTH_HOST  was added in 7.16.1, CURLSSH_AUTH_AGENT was added in
       7.28.0

RETURN VALUE
       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
       if not.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3), CURLOPT_SSH_PUBLIC_KEYFILE(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_AUTH_TYPES(3)