---
name: "CURLOPT_SSH_PRIVATE_KEYFILE"
section: "3"
platform: "macos"
package: "curl"
version: "166.0.0.0.1"
release: "macOS 26.5"
platforms: ["linux", "macos"]
url: "https://new.carta.tech/CURLOPT_SSH_PRIVATE_KEYFILE"
---

# CURLOPT\_SSH\_PRIVATE\_KEYFILE(3)

private key file for SSH auth

## NAME

CURLOPT\_SSH\_PRIVATE\_KEYFILE - private key file for SSH auth

## SYNOPSIS

```
#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)](/CURLOPT_KEYPASSWD/3.md)*.

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)](/CURLOPT_SSH_PUBLIC_KEYFILE/3.md)*, the transfer fails.

The application does not have to keep the string around after setting this option.

## DEFAULT

As explained above

## PROTOCOLS

SFTP and SCP

## EXAMPLE

```
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);
  }
}
```

## AVAILABILITY

Added in 7.16.1

## 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.

## SEE ALSO

[**CURLOPT\_SSH\_AUTH\_TYPES**(3)](/CURLOPT_SSH_AUTH_TYPES/3.md), [**CURLOPT\_SSH\_PUBLIC\_KEYFILE**(3)](/CURLOPT_SSH_PUBLIC_KEYFILE/3.md)