diff options
Diffstat (limited to 'docs/libcurl')
37 files changed, 1608 insertions, 25 deletions
diff --git a/docs/libcurl/curl_easy_getinfo.3 b/docs/libcurl/curl_easy_getinfo.3 index 9ffcd14a..fabc7e92 100644 --- a/docs/libcurl/curl_easy_getinfo.3 +++ b/docs/libcurl/curl_easy_getinfo.3 @@ -104,6 +104,9 @@ See \fICURLINFO_REQUEST_SIZE(3)\fP .IP CURLINFO_SSL_VERIFYRESULT Certificate verification result. See \fICURLINFO_SSL_VERIFYRESULT(3)\fP +.IP CURLINFO_PROXY_SSL_VERIFYRESULT +Proxy certificate verification result. +See \fICURLINFO_PROXY_SSL_VERIFYRESULT(3)\fP .IP CURLINFO_SSL_ENGINES A list of OpenSSL crypto engines. See \fICURLINFO_SSL_ENGINES(3)\fP @@ -180,6 +183,12 @@ See \fICURLINFO_RTSP_SERVER_CSEQ(3)\fP .IP CURLINFO_RTSP_CSEQ_RECV RTSP CSeq last received. See \fICURLINFO_RTSP_CSEQ_RECV(3)\fP +.IP CURLINFO_PROTOCOL +The protocol used for the connection. (Added in 7.52.0) +See \fICURLINFO_PROTOCOL(3)\fP +.IP CURLINFO_SCHEME +The scheme used for the connection. (Added in 7.52.0) +See \fICURLINFO_SCHEME(3)\fP .SH TIMES .nf An overview of the six time values available from curl_easy_getinfo() diff --git a/docs/libcurl/curl_easy_recv.3 b/docs/libcurl/curl_easy_recv.3 index 3560cc51..7a812dd0 100644 --- a/docs/libcurl/curl_easy_recv.3 +++ b/docs/libcurl/curl_easy_recv.3 @@ -46,12 +46,21 @@ calling \fIcurl_easy_perform(3)\fP or \fIcurl_multi_perform(3)\fP. Note that \fIcurl_easy_recv(3)\fP does not work on connections that were created without this option. -You must ensure that the socket has data to read before calling -\fIcurl_easy_recv(3)\fP, otherwise the call will return \fBCURLE_AGAIN\fP - -the socket is used in non-blocking mode internally. Use -\fIcurl_easy_getinfo(3)\fP with \fICURLINFO_ACTIVESOCKET(3)\fP to obtain the -socket; use your operating system facilities like \fIselect(2)\fP to check if -it has any data you can read. +The call will return \fBCURLE_AGAIN\fP if there is no data to read - the +socket is used in non-blocking mode internally. When \fBCURLE_AGAIN\fP is +returned, use your operating system facilities like \fIselect(2)\fP to wait +for data. The socket may be obtained using \fIcurl_easy_getinfo(3)\fP with +\fICURLINFO_ACTIVESOCKET(3)\fP. + +Wait on the socket only if \fIcurl_easy_recv(3)\fP returns \fBCURLE_AGAIN\fP. +The reason for this is libcurl or the SSL library may internally cache some +data, therefore you should call \fIcurl_easy_recv(3)\fP until all data is +read which would include any cached data. + +Furthermore if you wait on the socket and it tells you there is data to read, +\fIcurl_easy_recv(3)\fP may return \fBCURLE_AGAIN\fP if the only data that was +read was for internal SSL processing, and no other data is available. + .SH AVAILABILITY Added in 7.18.2. .SH RETURN VALUE @@ -60,13 +69,13 @@ On success, returns \fBCURLE_OK\fP, stores the received data into On failure, returns the appropriate error code. -If there is no data to read, the function returns \fBCURLE_AGAIN\fP. Use your -operating system facilities to wait until the data is ready, and retry. +The function may return \fBCURLE_AGAIN\fP. In this case, use your operating +system facilities to wait until data can be read, and retry. -Reading exactly 0 bytes would indicate a closed connection. +Reading exactly 0 bytes indicates a closed connection. If there's no socket available to use from the previous transfer, this function -returns CURLE_UNSUPPORTED_PROTOCOL. +returns \fBCURLE_UNSUPPORTED_PROTOCOL\fP. .SH EXAMPLE See \fBsendrecv.c\fP in \fBdocs/examples\fP directory for usage example. .SH "SEE ALSO" diff --git a/docs/libcurl/curl_easy_send.3 b/docs/libcurl/curl_easy_send.3 index 2a744398..47976f39 100644 --- a/docs/libcurl/curl_easy_send.3 +++ b/docs/libcurl/curl_easy_send.3 @@ -40,16 +40,20 @@ connection set-up. The variable \fBn\fP points to will receive the number of sent bytes. To establish the connection, set \fICURLOPT_CONNECT_ONLY(3)\fP option before -calling \fIcurl_easy_perform(3)\fP or \fIcurl_multi_perform()\fP. Note that +calling \fIcurl_easy_perform(3)\fP or \fIcurl_multi_perform(3)\fP. Note that \fIcurl_easy_send(3)\fP will not work on connections that were created without this option. -You must ensure that the socket is writable before calling -\fIcurl_easy_send(3)\fP, otherwise the call will return \fBCURLE_AGAIN\fP - -the socket is used in non-blocking mode internally. Use -\fIcurl_easy_getinfo(3)\fP with \fICURLINFO_ACTIVESOCKET(3)\fP to obtain the -socket; use your operating system facilities like \fIselect(2)\fP to check if -it can be written to. +The call will return \fBCURLE_AGAIN\fP if it's not possible to send data right +now - the socket is used in non-blocking mode internally. When +\fBCURLE_AGAIN\fP is returned, use your operating system facilities like +\fIselect(2)\fP to wait until the socket is writable. The socket may be +obtained using \fIcurl_easy_getinfo(3)\fP with \fICURLINFO_ACTIVESOCKET(3)\fP. + +Furthermore if you wait on the socket and it tells you it's writable, +\fIcurl_easy_send(3)\fP may return \fBCURLE_AGAIN\fP if the only data that was +sent was for internal SSL processing, and no other data could be sent. + .SH AVAILABILITY Added in 7.18.2. .SH RETURN VALUE @@ -59,8 +63,11 @@ wanted to send. On failure, returns the appropriate error code. +This function may return \fBCURLE_AGAIN\fP. In this case, use your operating +system facilities to wait until the socket is writable, and retry. + If there's no socket available to use from the previous transfer, this function -returns CURLE_UNSUPPORTED_PROTOCOL. +returns \fBCURLE_UNSUPPORTED_PROTOCOL\fP. .SH EXAMPLE See \fBsendrecv.c\fP in \fBdocs/examples\fP directory for usage example. .SH "SEE ALSO" diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3 index b32e1c03..a130a8a0 100644 --- a/docs/libcurl/curl_easy_setopt.3 +++ b/docs/libcurl/curl_easy_setopt.3 @@ -159,6 +159,8 @@ Protocols to allow redirects to. See \fICURLOPT_REDIR_PROTOCOLS(3)\fP Default protocol. See \fICURLOPT_DEFAULT_PROTOCOL(3)\fP .IP CURLOPT_PROXY Proxy to use. See \fICURLOPT_PROXY(3)\fP +.IP CURLOPT_PRE_PROXY +Socks proxy to use. See \fICURLOPT_PRE_PROXY(3)\fP .IP CURLOPT_PROXYPORT Proxy port to use. See \fICURLOPT_PROXYPORT(3)\fP .IP CURLOPT_PROXYTYPE @@ -228,10 +230,16 @@ Proxy password. See \fICURLOPT_PROXYPASSWORD(3)\fP HTTP server authentication methods. See \fICURLOPT_HTTPAUTH(3)\fP .IP CURLOPT_TLSAUTH_USERNAME TLS authentication user name. See \fICURLOPT_TLSAUTH_USERNAME(3)\fP +.IP CURLOPT_PROXY_TLSAUTH_USERNAME +Proxy TLS authentication user name. See \fICURLOPT_PROXY_TLSAUTH_USERNAME(3)\fP .IP CURLOPT_TLSAUTH_PASSWORD TLS authentication password. See \fICURLOPT_TLSAUTH_PASSWORD(3)\fP +.IP CURLOPT_PROXY_TLSAUTH_PASSWORD +Proxy TLS authentication password. See \fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP .IP CURLOPT_TLSAUTH_TYPE TLS authentication methods. See \fICURLOPT_TLSAUTH_TYPE(3)\fP +.IP CURLOPT_PROXY_TLSAUTH_TYPE +Proxy TLS authentication methods. See \fICURLOPT_PROXY_TLSAUTH_TYPE(3)\fP .IP CURLOPT_PROXYAUTH HTTP proxy authentication methods. See \fICURLOPT_PROXYAUTH(3)\fP .IP CURLOPT_SASL_IR @@ -447,14 +455,24 @@ Timeout for waiting for the server's connect back to be accepted. See \fICURLOPT .SH SSL and SECURITY OPTIONS .IP CURLOPT_SSLCERT Client cert. See \fICURLOPT_SSLCERT(3)\fP +.IP CURLOPT_PROXY_SSLCERT +Proxy client cert. See \fICURLOPT_PROXY_SSLCERT(3)\fP .IP CURLOPT_SSLCERTTYPE Client cert type. See \fICURLOPT_SSLCERTTYPE(3)\fP +.IP CURLOPT_PROXY_SSLCERTTYPE +Proxy client cert type. See \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP .IP CURLOPT_SSLKEY Client key. See \fICURLOPT_SSLKEY(3)\fP +.IP CURLOPT_PROXY_SSLKEY +Proxy client key. See \fICURLOPT_PROXY_SSLKEY(3)\fP .IP CURLOPT_SSLKEYTYPE Client key type. See \fICURLOPT_SSLKEYTYPE(3)\fP +.IP CURLOPT_PROXY_SSLKEYTYPE +Proxy client key type. See \fICURLOPT_PROXY_SSLKEYTYPE(3)\fP .IP CURLOPT_KEYPASSWD Client key password. See \fICURLOPT_KEYPASSWD(3)\fP +.IP CURLOPT_PROXY_KEYPASSWD +Proxy client key password. See \fICURLOPT_PROXY_KEYPASSWD(3)\fP .IP CURLOPT_SSL_ENABLE_ALPN Enable use of ALPN. See \fICURLOPT_SSL_ENABLE_ALPN(3)\fP .IP CURLOPT_SSL_ENABLE_NPN @@ -467,34 +485,53 @@ Default SSL engine. See \fICURLOPT_SSLENGINE_DEFAULT(3)\fP Enable TLS False Start. See \fICURLOPT_SSL_FALSESTART(3)\fP .IP CURLOPT_SSLVERSION SSL version to use. See \fICURLOPT_SSLVERSION(3)\fP +.IP CURLOPT_PROXY_SSLVERSION +Proxy SSL version to use. See \fICURLOPT_PROXY_SSLVERSION(3)\fP .IP CURLOPT_SSL_VERIFYHOST Verify the host name in the SSL certificate. See \fICURLOPT_SSL_VERIFYHOST(3)\fP +.IP CURLOPT_PROXY_SSL_VERIFYHOST +Verify the host name in the proxy SSL certificate. See \fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP .IP CURLOPT_SSL_VERIFYPEER Verify the SSL certificate. See \fICURLOPT_SSL_VERIFYPEER(3)\fP +.IP CURLOPT_PROXY_SSL_VERIFYPEER +Verify the proxy SSL certificate. See \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP .IP CURLOPT_SSL_VERIFYSTATUS Verify the SSL certificate's status. See \fICURLOPT_SSL_VERIFYSTATUS(3)\fP .IP CURLOPT_CAINFO CA cert bundle. See \fICURLOPT_CAINFO(3)\fP +.IP CURLOPT_PROXY_CAINFO +Proxy CA cert bundle. See \fICURLOPT_PROXY_CAINFO(3)\fP .IP CURLOPT_ISSUERCERT Issuer certificate. See \fICURLOPT_ISSUERCERT(3)\fP .IP CURLOPT_CAPATH Path to CA cert bundle. See \fICURLOPT_CAPATH(3)\fP +.IP CURLOPT_PROXY_CAPATH +Path to proxy CA cert bundle. See \fICURLOPT_PROXY_CAPATH(3)\fP .IP CURLOPT_CRLFILE Certificate Revocation List. See \fICURLOPT_CRLFILE(3)\fP +.IP CURLOPT_PROXY_CRLFILE +Proxy Certificate Revocation List. See \fICURLOPT_PROXY_CRLFILE(3)\fP .IP CURLOPT_CERTINFO Extract certificate info. See \fICURLOPT_CERTINFO(3)\fP .IP CURLOPT_PINNEDPUBLICKEY Set pinned SSL public key . See \fICURLOPT_PINNEDPUBLICKEY(3)\fP +.IP CURLOPT_PROXY_PINNEDPUBLICKEY +Set the proxy's pinned SSL public key. See +\fICURLOPT_PROXY_PINNEDPUBLICKEY(3)\fP .IP CURLOPT_RANDOM_FILE Provide source for entropy random data. See \fICURLOPT_RANDOM_FILE(3)\fP .IP CURLOPT_EGDSOCKET Identify EGD socket for entropy. See \fICURLOPT_EGDSOCKET(3)\fP .IP CURLOPT_SSL_CIPHER_LIST Ciphers to use. See \fICURLOPT_SSL_CIPHER_LIST(3)\fP +.IP CURLOPT_PROXY_SSL_CIPHER_LIST +Proxy ciphers to use. See \fICURLOPT_PROXY_SSL_CIPHER_LIST(3)\fP .IP CURLOPT_SSL_SESSIONID_CACHE Disable SSL session-id cache. See \fICURLOPT_SSL_SESSIONID_CACHE(3)\fP .IP CURLOPT_SSL_OPTIONS Control SSL behavior. See \fICURLOPT_SSL_OPTIONS(3)\fP +.IP CURLOPT_PROXY_SSL_OPTIONS +Control proxy SSL behavior. See \fICURLOPT_PROXY_SSL_OPTIONS(3)\fP .IP CURLOPT_KRBLEVEL Kerberos security level. See \fICURLOPT_KRBLEVEL(3)\fP .IP CURLOPT_GSSAPI_DELEGATION diff --git a/docs/libcurl/curl_formadd.3 b/docs/libcurl/curl_formadd.3 index 6923913d..bf1b11e1 100644 --- a/docs/libcurl/curl_formadd.3 +++ b/docs/libcurl/curl_formadd.3 @@ -105,6 +105,8 @@ content then you must make sure strlen() on the data pointer returns zero. followed by a filename, causes that file to be read and its contents used as data in this part. This part does \fInot\fP automatically become a file upload part simply because its data was read from a file. + +The specified file needs to kept around until the associated transfer is done. .IP CURLFORM_FILE followed by a filename, makes this part a file upload part. It sets the \fIfilename\fP field to the basename of the provided filename, it reads the @@ -117,6 +119,8 @@ providing multiple \fBCURLFORM_FILE\fP arguments each followed by the filename The given upload file has to exist in its full in the file system already when the upload starts, as libcurl needs to read the correct file size beforehand. + +The specified file needs to kept around until the associated transfer is done. .IP CURLFORM_CONTENTTYPE is used in combination with \fICURLFORM_FILE\fP. Followed by a pointer to a string which provides the content-type for this part, possibly instead of an diff --git a/docs/libcurl/curl_multi_socket.3 b/docs/libcurl/curl_multi_socket.3 index 52abf1ef..ea29e711 100644 --- a/docs/libcurl/curl_multi_socket.3 +++ b/docs/libcurl/curl_multi_socket.3 @@ -118,7 +118,7 @@ the return code means that libcurl may have more data available to return or that there may be more data to send off before it is "satisfied". In modern libcurls, \fICURLM_CALL_MULTI_PERFORM\fP or -\fICURLM_CALL_MULTI_SOKCET\fP should not be returned and no application needs +\fICURLM_CALL_MULTI_SOCKET\fP should not be returned and no application needs to care about them. NOTE that the return code is for the whole multi stack. Problems still might have diff --git a/docs/libcurl/curl_version_info.3 b/docs/libcurl/curl_version_info.3 index 5244c21b..ebb11c33 100644 --- a/docs/libcurl/curl_version_info.3 +++ b/docs/libcurl/curl_version_info.3 @@ -153,6 +153,9 @@ libcurl was built with support for Unix domain sockets. libcurl was built with support for Mozilla's Public Suffix List. This makes libcurl ignore cookies with a domain that's on the list. (Added in 7.47.0) +.IP CURL_VERSION_HTTPS_PROXY +libcurl was built with support for HTTPS-proxy. +(Added in 7.52.0) .RE \fIssl_version\fP is an ASCII string for the OpenSSL version used. If libcurl has no SSL support, this is NULL. diff --git a/docs/libcurl/libcurl-multi.3 b/docs/libcurl/libcurl-multi.3 index e5a58920..0717be77 100644 --- a/docs/libcurl/libcurl-multi.3 +++ b/docs/libcurl/libcurl-multi.3 @@ -42,7 +42,7 @@ and when to ask libcurl to get/send data. complicated for the application. 3. Enable the application to wait for action on its own file descriptors and -curl's file descriptors simultaneous easily. +curl's file descriptors simultaneously. 4. Enable event-based handling and scaling transfers up to and beyond thousands of parallel connections. diff --git a/docs/libcurl/libcurl-symbols.3 b/docs/libcurl/libcurl-symbols.3 index 0e0d379e..091032fd 100644 --- a/docs/libcurl/libcurl-symbols.3 +++ b/docs/libcurl/libcurl-symbols.3 @@ -19,7 +19,7 @@ .\" * KIND, either express or implied. .\" * .\" ************************************************************************** -.TH libcurl-symbols 3 "nov 2, 2016" "libcurl 7.41.0" "libcurl symbols" +.TH libcurl-symbols 3 "dec 23, 2016" "libcurl 7.41.0" "libcurl symbols" .SH NAME libcurl-symbols \- libcurl symbol version information .SH "libcurl symbols" @@ -522,8 +522,12 @@ Introduced in 7.19.0 Introduced in 7.21.0 .IP CURLINFO_PRIVATE Introduced in 7.10.3 +.IP CURLINFO_PROTOCOL +Introduced in 7.52.0 .IP CURLINFO_PROXYAUTH_AVAIL Introduced in 7.10.8 +.IP CURLINFO_PROXY_SSL_VERIFYRESULT +Introduced in 7.52.0 .IP CURLINFO_REDIRECT_COUNT Introduced in 7.9.7 .IP CURLINFO_REDIRECT_TIME @@ -542,6 +546,8 @@ Introduced in 7.20.0 Introduced in 7.20.0 .IP CURLINFO_RTSP_SESSION_ID Introduced in 7.20.0 +.IP CURLINFO_SCHEME +Introduced in 7.52.0 .IP CURLINFO_SIZE_DOWNLOAD Introduced in 7.4.1 .IP CURLINFO_SIZE_UPLOAD @@ -980,6 +986,8 @@ Introduced in 7.1 Introduced in 7.19.1 .IP CURLOPT_PREQUOTE Introduced in 7.9.5 +.IP CURLOPT_PRE_PROXY +Introduced in 7.52.0 .IP CURLOPT_PRIVATE Introduced in 7.10.3 .IP CURLOPT_PROGRESSDATA @@ -1005,8 +1013,42 @@ Introduced in 7.10 Introduced in 7.19.1 .IP CURLOPT_PROXYUSERPWD Introduced in 7.1 +.IP CURLOPT_PROXY_CAINFO +Introduced in 7.52.0 +.IP CURLOPT_PROXY_CAPATH +Introduced in 7.52.0 +.IP CURLOPT_PROXY_CRLFILE +Introduced in 7.52.0 +.IP CURLOPT_PROXY_KEYPASSWD +Introduced in 7.52.0 +.IP CURLOPT_PROXY_PINNEDPUBLICKEY +Introduced in 7.52.0 .IP CURLOPT_PROXY_SERVICE_NAME Introduced in 7.43.0 +.IP CURLOPT_PROXY_SSLCERT +Introduced in 7.52.0 +.IP CURLOPT_PROXY_SSLCERTTYPE +Introduced in 7.52.0 +.IP CURLOPT_PROXY_SSLKEY +Introduced in 7.52.0 +.IP CURLOPT_PROXY_SSLKEYTYPE +Introduced in 7.52.0 +.IP CURLOPT_PROXY_SSLVERSION +Introduced in 7.52.0 +.IP CURLOPT_PROXY_SSL_CIPHER_LIST +Introduced in 7.52.0 +.IP CURLOPT_PROXY_SSL_OPTIONS +Introduced in 7.52.0 +.IP CURLOPT_PROXY_SSL_VERIFYHOST +Introduced in 7.52.0 +.IP CURLOPT_PROXY_SSL_VERIFYPEER +Introduced in 7.52.0 +.IP CURLOPT_PROXY_TLSAUTH_PASSWORD +Introduced in 7.52.0 +.IP CURLOPT_PROXY_TLSAUTH_TYPE +Introduced in 7.52.0 +.IP CURLOPT_PROXY_TLSAUTH_USERNAME +Introduced in 7.52.0 .IP CURLOPT_PROXY_TRANSFER_MODE Introduced in 7.18.0 .IP CURLOPT_PUT @@ -1294,6 +1336,8 @@ Introduced in 7.19.4 Introduced in 7.10 .IP CURLPROXY_HTTP_1_0 Introduced in 7.19.4 +.IP CURLPROXY_HTTPS +Introduced in 7.52.0 .IP CURLPROXY_SOCKS4 Introduced in 7.10 .IP CURLPROXY_SOCKS4A @@ -1618,6 +1662,8 @@ Introduced in Introduced in .IP CURL_SSLVERSION_TLS Introduced in +.IP CURL_SSLVERSION_TLS +Introduced in .IP CURL_TIMECOND_IFMODSINCE Introduced in 7.9.7 .IP CURL_TIMECOND_IFUNMODSINCE @@ -1645,6 +1691,8 @@ Introduced in 7.10.6 Deprecated since 7.38.0 .IP CURL_VERSION_HTTP2 Introduced in 7.33.0 +.IP CURL_VERSION_HTTPS_PROXY +Introduced in 7.52.0 .IP CURL_VERSION_IDN Introduced in 7.12.0 .IP CURL_VERSION_IPV6 diff --git a/docs/libcurl/opts/CURLINFO_PROTOCOL.3 b/docs/libcurl/opts/CURLINFO_PROTOCOL.3 new file mode 100644 index 00000000..b8211187 --- /dev/null +++ b/docs/libcurl/opts/CURLINFO_PROTOCOL.3 @@ -0,0 +1,55 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLINFO_PROTOCOL 3 "23 November 2016" "libcurl 7.52.0" "curl_easy_getinfo options" +.SH NAME +CURLINFO_PROTOCOL \- get the protocol used in the connection +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROTOCOL, long *p); +.SH DESCRIPTION +Pass a pointer to a long to receive the version used in the last http connection. +The returned value will be one of the CURLPROTO_* values. +.SH PROTOCOLS +All +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + CURLcode res; + curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); + res = curl_easy_perform(curl); + if(res == CURLE_OK) { + long protocol; + curl_easy_getinfo(curl, CURLINFO_PROTOCOL, &protocol); + } + curl_easy_cleanup(curl); +} +.fi +.SH AVAILABILITY +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 CURLINFO_RESPONSE_CODE "(3), " +.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " diff --git a/docs/libcurl/opts/CURLINFO_PROXY_SSL_VERIFYRESULT.3 b/docs/libcurl/opts/CURLINFO_PROXY_SSL_VERIFYRESULT.3 new file mode 100644 index 00000000..3a80f978 --- /dev/null +++ b/docs/libcurl/opts/CURLINFO_PROXY_SSL_VERIFYRESULT.3 @@ -0,0 +1,43 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.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 certificate verification +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROXY_SSL_VERIFYRESULT, long *result); +.SH DESCRIPTION +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 +.SH EXAMPLE +TODO +.SH AVAILABILITY +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), " diff --git a/docs/libcurl/opts/CURLINFO_SCHEME.3 b/docs/libcurl/opts/CURLINFO_SCHEME.3 new file mode 100644 index 00000000..78c3d688 --- /dev/null +++ b/docs/libcurl/opts/CURLINFO_SCHEME.3 @@ -0,0 +1,59 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLINFO_SCHEME 3 "23 November 2016" "libcurl 7.52.0" "curl_easy_getinfo options" +.SH NAME +CURLINFO_SCHEME \- get the URL scheme (sometimes called protocol) used in the connection +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, long *p); +.SH DESCRIPTION +Pass a pointer to a char pointer to receive the pointer to a zero-terminated +string holding the URL scheme used for the most recent connection done with this +\fBcurl\fP handle. + +The \fBid\fP pointer will be NULL or pointing to private read-only memory you +MUST NOT free or modify. +.SH PROTOCOLS +All +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + CURLcode res; + curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); + res = curl_easy_perform(curl); + if(res == CURLE_OK) { + char * scheme; + curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme); + } + curl_easy_cleanup(curl); +} +.fi +.SH AVAILABILITY +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 CURLINFO_RESPONSE_CODE "(3), " +.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " diff --git a/docs/libcurl/opts/CURLINFO_SSL_VERIFYRESULT.3 b/docs/libcurl/opts/CURLINFO_SSL_VERIFYRESULT.3 index a87ccfe0..1651a9bd 100644 --- a/docs/libcurl/opts/CURLINFO_SSL_VERIFYRESULT.3 +++ b/docs/libcurl/opts/CURLINFO_SSL_VERIFYRESULT.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -22,13 +22,13 @@ .\" .TH CURLINFO_SSL_VERIFYRESULT 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" .SH NAME -CURLINFO_SSL_VERIFYRESULT \- get the result of the certification verification +CURLINFO_SSL_VERIFYRESULT \- get the result of the certificate verification .SH SYNOPSIS #include <curl/curl.h> CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SSL_VERIFYRESULT, long *result); .SH DESCRIPTION -Pass a pointer to a long to receive the result of the certification +Pass a pointer to a long to receive the result of the server SSL certificate verification that was requested (using the \fICURLOPT_SSL_VERIFYPEER(3)\fP option. .SH PROTOCOLS diff --git a/docs/libcurl/opts/CURLOPT_CONNECT_ONLY.3 b/docs/libcurl/opts/CURLOPT_CONNECT_ONLY.3 index 61289e8d..973c2aed 100644 --- a/docs/libcurl/opts/CURLOPT_CONNECT_ONLY.3 +++ b/docs/libcurl/opts/CURLOPT_CONNECT_ONLY.3 @@ -49,3 +49,4 @@ Added in 7.15.2 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. .SH "SEE ALSO" .BR CURLOPT_VERBOSE "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), " +.BR curl_easy_recv "(3), " curl_easy_send "(3) " diff --git a/docs/libcurl/opts/CURLOPT_PRE_PROXY.3 b/docs/libcurl/opts/CURLOPT_PRE_PROXY.3 new file mode 100644 index 00000000..035dd3ac --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PRE_PROXY.3 @@ -0,0 +1,69 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PRE_PROXY 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PRE_PROXY \- set pre-proxy to use +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRE_PROXY, char *preproxy); +.SH DESCRIPTION +Set the \fIpreproxy\fP to use for the upcoming request. The parameter +should be a char * to a zero terminated string holding the host name or dotted +numerical IP address. A numerical IPv6 address must be written within +[brackets]. + +To specify port number in this string, append :[port] to the end of the host +name. The proxy's port number may optionally be specified with the separate +option \fICURLOPT_PROXYPORT(3)\fP. If not specified, libcurl will default to +using port 1080 for proxies. + +A pre proxy is a SOCKS proxy that curl connects to before it connects to the +HTTP(S) proxy specified in the \fICURLOPT_PROXY\fP option. The pre proxy can +only be a SOCKS proxy. + +The pre proxy string should be prefixed with [scheme]:// to specify which kind +of socks is used. Use socks4://, socks4a://, socks5:// or socks5h:// (the last +one to enable socks5 and asking the proxy to do the resolving, also known as +\fICURLPROXY_SOCKS5_HOSTNAME\fP type) to request the specific SOCKS version to +be used. Otherwise SOCKS4 is used as default. + +Setting the pre proxy string to "" (an empty string) will explicitly disable +the use of a pre proxy. +.SH DEFAULT +Default is NULL, meaning no pre proxy is used. + +When you set a host name to use, do not assume that there's any particular +single port number used widely for proxies. Specify it! +.SH PROTOCOLS +All except file://. Note that some protocols don't do very well over proxy. +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.52.0 +.SH RETURN VALUE +Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or +CURLE_OUT_OF_MEMORY if there was insufficient heap space. +.SH "SEE ALSO" +.BR CURLOPT_PROXY "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), " + diff --git a/docs/libcurl/opts/CURLOPT_PROXYPORT.3 b/docs/libcurl/opts/CURLOPT_PROXYPORT.3 index 2380e09e..0e222896 100644 --- a/docs/libcurl/opts/CURLOPT_PROXYPORT.3 +++ b/docs/libcurl/opts/CURLOPT_PROXYPORT.3 @@ -29,7 +29,8 @@ CURLOPT_PROXYPORT \- port number the proxy listens on CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port); .SH DESCRIPTION Pass a long with this option to set the proxy port to connect to unless it is -specified in the proxy string \fICURLOPT_PROXY(3)\fP or uses the default one. +specified in the proxy string \fICURLOPT_PROXY(3)\fP or uses 443 for https +proxies and 1080 for all others as default. While this accepts a 'long', the port number is 16 bit so it can't be larger than 65535. diff --git a/docs/libcurl/opts/CURLOPT_PROXY_CAINFO.3 b/docs/libcurl/opts/CURLOPT_PROXY_CAINFO.3 new file mode 100644 index 00000000..dfc025f0 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_CAINFO.3 @@ -0,0 +1,70 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_CAINFO 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_CAINFO \- path to proxy Certificate Authority (CA) bundle +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAINFO, char *path); +.SH DESCRIPTION +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 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. + +This option is by default set to the system path where libcurl's cacert bundle +is assumed to be stored, as established at build time. + +If curl is built against the NSS SSL library, the NSS PEM PKCS#11 module +(libnsspem.so) needs to be available for this option to work properly. + +(iOS and macOS only) If curl is built against Secure Transport, then this +option is supported for backward compatibility with other SSL engines, but it +should not be set. If the option is not set, then curl will use the +certificates in the system and user Keychain to verify the peer, which is the +preferred method of verifying the peer's certificate chain. +.SH DEFAULT +Built-in system specific +.SH PROTOCOLS +Used with HTTPS proxy +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.52.0 + +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 +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_CAPATH "(3), " +.BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), " +.BR CURLOPT_CAPATH "(3), " +.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_CAPATH.3 b/docs/libcurl/opts/CURLOPT_PROXY_CAPATH.3 new file mode 100644 index 00000000..871d8c9b --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_CAPATH.3 @@ -0,0 +1,52 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_CAPATH 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_CAPATH \- specify directory holding proxy CA certificates +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAPATH, char *capath); +.SH DESCRIPTION +Pass a char * to a zero terminated string naming a directory holding multiple +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 +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 +Returns CURLE_OK if TLS enabled, and CURLE_UNKNOWN_OPTION if not, or +CURLE_OUT_OF_MEMORY if there was insufficient heap space. +.SH "SEE ALSO" +.BR CURLOPT_CAINFO "(3), " +.BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_CRLFILE.3 b/docs/libcurl/opts/CURLOPT_PROXY_CRLFILE.3 new file mode 100644 index 00000000..f9d44576 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_CRLFILE.3 @@ -0,0 +1,63 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_CRLFILE 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_CRLFILE \- specify a proxy Certificate Revocation List file +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CRLFILE, char *file); +.SH DESCRIPTION +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. + +When curl is built to use NSS or GnuTLS, there is no way to influence the use +of CRL passed to help in the verification process. When libcurl is built with +OpenSSL support, X509_V_FLAG_CRL_CHECK and X509_V_FLAG_CRL_CHECK_ALL are both +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_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 +be loaded. A failure in certificate verification due to a revocation +information found in the CRL does not trigger this specific error. +.SH DEFAULT +NULL +.SH 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), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3 b/docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3 new file mode 100644 index 00000000..bddecd12 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3 @@ -0,0 +1,50 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_KEYPASSWD 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_KEYPASSWD \- set passphrase to proxy private key +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_KEYPASSWD, char *pwd); +.SH DESCRIPTION +This option is for connecting to a HTTPS proxy, not a HTTPS server. + +Pass a pointer to a zero terminated string as parameter. It will be used as +the password required to use the \fICURLOPT_PROXY_SSLKEY(3)\fP private key. +You never needed a pass phrase to load a certificate but you need one to load +your private key. +.SH DEFAULT +NULL +.SH PROTOCOLS +Used with HTTPS proxy +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.52.0 +.SH RETURN VALUE +Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or +CURLE_OUT_OF_MEMORY if there was insufficient heap space. +.SH "SEE ALSO" +.BR CURLOPT_PROXY_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), " +.BR CURLOPT_SSLKEY "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_PINNEDPUBLICKEY.3 b/docs/libcurl/opts/CURLOPT_PROXY_PINNEDPUBLICKEY.3 new file mode 100644 index 00000000..db2cd70e --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_PINNEDPUBLICKEY.3 @@ -0,0 +1,99 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_PINNEDPUBLICKEY 3 "24 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_PINNEDPUBLICKEY \- set pinned public key for https proxy +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_PINNEDPUBLICKEY, char *pinnedpubkey); +.SH DESCRIPTION +Pass a pointer to a zero terminated string as parameter. The string can be the +file name of your pinned public key. The file format expected is "PEM" or "DER". +The string can also be any number of base64 encoded sha256 hashes preceded by +"sha256//" and separated by ";" + +When negotiating a TLS or SSL connection, the https proxy sends a certificate +indicating its identity. A public key is extracted from this certificate and +if it does not exactly match the public key provided to this option, curl will +abort the connection before sending or receiving any data. + +On mismatch, \fICURLE_SSL_PINNEDPUBKEYNOTMATCH\fP is returned. +.SH DEFAULT +NULL +.SH PROTOCOLS +All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. +.SH EXAMPLE +.nf +TODO +.fi +.SH PUBLIC KEY EXTRACTION +If you do not have the https proxy server's public key file you can extract it +from the https proxy server's certificate. +.nf +# retrieve the server's certificate if you don't already have it +# +# be sure to examine the certificate to see if it is what you expected +# +# Windows-specific: +# - Use NUL instead of /dev/null. +# - OpenSSL may wait for input instead of disconnecting. Hit enter. +# - If you don't have sed, then just copy the certificate into a file: +# Lines from -----BEGIN CERTIFICATE----- to -----END CERTIFICATE-----. +# +openssl s_client -servername www.example.com -connect www.example.com:443 < /dev/null | sed -n "/-----BEGIN/,/-----END/p" > www.example.com.pem + +# extract public key in pem format from certificate +openssl x509 -in www.example.com.pem -pubkey -noout > www.example.com.pubkey.pem + +# convert public key from pem to der +openssl asn1parse -noout -inform pem -in www.example.com.pubkey.pem -out www.example.com.pubkey.der + +# sha256 hash and base64 encode der to string for use +openssl dgst -sha256 -binary www.example.com.pubkey.der | openssl base64 +.fi +The public key in PEM format contains a header, base64 data and a +footer: +.nf +-----BEGIN PUBLIC KEY----- +[BASE 64 DATA] +-----END PUBLIC KEY----- +.fi +.SH AVAILABILITY +PEM/DER support: + + 7.52.0: GSKit, GnuTLS, NSS, OpenSSL, PolarSSL, mbedtls, wolfSSL/CyaSSL + +sha256 support: + + 7.52.0: GnuTLS, NSS, OpenSSL, PolarSSL, mbedtls, wolfSSL/CyaSSL + +Other SSL backends not supported. +.SH RETURN VALUE +Returns CURLE_OK if TLS enabled, 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), " +.BR CURLOPT_PROXY_SSL_VERIFYHOST "(3), " +.BR CURLOPT_PROXY_CAINFO "(3), " +.BR CURLOPT_PROXY_CAPATH "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3 new file mode 100644 index 00000000..9d3c029a --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3 @@ -0,0 +1,58 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_SSLCERT 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_SSLCERT \- set SSL proxy client certificate +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERT, char *cert); +.SH DESCRIPTION +This option is for connecting to a HTTPS proxy, not a HTTPS server. + +Pass a pointer to a zero terminated string as parameter. The string should be +the file name of your client certificate used to connect to the HTTPS proxy. +The default format is "P12" on Secure Transport and "PEM" on other engines, +and can be changed with \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP. + +With NSS or Secure Transport, this can also be the nickname of the certificate +you wish to authenticate with as it is named in the security database. If you +want to use a file from the current directory, please precede it with "./" +prefix, in order to avoid confusion with a nickname. + +When using a client certificate, you most likely also need to provide a +private key with \fICURLOPT_PROXY_SSLKEY(3)\fP. +.SH DEFAULT +NULL +.SH PROTOCOLS +Used with HTTPS proxy +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.52.0 +.SH RETURN VALUE +Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or +CURLE_OUT_OF_MEMORY if there was insufficient heap space. +.SH "SEE ALSO" +.BR CURLOPT_PROXY_SSLCERTTYPE "(3), " CURLOPT_PROXY_SSLKEY "(3), " +.BR CURLOPT_SSLCERT "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSLCERTTYPE.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSLCERTTYPE.3 new file mode 100644 index 00000000..72c7bf49 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSLCERTTYPE.3 @@ -0,0 +1,52 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_SSLCERTTYPE 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_SSLCERTTYPE \- specify type of the proxy client SSL certificate +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERTTYPE, char *type); +.SH DESCRIPTION +Pass a pointer to a zero terminated string as parameter. The string should be +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 +.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_SSLCERT "(3), " CURLOPT_PROXY_SSLKEY "(3), " +.BR CURLOPT_SSLCERTTYPE "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSLKEY.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSLKEY.3 new file mode 100644 index 00000000..12c3e685 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSLKEY.3 @@ -0,0 +1,54 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_SSLKEY 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_SSLKEY \- specify private keyfile for TLS and SSL proxy client cert +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEY, char *keyfile); +.SH DESCRIPTION +Pass a pointer to a zero terminated string as parameter. The string should be +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 +present in the keychain or PKCS#12 file containing the certificate. +.SH DEFAULT +NULL +.SH PROTOCOLS +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), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3 new file mode 100644 index 00000000..c167b6d5 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3 @@ -0,0 +1,46 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_SSLKEYTYPE 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_SSLKEYTYPE \- set type of the proxy private key file +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEYTYPE, char *type); +.SH DESCRIPTION +This option is for connecting to a HTTPS proxy, not a HTTPS server. + +Pass a pointer to a zero terminated string as parameter. The string should be +the format of your private key. Supported formats are "PEM", "DER" and "ENG". +.SH PROTOCOLS +Used with HTTPS proxy +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.52.0 +.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_SSLKEY "(3), " CURLOPT_PROXY_SSLCERT "(3), " +.BR CURLOPT_SSLKEYTYPE "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSLVERSION.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSLVERSION.3 new file mode 100644 index 00000000..f96a9e6c --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSLVERSION.3 @@ -0,0 +1,74 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_SSLVERSION 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +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 +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 +.IP CURL_SSLVERSION_DEFAULT +The default action. This will attempt to figure out the remote SSL protocol +version. +.IP CURL_SSLVERSION_TLSv1 +TLSv1.x +.IP CURL_SSLVERSION_TLSv1_0 +TLSv1.0 +.IP CURL_SSLVERSION_TLSv1_1 +TLSv1.1 +.IP CURL_SSLVERSION_TLSv1_2 +TLSv1.2 +.IP CURL_SSLVERSION_TLSv1_3 +TLSv1.3 +.RE +.SH DEFAULT +CURL_SSLVERSION_DEFAULT +.SH PROTOCOLS +All +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); + + /* ask libcurl to use TLS version 1.0 or later */ + curl_easy_setopt(curl, CURLOPT_PROXY_SSLVERSION, CURL_SSLVERSION_TLSv1); + + /* Perform the request */ + curl_easy_perform(curl); +} +.fi +.SH AVAILABILITY +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) " CURLOPT_SSLVERSION "(3), " + diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSL_CIPHER_LIST.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSL_CIPHER_LIST.3 new file mode 100644 index 00000000..54b3646d --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSL_CIPHER_LIST.3 @@ -0,0 +1,68 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_SSL_CIPHER_LIST 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_SSL_CIPHER_LIST \- specify ciphers to use for proxy TLS +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_CIPHER_LIST, char *list); +.SH DESCRIPTION +Pass a char *, pointing to a zero terminated string holding the list of +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 +compile OpenSSL. + +You'll find more details about cipher lists on this URL: + + https://www.openssl.org/docs/apps/ciphers.html + +For NSS, valid examples of cipher lists include 'rsa_rc4_128_md5', +\'rsa_aes_128_sha\', etc. With NSS you don't add/remove ciphers. If one uses +this option then all known ciphers are disabled and only those passed in are +enabled. + +You'll find more details about the NSS cipher lists on this URL: + + http://git.fedorahosted.org/cgit/mod_nss.git/plain/docs/mod_nss.html#Directives +.SH DEFAULT +NULL, use internal default +.SH PROTOCOLS +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_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), " +.BR CURLOPT_SSLVERSION "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSL_OPTIONS.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSL_OPTIONS.3 new file mode 100644 index 00000000..bed10dab --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSL_OPTIONS.3 @@ -0,0 +1,61 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_SSL_OPTIONS 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_SSL_OPTIONS \- set proxy SSL behavior options +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_OPTIONS, long bitmask); +.SH DESCRIPTION +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 +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. + +\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. +https://curl.haxx.se/docs/ssl-compared.html + +.SH DEFAULT +0 +.SH 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), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYHOST.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYHOST.3 new file mode 100644 index 00000000..de4b15b3 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYHOST.3 @@ -0,0 +1,82 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_SSL_VERIFYHOST 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_SSL_VERIFYHOST \- verify the proxy certificate's name against host +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_VERIFYHOST, long verify); +.SH DESCRIPTION +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 proxy cert contains +the correct name for the name it is known as. + +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. + +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 +proxy string which you told curl to use. + +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 0L, the connection succeeds regardless of the +names used in the certificate. Use that ability with caution! + +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 protocols when used over a HTTPS proxy. +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); + + /* Set the default value: strict name check please */ + curl_easy_setopt(curl, CURLOPT_PROXY_SSL_VERIFYHOST, 2L); + + curl_easy_perform(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_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_CAINFO "(3), ", +.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_CAINFO "(3), ", diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYPEER.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYPEER.3 new file mode 100644 index 00000000..9473495c --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYPEER.3 @@ -0,0 +1,89 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.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's SSL certificate +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_VERIFYPEER, long verify); +.SH DESCRIPTION +Pass a long as parameter set to 1L to enable or 0L to disable. + +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, +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_PROXY_CAINFO(3)\fP option +or the \fICURLOPT_PROXY_CAPATH(3)\fP option. + +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_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 +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 +1 +.SH PROTOCOLS +All +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); + + /* Set the default value: strict certificate check please */ + curl_easy_setopt(curl, CURLOPT_PROXY_SSL_VERIFYPEER, 1L); + + curl_easy_perform(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), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_PASSWORD.3 b/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_PASSWORD.3 new file mode 100644 index 00000000..809ffb27 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_PASSWORD.3 @@ -0,0 +1,48 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_TLSAUTH_PASSWORD 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_TLSAUTH_PASSWORD \- password to use for proxy TLS authentication +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_PASSWORD, char *pwd); +.SH DESCRIPTION +Pass a char * as parameter, which should point to the zero terminated password +to use for the TLS authentication method specified with the +\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 +.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_USERNAME "(3), " +.BR CURLOPT_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_USERNAME "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_TYPE.3 b/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_TYPE.3 new file mode 100644 index 00000000..dbf00b67 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_TYPE.3 @@ -0,0 +1,56 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_TLSAUTH_TYPE 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_TLSAUTH_TYPE \- set proxy TLS authentication methods +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_TYPE, char *type); +.SH DESCRIPTION +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_PROXY_TLSAUTH_USERNAME(3)\fP and +\fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP options. +.SH DEFAULT +blank +.SH 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), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_USERNAME.3 b/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_USERNAME.3 new file mode 100644 index 00000000..2a2c8669 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_USERNAME.3 @@ -0,0 +1,48 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_PROXY_TLSAUTH_USERNAME 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PROXY_TLSAUTH_USERNAME \- user name to use for proxy TLS authentication +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_USERNAME, char *user); +.SH DESCRIPTION +Pass a char * as parameter, which should point to the zero terminated username +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 +.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), " diff --git a/docs/libcurl/opts/CURLOPT_SSLVERSION.3 b/docs/libcurl/opts/CURLOPT_SSLVERSION.3 index 2f40e463..77dfcd49 100644 --- a/docs/libcurl/opts/CURLOPT_SSLVERSION.3 +++ b/docs/libcurl/opts/CURLOPT_SSLVERSION.3 @@ -48,6 +48,8 @@ TLSv1.0 (Added in 7.34.0) TLSv1.1 (Added in 7.34.0) .IP CURL_SSLVERSION_TLSv1_2 TLSv1.2 (Added in 7.34.0) +.IP CURL_SSLVERSION_TLSv1_3 +TLSv1.3 (Added in 7.52.0) .RE .SH DEFAULT CURL_SSLVERSION_DEFAULT diff --git a/docs/libcurl/opts/Makefile.am b/docs/libcurl/opts/Makefile.am index 8cb1b52b..eb7ca1bb 100644 --- a/docs/libcurl/opts/Makefile.am +++ b/docs/libcurl/opts/Makefile.am @@ -49,7 +49,9 @@ man_MANS = \ CURLINFO_PRIMARY_IP.3 \ CURLINFO_PRIMARY_PORT.3 \ CURLINFO_PRIVATE.3 \ + CURLINFO_PROTOCOL.3 \ CURLINFO_PROXYAUTH_AVAIL.3 \ + CURLINFO_PROXY_SSL_VERIFYRESULT.3 \ CURLINFO_REDIRECT_COUNT.3 \ CURLINFO_REDIRECT_TIME.3 \ CURLINFO_REDIRECT_URL.3 \ @@ -59,6 +61,7 @@ man_MANS = \ CURLINFO_RTSP_CSEQ_RECV.3 \ CURLINFO_RTSP_SERVER_CSEQ.3 \ CURLINFO_RTSP_SESSION_ID.3 \ + CURLINFO_SCHEME.3 \ CURLINFO_SIZE_DOWNLOAD.3 \ CURLINFO_SIZE_UPLOAD.3 \ CURLINFO_SPEED_DOWNLOAD.3 \ @@ -209,6 +212,7 @@ man_MANS = \ CURLOPT_POSTQUOTE.3 \ CURLOPT_POSTREDIR.3 \ CURLOPT_PREQUOTE.3 \ + CURLOPT_PRE_PROXY.3 \ CURLOPT_PRIVATE.3 \ CURLOPT_PROGRESSDATA.3 \ CURLOPT_PROGRESSFUNCTION.3 \ @@ -221,7 +225,24 @@ man_MANS = \ CURLOPT_PROXYTYPE.3 \ CURLOPT_PROXYUSERNAME.3 \ CURLOPT_PROXYUSERPWD.3 \ + CURLOPT_PROXY_CAINFO.3 \ + CURLOPT_PROXY_CAPATH.3 \ + CURLOPT_PROXY_CRLFILE.3 \ + CURLOPT_PROXY_KEYPASSWD.3 \ + CURLOPT_PROXY_PINNEDPUBLICKEY.3 \ CURLOPT_PROXY_SERVICE_NAME.3 \ + CURLOPT_PROXY_SSLCERT.3 \ + CURLOPT_PROXY_SSLCERTTYPE.3 \ + CURLOPT_PROXY_SSLKEY.3 \ + CURLOPT_PROXY_SSLKEYTYPE.3 \ + CURLOPT_PROXY_SSLVERSION.3 \ + CURLOPT_PROXY_SSL_CIPHER_LIST.3 \ + CURLOPT_PROXY_SSL_OPTIONS.3 \ + CURLOPT_PROXY_SSL_VERIFYHOST.3 \ + CURLOPT_PROXY_SSL_VERIFYPEER.3 \ + CURLOPT_PROXY_TLSAUTH_PASSWORD.3 \ + CURLOPT_PROXY_TLSAUTH_TYPE.3 \ + CURLOPT_PROXY_TLSAUTH_USERNAME.3 \ CURLOPT_PROXY_TRANSFER_MODE.3 \ CURLOPT_PUT.3 \ CURLOPT_QUOTE.3 \ @@ -327,6 +348,7 @@ HTMLPAGES = \ CURLINFO_HEADER_SIZE.html \ CURLINFO_HTTPAUTH_AVAIL.html \ CURLINFO_HTTP_CONNECTCODE.html \ + CURLINFO_HTTP_VERSION.html \ CURLINFO_LASTSOCKET.html \ CURLINFO_LOCAL_IP.html \ CURLINFO_LOCAL_PORT.html \ @@ -337,7 +359,9 @@ HTMLPAGES = \ CURLINFO_PRIMARY_IP.html \ CURLINFO_PRIMARY_PORT.html \ CURLINFO_PRIVATE.html \ + CURLINFO_PROTOCOL.html \ CURLINFO_PROXYAUTH_AVAIL.html \ + CURLINFO_PROXY_SSL_VERIFYRESULT.html \ CURLINFO_REDIRECT_COUNT.html \ CURLINFO_REDIRECT_TIME.html \ CURLINFO_REDIRECT_URL.html \ @@ -347,6 +371,7 @@ HTMLPAGES = \ CURLINFO_RTSP_CSEQ_RECV.html \ CURLINFO_RTSP_SERVER_CSEQ.html \ CURLINFO_RTSP_SESSION_ID.html \ + CURLINFO_SCHEME.html \ CURLINFO_SIZE_DOWNLOAD.html \ CURLINFO_SIZE_UPLOAD.html \ CURLINFO_SPEED_DOWNLOAD.html \ @@ -497,6 +522,7 @@ HTMLPAGES = \ CURLOPT_POSTQUOTE.html \ CURLOPT_POSTREDIR.html \ CURLOPT_PREQUOTE.html \ + CURLOPT_PRE_PROXY.html \ CURLOPT_PRIVATE.html \ CURLOPT_PROGRESSDATA.html \ CURLOPT_PROGRESSFUNCTION.html \ @@ -509,7 +535,24 @@ HTMLPAGES = \ CURLOPT_PROXYTYPE.html \ CURLOPT_PROXYUSERNAME.html \ CURLOPT_PROXYUSERPWD.html \ + CURLOPT_PROXY_CAINFO.html \ + CURLOPT_PROXY_CAPATH.html \ + CURLOPT_PROXY_CRLFILE.html \ + CURLOPT_PROXY_KEYPASSWD.html \ + CURLOPT_PROXY_PINNEDPUBLICKEY.html \ CURLOPT_PROXY_SERVICE_NAME.html \ + CURLOPT_PROXY_SSLCERT.html \ + CURLOPT_PROXY_SSLCERTTYPE.html \ + CURLOPT_PROXY_SSLKEY.html \ + CURLOPT_PROXY_SSLKEYTYPE.html \ + CURLOPT_PROXY_SSLVERSION.html \ + CURLOPT_PROXY_SSL_CIPHER_LIST.html \ + CURLOPT_PROXY_SSL_OPTIONS.html \ + CURLOPT_PROXY_SSL_VERIFYHOST.html \ + CURLOPT_PROXY_SSL_VERIFYPEER.html \ + CURLOPT_PROXY_TLSAUTH_PASSWORD.html \ + CURLOPT_PROXY_TLSAUTH_TYPE.html \ + CURLOPT_PROXY_TLSAUTH_USERNAME.html \ CURLOPT_PROXY_TRANSFER_MODE.html \ CURLOPT_PUT.html \ CURLOPT_QUOTE.html \ @@ -615,6 +658,7 @@ PDFPAGES = \ CURLINFO_HEADER_SIZE.pdf \ CURLINFO_HTTPAUTH_AVAIL.pdf \ CURLINFO_HTTP_CONNECTCODE.pdf \ + CURLINFO_HTTP_VERSION.pdf \ CURLINFO_LASTSOCKET.pdf \ CURLINFO_LOCAL_IP.pdf \ CURLINFO_LOCAL_PORT.pdf \ @@ -625,7 +669,9 @@ PDFPAGES = \ CURLINFO_PRIMARY_IP.pdf \ CURLINFO_PRIMARY_PORT.pdf \ CURLINFO_PRIVATE.pdf \ + CURLINFO_PROTOCOL.pdf \ CURLINFO_PROXYAUTH_AVAIL.pdf \ + CURLINFO_PROXY_SSL_VERIFYRESULT.pdf \ CURLINFO_REDIRECT_COUNT.pdf \ CURLINFO_REDIRECT_TIME.pdf \ CURLINFO_REDIRECT_URL.pdf \ @@ -635,6 +681,7 @@ PDFPAGES = \ CURLINFO_RTSP_CSEQ_RECV.pdf \ CURLINFO_RTSP_SERVER_CSEQ.pdf \ CURLINFO_RTSP_SESSION_ID.pdf \ + CURLINFO_SCHEME.pdf \ CURLINFO_SIZE_DOWNLOAD.pdf \ CURLINFO_SIZE_UPLOAD.pdf \ CURLINFO_SPEED_DOWNLOAD.pdf \ @@ -785,6 +832,7 @@ PDFPAGES = \ CURLOPT_POSTQUOTE.pdf \ CURLOPT_POSTREDIR.pdf \ CURLOPT_PREQUOTE.pdf \ + CURLOPT_PRE_PROXY.pdf \ CURLOPT_PRIVATE.pdf \ CURLOPT_PROGRESSDATA.pdf \ CURLOPT_PROGRESSFUNCTION.pdf \ @@ -797,7 +845,24 @@ PDFPAGES = \ CURLOPT_PROXYTYPE.pdf \ CURLOPT_PROXYUSERNAME.pdf \ CURLOPT_PROXYUSERPWD.pdf \ + CURLOPT_PROXY_CAINFO.pdf \ + CURLOPT_PROXY_CAPATH.pdf \ + CURLOPT_PROXY_CRLFILE.pdf \ + CURLOPT_PROXY_KEYPASSWD.pdf \ + CURLOPT_PROXY_PINNEDPUBLICKEY.pdf \ CURLOPT_PROXY_SERVICE_NAME.pdf \ + CURLOPT_PROXY_SSLCERT.pdf \ + CURLOPT_PROXY_SSLCERTTYPE.pdf \ + CURLOPT_PROXY_SSLKEY.pdf \ + CURLOPT_PROXY_SSLKEYTYPE.pdf \ + CURLOPT_PROXY_SSLVERSION.pdf \ + CURLOPT_PROXY_SSL_CIPHER_LIST.pdf \ + CURLOPT_PROXY_SSL_OPTIONS.pdf \ + CURLOPT_PROXY_SSL_VERIFYHOST.pdf \ + CURLOPT_PROXY_SSL_VERIFYPEER.pdf \ + CURLOPT_PROXY_TLSAUTH_PASSWORD.pdf \ + CURLOPT_PROXY_TLSAUTH_TYPE.pdf \ + CURLOPT_PROXY_TLSAUTH_USERNAME.pdf \ CURLOPT_PROXY_TRANSFER_MODE.pdf \ CURLOPT_PUT.pdf \ CURLOPT_QUOTE.pdf \ @@ -910,3 +975,9 @@ pdf: $(PDFPAGES) mancheck: @cd $(top_srcdir)/docs/libcurl/opts && ls `awk -F, '!/OBSOLETE/ && /^ CINIT/ { a=substr($$1, 9); print "CURLOPT_" a ".3"}' $(top_srcdir)/include/curl/curl.h` + rm -f in_temp + @(for a in $(man_MANS); do echo $$a >>in_temp; done) + sort in_temp > in_makefile + ls CURL*.3 > in_directory + -diff -u in_makefile in_directory + rm in_temp in_directory in_makefile diff --git a/docs/libcurl/opts/Makefile.in b/docs/libcurl/opts/Makefile.in index 195a225f..0296eb37 100644 --- a/docs/libcurl/opts/Makefile.in +++ b/docs/libcurl/opts/Makefile.in @@ -408,7 +408,9 @@ man_MANS = \ CURLINFO_PRIMARY_IP.3 \ CURLINFO_PRIMARY_PORT.3 \ CURLINFO_PRIVATE.3 \ + CURLINFO_PROTOCOL.3 \ CURLINFO_PROXYAUTH_AVAIL.3 \ + CURLINFO_PROXY_SSL_VERIFYRESULT.3 \ CURLINFO_REDIRECT_COUNT.3 \ CURLINFO_REDIRECT_TIME.3 \ CURLINFO_REDIRECT_URL.3 \ @@ -418,6 +420,7 @@ man_MANS = \ CURLINFO_RTSP_CSEQ_RECV.3 \ CURLINFO_RTSP_SERVER_CSEQ.3 \ CURLINFO_RTSP_SESSION_ID.3 \ + CURLINFO_SCHEME.3 \ CURLINFO_SIZE_DOWNLOAD.3 \ CURLINFO_SIZE_UPLOAD.3 \ CURLINFO_SPEED_DOWNLOAD.3 \ @@ -568,6 +571,7 @@ man_MANS = \ CURLOPT_POSTQUOTE.3 \ CURLOPT_POSTREDIR.3 \ CURLOPT_PREQUOTE.3 \ + CURLOPT_PRE_PROXY.3 \ CURLOPT_PRIVATE.3 \ CURLOPT_PROGRESSDATA.3 \ CURLOPT_PROGRESSFUNCTION.3 \ @@ -580,7 +584,24 @@ man_MANS = \ CURLOPT_PROXYTYPE.3 \ CURLOPT_PROXYUSERNAME.3 \ CURLOPT_PROXYUSERPWD.3 \ + CURLOPT_PROXY_CAINFO.3 \ + CURLOPT_PROXY_CAPATH.3 \ + CURLOPT_PROXY_CRLFILE.3 \ + CURLOPT_PROXY_KEYPASSWD.3 \ + CURLOPT_PROXY_PINNEDPUBLICKEY.3 \ CURLOPT_PROXY_SERVICE_NAME.3 \ + CURLOPT_PROXY_SSLCERT.3 \ + CURLOPT_PROXY_SSLCERTTYPE.3 \ + CURLOPT_PROXY_SSLKEY.3 \ + CURLOPT_PROXY_SSLKEYTYPE.3 \ + CURLOPT_PROXY_SSLVERSION.3 \ + CURLOPT_PROXY_SSL_CIPHER_LIST.3 \ + CURLOPT_PROXY_SSL_OPTIONS.3 \ + CURLOPT_PROXY_SSL_VERIFYHOST.3 \ + CURLOPT_PROXY_SSL_VERIFYPEER.3 \ + CURLOPT_PROXY_TLSAUTH_PASSWORD.3 \ + CURLOPT_PROXY_TLSAUTH_TYPE.3 \ + CURLOPT_PROXY_TLSAUTH_USERNAME.3 \ CURLOPT_PROXY_TRANSFER_MODE.3 \ CURLOPT_PUT.3 \ CURLOPT_QUOTE.3 \ @@ -686,6 +707,7 @@ HTMLPAGES = \ CURLINFO_HEADER_SIZE.html \ CURLINFO_HTTPAUTH_AVAIL.html \ CURLINFO_HTTP_CONNECTCODE.html \ + CURLINFO_HTTP_VERSION.html \ CURLINFO_LASTSOCKET.html \ CURLINFO_LOCAL_IP.html \ CURLINFO_LOCAL_PORT.html \ @@ -696,7 +718,9 @@ HTMLPAGES = \ CURLINFO_PRIMARY_IP.html \ CURLINFO_PRIMARY_PORT.html \ CURLINFO_PRIVATE.html \ + CURLINFO_PROTOCOL.html \ CURLINFO_PROXYAUTH_AVAIL.html \ + CURLINFO_PROXY_SSL_VERIFYRESULT.html \ CURLINFO_REDIRECT_COUNT.html \ CURLINFO_REDIRECT_TIME.html \ CURLINFO_REDIRECT_URL.html \ @@ -706,6 +730,7 @@ HTMLPAGES = \ CURLINFO_RTSP_CSEQ_RECV.html \ CURLINFO_RTSP_SERVER_CSEQ.html \ CURLINFO_RTSP_SESSION_ID.html \ + CURLINFO_SCHEME.html \ CURLINFO_SIZE_DOWNLOAD.html \ CURLINFO_SIZE_UPLOAD.html \ CURLINFO_SPEED_DOWNLOAD.html \ @@ -856,6 +881,7 @@ HTMLPAGES = \ CURLOPT_POSTQUOTE.html \ CURLOPT_POSTREDIR.html \ CURLOPT_PREQUOTE.html \ + CURLOPT_PRE_PROXY.html \ CURLOPT_PRIVATE.html \ CURLOPT_PROGRESSDATA.html \ CURLOPT_PROGRESSFUNCTION.html \ @@ -868,7 +894,24 @@ HTMLPAGES = \ CURLOPT_PROXYTYPE.html \ CURLOPT_PROXYUSERNAME.html \ CURLOPT_PROXYUSERPWD.html \ + CURLOPT_PROXY_CAINFO.html \ + CURLOPT_PROXY_CAPATH.html \ + CURLOPT_PROXY_CRLFILE.html \ + CURLOPT_PROXY_KEYPASSWD.html \ + CURLOPT_PROXY_PINNEDPUBLICKEY.html \ CURLOPT_PROXY_SERVICE_NAME.html \ + CURLOPT_PROXY_SSLCERT.html \ + CURLOPT_PROXY_SSLCERTTYPE.html \ + CURLOPT_PROXY_SSLKEY.html \ + CURLOPT_PROXY_SSLKEYTYPE.html \ + CURLOPT_PROXY_SSLVERSION.html \ + CURLOPT_PROXY_SSL_CIPHER_LIST.html \ + CURLOPT_PROXY_SSL_OPTIONS.html \ + CURLOPT_PROXY_SSL_VERIFYHOST.html \ + CURLOPT_PROXY_SSL_VERIFYPEER.html \ + CURLOPT_PROXY_TLSAUTH_PASSWORD.html \ + CURLOPT_PROXY_TLSAUTH_TYPE.html \ + CURLOPT_PROXY_TLSAUTH_USERNAME.html \ CURLOPT_PROXY_TRANSFER_MODE.html \ CURLOPT_PUT.html \ CURLOPT_QUOTE.html \ @@ -974,6 +1017,7 @@ PDFPAGES = \ CURLINFO_HEADER_SIZE.pdf \ CURLINFO_HTTPAUTH_AVAIL.pdf \ CURLINFO_HTTP_CONNECTCODE.pdf \ + CURLINFO_HTTP_VERSION.pdf \ CURLINFO_LASTSOCKET.pdf \ CURLINFO_LOCAL_IP.pdf \ CURLINFO_LOCAL_PORT.pdf \ @@ -984,7 +1028,9 @@ PDFPAGES = \ CURLINFO_PRIMARY_IP.pdf \ CURLINFO_PRIMARY_PORT.pdf \ CURLINFO_PRIVATE.pdf \ + CURLINFO_PROTOCOL.pdf \ CURLINFO_PROXYAUTH_AVAIL.pdf \ + CURLINFO_PROXY_SSL_VERIFYRESULT.pdf \ CURLINFO_REDIRECT_COUNT.pdf \ CURLINFO_REDIRECT_TIME.pdf \ CURLINFO_REDIRECT_URL.pdf \ @@ -994,6 +1040,7 @@ PDFPAGES = \ CURLINFO_RTSP_CSEQ_RECV.pdf \ CURLINFO_RTSP_SERVER_CSEQ.pdf \ CURLINFO_RTSP_SESSION_ID.pdf \ + CURLINFO_SCHEME.pdf \ CURLINFO_SIZE_DOWNLOAD.pdf \ CURLINFO_SIZE_UPLOAD.pdf \ CURLINFO_SPEED_DOWNLOAD.pdf \ @@ -1144,6 +1191,7 @@ PDFPAGES = \ CURLOPT_POSTQUOTE.pdf \ CURLOPT_POSTREDIR.pdf \ CURLOPT_PREQUOTE.pdf \ + CURLOPT_PRE_PROXY.pdf \ CURLOPT_PRIVATE.pdf \ CURLOPT_PROGRESSDATA.pdf \ CURLOPT_PROGRESSFUNCTION.pdf \ @@ -1156,7 +1204,24 @@ PDFPAGES = \ CURLOPT_PROXYTYPE.pdf \ CURLOPT_PROXYUSERNAME.pdf \ CURLOPT_PROXYUSERPWD.pdf \ + CURLOPT_PROXY_CAINFO.pdf \ + CURLOPT_PROXY_CAPATH.pdf \ + CURLOPT_PROXY_CRLFILE.pdf \ + CURLOPT_PROXY_KEYPASSWD.pdf \ + CURLOPT_PROXY_PINNEDPUBLICKEY.pdf \ CURLOPT_PROXY_SERVICE_NAME.pdf \ + CURLOPT_PROXY_SSLCERT.pdf \ + CURLOPT_PROXY_SSLCERTTYPE.pdf \ + CURLOPT_PROXY_SSLKEY.pdf \ + CURLOPT_PROXY_SSLKEYTYPE.pdf \ + CURLOPT_PROXY_SSLVERSION.pdf \ + CURLOPT_PROXY_SSL_CIPHER_LIST.pdf \ + CURLOPT_PROXY_SSL_OPTIONS.pdf \ + CURLOPT_PROXY_SSL_VERIFYHOST.pdf \ + CURLOPT_PROXY_SSL_VERIFYPEER.pdf \ + CURLOPT_PROXY_TLSAUTH_PASSWORD.pdf \ + CURLOPT_PROXY_TLSAUTH_TYPE.pdf \ + CURLOPT_PROXY_TLSAUTH_USERNAME.pdf \ CURLOPT_PROXY_TRANSFER_MODE.pdf \ CURLOPT_PUT.pdf \ CURLOPT_QUOTE.pdf \ @@ -1505,6 +1570,12 @@ pdf: $(PDFPAGES) mancheck: @cd $(top_srcdir)/docs/libcurl/opts && ls `awk -F, '!/OBSOLETE/ && /^ CINIT/ { a=substr($$1, 9); print "CURLOPT_" a ".3"}' $(top_srcdir)/include/curl/curl.h` + rm -f in_temp + @(for a in $(man_MANS); do echo $$a >>in_temp; done) + sort in_temp > in_makefile + ls CURL*.3 > in_directory + -diff -u in_makefile in_directory + rm in_temp in_directory in_makefile # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. diff --git a/docs/libcurl/symbols-in-versions b/docs/libcurl/symbols-in-versions index f6365ae1..bd5960c2 100644 --- a/docs/libcurl/symbols-in-versions +++ b/docs/libcurl/symbols-in-versions @@ -239,7 +239,9 @@ CURLINFO_PRETRANSFER_TIME 7.4.1 CURLINFO_PRIMARY_IP 7.19.0 CURLINFO_PRIMARY_PORT 7.21.0 CURLINFO_PRIVATE 7.10.3 +CURLINFO_PROTOCOL 7.52.0 CURLINFO_PROXYAUTH_AVAIL 7.10.8 +CURLINFO_PROXY_SSL_VERIFYRESULT 7.52.0 CURLINFO_REDIRECT_COUNT 7.9.7 CURLINFO_REDIRECT_TIME 7.9.7 CURLINFO_REDIRECT_URL 7.18.2 @@ -249,6 +251,7 @@ CURLINFO_RTSP_CLIENT_CSEQ 7.20.0 CURLINFO_RTSP_CSEQ_RECV 7.20.0 CURLINFO_RTSP_SERVER_CSEQ 7.20.0 CURLINFO_RTSP_SESSION_ID 7.20.0 +CURLINFO_SCHEME 7.52.0 CURLINFO_SIZE_DOWNLOAD 7.4.1 CURLINFO_SIZE_UPLOAD 7.4.1 CURLINFO_SLIST 7.12.3 @@ -456,6 +459,7 @@ CURLOPT_POSTFIELDSIZE_LARGE 7.11.1 CURLOPT_POSTQUOTE 7.1 CURLOPT_POSTREDIR 7.19.1 CURLOPT_PREQUOTE 7.9.5 +CURLOPT_PRE_PROXY 7.52.0 CURLOPT_PRIVATE 7.10.3 CURLOPT_PROGRESSDATA 7.1 CURLOPT_PROGRESSFUNCTION 7.1 7.32.0 @@ -468,7 +472,24 @@ CURLOPT_PROXYPORT 7.1 CURLOPT_PROXYTYPE 7.10 CURLOPT_PROXYUSERNAME 7.19.1 CURLOPT_PROXYUSERPWD 7.1 +CURLOPT_PROXY_CAINFO 7.52.0 +CURLOPT_PROXY_CAPATH 7.52.0 +CURLOPT_PROXY_CRLFILE 7.52.0 +CURLOPT_PROXY_KEYPASSWD 7.52.0 +CURLOPT_PROXY_PINNEDPUBLICKEY 7.52.0 CURLOPT_PROXY_SERVICE_NAME 7.43.0 +CURLOPT_PROXY_SSLCERT 7.52.0 +CURLOPT_PROXY_SSLCERTTYPE 7.52.0 +CURLOPT_PROXY_SSLKEY 7.52.0 +CURLOPT_PROXY_SSLKEYTYPE 7.52.0 +CURLOPT_PROXY_SSLVERSION 7.52.0 +CURLOPT_PROXY_SSL_CIPHER_LIST 7.52.0 +CURLOPT_PROXY_SSL_OPTIONS 7.52.0 +CURLOPT_PROXY_SSL_VERIFYHOST 7.52.0 +CURLOPT_PROXY_SSL_VERIFYPEER 7.52.0 +CURLOPT_PROXY_TLSAUTH_PASSWORD 7.52.0 +CURLOPT_PROXY_TLSAUTH_TYPE 7.52.0 +CURLOPT_PROXY_TLSAUTH_USERNAME 7.52.0 CURLOPT_PROXY_TRANSFER_MODE 7.18.0 CURLOPT_PUT 7.1 CURLOPT_QUOTE 7.1 @@ -611,6 +632,7 @@ CURLPROTO_TELNET 7.19.4 CURLPROTO_TFTP 7.19.4 CURLPROXY_HTTP 7.10 CURLPROXY_HTTP_1_0 7.19.4 +CURLPROXY_HTTPS 7.52.0 CURLPROXY_SOCKS4 7.10 CURLPROXY_SOCKS4A 7.18.0 CURLPROXY_SOCKS5 7.10 @@ -773,6 +795,7 @@ CURL_SSLVERSION_TLSv1 7.9.2 CURL_SSLVERSION_TLSv1_0 7.34.0 CURL_SSLVERSION_TLSv1_1 7.34.0 CURL_SSLVERSION_TLSv1_2 7.34.0 +CURL_SSLVERSION_TLSv1_3 7.52.0 CURL_TIMECOND_IFMODSINCE 7.9.7 CURL_TIMECOND_IFUNMODSINCE 7.9.7 CURL_TIMECOND_LASTMOD 7.9.7 @@ -786,6 +809,7 @@ CURL_VERSION_DEBUG 7.10.6 CURL_VERSION_GSSAPI 7.38.0 CURL_VERSION_GSSNEGOTIATE 7.10.6 7.38.0 CURL_VERSION_HTTP2 7.33.0 +CURL_VERSION_HTTPS_PROXY 7.52.0 CURL_VERSION_IDN 7.12.0 CURL_VERSION_IPV6 7.10 CURL_VERSION_KERBEROS4 7.10 7.33.0 |