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

chore: documentation for rule approval #1469

Merged
merged 1 commit into from
May 2, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
Binary file added docs/assets/images/screenshot_rule_approval.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshot_rule_show.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/usage/assess_observations.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ A new entry with the changed values is stored in the `Observation Log` after the

With the default settings of the product, the assessment is activated right away. If more control is needed, the product can be configured to require an approval before the assessment is activated. This can be done while creating or editing a product:

![Assessments need approval](../assets/images/screenshot_assessments_need_approval.png)
![Assessments need approval](../assets/images/screenshot_assessments_need_approval.png){ width="60%" style="display: block; margin: 0 auto" }

The setting is also available for product groups. If it is set for a product group, it will be inherited by all products in that group.

Expand All @@ -37,7 +37,7 @@ If the approval is required, the dialog showing the observation or and the dialo

Be aware, that the user who has created the assessment is not allowed to approve or reject it. The approval must be done by another user.

![Assessment approval](../assets/images/screenshot_assessment_approval.png)
![Assessment approval](../assets/images/screenshot_assessment_approval.png){ width="60%" style="display: block; margin: 0 auto" }

## Reviews

Expand Down
20 changes: 19 additions & 1 deletion docs/usage/rule_engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ Sometimes the result of a scanner doesn't fit to the product's needs. Either the

This can remove a lot of noise, for example by setting observations to `False positive`, in case the ruleset of the scanner can not be adjusted appropriately.

## Rules

![Rules](../assets/images/screenshot_rules.png)

Rules can be managed in two ways:

* **General rules** will be applied for all products. A product can be excluded from general rules in its settings.
* **Product Rules** are only valid for one product.
* **Product rules** are only valid for one product or for all products of a product group.

These fields are used to decide if a rule shall be applied for an observation:

Expand All @@ -24,3 +26,19 @@ These fields are used to decide if a rule shall be applied for an observation:
* **Origin cloud qualified resource** *(optional)*: Regular expression to match the cloud qualified resource, which is the concatenation of account (AWS) or subscription (Azure) or project (GCP) with the resource

If an observation matches all fields containing a value, than the new severity and/or new status is set in the observation and the rule's description is stored as a comment in the `Observation Log`.


## Approvals

With the default settings of the product, the rule will be activated right away if enabled. If more control is needed, an approval can be configured:

* For **General rules** the feature `General rules need approval` can be set in the [Settings](../getting_started/configuration.md#admininistration-in-secobserve).
* For **Product rules** the setting `Rules need approval` can be set while creating or editing a product. The setting is also available for product groups. If it is set for a product group, it will be inherited by all products in that group.

If the approval is required, the dialog showing the rule will show a button to either approve or reject the assessment:

![Show rule](../assets/images/screenshot_rule_show.png)

Be aware, that the user who has created or edited the rule is not allowed to approve or reject it. The approval must be done by another user.

![Rule approval](../assets/images/screenshot_rule_approval.png){ width="60%" style="display: block; margin: 0 auto" }
Loading