GNURLOPT_HTTPPROXYTUNNEL(3)

🦋 GNURLOPT_HTTPPROXYTUNNEL 🦋

okay bestie, welcome to the GNURLOPT_HTTPPROXYTUNNEL(3) page — yep, it's chilling in the curl_easy_setopt options manual, and it's all about tunneling through an HTTP proxy. no cap. 💅

🎀 NAME 🎀

CURLOPT_HTTPPROXYTUNNEL — tunnel through HTTP proxy ✨

🌸 SYNOPSIS 🌸

#include <gnurl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPROXYTUNNEL, long tunnel);

💖 DESCRIPTION 💖

Set the tunnel parameter to 1L and libcurl will tunnel all operations through the HTTP proxy (the one you set with CURLOPT_PROXY(3)). There is a big difference between using a proxy and tunneling through it — like, not the same vibe at all. 🫶

Tunneling means an HTTP CONNECT request is sent to the proxy, asking it to connect to a remote host on a specific port number, and then the traffic is just passed through the proxy. Proxies tend to white-list specific port numbers they allow CONNECT requests to, and often only port 80 and 443 are allowed. 🙈

To suppress proxy CONNECT response headers from user callbacks, use CURLOPT_SUPPRESS_CONNECT_HEADERS(3). 💌

HTTP proxies can generally only speak HTTP (for obvious reasons), which makes libcurl convert non-HTTP requests to HTTP when using an HTTP proxy without this tunnel option set. For example, asking for an FTP URL and specifying an HTTP proxy will make libcurl send an FTP URL in an HTTP GET request to the proxy. By instead tunneling through the proxy, you avoid that conversion (that rarely works through the proxy anyway). 😭

🍓 DEFAULT 🍓

0 — yeah bestie, it's off unless you turn it on. 💀

🌈 PROTOCOLS 🌈

All network protocols ✨

🧚 EXAMPLE 🧚

CURL *curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
  curl_easy_setopt(curl, CURLOPT_PROXY, "http://127.0.0.1:80");
  curl_easy_setopt(curl, CURLOPT_HTTPPROXYTUNNEL, 1L);
  curl_easy_perform(curl);
}

👑 AVAILABILITY 👑

Always — iconic behavior, honestly. ⭐

💜 RETURN VALUE 💜

Returns CURLE_OK 🎀

🔥 SEE ALSO 🔥

go peek at CURLOPT_PROXY(3), CURLOPT_PROXYTYPE(3), CURLOPT_PROXYPORT(3), 💖

---

mwah 💋 — signed off by source/version libcurl 7.37.0, date 17 Jun 2014, page GNURLOPT_HTTPPROXYTUNNEL(3). slay. 🎀