> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SBOM Workbench

> The [SBOM Workbench](https://github.com/scanoss/sbom-workbench) is a graphical user interface to scan and audit source code using the SCANOSS API.

Simply scan your source code directory to find and identify open source components. Generate your SPDX-Lite software bill of materials (SBOM) with the press of a button.

## Installation

1. Visit [SBOM Workbench releases](https://github.com/scanoss/sbom-workbench/releases)
2. Download the installer for your platform:
   * **macOS**: `.dmg` file
   * **Windows**: `.exe` installer
   * **Linux**: `.AppImage` or `.deb` package
3. Run the installer

## Getting Started

## Add or Import Your Project

In the `Home` tab, click the `New project` to add a new project from the source code itself, or click on the arrow to display te dropdown menu to add a new project from a WFP file or import an existing project in the state it was exported.

<img src="https://mintcdn.com/scanoss/Wa_LW7pXSVCv0_W3/en/latest/poc/security-dataset/images/sbom-wb-home.png?fit=max&auto=format&n=Wa_LW7pXSVCv0_W3&q=85&s=dc25540fb7a0f2a0e309670ff6506e19" alt="sbom-wb-home" width="3024" height="1686" data-path="en/latest/poc/security-dataset/images/sbom-wb-home.png" />

If you choose the option to add a new project, either from sources or WFP file, you will be taken to the `Project settings` screen.

<img src="https://mintcdn.com/scanoss/Wa_LW7pXSVCv0_W3/en/latest/poc/security-dataset/images/project-settings.png?fit=max&auto=format&n=Wa_LW7pXSVCv0_W3&q=85&s=41bc5b992a9dd727eae5f7334ffa1dbd" alt="project-setting" width="3024" height="1510" data-path="en/latest/poc/security-dataset/images/project-settings.png" />

Here, you can customize the following things:

* Project name
* License
* API connections
* Scanner settings

> You can provide a context file `scanoss.json` declaring known components to get the most accurate results.

After you add and configure your project settings, the SBOM Workbench will automatically go through various stages: scanning your project, detecting licenses, analysing for dependencies, searching for vulnerabilties and so on.

## Reports Dashboard

After you add and scan your project, the results will appear in the `Reports` tab.

The Reports tab provides an overview of detected components, licenses, dependencies, and vulnerabilities identified.

<img src="https://mintcdn.com/scanoss/Wa_LW7pXSVCv0_W3/en/latest/poc/security-dataset/images/workbench-reports.png?fit=max&auto=format&n=Wa_LW7pXSVCv0_W3&q=85&s=f0c00e45dd5b759bc52c6c2886adc94e" alt="workbench-reports" width="1645" height="1005" data-path="en/latest/poc/security-dataset/images/workbench-reports.png" />

## Detected Vulnerabilities

Clicking on `Vulnerabilities` displays detected security vulnerabilities (CVEs) for each component.

<img src="https://mintcdn.com/scanoss/Wa_LW7pXSVCv0_W3/en/latest/poc/security-dataset/images/workbench-vulnerabilities-dashboard.png?fit=max&auto=format&n=Wa_LW7pXSVCv0_W3&q=85&s=7c2c03ea24782db004533ba0e835f560" alt="workbench-vulnerabilities-dashboard" width="1641" height="1001" data-path="en/latest/poc/security-dataset/images/workbench-vulnerabilities-dashboard.png" />

## Detected Components

For this step, navigate to the `Detected Components` tab.

<img src="https://mintcdn.com/scanoss/Wa_LW7pXSVCv0_W3/en/latest/poc/security-dataset/images/detected-components.png?fit=max&auto=format&n=Wa_LW7pXSVCv0_W3&q=85&s=9602c4c9ae0efb66dab75eb70a789024" alt="detected-components" width="1637" height="1000" data-path="en/latest/poc/security-dataset/images/detected-components.png" />

Use this tab to automatically identify detected components and dependencies, or manually provide their details: name, version, license, optional URL, PURL, and usage (file, snippet, or prerequisite).

To access all actions, click the component. If needed, you can restore it to its original state to correct the identification.

> You can mark components as Original, but there is no option to ignore components, as this would conflict with the principles of an SBOM.

After finishing the identification process, you can review it in the `Identified components` tab.

<img src="https://mintcdn.com/scanoss/Wa_LW7pXSVCv0_W3/en/latest/poc/security-dataset/images/identified-components.png?fit=max&auto=format&n=Wa_LW7pXSVCv0_W3&q=85&s=d778ba02acc9470a784d8bb535698939" alt="identified-components" width="1635" height="1004" data-path="en/latest/poc/security-dataset/images/identified-components.png" />

## Identified Components

Go to the `Identified` view in the `Reports` tab for a final project review (compare it with the `Detected` view if needed), then click `Export` to select your SBOM format.

<img src="https://mintcdn.com/scanoss/Wa_LW7pXSVCv0_W3/en/latest/poc/security-dataset/images/identified.png?fit=max&auto=format&n=Wa_LW7pXSVCv0_W3&q=85&s=ae79baa0ae2124d37bf12b5374edc930" alt="identified" width="1642" height="1002" data-path="en/latest/poc/security-dataset/images/identified.png" />

After selecting your preferred format and specifying the export path, the SBOM will be downloaded to that location.
