CVEScan Python API

CVEScan is a Python package and once installed it is entirely available from Python.

cvescan.api.CVEScan

This section introduces the Python cvescan.api package and more precisely the top level API class CVEScan. Intended as the entry-point for all invocations of the CVEScan features.

Main Features

• CVEScan.scan_inventory Scans a SBOM for vulnerabilities.
• CVEScan.filter_report Automatically asserts vulnerabilities in a CVEScan report
• CVEScan.export_report Export a digest of a given CVEScan report to other formats.

API Objects Management

• CVEScan.load_sbom Load a SBOM from a given file of a supported format.
• CVEScan.load_report Load a CVEScan report from its JSON representation.
• CVEScan.load_annotations Load annotations from their JSON representation.

Other Features

• CVEScan.inventory_formats Lists SBOM files supported formats.
• CVEScan.export_formats Lists supported report export formats.
• CVEScan.version Returns the current version of the package.