CURLOPT_PROXY_CRLFILE.3: clarify https proxy and availability

This commit is contained in:
Daniel Stenberg 2016-11-25 16:36:27 +01:00
parent 67edddeb92
commit 2527dd4378
1 changed files with 7 additions and 3 deletions

View File

@ -28,7 +28,8 @@ CURLOPT_PROXY_CRLFILE \- specify a proxy Certificate Revocation List file
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CRLFILE, char *file);
.SH DESCRIPTION
TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX)
This option is for connecting to a HTTPS proxy, not a HTTPS server.
Pass a char * to a zero terminated string naming a \fIfile\fP with the
concatenation of CRL (in PEM format) to use in the certificate validation that
occurs during the SSL exchange.
@ -40,7 +41,7 @@ set, requiring CRL check against all the elements of the certificate chain if
a CRL file is passed.
This option makes sense only when used in combination with the
\fICURLOPT_SSL_VERIFYPEER(3)\fP option.
\fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP option.
A specific error code (\fICURLE_SSL_CRL_BADFILE\fP) is defined with the
option. It is returned when the SSL exchange fails because the CRL file cannot
@ -49,11 +50,14 @@ information found in the CRL does not trigger this specific error.
.SH DEFAULT
NULL
.SH PROTOCOLS
All TLS-based protocols
Used with HTTPS proxy.
.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_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "