VIRTS-3035 - Githubissues

CDJellen commented 2 years ago

VIRTS-3035: Pathfinder UI/UX Improvements (Part I)

Affects:

app/parsers/nmap.py
app/pathfinder_gui.py
app/pathfinder_svc.py
scanners/nmap/scanner.py
static/js/pathfinder.js
templates/pathfinder.html Change: New functionality to

Set report name to file name when loading from disk,
Add a custom name to nmap scans,
Remove reports from memory,
Rename reports post-load or post-scan.

Description

This branch adds new functionality to the current Pathfinder plugin, building off of the Pathfinder API and the new core CALDERA API v2. Changes include adding a new view tab called "Reports" to perform a few of the missing CRUD operations, including renaming reports in memory and removing reports from memory. The "Import Scan" functionality now captures the file name of the .xml or .yml report file, and uses this file name as the report name. Finally, the default nmap scanner was expanded to include a new custom name input field, to de-clutter the report "view" screen after executing a series of reports over a live network.

Checklist:

[X] My code follows the style guidelines of this project
[X] I have performed a self-review of my own code
[ ] I have made corresponding changes to the documentation
[ ] I have added tests that prove my fix is effective or that my feature works

CDJellen commented 2 years ago

Feel free to pull the branch and let me know what you think!

Areas likely pending update:

currently the new "Reports" tab displays both the console and graph view. Pending major changes, I am considering adding more descriptive logged status messages for the new PATCH and DELETE requests, and removing the Graph from the view screen. I found the graph helpful in differentiating between similarly-named reports.
I've elected to hold off on adding dropdown help tooltips until we migrate to the new Alpine.js and Bulma framework, but can work to make this change in the current templating scheme if needed.
There is some duplicity in being able to download reports from either the "View" or the "Reports" pane. I've elected to keep the feature in both for now, as it makes sense to me as a user to have access to the feature either when investigating the attack graph, or in the CRUD-style menu for downloading and then removing, or renaming and then downloading.

As always, I am more than happy to make changes as needed. Thank you!