Artifactspublic-v0

curl

master
ply4 git calls351 ms288 KiB2 cachedprotocol v2
99 lines3.0 KiBRaw

NAME

CURLOPT_SOCKS5_AUTH - methods for SOCKS5 proxy authentication

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_AUTH, long bitmask);

DESCRIPTION

Pass a long as parameter, which is set to a bitmask, to tell libcurl which authentication method(s) are allowed for SOCKS5 proxy authentication. The only supported flags are CURLAUTH_BASIC, which allows username/password authentication, and CURLAUTH_GSSAPI, which allows GSS-API authentication. Set the actual username and password with the CURLOPT_PROXYUSERPWD(3) option.

libcurl offers the SOCKS5 "no authentication" method in addition to the ones in the bitmask, and accepts it if the proxy selects it. CURLAUTH_NONE is zero and therefore cannot be combined with the other flags; setting the bitmask to CURLAUTH_NONE makes libcurl offer only the no authentication method.

Add CURLAUTH_ONLY to the bitmask to require authentication. libcurl then does not offer the no authentication method, and rejects it with CURLE_PROXY if the proxy selects it anyway. A connection that was set up without SOCKS5 authentication is also not reused for such a transfer. Setting CURLAUTH_ONLY without CURLAUTH_BASIC or CURLAUTH_GSSAPI makes curl_easy_setopt(3) return CURLE_BAD_FUNCTION_ARGUMENT.

The specific socks authentication method is an access property, it does not change the security context. This means that this option changes how the connection and access to the proxy happens when a connection is setup, but it does not affect which proxy connections libcurl can reuse. libcurl may reuse a connection that was set up with a different socks authentication method. Proxy connection reuse still depends on other properties matching, such as the protocol, proxy hostname, port number, credentials and other settings that affect the connection.

DEFAULT

CURLAUTH_BASIC | CURLAUTH_GSSAPI

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    /* request to use a SOCKS5 proxy */
    curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://user:pass@myproxy.com");

    /* enable username/password authentication only */
    curl_easy_setopt(curl, CURLOPT_SOCKS5_AUTH, CURLAUTH_BASIC);

    /* Perform the request */
    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

HISTORY

CURLAUTH_* macros became long types in 7.26.0, prior to this version a long cast was necessary when passed to curl_easy_setopt(3).

CURLAUTH_ONLY is supported since 8.23.0.

%AVAILABILITY%

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_SOCKS5_AUTH
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_PROXY (3)
9 - CURLOPT_PROXYTYPE (3)
10Protocol:
11 - All
12Added-in: 7.55.0
13---
15# NAME
17CURLOPT_SOCKS5_AUTH - methods for SOCKS5 proxy authentication
19# SYNOPSIS
21~~~c
22#include <curl/curl.h>
24CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_AUTH, long bitmask);
25~~~
27# DESCRIPTION
29Pass a long as parameter, which is set to a bitmask, to tell libcurl which
30authentication method(s) are allowed for SOCKS5 proxy authentication. The only
31supported flags are *CURLAUTH_BASIC*, which allows username/password
32authentication, and *CURLAUTH_GSSAPI*, which allows GSS-API authentication.
33Set the actual username and password with the CURLOPT_PROXYUSERPWD(3) option.
35libcurl offers the SOCKS5 "no authentication" method in addition to the ones
36in the bitmask, and accepts it if the proxy selects it. *CURLAUTH_NONE* is zero
37and therefore cannot be combined with the other flags; setting the bitmask to
38*CURLAUTH_NONE* makes libcurl offer only the no authentication method.
40Add *CURLAUTH_ONLY* to the bitmask to require authentication. libcurl then does
41not offer the no authentication method, and rejects it with *CURLE_PROXY* if
42the proxy selects it anyway. A connection that was set up without SOCKS5
43authentication is also not reused for such a transfer. Setting *CURLAUTH_ONLY*
44without *CURLAUTH_BASIC* or *CURLAUTH_GSSAPI* makes curl_easy_setopt(3) return
45*CURLE_BAD_FUNCTION_ARGUMENT*.
47The specific socks authentication method is an *access property*, it does not
48change the security context. This means that this option changes how the
49connection and access to the proxy happens when a connection is setup, but it
50does not affect which proxy connections libcurl can reuse. libcurl may reuse a
51connection that was set up with a different socks authentication method. Proxy
52connection reuse still depends on other properties matching, such as the
53protocol, proxy hostname, port number, credentials and other settings that
54affect the connection.
56# DEFAULT
58CURLAUTH_BASIC | CURLAUTH_GSSAPI
60# %PROTOCOLS%
62# EXAMPLE
64~~~c
65int main(void)
67 CURL *curl = curl_easy_init();
68 if(curl) {
69 CURLcode result;
70 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
72 /* request to use a SOCKS5 proxy */
73 curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://user:pass@myproxy.com");
75 /* enable username/password authentication only */
76 curl_easy_setopt(curl, CURLOPT_SOCKS5_AUTH, CURLAUTH_BASIC);
78 /* Perform the request */
79 result = curl_easy_perform(curl);
80 curl_easy_cleanup(curl);
81 }
83~~~
85# HISTORY
87**CURLAUTH_*** macros became `long` types in 7.26.0, prior to this version
88a `long` cast was necessary when passed to curl_easy_setopt(3).
90*CURLAUTH_ONLY* is supported since 8.23.0.
92# %AVAILABILITY%
94# RETURN VALUE
96curl_easy_setopt(3) returns a CURLcode indicating success or error.
98CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
99libcurl-errors(3).
Diagnostics4 git calls · 351 ms
CallStatusSizeTime0351 ms
discover200152 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
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 · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=345
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=3
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 KiB345 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1482
git.response.cache=MISS
git.response.duration_ms=345
git.fetch.wants=a1dcc1db8f0247d1c6a6ab4db037e925ac0f2d98
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=1482
git.pkt.payload.max=1461
git.sideband.band1.bytes=1460
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
a5e387ba99aba691
Request
20e885da…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format