Skip to content

Commit

Permalink
fix api key validation issue when quotations are escaped inside string
Browse files Browse the repository at this point in the history
  • Loading branch information
jackgopack4 committed Nov 22, 2024
1 parent 83f1fc6 commit 703fcac
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .chloggen/dd-config-api-key-fix.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: connector/datadog, exporter/datadog, pkg/datadog

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: strip extra quotations from API keys when read in via environment variables

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [36509]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
API keys should still validate even if reading in via environment variable caused extra quotations.
# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
3 changes: 2 additions & 1 deletion pkg/datadog/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,8 @@ func (c *Config) Unmarshal(configMap *confmap.Conf) error {
}
c.warnings = append(c.warnings, renamingWarnings...)

c.API.Key = configopaque.String(strings.TrimSpace(string(c.API.Key)))
// remove leading/trailing quotation marks to avoid issues with the API key
c.API.Key = configopaque.String(strings.Trim(c.API.Key.String(), `"'`))

// If an endpoint is not explicitly set, override it based on the site.
if !configMap.IsSet("metrics::endpoint") {
Expand Down

0 comments on commit 703fcac

Please sign in to comment.