Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make redaction of common keys in diagnostics case insensitive #6109

Merged
32 changes: 32 additions & 0 deletions changelog/fragments/1732184289-redact-case-insensitive.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Kind can be one of:
# - breaking-change: a change to previously-documented behavior
# - deprecation: functionality that is being removed in a later release
# - bug-fix: fixes a problem in a previous version
# - enhancement: extends functionality but does not break or fix existing behavior
# - feature: new functionality
# - known-issue: problems that we are aware of in a given version
# - security: impacts on the security of a product or a user’s deployment.
# - upgrade: important information for someone upgrading from a prior version
# - other: does not fit into any of the other categories
kind: bug-fix

# Change summary; a 80ish characters long description of the change.
summary: Make redaction of common keys in diagnostics case insensitive

# Long description; in case the summary is not enough to describe the change
# this field accommodate a description without length limits.
# NOTE: This field will be rendered only for breaking-change and known-issue kinds at the moment.
#description:

# Affected component; usually one of "elastic-agent", "fleet-server", "filebeat", "metricbeat", "auditbeat", "all", etc.
component: elastic-agent

# PR URL; optional; the PR number that added the changeset.
# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
# Please provide it if you are adding a fragment for a different PR.
#pr: https://github.com/owner/repo/1234

# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of).
# If not present is automatically filled by the tooling with the issue linked to the PR number.
#issue: https://github.com/owner/repo/1234
1 change: 1 addition & 0 deletions internal/pkg/diagnostics/diagnostics.go
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,7 @@ func redactKey(k string) bool {
return false
}

k = strings.ToLower(k)
return strings.Contains(k, "certificate") ||
strings.Contains(k, "passphrase") ||
strings.Contains(k, "password") ||
Expand Down
28 changes: 27 additions & 1 deletion internal/pkg/diagnostics/diagnostics_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,33 @@ inputs:
outputs:
default:
api_key: <REDACTED>
redactOtherKey: secretOutputValue
redactOtherKey: <REDACTED>
type: elasticsearch
`,
}, {
name: "uppercase fields are redacted",
input: []byte(`id: test-policy
inputs:
- type: test_input
outputs:
default:
type: elasticsearch
api_key: secretKey
Certificate: secretCert
PassPhrase: secretPassphrase
PASSWORD: secretPassword
tOkEn: secretToken
`),
expect: `id: test-policy
inputs:
- type: test_input
outputs:
default:
Certificate: <REDACTED>
PASSWORD: <REDACTED>
PassPhrase: <REDACTED>
api_key: <REDACTED>
tOkEn: <REDACTED>
type: elasticsearch
`,
}, {
Expand Down
Loading