[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] [gnurl] 139/254: CURLOPT_HTTPPROXYTUNNEL: clarify, add exam
From: |
gnunet |
Subject: |
[GNUnet-SVN] [gnurl] 139/254: CURLOPT_HTTPPROXYTUNNEL: clarify, add example |
Date: |
Sat, 17 Jun 2017 16:52:51 +0200 |
This is an automated email from the git hooks/post-receive script.
ng0 pushed a commit to annotated tag gnurl-7.54.1
in repository gnurl.
commit e366ca2b85a78a0ad8d663534bd462e61ad407b5
Author: Daniel Stenberg <address@hidden>
AuthorDate: Mon May 15 10:11:23 2017 +0200
CURLOPT_HTTPPROXYTUNNEL: clarify, add example
---
docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.3 | 35 +++++++++++++++++++----------
1 file changed, 23 insertions(+), 12 deletions(-)
diff --git a/docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.3
b/docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.3
index bdd04dfff..5ded4d27a 100644
--- a/docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.3
+++ b/docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <address@hidden>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -28,27 +28,38 @@ CURLOPT_HTTPPROXYTUNNEL \- tunnel through HTTP proxy
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPROXYTUNNEL, long tunnel);
.SH DESCRIPTION
-Set the parameter to 1 to make libcurl tunnel all operations through the HTTP
-proxy. There is a big difference between using a proxy and to tunnel through
-it. If you don't know what this means, you probably don't want this tunneling
-option.
+Set the \fBtunnel\fP parameter to 1L to make libcurl tunnel all operations
+through the HTTP proxy (set with \fICURLOPT_PROXY(3)\fP). There is a big
+difference between using a proxy and to tunnel through it.
-Tunneling essentially means that a CONNECT 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 whitelist specific port numbers
+Tunneling means that a 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
it allows CONNECT requests to and often only port 80 and 443 are allowed.
-When using this, it only makes sense to use \fICURLOPT_PROXYTYPE(3)\fP set to
-a HTTP proxy.
-
To suppress proxy CONNECT response headers from user callbacks use
\fICURLOPT_SUPPRESS_CONNECT_HEADERS(3)\fP.
+
+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 a HTTP GET request to the
+proxy. By instead tunneling through the proxy, you avoid that conversion (that
+rarely works through the proxy anyway).
.SH DEFAULT
0
.SH PROTOCOLS
All network protocols
.SH EXAMPLE
-TODO
+.nf
+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);
+}
+.fi
.SH AVAILABILITY
Always
.SH RETURN VALUE
--
To stop receiving notification emails like this one, please contact
address@hidden
- [GNUnet-SVN] [gnurl] 111/254: curl.1: depend the build on the Makefile.inc too, (continued)
- [GNUnet-SVN] [gnurl] 111/254: curl.1: depend the build on the Makefile.inc too, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 198/254: curl-compilers.m4: fix compiler_num for clang, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 100/254: curl: remove tool_writeenv.[ch], gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 129/254: mbedtls: Support server renegotiation request, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 157/254: cmake: auto detection of CURL_CA_BUNDLE/CURL_CA_PATH, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 180/254: test557: fix ubsan runtime error due to int left shift, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 213/254: cyassl: define build macros before including ssl.h, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 46/254: examples: fixed too long line and too long string warnings, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 203/254: build: provide easy code coverage measuring, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 248/254: configure: update the copyright year in the output, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 139/254: CURLOPT_HTTPPROXYTUNNEL: clarify, add example,
gnunet <=
- [GNUnet-SVN] [gnurl] 67/254: buffer: use data->set.buffer_size instead of BUFSIZE, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 195/254: CURLOPT_SSH_KEY*.3: typos, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 192/254: CURLOPT_FNMATCH_DATA.3: modified example to avoid fcpp issues, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 140/254: docs/libcurl/opts: added more examples in man pages, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 171/254: ssh: fix 'left' may be used uninitialized, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 84/254: curl_setup_once: use SEND_QUAL_ARG2 for swrite, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 160/254: assert: avoid, use DEBUGASSERT instead!, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 209/254: MD(4|5): silence cast-align clang warning, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 187/254: curl-compilers.m4: enable -Wshift-sign-overflow for clang, gnunet, 2017/06/17
- [GNUnet-SVN] [gnurl] 247/254: BINDINGS: update SP-Forth and OCaml urls, gnunet, 2017/06/17