curl/curl
1
1
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-09-20 11:02:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

CURLOPT_PROXY_CAINFO.3: clarify proxy use

Browse Source
This commit is contained in:
Daniel Stenberg 2016-11-25 16:40:32 +01:00
parent 2527dd4378
commit 3f7d9b9001
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/libcurl/opts/CURLOPT_PROXY_CAINFO.3
View File

@ -28,12 +28,13 @@ CURLOPT_PROXY_CAINFO \- path to proxy Certificate Authority (CA) bundle
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAINFO, char *path); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAINFO, char *path);
.SH DESCRIPTION .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 file holding one or more
certificates to verify the peer with.
If \fICURLOPT_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the Pass a char * to a zero terminated string naming a file holding one or more
server's certificate, \fICURLOPT_CAINFO(3)\fP need not even indicate an certificates to verify the HTTPS proxy with.
If \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the
server's certificate, \fICURLOPT_PROXY_CAINFO(3)\fP need not even indicate an
accessible file. accessible file.
This option is by default set to the system path where libcurl's cacert bundle This option is by default set to the system path where libcurl's cacert bundle
@ -50,15 +51,20 @@ preferred method of verifying the peer's certificate chain.
.SH DEFAULT .SH DEFAULT
Built-in system specific Built-in system specific
.SH PROTOCOLS .SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. Used with HTTPS proxy
.SH EXAMPLE .SH EXAMPLE
TODO TODO
.SH AVAILABILITY .SH AVAILABILITY
For SSL engines that don't support certificate files the CURLOPT_PROXY_CAINFO option Added in 7.52.0
is ignored. Refer to https://curl.haxx.se/docs/ssl-compared.html
For TLS backends that don't support certificate files, the
\fICURLOPT_PROXY_CAINFO(3)\fP option is ignored. Refer to
https://curl.haxx.se/docs/ssl-compared.html
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_PROXY_CAPATH "(3), "
.BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
.BR CURLOPT_CAPATH "(3), " .BR CURLOPT_CAPATH "(3), "
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), " .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "