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

[exporter/datadog] add basic API key validation on startup #36510

Merged
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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]
5 changes: 3 additions & 2 deletions pkg/datadog/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ func (c *Config) Validate() error {
return fmt.Errorf("hostname field is invalid: %w", err)
}

if c.API.Key == "" {
if string(c.API.Key) == "" {
return ErrUnsetAPIKey
}

Expand Down 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)))
mx-psi marked this conversation as resolved.
Show resolved Hide resolved
// remove leading/trailing quotation marks to avoid issues with the API key
c.API.Key = configopaque.String(strings.Trim(string(c.API.Key), `"'`))
jackgopack4 marked this conversation as resolved.
Show resolved Hide resolved

// If an endpoint is not explicitly set, override it based on the site.
if !configMap.IsSet("metrics::endpoint") {
Expand Down
12 changes: 12 additions & 0 deletions pkg/datadog/config/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,18 @@ func TestValidate(t *testing.T) {
}
}

func TestAPIKeyDoubleQuotes(t *testing.T) {
configMap := confmap.NewFromStringMap(map[string]any{
"api": map[string]any{
"key": "'apikey'",
},
})
cfg := CreateDefaultConfig().(*Config)
err := cfg.Unmarshal(configMap)
assert.NoError(t, err)
assert.Equal(t, "apikey", string(cfg.API.Key))
}

func TestUnmarshal(t *testing.T) {
cfgWithHTTPConfigs := CreateDefaultConfig().(*Config)
idleConnTimeout := 30 * time.Second
Expand Down