[CRED-2625] Redact Authorization (Bearer) header in sanitize_request_header#3340
Draft
luczhou wants to merge 1 commit into
Draft
[CRED-2625] Redact Authorization (Bearer) header in sanitize_request_header#3340luczhou wants to merge 1 commit into
luczhou wants to merge 1 commit into
Conversation
api_client.rb's debug log path calls sanitize_request_header before @config.logger.debug to mask DD-API-KEY and DD-APPLICATION-KEY values. The Authorization header set from Bearer-token auth (delegated tokens, PATs) is missing from the keys_to_redact list and gets logged verbatim — any caller running with debug logging and access-token auth leaks the bearer to the global logger. Surfaced cross-language by terraform-provider-datadog#3757, which is the first Terraform code path to set the equivalent ContextAccessToken in the Go SDK. The same gap exists here in Ruby. Add "Authorization" as a third entry in keys_to_redact. Apply the change to both the .j2 template and the generated api_client.rb so the file matches what the next regen produces. Test (spec/api_client_spec.rb #sanitize_request_header) drives the method directly with all three credential headers plus a non-credential header set, asserts each credential becomes "REDACTED", the non- credential header passes through unchanged, and the input hash is not mutated. Refs: CRED-2625, terraform-provider-datadog#3757 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
5 tasks
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.
Description
api_client.rb's debug-log path (lib/datadog_api_client/api_client.rb:155-164, called from line 211) runs request headers throughsanitize_request_headerbefore@config.logger.debugto maskDD-API-KEYandDD-APPLICATION-KEYvalues. TheAuthorizationheader set from Bearer-token auth (delegated tokens, PATs) is missing from thekeys_to_redactlist and gets logged verbatim — any caller running with debug logging and access-token auth leaks the bearer to the global logger.Surfaced cross-language by terraform-provider-datadog#3757, which is the first Terraform code path to set the equivalent
ContextAccessTokenin the Go SDK. The same gap exists here in Ruby.Tracking ticket: CRED-2625.
Changes
.generator/src/generator/templates/api_client.j2:146: add"Authorization"as a third entry inkeys_to_redact.lib/datadog_api_client/api_client.rb: mirror the same edit in the generated file so the diff matches what the next regen produces.spec/api_client_spec.rb: new#sanitize_request_headerdescribe block — drives the method directly with all three credential headers plus a non-credential header, asserts each credential becomes"REDACTED", the non-credential header passes through unchanged, and the input hash is not mutated.Cross-language
Related work tracked under CRED-2625:
datadog-api-client-goPR #4098 — same fix shape (redactContextAccessTokeninCallAPIdebug dump).datadog-api-client-typescriptPR #4168 — same fix shape (addAuthorizationto allowlist inisomorphic-fetch.ts:logRequest).datadog-api-client-javaGH issue (forthcoming) — wider gap. JerseyLoggingFeature.PAYLOAD_ANYhas no header redaction at all, so api/app keys and bearer leak there.datadog-api-client-python— no equivalent gap (no request-header logging inrest.j2).Testing
bundle exec rspec spec/api_client_spec.rb -e "sanitize_request_header"passesbundle exec rspec spec/api_client_spec.rb(run by CI)🤖 Generated with Claude Code