CURLOPT_PROTOCOLS_STR - Man Page

allowed protocols

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROTOCOLS_STR, char *spec);

Description

Pass a pointer to a string that holds a comma-separated list of case insensitive protocol names (URL schemes) to allow in the transfer. This option allows applications to use libcurl built to support a wide range of protocols but still limit specific transfers to only be allowed to use a subset of them. By default, libcurl accepts all protocols it was built with support for. See also CURLOPT_REDIR_PROTOCOLS_STR(3).

If trying to set a non-existing protocol or if no matching protocol at all is set, it returns error.

These are the available protocols:

DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, POP3, POP3S, RTMP, RTMPE, RTMPS, RTMPT, RTMPTE, RTMPTS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP

You can set "ALL" as a short-cut to enable all protocols. Note that by setting all, you may enable protocols that were not supported the day you write this but are introduced in a future libcurl version.

curl_version_info(3) can be used to get a list of all supported protocols in the current libcurl. CURLINFO_SCHEME(3) is the recommended way to figure out the protocol used in a previous transfer.

Default

All protocols built-in

Protocols

All

Example

curl = curl_easy_init();
if(curl) {
  /* pass in the URL from an external source */
  curl_easy_setopt(curl, CURLOPT_URL, argv[1]);

  /* only allow HTTP, TFTP and SFTP */
  curl_easy_setopt(curl, CURLOPT_PROTOCOLS_STR, "http,tftp,sftp");

  /* Perform the request */
  curl_easy_perform(curl);
}

Availability

Added in 7.85.0

Return Value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

See Also

CURLOPT_REDIR_PROTOCOLS_STR(3), CURLOPT_URL(3), curl_version_info(3), CURLINFO_SCHEME(3),

Referenced By

curl_easy_setopt(3), CURLOPT_PROTOCOLS(3), CURLOPT_REDIR_PROTOCOLS_STR(3).

June 13, 2022 libcurl 7.85.0 curl_easy_setopt options