Skip to content

Commit

Permalink
docs: provide logging recommendations (#371) (#372)
Browse files Browse the repository at this point in the history
Co-authored-by: mickael-hc <86245626+mickael-hc@users.noreply.github.com>
  • Loading branch information
nywilken and mickael-hc committed Jun 30, 2022
1 parent 106ef8d commit d10f069
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ go-getter contains mitigations for some of these security issues, but should sti
caution in security-critical contexts. See the available [security options](#Security-Options) that
can be configured to mitigate some of these risks.

go-getter may return values that contain caller-provided query parameters that can contain sensitive data.
Context around what parameters are and are not sensitive is known only by the caller of go-getter, and specific to each use case.
We recommend the caller ensure that go-getter's return values (e.g., error messages) are properly handled and sanitized to ensure
sensitive data is not persisted to logs.
## URL Format

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

0 comments on commit d10f069

Please sign in to comment.