Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Vulnerability report

The vulnerability report describes one version of a project for readers who do not use nanobom: customers, auditors, regulators. It is a page of the interface, made to be printed or saved as PDF, and the same content as an HTML document from the API, for archiving. The steps are in Share a vulnerability report.

In the interface

The Report button of the project page opens /organizations/{organization}/projects/{project}/report, for the version the page shows (?version=…, the latest version without it). Any member of the organization can open it, as for the project page. The page is in the language of the interface; printing leaves out the header, the breadcrumb and the printing hint, and always uses light colors.

Endpoint

GET /api/organizations/{organization}/projects/{project}/report
AuthenticationA token of either scope, in Authorization: Bearer nanobom_… or X-Api-Key, or the session of a signed-in member, as on the read API
versionThe name of a project version (?version=2.4; an empty version= names the unnamed version). Without it, the latest version
Accept-LanguageThe language of the report, English or French; English when absent or not offered

A token reaches its organization’s projects, or its own project for a project token.

StatusWhen
200The report, Content-Type: text/html; charset=utf-8: a complete HTML document with the interface’s stylesheet inlined, so a saved copy keeps its layout without the server (fonts fall back to the system’s)
401No token or session, or an invalid token
404Unknown organization, project or version, or one the token does not reach
422An invalid query string, such as version given twice

Errors are JSON, {"error": "…"}, in English. Like every read API response, the report is Cache-Control: private, no-cache and varies on Cookie, Authorization and X-Api-Key. It is not described in the OpenAPI document, which covers the JSON endpoints.

Content

The page and the document hold the same sections, in this order. Dates are in UTC.

SectionContent
TitleOrganization, project and version (or “Unnamed version”), the time of generation, the nanobom version and the host of NANOBOM_PUBLIC_URL
WarningsWhen the project received no SBOM for longer than NANOBOM_STALE_AFTER_DAYS (as on the project page), and when the version is inactive, so no longer checked
Scope and provenanceThe latest upload of the version (time, SBOM format, source commit and image tag when given), the components checked, the components of that SBOM without a package URL (not checked), the end of the last successful run covering the project, and the last reads of the CISA KEV catalog and of FIRST EPSS scores
SummaryA sentence on open findings of high or critical severity, the open findings by severity, how many are known exploited, the ignored findings, and the findings fixed in the last 90 days
Open vulnerabilitiesEach open finding, in the order of the project page (known exploited first, then by severity and EPSS): identifier and aliases, component and version, severity and CVSS score, known exploited, EPSS percentile, direct or transitive dependency (and through which direct dependencies), fixed versions per the OSV record, first seen
Assessed as not affecting the productEach ignored finding with its justification (“None (accepted risk)” without one), its reason, when it was ignored and by which member or upload token, and its expiry. The address of the VEX export of the same version precedes them, for machine-readable use
LicensesWith a license policy, the components it forbids or warns about; without one, the components by license expression, the 10 most common, then the others together and those without a license
MethodWhat nanobom checks and what it does not, and that the report reflects the time of generation

Lists are bounded so that a large project gives a report of reasonable size: at most 500 open findings, 500 ignored findings and 200 license violations, each followed by how many more the project page lists. The counts of the summary always cover every finding.

The report shows nothing a viewer of the project cannot see: who ignored a finding is the username the finding page shows.