VAULT-30108: Include User-Agent header in audit requests by default #28596
Conversation
This file contains 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
github-actions
bot
added
the
hashicorp-contributed-pr
|
CI Results: |
VioletHynes
approved these changes
Oct 4, 2024
| @@ -254,9 +254,11 @@ func TestAuditedHeadersConfig_ApplyConfig(t *testing.T) { | |||
| t.Fatal(err) | |||
| } | |||
|
|
|||
| const hmacPrefix = "hmac-sha256:" | |||
There was a problem hiding this comment.
Love this little clean up :)
| @@ -175,6 +175,7 @@ func (a *HeadersConfig) DefaultHeaders() map[string]*headerSettings { | |||
| return map[string]*headerSettings{ | |||
| correlationID: {}, | |||
| xCorrelationID: {}, | |||
| "user-agent": {}, | |||
There was a problem hiding this comment.
Huh, just one line of code! Awesome :D
| err := json.Unmarshal(scanner.Bytes(), &entry) | ||
| require.NoError(t, err) | ||
|
|
||
| request := entry["request"].(map[string]interface{}) |
There was a problem hiding this comment.
nit: would be nice to have an ok here and require.True it
| request := entry["request"].(map[string]interface{}) | ||
|
|
||
| // test probe will not have headers set | ||
| if request["path"].(string) != "sys/audit/test" { |
There was a problem hiding this comment.
nit: would be nice to ensure we get ok from the type assertion
|
Build Results: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR adds the User-Agent as a default header in audit request entries. As with other request headers, this will not be hashed by default. One can override this and choose to HMAC the value via the /sys/config/auditing/request-headers/:name endpoint.
TODO only if you're a HashiCorp employee
to N, N-1, and N-2, using the
backport/ent/x.x.x+entlabels. If this PR is in the CE repo, you should only backport to N, using thebackport/x.x.xlabel, not the enterprise labels.of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.