1
0
mirror of https://github.com/moparisthebest/curl synced 2024-11-10 11:35:07 -05:00
curl/docs
Alex Rousskov cb4e2be7c6 proxy: Support HTTPS proxy and SOCKS+HTTP(s)
* HTTPS proxies:

An HTTPS proxy receives all transactions over an SSL/TLS connection.
Once a secure connection with the proxy is established, the user agent
uses the proxy as usual, including sending CONNECT requests to instruct
the proxy to establish a [usually secure] TCP tunnel with an origin
server. HTTPS proxies protect nearly all aspects of user-proxy
communications as opposed to HTTP proxies that receive all requests
(including CONNECT requests) in vulnerable clear text.

With HTTPS proxies, it is possible to have two concurrent _nested_
SSL/TLS sessions: the "outer" one between the user agent and the proxy
and the "inner" one between the user agent and the origin server
(through the proxy). This change adds supports for such nested sessions
as well.

A secure connection with a proxy requires its own set of the usual SSL
options (their actual descriptions differ and need polishing, see TODO):

  --proxy-cacert FILE        CA certificate to verify peer against
  --proxy-capath DIR         CA directory to verify peer against
  --proxy-cert CERT[:PASSWD] Client certificate file and password
  --proxy-cert-type TYPE     Certificate file type (DER/PEM/ENG)
  --proxy-ciphers LIST       SSL ciphers to use
  --proxy-crlfile FILE       Get a CRL list in PEM format from the file
  --proxy-insecure           Allow connections to proxies with bad certs
  --proxy-key KEY            Private key file name
  --proxy-key-type TYPE      Private key file type (DER/PEM/ENG)
  --proxy-pass PASS          Pass phrase for the private key
  --proxy-ssl-allow-beast    Allow security flaw to improve interop
  --proxy-sslv2              Use SSLv2
  --proxy-sslv3              Use SSLv3
  --proxy-tlsv1              Use TLSv1
  --proxy-tlsuser USER       TLS username
  --proxy-tlspassword STRING TLS password
  --proxy-tlsauthtype STRING TLS authentication type (default SRP)

All --proxy-foo options are independent from their --foo counterparts,
except --proxy-crlfile which defaults to --crlfile and --proxy-capath
which defaults to --capath.

Curl now also supports %{proxy_ssl_verify_result} --write-out variable,
similar to the existing %{ssl_verify_result} variable.

Supported backends: OpenSSL, GnuTLS, and NSS.

* A SOCKS proxy + HTTP/HTTPS proxy combination:

If both --socks* and --proxy options are given, Curl first connects to
the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS
proxy.

TODO: Update documentation for the new APIs and --proxy-* options.
Look for "Added in 7.XXX" marks.
2016-11-24 23:41:44 +01:00
..
cmdline-opts cmdline-docs: more conversion 2016-11-16 15:15:57 +01:00
examples examples/fileupload.c: fclose the file as well 2016-11-08 23:00:43 +01:00
libcurl proxy: Support HTTPS proxy and SOCKS+HTTP(s) 2016-11-24 23:41:44 +01:00
.gitignore IGNORE: files generated by maketgz 2010-04-14 17:34:57 +02:00
BINDINGS.md docs: Spelling fixes 2016-11-15 15:41:45 +01:00
BUGS URLs: follow GitHub project rename (also Travis CI) 2016-02-04 23:01:38 +01:00
CHECKSRC.md docs: Spelling fixes 2016-11-15 15:41:45 +01:00
CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md: added 2015-06-29 11:35:13 +02:00
CODE_STYLE.md CODE_STYLE.md: link to INTERNALS.md correctly 2016-11-09 09:56:13 +01:00
CONTRIBUTE.md s/cURL/curl 2016-10-18 13:59:54 +02:00
curl-config.1 URLs: change all http:// URLs to https:// 2016-02-03 00:19:02 +01:00
curl.1 proxy: Support HTTPS proxy and SOCKS+HTTP(s) 2016-11-24 23:41:44 +01:00
FAQ s/cURL/curl 2016-10-18 13:59:54 +02:00
FEATURES mbedtls: Added support for NTLM 2016-08-03 19:33:59 +01:00
HISTORY.md s/cURL/curl 2016-11-07 10:36:23 +01:00
HTTP2.md docs: Spelling fixes 2016-11-15 15:41:45 +01:00
HTTP-COOKIES.md docs/HTTP-COOKIES: converted to markdown 2016-03-29 08:53:40 +02:00
index.html added doctype tag to get HTML compliant 2004-04-27 07:05:22 +00:00
INSTALL INSTALL: converted to markdown => INSTALL.md 2016-10-21 15:57:29 +02:00
INSTALL.cmake cmake: enable IPv6 by default if available 2014-10-13 11:21:03 +02:00
INSTALL.md INSTALL.md: Updated minimum file sizes for 7.50.3 2016-10-23 22:42:19 +02:00
INTERNALS.md docs: Spelling fixes 2016-11-15 15:41:45 +01:00
KNOWN_BUGS KNOWN_BUGS: HTTP/2 server push enabled when no pushes can be accepted 2016-10-27 23:47:59 +02:00
LICENSE-MIXING.md docs: Spelling fixes 2016-11-15 15:41:45 +01:00
MAIL-ETIQUETTE s/cURL/curl 2016-10-18 13:59:54 +02:00
Makefile.am BINDINGS: converted to markdown 2016-10-28 09:54:39 +02:00
MANUAL MANUAL: Remove invalid link to LDAP documentation (#962) 2016-08-13 14:38:09 +02:00
mk-ca-bundle.1 mk-ca-bundle.1: document -k 2016-10-24 10:24:27 +02:00
README.cmake removed execute file permission 2011-12-30 03:53:25 +01:00
README.md docs/README.md: to render nicer pages on github 2016-06-28 14:09:51 +02:00
README.netware docs: fixed a bunch of typos 2014-03-14 23:38:00 +01:00
README.win32 removed trailing whitespace 2010-02-14 19:40:18 +00:00
RELEASE-PROCEDURE RELEASE-PROCEDURE: Added some more future release dates 2016-08-17 23:25:04 +01:00
RESOURCES HTTPS: update a bunch of URLs from HTTP to HTTPS 2016-02-02 00:24:30 +01:00
ROADMAP.md ROADMAP: QUIC and TLS 1.3 2016-07-19 23:10:39 +02:00
SECURITY.md docs: Spelling fixes 2016-11-15 15:41:45 +01:00
SSL-PROBLEMS.md docs-make: have markdown files use .md 2016-08-09 14:47:20 +02:00
SSLCERTS.md SSLCERTS.md: renamed to markdown extension 2016-08-09 12:03:46 +02:00
THANKS THANKS: synced with 7.51.0 2016-11-02 07:34:06 +01:00
THANKS-filter RELEASE-NOTES: 7.51.0 2016-11-02 07:34:06 +01:00
TheArtOfHttpScripting s/cURL/curl 2016-11-07 10:36:23 +01:00
TODO http2: Use huge HTTP/2 windows 2016-11-16 17:35:11 -05:00
VERSIONS VERSIONS: now using markdown 2015-06-10 00:21:06 +02:00

curl logo

Documentation

You'll find a mix of various documentation in this directory and subdirectories, using several different formats. Some of them are not ideally for reading directly in your browser.

If you rather see the rendered version of the documentation, check out the curl web site's documentation section for general curl stuff or the libcurl section for libcurl related documentation.