src/sbom/Kconfig

   1 ## SPDX-License-Identifier: GPL-2.0-only
   2
   3 config SBOM
   4         bool "Include SBOM data for coreboot"
   5         default n
   6         help
   7           Select this option if you want to include a
   8           coswid (Concise Software Identification Tag) of coreboot itself
   9           into the SBOM (Software Bill of Materials) File in your build
  10
  11 if SBOM
  12
  13 config SBOM_COMPILER
  14         bool "Include compiler metadata in SBOM"
  15         default n
  16         help
  17           Select this option if you want to include a
  18           coswid (Concise Software Identification Tag) of the compiler
  19           used to compile coreboot into the SBOM (Software Bill of Materials)
  20           File in your build
  21           Note: if the system toolchain is used to build coreboot
  22           one should check the final SBOM file for the expected results
  23
  24 config SBOM_PAYLOAD
  25         bool "Include payload metadata in SBOM"
  26         default n
  27         help
  28           Select this option if you want to include a
  29           coswid (Concise Software Identification Tag) of the payload into
  30           the SBOM (Software Bill of Materials) File in your build
  31
  32 config SBOM_PAYLOAD_GENERATE
  33         bool "Auto-generate generic SBOM info for payload"
  34         depends on SBOM_PAYLOAD && (PAYLOAD_BOOTBOOT || PAYLOAD_DEPTHCHARGE || PAYLOAD_FILO || PAYLOAD_GRUB2 || PAYLOAD_LINUXBOOT || PAYLOAD_SEABIOS || PAYLOAD_SKIBOOT || PAYLOAD_UBOOT || PAYLOAD_YABITS)
  35         default y
  36         help
  37           Select this option if you want coreboot to generate and include
  38           the coswid (Concise Software Identification Tag) instead of supplying
  39           it manually. Be aware that this option is only meant to be a
  40           transition and suppliers of Software should always prefer to include
  41           their own Software descriptions, since ours may be incomplete or
  42           straight up wrong.
  43
  44 config SBOM_PAYLOAD_PATH
  45         string "SBOM file path"
  46         depends on SBOM_PAYLOAD && !SBOM_PAYLOAD_GENERATE
  47         help
  48           The path of the .ini file describing the payload
  49           Software included in the build
  50
  51 config SBOM_ME
  52         bool "Include ME metadata in SBOM"
  53         depends on HAVE_ME_BIN
  54         default n
  55         help
  56           Select this option if you want to include a
  57           coswid (Concise Software Identification Tag) of the
  58           ME firmware into the SBOM (Software Bill of Materials)
  59           File in your build
  60
  61 config SBOM_ME_GENERATE
  62         bool "Auto-generate generic SBOM info for ME firmware"
  63         depends on SBOM_ME
  64         default y
  65         help
  66           Select this option if you want coreboot to generate and include
  67           the coswid (Concise Software Identification Tag) instead of
  68           supplying it manually. Be aware that this option is only meant
  69           to be a transition and suppliers of Software should always prefer
  70           to include their own Software descriptions, since ours may be
  71           incomplete or straight up wrong.
  72
  73 config SBOM_ME_PATH
  74         string "Path to sbom.json for the ME firmware"
  75         depends on SBOM_ME && !SBOM_ME_GENERATE
  76         help
  77           The path of the SBOM file (sbom.json file)
  78           The path of the .json file describing the Software included in the build
  79
  80 config SBOM_EC
  81         bool "Include EC metadata in SBOM"
  82         depends on HAVE_EC_BIN
  83         default n
  84         help
  85           Select this option if you want to include a
  86           coswid (Concise Software Identification Tag) of the
  87           EC (Embedded Controller) firmware into the
  88           SBOM (Software Bill of Materials) File in your build
  89
  90 config SBOM_EC_PATH
  91         string "Path to SBOM file for the EC firmware"
  92         depends on SBOM_EC
  93         default "src/sbom/generic-ec.json"
  94         help
  95           The path of the SBOM file describing the Software included in the build
  96           File can be a .json, .xml, .cbor, .uswid, or .pc
  97
  98 config SBOM_SINIT_ACM
  99         bool "Include SINIT ACM metadata in SBOM"
 100         depends on INTEL_TXT_SINITACM_FILE != ""
 101         default n
 102         help
 103           Select this option if you want to include a
 104           coswid (Concise Software Identification Tag) of the
 105           SINIT ACM (Authenticated Code Module) firmware into the
 106           SBOM (Software Bill of Materials) File in your build
 107
 108 config SBOM_SINIT_ACM_PATH
 109         string "Path to SBOM file for the SINIT AMC firmware"
 110         depends on SBOM_SINIT_ACM
 111         default "src/sbom/intel-sinit-acm.json"
 112         help
 113           The path of the SBOM file describing the Software included in the build
 114           File can be a .json, .xml, .cbor, .uswid, or .pc
 115
 116 config SBOM_BIOS_ACM
 117         bool "Include BIOS ACM metadata in SBOM"
 118         depends on INTEL_TXT_BIOSACM_FILE != ""
 119         default n
 120         help
 121           Select this option if you want to include a
 122           coswid (Concise Software Identification Tag) of the
 123           BIOS ACM (Authenticated Code Module) firmware into the
 124           SBOM (Software Bill of Materials) File in your build
 125
 126 config SBOM_BIOS_ACM_PATH
 127         string "Path to SBOM file for the BIOS AMC firmware"
 128         depends on SBOM_SINIT_ACM
 129         default "src/sbom/intel-bios-acm.json"
 130         help
 131           The path of the SBOM file describing the Software included in the build
 132           File can be a .json, .xml, .cbor, .uswid, or .pc
 133
 134 config SBOM_MICROCODE
 135         bool "Include microcode metadata in SBOM"
 136         default n
 137         help
 138           Select this option if you want to include a
 139           coswid (Concise Software Identification Tag) of the
 140           microcode firmware into the SBOM (Software Bill of Materials)
 141           File in your build
 142
 143 config SBOM_FSP
 144         bool "Include Intel FSP metadata in SBOM"
 145         default n
 146         depends on (FSP_S_FILE != "" || FSP_M_FILE != "" || FSP_T_FILE != "")
 147         help
 148           Select this option if you want to include a
 149           coswid (Concise Software Identification Tag) of the
 150           FSP firmware into the SBOM (Software Bill of Materials)
 151           File in your build
 152
 153 config SBOM_FSP_PATH
 154         string "Path to SBOM file for the FSP firmware"
 155         depends on SBOM_FSP
 156         default "build/sbom/generic-fsp.json"
 157         help
 158           The path of the SBOM file describing the Software included in the build
 159           File can be a .json, .xml, .cbor, .uswid, or .pc
 160
 161 config SBOM_VBOOT
 162         bool "Include VBOOT metadata in SBOM"
 163         default n
 164         depends on VBOOT_LIB
 165         help
 166           Select this option if you want to include a
 167           coswid (Concise Software Identification Tag) of the
 168           VBOOT Software into the SBOM (Software Bill of Materials)
 169           File in your build
 170
 171 endif