mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
47 lines
1.4 KiB
Groff
47 lines
1.4 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_SSH_AUTH_TYPES.md
|
|
.TH CURLOPT_SSH_AUTH_TYPES 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_SSH_AUTH_TYPES \- auth types for SFTP and SCP
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_AUTH_TYPES, long bitmask);
|
|
.fi
|
|
.SH 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 \fICURLSSH_AUTH_ANY\fP 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.
|
|
.SH DEFAULT
|
|
CURLSSH_AUTH_ANY (all available)
|
|
.SH PROTOCOLS
|
|
SCP and SFTP
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
|
|
curl_easy_setopt(curl, CURLOPT_SSH_AUTH_TYPES,
|
|
CURLSSH_AUTH_PUBLICKEY | CURLSSH_AUTH_KEYBOARD);
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
CURLSSH_AUTH_HOST was added in 7.16.1, CURLSSH_AUTH_AGENT was added in 7.28.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 (3),
|
|
.BR CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 (3),
|
|
.BR CURLOPT_SSH_PUBLIC_KEYFILE (3)
|