Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSH_AUTH_TYPES.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 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_AUTH_TYPES 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_SSH_AUTH_TYPES \- set desired auth types for SFTP and SCP
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_AUTH_TYPES, long bitmask);
31: .SH DESCRIPTION
32: Pass a long set to a bitmask consisting of one or more of
33: CURLSSH_AUTH_PUBLICKEY, CURLSSH_AUTH_PASSWORD, CURLSSH_AUTH_HOST,
34: CURLSSH_AUTH_KEYBOARD and CURLSSH_AUTH_AGENT.
35:
36: Set \fICURLSSH_AUTH_ANY\fP to let libcurl pick a suitable one. Currently
37: CURLSSH_AUTH_HOST has no effect. If CURLSSH_AUTH_AGENT is used, libcurl
38: attempts to connect to ssh-agent or pageant and let the agent attempt the
39: authentication.
40: .SH DEFAULT
41: None
42: .SH PROTOCOLS
43: SFTP and SCP
44: .SH EXAMPLE
45: .nf
46: CURL *curl = curl_easy_init();
47: if(curl) {
48: curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
49: curl_easy_setopt(curl, CURLOPT_SSH_AUTH_TYPES,
50: CURLSSH_AUTH_PUBLICKEY | CURLSSH_AUTH_KEYBOARD);
51: ret = curl_easy_perform(curl);
52: curl_easy_cleanup(curl);
53: }
54: .fi
55: .SH AVAILABILITY
56: CURLSSH_AUTH_HOST was added in 7.16.1, CURLSSH_AUTH_AGENT was added in 7.28.0
57: .SH RETURN VALUE
58: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
59: .SH "SEE ALSO"
60: .BR CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 "(3), " CURLOPT_SSH_PUBLIC_KEYFILE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>