Skip to content

Commit ec156d5

Browse files
committed
docs/libcurl: mention sensitive data/headers
In the CURLOPT_DEBUGFUNCTION and CURLOPT_VERBOSE documentation. Mentioned-by: Gordon Parke Fixes #17353
1 parent f5b7eb2 commit ec156d5

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

docs/libcurl/opts/CURLOPT_DEBUGFUNCTION.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,13 @@ Pass a pointer to your callback function, which should match the prototype
5151
shown above.
5252
5353
CURLOPT_DEBUGFUNCTION(3) replaces the standard debug function used when
54-
CURLOPT_VERBOSE(3) is in effect. This callback receives debug
55-
information, as specified in the *type* argument. This function must
56-
return 0. The *data* pointed to by the char * passed to this function is
57-
not null-terminated, but is exactly of the *size* as told by the
58-
*size* argument.
54+
CURLOPT_VERBOSE(3) is in effect. This callback receives debug information, as
55+
specified in the *type* argument. This function must return 0. The *data*
56+
pointed to by the char * passed to this function is not null-terminated, but
57+
is exactly of the *size* as told by the *size* argument.
58+
59+
**WARNING** this callback maye receive sensitive contents from headers and
60+
data.
5961
6062
The *clientp* argument is the pointer set with CURLOPT_DEBUGDATA(3).
6163

docs/libcurl/opts/CURLOPT_VERBOSE.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,19 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_VERBOSE, long onoff);
2828
2929
# DESCRIPTION
3030
31-
Set the *onoff* parameter to 1 to make the library display a lot of
32-
verbose information about its operations on this *handle*. Useful for
33-
libcurl and/or protocol debugging and understanding. The verbose information
34-
is sent to stderr, or the stream set with CURLOPT_STDERR(3).
31+
Set the *onoff* parameter to 1 to make the library display a lot of verbose
32+
information about its operations on this *handle*. Useful for libcurl and/or
33+
protocol debugging and understanding. The verbose information is sent to
34+
stderr, or the stream set with CURLOPT_STDERR(3).
3535
3636
You hardly ever want this enabled in production use, you almost always want
3737
this used when you debug/report problems.
3838
3939
To also get all the protocol data sent and received, consider using the
4040
CURLOPT_DEBUGFUNCTION(3).
4141
42+
**WARNING** this may show sensitive contents from headers and data.
43+
4244
# DEFAULT
4345
4446
0, meaning disabled.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy