Skip to content

Commit eba5dd7

Browse files
authored
docs: warn to redact credentials from log output before sharing (ai-openshell#2124)
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>
1 parent 9c14de7 commit eba5dd7

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ body:
5959
id: logs
6060
attributes:
6161
label: Logs
62-
description: Relevant log output, error messages, or stack traces.
62+
description: |
63+
Relevant log output, error messages, or stack traces.
64+
Redact credentials, API keys, and tokens before pasting — verbose error output from some frameworks includes the full request config.
6365
render: shell
6466
validations:
6567
required: false

‎docs/security/best-practices.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,7 @@ The following patterns weaken security without providing meaningful benefit.
288288
| Using broad binary globs | A glob like `/**` allows any binary to reach the endpoint, defeating binary-scoped enforcement. | Scope globs to specific directories (for example, `/sandbox/.vscode-server/**`). |
289289
| Skipping TLS termination on HTTPS APIs | Setting `tls: skip` disables placeholder credential rewriting, dynamic token grant injection, and L7 inspection. | Use the default auto-detect behavior unless the upstream requires client-certificate mTLS. |
290290
| Setting `enforcement: enforce` before auditing | Jumping to `enforce` without first running in `audit` mode risks breaking the agent's workflow. | Start with `audit`, review the logs, and switch to `enforce` after you validate the rules. |
291+
| Pasting raw stack traces in bug reports | Some frameworks include the full request config — including credentials — in error objects. The sandbox does not scrub application-level output. | Inspect error output before sharing. Redact any credentials, API keys, or tokens. |
291292

292293
## Related Topics
293294

0 commit comments

Comments
 (0)