]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: reference non deprecated libcurl options
authorYedaya Katsman <yedaya.ka@gmail.com>
Fri, 14 Jun 2024 08:19:32 +0000 (11:19 +0300)
committerDaniel Stenberg <daniel@haxx.se>
Fri, 14 Jun 2024 11:24:41 +0000 (13:24 +0200)
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

docs/libcurl/libcurl-security.md
docs/libcurl/opts/CURLINFO_TLS_SSL_PTR.md
docs/libcurl/opts/CURLOPT_DISALLOW_USERNAME_IN_URL.md
docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.md
docs/libcurl/opts/CURLOPT_POST.md
docs/libcurl/opts/CURLOPT_SOCKS5_GSSAPI_NEC.md
docs/libcurl/opts/CURLOPT_TRAILERFUNCTION.md
docs/libcurl/opts/CURLOPT_URL.md

index 541489d23333af7aee78e85c756b2643fd0d2f62..a56a456015d2264a7ae16529e37372f3bf585835 100644 (file)
@@ -121,7 +121,7 @@ user running the libcurl application, SCP: or SFTP: URLs could access password
 or private-key protected resources,
 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.
 
 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
 CURLOPT_FOLLOWLOCATION(3) and handling redirects itself, sanitizing URLs
 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
 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
 translation service might happily translate **file://localhost/etc/passwd**
 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.
 
 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
 
-## 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
 
index d801f5a6f440b1daa67008922a46449f742e610a..af661a1658b4daa6a1233d888bfb53c20c664531 100644 (file)
@@ -60,8 +60,8 @@ struct curl_tlssessioninfo {
 The *backend* struct member is one of the defines in the CURLSSLBACKEND_*
 series: CURLSSLBACKEND_NONE (when built without TLS support),
 CURLSSLBACKEND_WOLFSSL, CURLSSLBACKEND_SECURETRANSPORT, CURLSSLBACKEND_GNUTLS,
-CURLSSLBACKEND_MBEDTLS, CURLSSLBACKEND_NSS, CURLSSLBACKEND_OPENSSL,
-CURLSSLBACKEND_SCHANNEL or CURLSSLBACKEND_MESALINK. (Note that the OpenSSL
+CURLSSLBACKEND_MBEDTLS, CURLSSLBACKEND_NSS, CURLSSLBACKEND_OPENSSL or
+CURLSSLBACKEND_SCHANNEL. (Note that the OpenSSL
 forks are all reported as just OpenSSL here.)
 
 The *internals* struct member points to a TLS library specific pointer for
index 788ef30185a8d9d06370e62127877cbd59c90c71..f22fd0efa7632551fabb3f2625fca94cd70e2b09 100644 (file)
@@ -5,7 +5,7 @@ Title: CURLOPT_DISALLOW_USERNAME_IN_URL
 Section: 3
 Source: libcurl
 See-also:
-  - CURLOPT_PROTOCOLS (3)
+  - CURLOPT_PROTOCOLS_STR (3)
   - CURLOPT_URL (3)
   - curl_url_set (3)
   - libcurl-security (3)
index 9dee48befaf7e2ee0faf79e376d2b8420342a30a..02fddd395f83e94dba752d78eeaf5619da7fee36 100644 (file)
@@ -8,8 +8,8 @@ See-also:
   - CURLINFO_REDIRECT_COUNT (3)
   - CURLINFO_REDIRECT_URL (3)
   - CURLOPT_POSTREDIR (3)
-  - CURLOPT_PROTOCOLS (3)
-  - CURLOPT_REDIR_PROTOCOLS (3)
+  - CURLOPT_PROTOCOLS_STR (3)
+  - CURLOPT_REDIR_PROTOCOLS_STR (3)
 Protocol:
   - HTTP
 ---
@@ -38,7 +38,7 @@ maximum limit is reached. CURLOPT_MAXREDIRS(3) is used to limit the
 number of redirects libcurl follows.
 
 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.
 
 When following a redirect, the specific 30x response code also dictates which
index b2aef4f3091d536f33818b060e48857347127576..a38805528315d28110e02249e01445e663e226cf 100644 (file)
@@ -9,7 +9,7 @@ Protocol:
 See-also:
   - CURLOPT_HTTPPOST (3)
   - CURLOPT_POSTFIELDS (3)
-  - CURLOPT_PUT (3)
+  - CURLOPT_UPLOAD (3)
 ---
 
 # NAME
index b46713017b3a160a3b24f3fe104ea717600cf7a7..8aea72cb418c4945c369bb7f9443f6ef19b50ea8 100644 (file)
@@ -6,7 +6,7 @@ Section: 3
 Source: libcurl
 See-also:
   - CURLOPT_PROXY (3)
-  - CURLOPT_SOCKS5_GSSAPI_SERVICE (3)
+  - CURLOPT_PROXY_SERVICE_NAME (3)
 Protocol:
   - All
 ---
index a6cd7fa5f1987fb7544e85994087c98a7fbc64f6..939512662ccf45ee3e4c38f8beb78d695aedcc84 100644 (file)
@@ -77,7 +77,7 @@ int main(void)
     /* Set the URL of the request */
     curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
     /* 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
        Let that function be read_cb */
index 2522d96bacfa948f4beb1fe427c3e60c6ddb2cbb..48e987305519dc93f6e364729d48e2b6a21ee6c4 100644 (file)
@@ -10,7 +10,7 @@ See-also:
   - CURLOPT_FORBID_REUSE (3)
   - CURLOPT_FRESH_CONNECT (3)
   - CURLOPT_PATH_AS_IS (3)
-  - CURLOPT_PROTOCOLS (3)
+  - CURLOPT_PROTOCOLS_STR (3)
   - curl_easy_perform (3)
   - curl_url_get (3)
   - curl_url_set (3)
@@ -109,11 +109,11 @@ custom port number can allow external users to play tricks with your local
 services.
 
 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
 (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