---
name: "CURLOPT_SSH_AUTH_TYPES"
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_AUTH_TYPES"
---

# CURLOPT\_SSH\_AUTH\_TYPES(3)

auth types for SFTP and SCP

## NAME

CURLOPT\_SSH\_AUTH\_TYPES - auth types for SFTP and SCP

## SYNOPSIS

```
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_AUTH_TYPES, long bitmask);
```

## 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 *CURLSSH\_AUTH\_ANY* 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.

## DEFAULT

CURLSSH\_AUTH\_ANY (all available)

## 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_AUTH_TYPES,
                     CURLSSH_AUTH_PUBLICKEY | CURLSSH_AUTH_KEYBOARD);
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}
```

## AVAILABILITY

CURLSSH\_AUTH\_HOST was added in 7.16.1, CURLSSH\_AUTH\_AGENT was added in 7.28.0

## RETURN VALUE

Returns CURLE\_OK if the option is supported, and CURLE\_UNKNOWN\_OPTION if not.

## SEE ALSO

[**CURLOPT\_SSH\_HOST\_PUBLIC\_KEY\_MD5**(3)](/CURLOPT_SSH_HOST_PUBLIC_KEY_MD5/3.md), [**CURLOPT\_SSH\_HOST\_PUBLIC\_KEY\_SHA256**(3)](/CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256/3.md), [**CURLOPT\_SSH\_PUBLIC\_KEYFILE**(3)](/CURLOPT_SSH_PUBLIC_KEYFILE/3.md)