mirror of
https://github.com/curl/curl.git
synced 2026-08-06 02:46:13 +03:00
8c1d9378ac
- generate AVAILABILITY manpage sections automatically - for consistent wording - allows us to double-check against other documumentation (symbols-in-versions etc) - enables proper automation/scripting based on this data - lots of them were wrong or missing in the manpages - several of them repeated (sometimes mismatching) backend support info Add test 1488 to verify "added-in" version numbers against symbols-in-versions. Closes #14217
72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_SSH_PRIVATE_KEYFILE
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_SSH_AUTH_TYPES (3)
|
|
- CURLOPT_SSH_PUBLIC_KEYFILE (3)
|
|
Protocol:
|
|
- SFTP
|
|
- SCP
|
|
Added-in: 7.16.1
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_SSH_PRIVATE_KEYFILE - private key file for SSH auth
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE,
|
|
char *filename);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a char pointer pointing to a *filename* for your private key. If not
|
|
used, libcurl defaults to **$HOME/.ssh/id_rsa** or **$HOME/.ssh/id_dsa** if
|
|
the HOME environment variable is set, and in the current directory if HOME is
|
|
not set.
|
|
|
|
If the file is password-protected, set the password with
|
|
CURLOPT_KEYPASSWD(3).
|
|
|
|
The SSH library derives the public key from this private key when possible. If
|
|
the SSH library cannot derive the public key from the private one and no
|
|
public one is provided with CURLOPT_SSH_PUBLIC_KEYFILE(3), the transfer
|
|
fails.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
# DEFAULT
|
|
|
|
As explained above
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
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_PRIVATE_KEYFILE,
|
|
"/home/clarkkent/.ssh/id_rsa");
|
|
curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "password");
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# 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.
|