feat: improved WAF init error reporting #44
Merged
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
The `ddwaf_init` call attempts to provide more information about failure causes through the `diagnostics` object returned. This may be populated even when receiving a `NULL` handle. This PR attempts to obtain an error from diagnostics when available in order to provide improved error messaging to the callers. Additionally, if diagnostics include any "top-level" error (via the `DiagnosticEntry.Error` field), consider the WAF initialization as failed and return the specified error. Errors reported at the individual entity level are not considered in this new check, as they may stem from new rules using operators that are not yet available in the current WAF library version, and that should be okay. This saves all users of the WAF from having to manually check for these error conditions in all places, which is cumbersome and error-prone.
Julio-Guerra
reviewed
Nov 9, 2023
RomainMuller
added a commit
to DataDog/dd-trace-go
that referenced
this pull request
Nov 9, 2023
Julio-Guerra
reviewed
Nov 9, 2023
Julio-Guerra
requested changes
Nov 9, 2023
eliottness
reviewed
Nov 9, 2023
eliottness
reviewed
Nov 9, 2023
| // wafInit initializes a new WAF with the provided ruleset, configuration and info objects. A | ||
| // cgoRefPool ensures that the provided input values are not moved or garbage collected by the Go | ||
| // runtime during the WAF call. | ||
| func (waf *wafDl) wafInit(ruleset *wafObject, config *wafConfig, info *wafObject, refs cgoRefPool) wafHandle { |
There was a problem hiding this comment.
If you do it here you can also do it in wafRun I guess
There was a problem hiding this comment.
Except wafRun requires some of the data to live as long as the context does, but not all of them... I actually have some (perhaps better?) ideas there, so I'll probably end up making another PR with changes to the cgoRefPool ergonomics...
| // Start off with a perfectly valid input... | ||
| rules := makeValidRuleset() | ||
| // And corrupt data for one particular field... | ||
| rules[field] = 1337.42 |
Julio-Guerra
approved these changes
Nov 14, 2023
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.
The
ddwaf_initcall attempts to provide more information about failure causes through thediagnosticsobject returned. This may be populated even when receiving aNULLhandle.This PR attempts to obtain an error from diagnostics when available in order to provide improved error messaging to the callers.