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

Move "Rules" back into Common Controls #443

Open
1 task
adhilto opened this issue Oct 1, 2024 · 0 comments
Open
1 task

Move "Rules" back into Common Controls #443

adhilto opened this issue Oct 1, 2024 · 0 comments
Milestone

Comments

@adhilto
Copy link
Collaborator

adhilto commented Oct 1, 2024

💡 Summary

  • Remove "Rules" as a standalone report
  • Put the results for rules inside the Common Controls report

Motivation and context

  • Rules breaks the JSON output schema used for all the other baselines, increasing the complexity for downstream systems to process ScubaGoggles data.
  • Rules breaks the 1:1 control to test result ratio we so carefully maintain elsewhere, again increasing complexity for downstream systems.
  • Rules also increases the complexity of our own code.
  • Making Rules its own report makes it hard to interpret the results. For example, say you assess the just Common Controls baseline configure GWS.COMMONCONTROLS.13.1v0.3 to be omitted. Later, an analyst might look at the results and calculate that you omitted over half of the controls, when in reality you just omitted one.

Implementation notes

There are several different ways you could implement this.

  1. Make the details column read like "3/39 rules enabled. The following rules are disabled: [bulleted list of disabled rules]. The state of the following rules could not be determined: [bulleted list of rules without events]"
  2. Make the details column read like "3/39 rules enabled. The following rules are disabled: [single-line comma-separated list of disabled rules]. The state of the following rules could not be determined: [single-line comma-separated list of rules without events]"
  3. Make the details column read like "3/39 rules enabled. See the Rules table below for more details." And have a Rules table below the Common Controls results, similar to the CAP table below the AAD report in ScubaGear.

Personally, I think I'm partial to option number 2 above, but we should discuss this as a team to determine the best option.

Acceptance criteria

  • Rules is no longer a separate report
@snarve snarve added this to the Driftwood milestone Oct 15, 2024
@adhilto adhilto modified the milestones: Driftwood, Eel Nov 19, 2024
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

2 participants