|
| 1 | +*************************************************************** |
| 2 | +How to Guide for working with Software Bill of Materials (SBOM) |
| 3 | +*************************************************************** |
| 4 | + |
| 5 | +Generating an Software Bill of Materials (SBOM) |
| 6 | +=============================================== |
| 7 | + |
| 8 | +|__SDK_FULL_NAME__| build generates SBOMs in the following formats and versions: |
| 9 | + |
| 10 | +.. list-table:: |
| 11 | + :header-rows: 1 |
| 12 | + |
| 13 | + * - Format |
| 14 | + - Version |
| 15 | + - Yocto |
| 16 | + - Buildroot |
| 17 | + * - SPDX |
| 18 | + - 3.0 |
| 19 | + - Supported |
| 20 | + - Not-Supported |
| 21 | + * - CycloneDX |
| 22 | + - 1.6 |
| 23 | + - Supported |
| 24 | + - Supported |
| 25 | + |
| 26 | +Follow the steps below based on your required format. |
| 27 | + |
| 28 | +Generating an SBOM in SPDX 3.0 Format |
| 29 | +------------------------------------- |
| 30 | + |
| 31 | +SPDX 3.0 is generated by default when building |__SDK_FULL_NAME__| Yocto, no extra steps required. |
| 32 | +If you require additional vulnerability information, follow these steps: |
| 33 | + |
| 34 | +1. Add the following line to your ``local.conf``: |
| 35 | + |
| 36 | + .. code-block:: text |
| 37 | +
|
| 38 | + INHERIT += "vex" |
| 39 | +
|
| 40 | +2. Build Yocto according to the build instructions in :ref:`Processor SDK - Building the SDK with Yocto <building-the-sdk-with-yocto>`. |
| 41 | + |
| 42 | +The following artifacts will be generated in the Yocto deploy directory: |
| 43 | + |
| 44 | +.. list-table:: |
| 45 | + :header-rows: 1 |
| 46 | + :widths: 50 50 |
| 47 | + |
| 48 | + * - File |
| 49 | + - Description |
| 50 | + * - ``${IMAGE_NAME}.rootfs.spdx.json`` |
| 51 | + - The SPDX v3.0 SBOM file |
| 52 | + * - ``${IMAGE_NAME}.rootfs.json`` |
| 53 | + - Vulnerability information file generated by ``vex.bbclass`` |
| 54 | + |
| 55 | + |
| 56 | +Generating an SBOM in CycloneDX Format |
| 57 | +-------------------------------------- |
| 58 | + |
| 59 | +To generate an SBOM in CycloneDX format, follow these steps: |
| 60 | + |
| 61 | +1. Start with the build instructions in :ref:`Processor SDK - Building the SDK with Yocto <building-the-sdk-with-yocto>` |
| 62 | +2. After cloning ``oe-layersetup``, uncomment the ``meta-cyclonedx`` line in |
| 63 | + the layer configuration file, for example: |
| 64 | + |
| 65 | + .. code-block:: text |
| 66 | +
|
| 67 | + meta-cyclonedx,https://github.com/iris-GmbH/meta-cyclonedx.git,main,0170751b487162f8e476fd32d441ddfcf24ca78a,layers= |
| 68 | +
|
| 69 | +3. Add the following line to your ``local.conf``: |
| 70 | + |
| 71 | + .. code-block:: text |
| 72 | +
|
| 73 | + INHERIT += "cyclonedx-export" |
| 74 | +
|
| 75 | +4. Continue to build Yocto according to the build instructions in :ref:`Processor SDK - Building the SDK with Yocto <building-the-sdk-with-yocto>`. |
| 76 | + |
| 77 | +The following artifacts will be generated in the Yocto deploy directory: |
| 78 | + |
| 79 | +.. list-table:: |
| 80 | + :header-rows: 1 |
| 81 | + :widths: 50 50 |
| 82 | + |
| 83 | + * - File |
| 84 | + - Description |
| 85 | + * - ``${IMAGE_NAME}.rootfs.cyclonedx.bom.json`` |
| 86 | + - The CycloneDX SBOM file |
| 87 | + * - ``${IMAGE_NAME}.rootfs.cyclonedx.vex.json`` |
| 88 | + - The CycloneDX VEX file |
| 89 | + |
| 90 | +Working with Software Bill of Materials (SBOM) |
| 91 | +============================================== |
| 92 | + |
| 93 | +It is recommended to use open-source tools for working with SBOMs. |
| 94 | +The following open-source tools are recommended for working with SBOMs: |
| 95 | + |
| 96 | +.. list-table:: |
| 97 | + :header-rows: 1 |
| 98 | + :widths: 20 40 40 |
| 99 | + |
| 100 | + * - Format |
| 101 | + - Tool |
| 102 | + - Description |
| 103 | + * - CycloneDX |
| 104 | + - `CycloneDX Sunshine <https://github.com/CycloneDX/Sunshine/>`_ |
| 105 | + - Visualize CycloneDX SBOMs in a human-readable format |
| 106 | + * - CycloneDX |
| 107 | + - `CycloneDX CLI <https://github.com/CycloneDX/cyclonedx-cli>`_ |
| 108 | + - BOM analysis, modification, diffing, merging, format conversion, signing and verification. |
| 109 | + * - SPDX |
| 110 | + - `SPDX Open Source Tools <https://spdx.dev/tools/open-source-tools/>`_ |
| 111 | + - A collection of open-source tools for working with SPDX SBOMs |
| 112 | + |
| 113 | +.. note:: |
| 114 | + |
| 115 | + SPDX 3.0 is not yet widely supported by SPDX tools. Using such tools with |
| 116 | + SPDX 3.0 files may give varied or unexpected results. |
0 commit comments