docs: reference non deprecated libcurl options

There are a places where man pages reference deprecated CURLOPT options,
where it doesn't make sense, replace them with the reccomended
replacement option.

also remove reference to the removed mesalink TLS backend

Closes #13951
This commit is contained in:
Yedaya Katsman 2024-06-14 11:19:32 +03:00 committed by Daniel Stenberg
parent 6b93190fae
commit 9d09f9ec7a
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
8 changed files with 17 additions and 17 deletions

View File

@ -121,7 +121,7 @@ user running the libcurl application, SCP: or SFTP: URLs could access password
or private-key protected resources, or private-key protected resources,
e.g. **sftp://user@some-internal-server/etc/passwd** e.g. **sftp://user@some-internal-server/etc/passwd**
The CURLOPT_REDIR_PROTOCOLS(3) and CURLOPT_NETRC(3) options can be The CURLOPT_REDIR_PROTOCOLS_STR(3) and CURLOPT_NETRC(3) options can be
used to mitigate against this kind of attack. used to mitigate against this kind of attack.
A redirect can also specify a location available only on the machine running A redirect can also specify a location available only on the machine running
@ -132,7 +132,7 @@ E.g. **http://127.0.0.1/** or **http://intranet/delete-stuff.cgi?delete=all** or
Applications can mitigate against this by disabling Applications can mitigate against this by disabling
CURLOPT_FOLLOWLOCATION(3) and handling redirects itself, sanitizing URLs CURLOPT_FOLLOWLOCATION(3) and handling redirects itself, sanitizing URLs
as necessary. Alternately, an app could leave CURLOPT_FOLLOWLOCATION(3) as necessary. Alternately, an app could leave CURLOPT_FOLLOWLOCATION(3)
enabled but set CURLOPT_REDIR_PROTOCOLS(3) and install a enabled but set CURLOPT_REDIR_PROTOCOLS_STR(3) and install a
CURLOPT_OPENSOCKETFUNCTION(3) or CURLOPT_PREREQFUNCTION(3) callback CURLOPT_OPENSOCKETFUNCTION(3) or CURLOPT_PREREQFUNCTION(3) callback
function in which addresses are sanitized before use. function in which addresses are sanitized before use.
@ -164,7 +164,7 @@ non-redirected URLs, if the user is allowed to specify an arbitrary URL that
could point to a private resource. For example, a web app providing a could point to a private resource. For example, a web app providing a
translation service might happily translate **file://localhost/etc/passwd** translation service might happily translate **file://localhost/etc/passwd**
and display the result. Applications can mitigate against this with the and display the result. Applications can mitigate against this with the
CURLOPT_PROTOCOLS(3) option as well as by similar mitigation techniques CURLOPT_PROTOCOLS_STR(3) option as well as by similar mitigation techniques
for redirections. for redirections.
A malicious FTP server could in response to the PASV command return an IP A malicious FTP server could in response to the PASV command return an IP
@ -308,9 +308,9 @@ Remedies:
curl command lines can use *--proto* to limit what URL schemes it accepts curl command lines can use *--proto* to limit what URL schemes it accepts
## Use CURLOPT_PROTOCOLS ## Use CURLOPT_PROTOCOLS_STR
libcurl programs can use CURLOPT_PROTOCOLS(3) to limit what URL schemes it accepts libcurl programs can use CURLOPT_PROTOCOLS_STR(3) to limit what URL schemes it accepts
## consider not allowing the user to set the full URL ## consider not allowing the user to set the full URL

View File

@ -60,8 +60,8 @@ struct curl_tlssessioninfo {
The *backend* struct member is one of the defines in the CURLSSLBACKEND_* The *backend* struct member is one of the defines in the CURLSSLBACKEND_*
series: CURLSSLBACKEND_NONE (when built without TLS support), series: CURLSSLBACKEND_NONE (when built without TLS support),
CURLSSLBACKEND_WOLFSSL, CURLSSLBACKEND_SECURETRANSPORT, CURLSSLBACKEND_GNUTLS, CURLSSLBACKEND_WOLFSSL, CURLSSLBACKEND_SECURETRANSPORT, CURLSSLBACKEND_GNUTLS,
CURLSSLBACKEND_MBEDTLS, CURLSSLBACKEND_NSS, CURLSSLBACKEND_OPENSSL, CURLSSLBACKEND_MBEDTLS, CURLSSLBACKEND_NSS, CURLSSLBACKEND_OPENSSL or
CURLSSLBACKEND_SCHANNEL or CURLSSLBACKEND_MESALINK. (Note that the OpenSSL CURLSSLBACKEND_SCHANNEL. (Note that the OpenSSL
forks are all reported as just OpenSSL here.) forks are all reported as just OpenSSL here.)
The *internals* struct member points to a TLS library specific pointer for The *internals* struct member points to a TLS library specific pointer for

View File

@ -5,7 +5,7 @@ Title: CURLOPT_DISALLOW_USERNAME_IN_URL
Section: 3 Section: 3
Source: libcurl Source: libcurl
See-also: See-also:
- CURLOPT_PROTOCOLS (3) - CURLOPT_PROTOCOLS_STR (3)
- CURLOPT_URL (3) - CURLOPT_URL (3)
- curl_url_set (3) - curl_url_set (3)
- libcurl-security (3) - libcurl-security (3)

View File

@ -8,8 +8,8 @@ See-also:
- CURLINFO_REDIRECT_COUNT (3) - CURLINFO_REDIRECT_COUNT (3)
- CURLINFO_REDIRECT_URL (3) - CURLINFO_REDIRECT_URL (3)
- CURLOPT_POSTREDIR (3) - CURLOPT_POSTREDIR (3)
- CURLOPT_PROTOCOLS (3) - CURLOPT_PROTOCOLS_STR (3)
- CURLOPT_REDIR_PROTOCOLS (3) - CURLOPT_REDIR_PROTOCOLS_STR (3)
Protocol: Protocol:
- HTTP - HTTP
--- ---
@ -38,7 +38,7 @@ maximum limit is reached. CURLOPT_MAXREDIRS(3) is used to limit the
number of redirects libcurl follows. number of redirects libcurl follows.
libcurl restricts what protocols it automatically follow redirects to. The libcurl restricts what protocols it automatically follow redirects to. The
accepted target protocols are set with CURLOPT_REDIR_PROTOCOLS(3). By accepted target protocols are set with CURLOPT_REDIR_PROTOCOLS_STR(3). By
default libcurl allows HTTP, HTTPS, FTP and FTPS on redirects. default libcurl allows HTTP, HTTPS, FTP and FTPS on redirects.
When following a redirect, the specific 30x response code also dictates which When following a redirect, the specific 30x response code also dictates which

View File

@ -9,7 +9,7 @@ Protocol:
See-also: See-also:
- CURLOPT_HTTPPOST (3) - CURLOPT_HTTPPOST (3)
- CURLOPT_POSTFIELDS (3) - CURLOPT_POSTFIELDS (3)
- CURLOPT_PUT (3) - CURLOPT_UPLOAD (3)
--- ---
# NAME # NAME

View File

@ -6,7 +6,7 @@ Section: 3
Source: libcurl Source: libcurl
See-also: See-also:
- CURLOPT_PROXY (3) - CURLOPT_PROXY (3)
- CURLOPT_SOCKS5_GSSAPI_SERVICE (3) - CURLOPT_PROXY_SERVICE_NAME (3)
Protocol: Protocol:
- All - All
--- ---

View File

@ -77,7 +77,7 @@ int main(void)
/* Set the URL of the request */ /* Set the URL of the request */
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
/* Now set it as a put */ /* Now set it as a put */
curl_easy_setopt(curl, CURLOPT_PUT, 1L); curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
/* Assuming we have a function that returns the data to be pushed /* Assuming we have a function that returns the data to be pushed
Let that function be read_cb */ Let that function be read_cb */

View File

@ -10,7 +10,7 @@ See-also:
- CURLOPT_FORBID_REUSE (3) - CURLOPT_FORBID_REUSE (3)
- CURLOPT_FRESH_CONNECT (3) - CURLOPT_FRESH_CONNECT (3)
- CURLOPT_PATH_AS_IS (3) - CURLOPT_PATH_AS_IS (3)
- CURLOPT_PROTOCOLS (3) - CURLOPT_PROTOCOLS_STR (3)
- curl_easy_perform (3) - curl_easy_perform (3)
- curl_url_get (3) - curl_url_get (3)
- curl_url_set (3) - curl_url_set (3)
@ -109,11 +109,11 @@ custom port number can allow external users to play tricks with your local
services. services.
Accepting external URLs may also use other protocols than http:// or other Accepting external URLs may also use other protocols than http:// or other
common ones. Restrict what accept with CURLOPT_PROTOCOLS(3). common ones. Restrict what accept with CURLOPT_PROTOCOLS_STR(3).
User provided URLs can also be made to point to sites that redirect further on User provided URLs can also be made to point to sites that redirect further on
(possibly to other protocols too). Consider your (possibly to other protocols too). Consider your
CURLOPT_FOLLOWLOCATION(3) and CURLOPT_REDIR_PROTOCOLS(3) settings. CURLOPT_FOLLOWLOCATION(3) and CURLOPT_REDIR_PROTOCOLS_STR(3) settings.
# EXAMPLE # EXAMPLE