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

Standardize Scan Results for Report Generation #5

Open
s4dhulabs opened this issue Oct 5, 2024 · 0 comments
Open

Standardize Scan Results for Report Generation #5

s4dhulabs opened this issue Oct 5, 2024 · 0 comments
Assignees
Labels

Comments

@s4dhulabs
Copy link
Owner

Description:

Currently, the Vimana framework allows plugins to save scan results to disk and the database. However, the report generation feature is still in the testing phase, and each plugin has its own methods for presenting results and enabling post-scan interaction. For example, the DMT plugin not only saves the scan results but also creates a session in the Sessions section for further analysis. This session can be accessed later for a more in-depth analysis, using the vulnerabilities, misconfigurations, and metadata from the DMT scan as input.

To streamline the report generation process, we need to establish a standardized format for scan results across all plugins. This will enable a unified reporting feature that can generate reports in various formats (e.g., summarized, technical, executive) based on the input from any plugin.

Steps to Reproduce:

  1. Run a scan using any plugin (e.g., DMT).
  2. Observe that the scan results are saved in a plugin-specific format.
  3. Attempt to generate a report using the current report generation feature.
  4. Notice the lack of standardization in the scan results, making it difficult to generate consistent reports.

Expected Behavior:

  • All plugins should save scan results in a standardized format.
  • The report generation feature should be able to accept input from any plugin and generate reports in various formats (e.g., summarized, technical, executive).
  • The standardized format should include essential details such as vulnerabilities, misconfigurations, metadata, and any other relevant information.

Proposed Solution:

  • Define a standardized format for scan results that includes all necessary details.
  • Update all plugins to save scan results in the standardized format.
  • Implement a unified report generation feature that can accept input from any plugin and generate reports in the specified formats.
  • Ensure that the standardized format supports both the initial scan results and any post-scan interactions or sessions.

Additional Context:

This issue is critical for ensuring the reliability and consistency of the report generation feature within the Vimana framework. By standardizing the scan results, we can provide a more cohesive and professional reporting experience for users.

@s4dhulabs s4dhulabs self-assigned this Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant