docs: warn to redact credentials from log output before sharing#2124
Open
elezar wants to merge 1 commit into
Open
docs: warn to redact credentials from log output before sharing#2124elezar wants to merge 1 commit into
elezar wants to merge 1 commit into
Conversation
Add a reminder to the bug report template's Logs field and a new row in the security best-practices Common Mistakes table advising reporters to redact credentials, API keys, and tokens from stack traces before pasting. Signed-off-by: Evan Lezar <elezar@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
🌿 Preview your docs: https://nvidia-preview-pr-2124.docs.buildwithfern.com/openshell |
elezar
requested review from
a team,
derekwaynecarr,
maxamillion and
mrunalp
as code owners
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/security/best-practices.mdxnoting that some frameworks include credentials in error objects and that the sandbox does not scrub application-level outputRelated Issue
Prompted by secret scanning alert #8, where a reporter inadvertently leaked a Lark application secret by pasting a raw framework stack trace that included the full request config.
Changes
.github/ISSUE_TEMPLATE/bug_report.yml— expandedLogsfield description to remind reporters to redact credentials before pastingdocs/security/best-practices.mdx— new Common Mistakes row covering credential leakage via stack tracesTesting
mise run markdown:lintpassesChecklist