Exporting a Scan Report

You can download a scan report in the PDF, JSON or CSV format for further analysis. Bright also provides the option to generate a SARIF (Static Analysis Results Interchange Format) report file and upload it to your GitHub repository so that you can open the detected vulnerabilities as Code Scanning Alerts. Using this option, you can easily triage the existing security issues, prioritize fixes and open tickets for them in your GitHub repository. Each detected vulnerability from the report will be displayed as a separate alert automatically.

👍

Tip:

To configure an integration with your GitHub CI pipeline, read here.

Bright provides you with the opportunity to select the scope of the information to be included in the PDF report. For example, you can get a full report or only select certain parts of the full report to be exported.

The following PDF report options are available:

• Full Report – Combines the Executive Summary and the Scan Details reports.
• Executive Summary – Is intended for executives. It contains a brief analysis of each issue and its possible consequences, as well as a compliance report.
• Scan Details – Provides detailed information about the scan, including all the technical information about the issues that have been detected, possible consequences, remedy suggestions, and much more.
• Custom report – Enables you to select the parts of the full report to be exported during this action.

To export a scan report, do the following:

1. In the left pane, select the Scans option to display the scans list.
2. Click next to the scan to be exported.
3. From the dropdown list, select Export as CSV, Export as SARIF, Export as JSON or Export as PDF.

• Export as CSV – Exports a simple CSV file containing a short description of the issues that have been detected.
• Export as SARIF - Sends a SARIF report file to your GitHub repository and creates code scanning alerts for each detected vulnerability from the report.

👍

Exporting a SARIF report is also available via API. For details, see the Swagger link.

• Export as JSON - Exports a simple JSON file containing a short description of the issues that have been detected.
• Export as PDF – Select one of the report options to be exported.
  For the Custom report, in the dialog box, select the information to be included in to the report and click Export.

Customizing PDF reports

You can make your PDF reports more distinctive by customizing their appearance. You can change the cover, add your company logo, select other colors and fonts, and optimize page parameters.

To customize a PDF report, follow these steps:

1. In the left pane, select Organization, and then scroll down to the PDF REPORT CUSTOMIZATION section.

2. Expand the options you want to configure.
3. Complete the fields with your custom values or upload an image file.
   For example, to upload your company logo, expand Page options: logo, click the Image file field and select the logo from your local storage.

4. To save the changes, in the upper right corner of the PDF REPORT CUSTOMIZATION section, click Save.