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

ruleConfiguration.defaultLevel should not contain an 'open' value #288

Closed
michaelcfanning opened this issue Nov 20, 2018 · 4 comments
Closed

Comments

@michaelcfanning
Copy link
Contributor

michaelcfanning commented Nov 20, 2018

Our result levels divide into two groups, a set of rough severities in cases where a result is detected, plus an additional set of values that allow for some signal to be comprehensively generated for all scan targets (this latter category is for compliance purposes).

The ruleConfiguration.defaultLevel should only contain values for the former case. That is, the property represents the default severity of a problem when one is detected.

'open' simply means 'we don't know yet', so it is not an actual level of interest to configure as a default for a rule.

@michaelcfanning
Copy link
Contributor Author

Related, just to emphasize, there is a significant problem with allowing the log file producer to specify a default level as 'open', this recategorizes the result as a non-result. That is, all the results in a log file, if they do not have an explicit level, and if the rule they're associated with has 'open' as a value, are not actually results, they are a marker that whether or not we have a result is an open question. This is very non-obvious. In the absence of any explicit other information directly applied to a result, it is helpful if users can assume the result is a positive indicator of a problem.

@michaelcfanning
Copy link
Contributor Author

The backwards compatible transformation for this spec change:

Walk all results. if they have no explicit indicator of result.level and if the rule.configuration.defaultLevel was previously marked 'open', mark result.level explicitly as 'open'.

@ghost ghost changed the title configuration.defaultLevel should not contain an 'open' value ruleConfiguration.defaultLevel should not contain an 'open' value Nov 21, 2018
@ghost
Copy link

ghost commented Nov 21, 2018

I support this message.

@ghost ghost self-assigned this Nov 21, 2018
@ghost ghost added bug impact-breaks-producers triage-approved 2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. labels Nov 21, 2018
@michaelcfanning
Copy link
Contributor Author

Change draft looks good from my perspective.

ghost pushed a commit that referenced this issue Nov 29, 2018
@ghost ghost closed this as completed Nov 29, 2018
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant