Artifactspublic-v0

curl

master
ply4 git calls607 ms288 KiB2 cachedprotocol v2
97 lines2.6 KiBRaw

NAME

CURLOPT_PROTOCOLS_STR - allowed protocols

SYNOPSIS

c
#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, MQTT, MQTTS, POP3, POP3S, RTSP, SCP, SFTP, SMTP, SMTPS, TELNET, TFTP, WS, WSS

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.

Using this option multiple times makes the last set string override the previous ones. Set it to NULL to restore to the internal default.

DEFAULT

All protocols built-in

%PROTOCOLS%

EXAMPLE

c
int main(int argc, char *argv[])
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    /* 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 */
    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

HISTORY

RTMP and its related protocol schemes are not supported since curl 8.20.0

SMB and SMBS were removed in curl 8.23.0

%AVAILABILITY%

RETURN VALUE

Returns CURLE_UNKNOWN_OPTION if the option is not implemented, CURLE_UNSUPPORTED_PROTOCOL if a listed protocol is not supported or disabled, CURLE_BAD_FUNCTION_ARGUMENT if no protocol is listed else CURLE_OK.

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_PROTOCOLS_STR
5Section: 3
6Source: libcurl
7See-also:
8 - CURLINFO_SCHEME (3)
9 - CURLOPT_DEFAULT_PROTOCOL (3)
10 - CURLOPT_REDIR_PROTOCOLS_STR (3)
11 - CURLOPT_URL (3)
12 - curl_version_info (3)
13Protocol:
14 - All
15Added-in: 7.85.0
16---
18# NAME
20CURLOPT_PROTOCOLS_STR - allowed protocols
22# SYNOPSIS
24~~~c
25#include <curl/curl.h>
27CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROTOCOLS_STR, char *spec);
28~~~
30# DESCRIPTION
32Pass a pointer to a string that holds a comma-separated list of case
33insensitive protocol names (URL schemes) to allow in the transfer. This
34option allows applications to use libcurl built to support a wide range of
35protocols but still limit specific transfers to only be allowed to use a
36subset of them. By default, libcurl accepts all protocols it was built with
37support for. See also CURLOPT_REDIR_PROTOCOLS_STR(3).
39If trying to set a non-existing protocol or if no matching protocol at all is
40set, it returns error.
42These are the available protocols:
44DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS,
45MQTT, MQTTS, POP3, POP3S, RTSP, SCP, SFTP, SMTP, SMTPS, TELNET, TFTP, WS, WSS
47You can set "ALL" as a short-cut to enable all protocols. Note that by setting
48all, you may enable protocols that were not supported the day you write this
49but are introduced in a future libcurl version.
51curl_version_info(3) can be used to get a list of all supported protocols in
52the current libcurl. CURLINFO_SCHEME(3) is the recommended way to figure out
53the protocol used in a previous transfer.
55Using this option multiple times makes the last set string override the
56previous ones. Set it to NULL to restore to the internal default.
58# DEFAULT
60All protocols built-in
62# %PROTOCOLS%
64# EXAMPLE
66~~~c
67int main(int argc, char *argv[])
69 CURL *curl = curl_easy_init();
70 if(curl) {
71 CURLcode result;
72 /* pass in the URL from an external source */
73 curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
75 /* only allow HTTP, TFTP and SFTP */
76 curl_easy_setopt(curl, CURLOPT_PROTOCOLS_STR, "http,tftp,sftp");
78 /* Perform the request */
79 result = curl_easy_perform(curl);
80 curl_easy_cleanup(curl);
81 }
83~~~
85# HISTORY
87RTMP and its related protocol schemes are not supported since curl 8.20.0
89SMB and SMBS were removed in curl 8.23.0
91# %AVAILABILITY%
93# RETURN VALUE
95Returns CURLE_UNKNOWN_OPTION if the option is not implemented,
96CURLE_UNSUPPORTED_PROTOCOL if a listed protocol is not supported or disabled,
97CURLE_BAD_FUNCTION_ARGUMENT if no protocol is listed else CURLE_OK.
Diagnostics4 git calls · 607 ms
CallStatusSizeTime0607 ms
discover200152 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=2
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit16 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=16
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2001.4 KiB589 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=589
git.response.bytes=1421
git.response.cache=MISS
git.response.duration_ms=589
git.fetch.wants=6986b8566733bc7d98948e6afb15aa33d3f9e583
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1421
git.pkt.payload.max=1400
git.sideband.band1.bytes=1399
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e33ecf39fabe76
Request
d675f6a9…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format