mirror of
https://github.com/curl/curl.git
synced 2024-11-21 01:16:58 +08:00
HTTPS-PROXY docs: update/polish
This commit is contained in:
Daniel Stenberg
parent
7ebd9bcfc6
commit
b0fcb92f80
@ -22,23 +22,22 @@
|
||||
.\"
|
||||
.TH CURLINFO_PROXY_SSL_VERIFYRESULT 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_getinfo options"
|
||||
.SH NAME
|
||||
CURLINFO_PROXY_SSL_VERIFYRESULT \- get the result of the proxy certification verification
|
||||
CURLINFO_PROXY_SSL_VERIFYRESULT \- get the result of the proxy certificate verification
|
||||
.SH SYNOPSIS
|
||||
#include <curl/curl.h>
|
||||
|
||||
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROXY_SSL_VERIFYRESULT, long *result);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a pointer to a long to receive the result of the certification
|
||||
verification that was requested (using the \fICURLOPT_SSL_VERIFYPEER(3)\fP
|
||||
option.
|
||||
Pass a pointer to a long to receive the result of the certificate verification
|
||||
that was requested (using the \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP option.
|
||||
.SH PROTOCOLS
|
||||
All using TLS
|
||||
All
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH AVAILABILITY
|
||||
Added in 7.5
|
||||
Added in 7.52.0
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||||
.SH "SEE ALSO"
|
||||
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
|
||||
.BR CURLINFO_SSL_VERIFYRESULT "(3), "
|
||||
|
||||
@ -28,22 +28,20 @@ CURLOPT_PROXY_CAPATH \- specify directory holding proxy CA certificates
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAPATH, char *capath);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a char * to a zero terminated string naming a directory holding multiple
|
||||
CA certificates to verify the peer with. If libcurl is built against OpenSSL,
|
||||
the certificate directory must be prepared using the openssl c_rehash utility.
|
||||
This makes sense only when used in combination with the
|
||||
\fICURLOPT_SSL_VERIFYPEER(3)\fP option.
|
||||
|
||||
The \fICURLOPT_CAPATH(3)\fP function apparently does not work in Windows due
|
||||
to some limitation in openssl.
|
||||
CA certificates to verify the HTTPS proxy with. If libcurl is built against
|
||||
OpenSSL, the certificate directory must be prepared using the openssl c_rehash
|
||||
utility. This makes sense only when \fICURLOPT_SSL_VERIFYPEER(3)\fP is enabled
|
||||
(which it is by default).
|
||||
.SH DEFAULT
|
||||
NULL
|
||||
.SH PROTOCOLS
|
||||
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
||||
Everything used over an HTTPS proxy
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0
|
||||
|
||||
This option is supported by the OpenSSL, GnuTLS and PolarSSL backends. The NSS
|
||||
backend provides the option only for backward compatibility.
|
||||
.SH RETURN VALUE
|
||||
|
||||
@ -28,22 +28,25 @@ CURLOPT_PROXY_SSLCERTTYPE \- specify type of the proxy client SSL certificate
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERTTYPE, char *type);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a pointer to a zero terminated string as parameter. The string should be
|
||||
the format of your certificate. Supported formats are "PEM" and "DER", except
|
||||
with Secure Transport. OpenSSL (versions 0.9.3 and later) and Secure Transport
|
||||
(on iOS 5 or later, or OS X 10.7 or later) also support "P12" for
|
||||
PKCS#12-encoded files.
|
||||
the format of your client certificate used when connecting to a HTTPS proxy.
|
||||
|
||||
Supported formats are "PEM" and "DER", except with Secure Transport. OpenSSL
|
||||
(versions 0.9.3 and later) and Secure Transport (on iOS 5 or later, or OS X
|
||||
10.7 or later) also support "P12" for PKCS#12-encoded files.
|
||||
.SH DEFAULT
|
||||
"PEM"
|
||||
.SH PROTOCOLS
|
||||
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
||||
All
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0
|
||||
|
||||
If built TLS enabled.
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
|
||||
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_SSLCERT "(3), " CURLOPT_SSLKEY "(3), "
|
||||
.BR CURLOPT_PROXY_SSLCERT "(3), " CURLOPT_PROXY_SSLKEY "(3), "
|
||||
.BR CURLOPT_SSLCERTTYPE "(3), "
|
||||
|
||||
@ -28,10 +28,10 @@ CURLOPT_PROXY_SSLKEY \- specify private keyfile for TLS and SSL proxy client cer
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEY, char *keyfile);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a pointer to a zero terminated string as parameter. The string should be
|
||||
the file name of your private key. The default format is "PEM" and can be
|
||||
changed with \fICURLOPT_SSLKEYTYPE(3)\fP.
|
||||
the file name of your private key used for connecting to the HTTPS proxy. The
|
||||
default format is "PEM" and can be changed with
|
||||
\fICURLOPT_PROXY_SSLKEYTYPE(3)\fP.
|
||||
|
||||
(iOS and Mac OS X only) This option is ignored if curl was built against
|
||||
Secure Transport. Secure Transport expects the private key to be already
|
||||
@ -39,13 +39,16 @@ present in the keychain or PKCS#12 file containing the certificate.
|
||||
.SH DEFAULT
|
||||
NULL
|
||||
.SH PROTOCOLS
|
||||
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
||||
All
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0
|
||||
|
||||
If built TLS enabled.
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
|
||||
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_PROXY_SSLKEYTYPE "(3), " CURLOPT_PROXY_SSLCERT "(3), "
|
||||
.BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "
|
||||
|
||||
@ -22,15 +22,14 @@
|
||||
.\"
|
||||
.TH CURLOPT_PROXY_SSLVERSION 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
|
||||
.SH NAME
|
||||
CURLOPT_PROXY_SSLVERSION \- set proxy preferred TLS/SSL version
|
||||
CURLOPT_PROXY_SSLVERSION \- set preferred proxy TLS/SSL version
|
||||
.SH SYNOPSIS
|
||||
#include <curl/curl.h>
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLVERSION, long version);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a long as parameter to control which version of SSL/TLS to attempt to
|
||||
use.
|
||||
Pass a long as parameter to control which version of SSL/TLS to attempt to use
|
||||
when connecting to an HTTPS proxy.
|
||||
|
||||
Use one of the available defines for this purpose. The available options are:
|
||||
.RS
|
||||
@ -39,23 +38,19 @@ The default action. This will attempt to figure out the remote SSL protocol
|
||||
version.
|
||||
.IP CURL_SSLVERSION_TLSv1
|
||||
TLSv1.x
|
||||
.IP CURL_SSLVERSION_SSLv2
|
||||
SSLv2
|
||||
.IP CURL_SSLVERSION_SSLv3
|
||||
SSLv3
|
||||
.IP CURL_SSLVERSION_TLSv1_0
|
||||
TLSv1.0 (Added in 7.34.0)
|
||||
TLSv1.0
|
||||
.IP CURL_SSLVERSION_TLSv1_1
|
||||
TLSv1.1 (Added in 7.34.0)
|
||||
TLSv1.1
|
||||
.IP CURL_SSLVERSION_TLSv1_2
|
||||
TLSv1.2 (Added in 7.34.0)
|
||||
TLSv1.2
|
||||
.IP CURL_SSLVERSION_TLSv1_3
|
||||
TLSv1.3 (Added in 7.52.0)
|
||||
TLSv1.3
|
||||
.RE
|
||||
.SH DEFAULT
|
||||
CURL_SSLVERSION_DEFAULT
|
||||
.SH PROTOCOLS
|
||||
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
||||
All
|
||||
.SH EXAMPLE
|
||||
.nf
|
||||
CURL *curl = curl_easy_init();
|
||||
@ -70,12 +65,10 @@ if(curl) {
|
||||
}
|
||||
.fi
|
||||
.SH AVAILABILITY
|
||||
SSLv2 is disabled by default since 7.18.1. Other SSL versions availability may
|
||||
vary depending on which backend libcurl has been built to use.
|
||||
|
||||
SSLv3 is disabled by default since 7.39.0.
|
||||
Added in 7.52.0
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_USE_SSL "(3), " CURLOPT_HTTP_VERSION "(3), "
|
||||
.BR CURLOPT_IPRESOLVE "(3) "
|
||||
.BR CURLOPT_IPRESOLVE "(3) " CURLOPT_SSLVERSION "(3), "
|
||||
|
||||
|
||||
@ -28,12 +28,11 @@ CURLOPT_PROXY_SSL_CIPHER_LIST \- specify ciphers to use for proxy TLS
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_CIPHER_LIST, char *list);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a char *, pointing to a zero terminated string holding the list of
|
||||
ciphers to use for the SSL connection. The list must be syntactically correct,
|
||||
it consists of one or more cipher strings separated by colons. Commas or
|
||||
spaces are also acceptable separators but colons are normally used, \&!, \&-
|
||||
and \&+ can be used as operators.
|
||||
ciphers to use for the connection to the HTTPS proxy. The list must be
|
||||
syntactically correct, it consists of one or more cipher strings separated by
|
||||
colons. Commas or spaces are also acceptable separators but colons are
|
||||
normally used, \&!, \&- and \&+ can be used as operators.
|
||||
|
||||
For OpenSSL and GnuTLS valid examples of cipher lists include 'RC4-SHA',
|
||||
\'SHA1+DES\', 'TLSv1' and 'DEFAULT'. The default list is normally set when you
|
||||
@ -54,13 +53,16 @@ You'll find more details about the NSS cipher lists on this URL:
|
||||
.SH DEFAULT
|
||||
NULL, use internal default
|
||||
.SH PROTOCOLS
|
||||
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
||||
All
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0
|
||||
|
||||
If built TLS enabled.
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
|
||||
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "
|
||||
.BR CURLOPT_PROXY_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "
|
||||
.BR CURLOPT_SSLVERSION "(3), "
|
||||
|
||||
@ -28,35 +28,34 @@ CURLOPT_PROXY_SSL_OPTIONS \- set proxy SSL behavior options
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_OPTIONS, long bitmask);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a long with a bitmask to tell libcurl about specific SSL behaviors.
|
||||
|
||||
\fICURLSSLOPT_ALLOW_BEAST\fP tells libcurl to not attempt to use any
|
||||
workarounds for a security flaw in the SSL3 and TLS1.0 protocols. If this
|
||||
option isn't used or this bit is set to 0, the SSL layer libcurl uses may use a
|
||||
work-around for this flaw although it might cause interoperability problems
|
||||
option isn't used or this bit is set to 0, the SSL layer libcurl uses may use
|
||||
a work-around for this flaw although it might cause interoperability problems
|
||||
with some (older) SSL implementations. WARNING: avoiding this work-around
|
||||
lessens the security, and by setting this option to 1 you ask for exactly that.
|
||||
This option is only supported for DarwinSSL, NSS and OpenSSL.
|
||||
|
||||
Added in 7.44.0:
|
||||
lessens the security, and by setting this option to 1 you ask for exactly
|
||||
that. This option is only supported for DarwinSSL, NSS and OpenSSL.
|
||||
|
||||
\fICURLSSLOPT_NO_REVOKE\fP tells libcurl to disable certificate revocation
|
||||
checks for those SSL backends where such behavior is present. \fBCurrently this
|
||||
option is only supported for WinSSL (the native Windows SSL library), with an
|
||||
exception in the case of Windows' Untrusted Publishers blacklist which it seems
|
||||
can't be bypassed.\fP This option may have broader support to accommodate other
|
||||
SSL backends in the future.
|
||||
checks for those SSL backends where such behavior is present. \fBCurrently
|
||||
this option is only supported for WinSSL (the native Windows SSL library),
|
||||
with an exception in the case of Windows' Untrusted Publishers blacklist which
|
||||
it seems can't be bypassed.\fP This option may have broader support to
|
||||
accommodate other SSL backends in the future.
|
||||
https://curl.haxx.se/docs/ssl-compared.html
|
||||
|
||||
|
||||
.SH DEFAULT
|
||||
0
|
||||
.SH PROTOCOLS
|
||||
All TLS-based protocols
|
||||
All
|
||||
.SH AVAILABLE
|
||||
Added in 7.52.0
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_PROXY_SSLVERSION "(3), " CURLOPT_PROXY_SSL_CIPHER_LIST "(3), "
|
||||
.BR CURLOPT_SSLVERSION "(3), " CURLOPT_SSL_CIPHER_LIST "(3), "
|
||||
|
||||
@ -28,44 +28,35 @@ CURLOPT_PROXY_SSL_VERIFYHOST \- verify the proxy certificate's name against host
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_VERIFYHOST, long verify);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a long as parameter specifying what to \fIverify\fP.
|
||||
Pass a long set to 2L as asking curl to \fIverify\fP in the HTTPS proxy's
|
||||
certificate name fields against the proxy name.
|
||||
|
||||
This option determines whether libcurl verifies that the server cert is for
|
||||
the server it is known as.
|
||||
This option determines whether libcurl verifies that the proxy cert contains
|
||||
the correct name for the name it is known as.
|
||||
|
||||
When negotiating TLS and SSL connections, the server sends a certificate
|
||||
indicating its identity.
|
||||
When \fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP is 2, the proxy certificate must
|
||||
indicate that the server is the proxy to which you meant to connect to, or the
|
||||
connection fails.
|
||||
|
||||
When \fICURLOPT_SSL_VERIFYHOST(3)\fP is 2, that certificate must indicate that
|
||||
the server is the server to which you meant to connect, or the connection
|
||||
fails. Simply put, it means it has to have the same name in the certificate as
|
||||
is in the URL you operate against.
|
||||
|
||||
Curl considers the server the intended one when the Common Name field or a
|
||||
Curl considers the proxy the intended one when the Common Name field or a
|
||||
Subject Alternate Name field in the certificate matches the host name in the
|
||||
URL to which you told Curl to connect.
|
||||
proxy string which you told curl to use.
|
||||
|
||||
When the \fIverify\fP value is 1, \fIcurl_easy_setopt\fP will return an error
|
||||
and the option value will not be changed. It was previously (in 7.28.0 and
|
||||
earlier) a debug option of some sorts, but it is no longer supported due to
|
||||
frequently leading to programmer mistakes. Future versions will stop returning
|
||||
an error for 1 and just treat 1 and 2 the same.
|
||||
When the \fIverify\fP value is 1L, \fIcurl_easy_setopt\fP will return an error
|
||||
and the option value will not be changed due to old legacy reasons.
|
||||
|
||||
When the \fIverify\fP value is 0, the connection succeeds regardless of the
|
||||
names in the certificate. Use that ability with caution!
|
||||
When the \fIverify\fP value is 0L, the connection succeeds regardless of the
|
||||
names used in the certificate. Use that ability with caution!
|
||||
|
||||
The default value for this option is 2.
|
||||
|
||||
This option controls checking the server's certificate's claimed identity.
|
||||
The server could be lying. To control lying, see
|
||||
\fICURLOPT_SSL_VERIFYPEER(3)\fP. If libcurl is built against NSS and
|
||||
\fICURLOPT_SSL_VERIFYPEER(3)\fP is zero, \fICURLOPT_SSL_VERIFYHOST(3)\fP is
|
||||
also set to zero and cannot be overridden.
|
||||
See also \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP to verify the digital signature
|
||||
of the proxy certificate. If libcurl is built against NSS and
|
||||
\fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is zero,
|
||||
\fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP is also set to zero and cannot be
|
||||
overridden.
|
||||
.SH DEFAULT
|
||||
2
|
||||
.SH PROTOCOLS
|
||||
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
||||
All protocols when used over a HTTPS proxy.
|
||||
.SH EXAMPLE
|
||||
.nf
|
||||
CURL *curl = curl_easy_init();
|
||||
@ -79,10 +70,13 @@ if(curl) {
|
||||
}
|
||||
.fi
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0.
|
||||
|
||||
If built TLS enabled.
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
|
||||
|
||||
If 1 is set as argument, \fICURLE_BAD_FUNCTION_ARGUMENT\fP is returned.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_CAINFO "(3), "
|
||||
.BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_CAINFO "(3), ",
|
||||
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_CAINFO "(3), ",
|
||||
|
||||
@ -22,36 +22,39 @@
|
||||
.\"
|
||||
.TH CURLOPT_PROXY_SSL_VERIFYPEER 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
|
||||
.SH NAME
|
||||
CURLOPT_PROXY_SSL_VERIFYPEER \- verify the proxy peer's SSL certificate
|
||||
CURLOPT_PROXY_SSL_VERIFYPEER \- verify the proxy's SSL certificate
|
||||
.SH SYNOPSIS
|
||||
#include <curl/curl.h>
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_VERIFYPEER, long verify);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a long as parameter to enable or disable.
|
||||
Pass a long as parameter set to 1L to enable or 0L to disable.
|
||||
|
||||
This option determines whether curl verifies the authenticity of the peer's
|
||||
This option tells curl to verifies the authenticity of the HTTPS proxy's
|
||||
certificate. A value of 1 means curl verifies; 0 (zero) means it doesn't.
|
||||
|
||||
This is the proxy version of \fICURLOPT_SSL_VERIFYPEER(3)\fP that's used for
|
||||
ordinary HTTPS servers.
|
||||
|
||||
When negotiating a TLS or SSL connection, the server sends a certificate
|
||||
indicating its identity. Curl verifies whether the certificate is authentic,
|
||||
indicating its identity. Curl verifies whether the certificate is authentic,
|
||||
i.e. that you can trust that the server is who the certificate says it is.
|
||||
This trust is based on a chain of digital signatures, rooted in certification
|
||||
authority (CA) certificates you supply. curl uses a default bundle of CA
|
||||
certificates (the path for that is determined at build time) and you can
|
||||
specify alternate certificates with the \fICURLOPT_CAINFO(3)\fP option or the
|
||||
\fICURLOPT_CAPATH(3)\fP option.
|
||||
specify alternate certificates with the \fICURLOPT_PROXY_CAINFO(3)\fP option
|
||||
or the \fICURLOPT_PROXY_CAPATH(3)\fP option.
|
||||
|
||||
When \fICURLOPT_SSL_VERIFYPEER(3)\fP is enabled, and the verification fails to
|
||||
prove that the certificate is authentic, the connection fails. When the
|
||||
option is zero, the peer certificate verification succeeds regardless.
|
||||
When \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is enabled, and the verification
|
||||
fails to prove that the certificate is authentic, the connection fails. When
|
||||
the option is zero, the peer certificate verification succeeds regardless.
|
||||
|
||||
Authenticating the certificate is not enough to be sure about the server. You
|
||||
typically also want to ensure that the server is the server you mean to be
|
||||
talking to. Use \fICURLOPT_SSL_VERIFYHOST(3)\fP for that. The check that the
|
||||
host name in the certificate is valid for the host name you're connecting to
|
||||
is done independently of the \fICURLOPT_SSL_VERIFYPEER(3)\fP option.
|
||||
talking to. Use \fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP for that. The check
|
||||
that the host name in the certificate is valid for the host name you're
|
||||
connecting to is done independently of the
|
||||
\fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP option.
|
||||
|
||||
WARNING: disabling verification of the certificate allows bad guys to
|
||||
man-in-the-middle the communication without you knowing it. Disabling
|
||||
@ -59,9 +62,9 @@ verification makes the communication insecure. Just having encryption on a
|
||||
transfer is not enough as you cannot be sure that you are communicating with
|
||||
the correct end-point.
|
||||
.SH DEFAULT
|
||||
By default, curl assumes a value of 1.
|
||||
1
|
||||
.SH PROTOCOLS
|
||||
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
||||
All
|
||||
.SH EXAMPLE
|
||||
.nf
|
||||
CURL *curl = curl_easy_init();
|
||||
@ -75,8 +78,12 @@ if(curl) {
|
||||
}
|
||||
.fi
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0
|
||||
|
||||
If built TLS enabled.
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
|
||||
.BR CURLOPT_SSL_VERIFYPEER "(3), "
|
||||
.BR CURLOPT_SSL_VERIFYHOST "(3), "
|
||||
|
||||
@ -28,21 +28,21 @@ CURLOPT_PROXY_TLSAUTH_PASSWORD \- password to use for proxy TLS authentication
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_PASSWORD, char *pwd);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a char * as parameter, which should point to the zero terminated password
|
||||
to use for the TLS authentication method specified with the
|
||||
\fICURLOPT_TLSAUTH_TYPE(3)\fP option. Requires that the
|
||||
\fICURLOPT_TLSAUTH_USERNAME(3)\fP option also be set.
|
||||
\fICURLOPT_PROXY_TLSAUTH_TYPE(3)\fP option. Requires that the
|
||||
\fICURLOPT_PROXY_TLSAUTH_USERNAME(3)\fP option also be set.
|
||||
.SH DEFAULT
|
||||
NULL
|
||||
.SH PROTOCOLS
|
||||
All TLS-based protocols
|
||||
All
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH AVAILABILITY
|
||||
Added in 7.21.4
|
||||
Added in 7.52.0
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
||||
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_PROXY_TLSAUTH_TYPE "(3), " CURLOPT_PROXY_TLSAUTH_USERNAME "(3), "
|
||||
.BR CURLOPT_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_USERNAME "(3), "
|
||||
|
||||
@ -28,26 +28,29 @@ CURLOPT_PROXY_TLSAUTH_TYPE \- set proxy TLS authentication methods
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_TYPE, char *type);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a pointer to a zero terminated string as parameter. The string
|
||||
should be the method of the TLS authentication. Supported method is "SRP".
|
||||
Pass a pointer to a zero terminated string as parameter. The string should be
|
||||
the method of the TLS authentication used for the HTTPS connection. Supported
|
||||
method is "SRP".
|
||||
|
||||
.IP SRP
|
||||
TLS-SRP authentication. Secure Remote Password authentication for TLS is
|
||||
defined in RFC5054 and provides mutual authentication if both sides have a
|
||||
shared secret. To use TLS-SRP, you must also set the
|
||||
\fICURLOPT_TLSAUTH_USERNAME(3)\fP and \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
|
||||
options.
|
||||
\fICURLOPT_PROXY_TLSAUTH_USERNAME(3)\fP and
|
||||
\fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP options.
|
||||
.SH DEFAULT
|
||||
blank
|
||||
.SH PROTOCOLS
|
||||
All TLS-based protocols
|
||||
All
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0
|
||||
|
||||
You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
|
||||
to work.
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_PROXY_TLSAUTH_USERNAME "(3), " CURLOPT_PROXY_TLSAUTH_PASSWORD "(3), "
|
||||
.BR CURLOPT_TLSAUTH_USERNAME "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "
|
||||
|
||||
@ -28,19 +28,21 @@ CURLOPT_PROXY_TLSAUTH_USERNAME \- user name to use for proxy TLS authentication
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_USERNAME, char *user);
|
||||
.SH DESCRIPTION
|
||||
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
|
||||
Pass a char * as parameter, which should point to the zero terminated username
|
||||
to use for the TLS authentication method specified with the
|
||||
\fICURLOPT_TLSAUTH_TYPE(3)\fP option. Requires that the
|
||||
\fICURLOPT_TLSAUTH_PASSWORD(3)\fP option also be set.
|
||||
to use for the HTTPS proxy TLS authentication method specified with the
|
||||
\fICURLOPT_PROXY_TLSAUTH_TYPE(3)\fP option. Requires that the
|
||||
\fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP option also be set.
|
||||
.SH DEFAULT
|
||||
NULL
|
||||
.SH PROTOCOLS
|
||||
All TLS-based protocols
|
||||
All
|
||||
.SH EXAMPLE
|
||||
TODO
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0
|
||||
.SH RETURN VALUE
|
||||
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
||||
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
||||
.SH "SEE ALSO"
|
||||
.BR CURLOPT_PROXY_TLSAUTH_TYPE "(3), " CURLOPT_PROXY_TLSAUTH_PASSWORD "(3), "
|
||||
.BR CURLOPT_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "
|
||||
|
||||
Loading…
Reference in New Issue
Block a user