docs/libcurl/opts/CURLOPT_SSH_AUTH_TYPES.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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_AUTH_TYPES 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSH_AUTH_TYPES \- set desired auth types for SFTP and SCP
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_AUTH_TYPES, long bitmask);
  30 .SH DESCRIPTION
  31 Pass a long set to a bitmask consisting of one or more of
  32 CURLSSH_AUTH_PUBLICKEY, CURLSSH_AUTH_PASSWORD, CURLSSH_AUTH_HOST,
  33 CURLSSH_AUTH_KEYBOARD and CURLSSH_AUTH_AGENT.
  34
  35 Set \fICURLSSH_AUTH_ANY\fP to let libcurl pick a suitable one. Currently
  36 CURLSSH_AUTH_HOST has no effect. If CURLSSH_AUTH_AGENT is used, libcurl
  37 attempts to connect to ssh-agent or pageant and let the agent attempt the
  38 authentication.
  39 .SH DEFAULT
  40 None
  41 .SH PROTOCOLS
  42 SFTP and SCP
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 CURLSSH_AUTH_HOST was added in 7.16.1, CURLSSH_AUTH_AGENT was added in 7.28.0
  47 .SH RETURN VALUE
  48 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  49 .SH "SEE ALSO"
  50 .BR CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 "(3), " CURLOPT_SSH_PUBLIC_KEYFILE "(3), "