Skip to content

Commit 293f9e2

Browse files
authored
docs: provide logging recommendations (#371)
1 parent ef2fcc6 commit 293f9e2

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ or other security flaws.
5454
go-getter contains mitigations for some of these security issues, but should still be used with
5555
caution in security-critical contexts. See the available [security options](#Security-Options) that
5656
can be configured to mitigate some of these risks.
57+
58+
go-getter may return values that contain caller-provided query parameters that can contain sensitive data.
59+
Context around what parameters are and are not sensitive is known only by the caller of go-getter, and specific to each use case.
60+
We recommend the caller ensure that go-getter's return values (e.g., error messages) are properly handled and sanitized to ensure
61+
sensitive data is not persisted to logs.
5762
## URL Format
5863

5964
go-getter uses a single string URL as input to download from a variety of

0 commit comments

Comments
 (0)