-
Notifications
You must be signed in to change notification settings - Fork 1.9k
feat: add category filter to all Prowler dashboards #9137
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
Open
sonofagl1tch
wants to merge
11
commits into
prowler-cloud:master
Choose a base branch
from
sonofagl1tch:prowler-dashboard-6646
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+811
−6
Open
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
0a68856
add category filter to all Prowler dashboards
sonofagl1tch d5eb66f
completed checklist and added changelog
sonofagl1tch 8f6ee72
feat(api): add category filter support for findings endpoint
sonofagl1tch 9b1ee46
Merge branch 'master' into prowler-dashboard-6646
sonofagl1tch 9af726b
updated categories to use correct case
sonofagl1tch 6be3abe
Merge branch 'prowler-dashboard-6646' of https://github.com/sonofagl1…
sonofagl1tch 46bfca4
did a codebase search for branch. results show there are no occurrenc…
sonofagl1tch c5b8092
Update api/src/backend/api/filters.py
sonofagl1tch 13d127e
chore(revision): remove dashboard tests
pedrooot e461c65
chore(revision): remove docs
pedrooot baa3e1e
perf(api): optimize findings metadata endpoints using indexed fields
sonofagl1tch File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
102 changes: 102 additions & 0 deletions
102
docs/user-guide/cli/tutorials/dashboard-category-filter.mdx
sonofagl1tch marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| title: 'Dashboard Category Filter' | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| The Prowler Dashboard includes a **Category** filter that allows you to filter findings by their assigned categories. This is particularly useful when you want to focus on specific security concerns like internet-exposed resources, encryption issues, or logging configurations. | ||
|
|
||
| ## Using the Category Filter | ||
|
|
||
| ### Step 1: Run Prowler with Categories | ||
|
|
||
| First, run Prowler with the `--categories` flag to generate findings for specific categories: | ||
|
|
||
| ```sh | ||
| prowler aws --categories internet-exposed | ||
| ``` | ||
|
|
||
| This will scan your AWS environment and identify all resources that are exposed to the internet. | ||
|
|
||
| ### Step 2: Launch the Dashboard | ||
|
|
||
| Start the Prowler dashboard: | ||
|
|
||
| ```sh | ||
| prowler dashboard | ||
| ``` | ||
|
|
||
| ### Step 3: Apply Category Filter | ||
|
|
||
| In the dashboard's Overview page, you'll find a **Category** dropdown filter alongside other filters like Severity, Service, Provider, and Status. | ||
|
|
||
| <img src="/images/cli/dashboard/dashboard-overview.png" /> | ||
|
|
||
| The Category filter allows you to: | ||
|
|
||
| - Select **All** to view findings from all categories | ||
| - Select one or more specific categories to filter results | ||
| - Combine category filtering with other filters for precise analysis | ||
|
|
||
| ## Available Categories | ||
|
|
||
| Common categories include: | ||
|
|
||
| - `internet-exposed` - Resources accessible from the internet | ||
| - `encryption` - Encryption-related findings | ||
| - `logging` - Logging and monitoring configurations | ||
| - `secrets` - Secrets management issues | ||
| - `forensics-ready` - Forensic readiness checks | ||
| - `trustboundaries` - Trust boundary violations | ||
| - And more... | ||
|
|
||
| To see all available categories for a provider: | ||
|
|
||
| ```sh | ||
| prowler <provider> --list-categories | ||
| ``` | ||
|
|
||
| ## Example Use Cases | ||
|
|
||
| ### Filter Internet-Exposed Resources | ||
|
|
||
| ```sh | ||
| # Run scan for internet-exposed resources | ||
| prowler aws --categories internet-exposed | ||
|
|
||
| # Launch dashboard | ||
| prowler dashboard | ||
|
|
||
| # In the dashboard, select "internet-exposed" from the Category dropdown | ||
| ``` | ||
|
|
||
| ### Multiple Categories | ||
|
|
||
| You can scan and filter by multiple categories: | ||
|
|
||
| ```sh | ||
| prowler aws --categories internet-exposed,encryption | ||
| ``` | ||
|
|
||
| Then use the Category filter in the dashboard to view findings from either or both categories. | ||
|
|
||
| ## Category Filter Behavior | ||
|
|
||
| - **Default**: Set to "All" (shows all findings regardless of category) | ||
| - **Multi-select**: You can select multiple categories simultaneously | ||
| - **Dynamic**: The available categories update based on your current data and other active filters | ||
| - **Comma-separated**: Findings can belong to multiple categories, and the filter handles this automatically | ||
|
|
||
| ## Integration with Other Filters | ||
|
|
||
| The Category filter works seamlessly with other dashboard filters: | ||
|
|
||
| ```sh | ||
| # Example: View only FAIL status findings in the internet-exposed category | ||
| # 1. Run: prowler aws --categories internet-exposed | ||
| # 2. Launch dashboard | ||
| # 3. Set Status filter to "FAIL" | ||
| # 4. Set Category filter to "internet-exposed" | ||
| ``` | ||
|
|
||
| This allows for powerful, multi-dimensional analysis of your security posture. |
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.