# # Copyright OpenEmbedded Contributors # # SPDX-License-Identifier: GPL-2.0-only # inherit spdx-common SPDX_VERSION = "3.0.0" # The list of SPDX profiles generated documents will conform to SPDX_PROFILES ?= "core build software simpleLicensing security" SPDX_INCLUDE_BUILD_VARIABLES ??= "0" SPDX_INCLUDE_BUILD_VARIABLES[doc] = "If set to '1', the bitbake variables for a \ recipe will be included in the Build object. This will most likely result \ in non-reproducible SPDX output" SPDX_INCLUDE_BITBAKE_PARENT_BUILD ??= "0" SPDX_INCLUDE_BITBAKE_PARENT_BUILD[doc] = "Report the parent invocation of bitbake \ for each Build object. This allows you to know who invoked bitbake to perform \ a build, but will result in non-reproducible SPDX output." SPDX_PACKAGE_ADDITIONAL_PURPOSE ?= "" SPDX_PACKAGE_ADDITIONAL_PURPOSE[doc] = "The list of additional purposes to assign to \ the generated packages for a recipe. The primary purpose is always `install`. \ Packages overrides are allowed to override the additional purposes for \ individual packages." SPDX_IMAGE_PURPOSE ?= "filesystemImage" SPDX_IMAGE_PURPOSE[doc] = "The list of purposes to assign to the generated images. \ The first listed item will be the Primary Purpose and all additional items will \ be added as additional purposes" SPDX_SDK_PURPOSE ?= "install" SPDX_SDK_PURPOSE[doc] = "The list of purposes to assign to the generate SDK installer. \ The first listed item will be the Primary Purpose and all additional items will \ be added as additional purposes" SPDX_INCLUDE_VEX ??= "current" SPDX_INCLUDE_VEX[doc] = "Controls what VEX information is in the output. Set to \ 'none' to disable all VEX data. Set to 'current' to only include VEX data \ for vulnerabilities not already fixed in the upstream source code \ (recommended). Set to 'all' to get all known historical vulnerabilities, \ including those already fixed upstream (warning: This can be large and \ slow)." SPDX_INCLUDE_TIMESTAMPS ?= "0" SPDX_INCLUDE_TIMESTAMPS[doc] = "Include time stamps in SPDX output. This is \ useful if you want to know when artifacts were produced and when builds \ occurred, but will result in non-reproducible SPDX output" SPDX_IMPORTS ??= "" SPDX_IMPORTS[doc] = "SPDX_IMPORTS is the base variable that describes how to \ reference external SPDX ids. Each import is defined as a key in this \ variable with a suffix to describe to as a suffix to look up more \ information about the import. Each key can have the following variables: \ SPDX_IMPORTS__spdxid: The Fully qualified SPDX ID of the object \ SPDX_IMPORTS__uri: The URI where the SPDX Document that contains \ the external object can be found. Optional but recommended \ SPDX_IMPORTS__hash_: The Checksum of the SPDX Document that \ contains the External ID. must be one the valid SPDX hashing \ algorithms, as described by the HashAlgorithm vocabulary in the\ SPDX 3 spec. Optional but recommended" # Agents # Bitbake variables can be used to describe an SPDX Agent that may be used # during the build. An Agent is specified using a set of variables which all # start with some common base name: # # _name: The name of the Agent (required) # _type: The type of Agent. Must be one of "person", "organization", # "software", or "agent" (the default if not specified) # _comment: The comment for the Agent (optional) # _id_: And External Identifier for the Agent. must be a valid # ExternalIdentifierType from the SPDX 3 spec. Commonly, an E-mail address # can be specified with _id_email # # Alternatively, an Agent can be an external reference by referencing a key # in SPDX_IMPORTS like so: # # _import = "" # # Finally, the same agent described by another set of agent variables can be # referenced by specifying the basename of the variable that should be # referenced: # # SPDX_PACKAGE_SUPPLIER_ref = "SPDX_AUTHORS_openembedded" SPDX_AUTHORS ??= "openembedded" SPDX_AUTHORS[doc] = "A space separated list of the document authors. Each item \ is used to name a base variable like SPDX_AUTHORS_ that \ describes the author." SPDX_AUTHORS_openembedded_name = "OpenEmbedded" SPDX_AUTHORS_openembedded_type = "organization" SPDX_BUILD_HOST[doc] = "The base variable name to describe the build host on \ which a build is running. Must be an SPDX_IMPORTS key. Requires \ SPDX_INCLUDE_BITBAKE_PARENT_BUILD. NOTE: Setting this will result in \ non-reproducible SPDX output" SPDX_INVOKED_BY[doc] = "The base variable name to describe the Agent that \ invoked the build, which builds will link to if specified. Requires \ SPDX_INCLUDE_BITBAKE_PARENT_BUILD. NOTE: Setting this will likely result in \ non-reproducible SPDX output" SPDX_ON_BEHALF_OF[doc] = "The base variable name to describe the Agent on who's \ behalf the invoking Agent (SPDX_INVOKED_BY) is running the build. Requires \ SPDX_INCLUDE_BITBAKE_PARENT_BUILD. NOTE: Setting this will likely result in \ non-reproducible SPDX output" SPDX_PACKAGE_SUPPLIER[doc] = "The base variable name to describe the Agent who \ is supplying artifacts produced by the build" IMAGE_CLASSES:append = " create-spdx-image-3.0" SDK_CLASSES += "create-spdx-sdk-3.0" oe.spdx30_tasks.set_timestamp_now[vardepsexclude] = "SPDX_INCLUDE_TIMESTAMPS" oe.spdx30_tasks.get_package_sources_from_debug[vardepsexclude] += "STAGING_KERNEL_DIR" oe.spdx30_tasks.collect_dep_objsets[vardepsexclude] = "SPDX_MULTILIB_SSTATE_ARCHS" python do_create_spdx() { import oe.spdx30_tasks oe.spdx30_tasks.create_spdx(d) } do_create_spdx[vardepsexclude] += "BB_NUMBER_THREADS" addtask do_create_spdx after \ do_collect_spdx_deps \ do_deploy_source_date_epoch \ do_populate_sysroot do_package do_packagedata \ ${create_spdx_source_deps(d)} \ before do_populate_sdk do_populate_sdk_ext do_build do_rm_work def create_spdx_source_deps(d): deps = [] if d.getVar("SPDX_INCLUDE_SOURCES") == "1": deps.extend([ # do_unpack is a hack for now; we only need it to get the # dependencies do_unpack already has so we can extract the source # ourselves "do_unpack", # For kernel source code "do_shared_workdir", ]) return " ".join(deps) SSTATETASKS += "do_create_spdx" do_create_spdx[sstate-inputdirs] = "${SPDXDEPLOY}" do_create_spdx[sstate-outputdirs] = "${DEPLOY_DIR_SPDX}" python do_create_spdx_setscene () { sstate_setscene(d) } addtask do_create_spdx_setscene do_create_spdx[dirs] = "${SPDXWORK}" do_create_spdx[cleandirs] = "${SPDXDEPLOY} ${SPDXWORK}" do_create_spdx[depends] += "${PATCHDEPENDENCY}" python do_create_package_spdx() { import oe.spdx30_tasks oe.spdx30_tasks.create_package_spdx(d) } do_create_package_spdx[vardepsexclude] += "OVERRIDES SPDX_MULTILIB_SSTATE_ARCHS" addtask do_create_package_spdx after do_create_spdx before do_build do_rm_work SSTATETASKS += "do_create_package_spdx" do_create_package_spdx[sstate-inputdirs] = "${SPDXRUNTIMEDEPLOY}" do_create_package_spdx[sstate-outputdirs] = "${DEPLOY_DIR_SPDX}" python do_create_package_spdx_setscene () { sstate_setscene(d) } addtask do_create_package_spdx_setscene do_create_package_spdx[dirs] = "${SPDXRUNTIMEDEPLOY}" do_create_package_spdx[cleandirs] = "${SPDXRUNTIMEDEPLOY}" do_create_package_spdx[rdeptask] = "do_create_spdx" python spdx30_build_started_handler () { import oe.spdx30_tasks d = e.data.createCopy() oe.spdx30_tasks.write_bitbake_spdx(d) } addhandler spdx30_build_started_handler spdx30_build_started_handler[eventmask] = "bb.event.BuildStarted"