Skip to contentSkip to conversation

improve_kerne_cve_report: Add a bbclass support

PATCH In review ValentinBoudevin 2 participants 4 messages Jan 6 – Jan 16 1 message not in the archive

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 improve_kerne_cve_report: Add a bbclass support

The script improve_kernel_cve_report.py doesn't have a bbclass. It can be usefull to have one to generate improved cve-check files at every run.

This new class can be used to generate a new file in tmp/deploy/images with a .scouted.json in addition to the existing .json cve-check file.

The new .scouted.json is based on the cve-check file and the SBOM (SPDX3 mandatory) to generate this improved cve-check file with extra entries found by the script improve_kernel_cve_report.py.

It only requires an inherit on an image recipe (e.g. "inherit improve_kernel_cve_report" in core-image-minimal).

It can be add to core-image-minimal in a second step if revelant.

---
 .../classes/improve_kernel_cve_report.bbclass | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 meta/classes/improve_kernel_cve_report.bbclass
meta/classes/improve_kernel_cve_report.bbclass new file +71 -0
new file mode 100644
index 0000000000..5c496252b4
@@ -0,0 +1,71 @@
+python do_clean:append() {
+    import os, glob
+    if bb.utils.contains('INHERIT', 'create-spdx-2.2', 'false', 'true', d):
+        deploy_dir = d.expand('${DEPLOY_DIR_IMAGE}')
+        for f in glob.glob(os.path.join(deploy_dir, '*scouted.json')):
+            bb.note("Removing " + f)
+            os.remove(f)
+}
+
+python do_clone_kernel_cve() {
+    import subprocess
+    import shutil, os
+    check_spdx = d.getVar("INHERIT")
+    rootdir = os.path.join(d.getVar("WORKDIR"), "vulns")
+    # Check if the feature is enabled and if SPDX 2.2 is not used
+    if "create-spdx-2.2" not in check_spdx:
+        d.setVar("SRC_URI", "git://git.kernel.org/pub/scm/linux/security/vulns.git;branch=master;protocol=https")
+        d.setVar("SRCREV", "${AUTOREV}")
+        src_uri = (d.getVar('SRC_URI') or "").split()
+        # Fetch the kernel vulnerabilities sources
+        fetcher = bb.fetch2.Fetch(src_uri, d)
+        fetcher.download()
+        # Unpack into the standard work directory
+        fetcher.unpack(rootdir)
+        # Remove the folder ${PN} set by unpack
+        subdirs = [d for d in os.listdir(rootdir) if os.path.isdir(os.path.join(rootdir, d))]
+        if len(subdirs) == 1:
+            srcdir = os.path.join(rootdir, subdirs[0])
+            for f in os.listdir(srcdir):
+                shutil.move(os.path.join(srcdir, f), rootdir)
+            shutil.rmtree(srcdir)
+        bb.note("Vulnerabilities repo unpacked into: %s" % rootdir)
+    elif "create-spdx-2.2" in check_spdx:
+        bb.warn(f"improve_kernel_cve_report: Extra Kernel CVEs Scouting is desactivate because incompatible with SPDX 2.2.")
+}
+do_clone_kernel_cve[network] = "1"
+do_clone_kernel_cve[nostamp] = "1"
+do_clone_kernel_cve[doc] = "Clone the latest kernel vulnerabilities from https://git.kernel.org/pub/scm/linux/security/vulns.git"
+addtask clone_kernel_cve after
+
+do_scout_extra_kernel_vulns() {
+    spdx_file="${SPDXIMAGEDEPLOYDIR}/${IMAGE_LINK_NAME}.spdx.json"
+    original_cve_check_file="${DEPLOY_DIR_IMAGE}/${IMAGE_LINK_NAME}.json"
+    new_cve_report_file="${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.scouted.json"
+    improve_kernel_cve_script="${COREBASE}/scripts/contrib/improve_kernel_cve_report.py"
+
+    if ${@bb.utils.contains('INHERIT', 'create-spdx-2.2', 'true', 'false', d)}; then
+        bbwarn "improve_kernel_cve_report: Skipping extra kernel vulnerabilities scouting because incompatible with SPDX 2."
+        return 0
+    elif [ ! -f "${spdx_file}" ]; then
+        bbwarn "improve_kernel_cve_report: SPDX file not found: ${spdx_file}. Skipping extra kernel vulnerabilities scoutings."
+        return 0
+    elif [ ! -f "${original_cve_check_file}" ]; then
+        bbwarn "improve_kernel_cve_report: CVE_CHECK file not found: ${original_cve_check_file}. Skipping extra kernel vulnerabilities scouting."
+        return 0
+    fi
+
+    #Launch the new script to improve the cve report
+    python3 "${improve_kernel_cve_script}" \
+        --spdx "${spdx_file}" \
+        --old-cve-report "${original_cve_check_file}" \
+        --new-cve-report "${new_cve_report_file}" \
+        --datadir "${WORKDIR}/vulns"
+    bbplain "Improve CVE report with extra kernel cves: ${new_cve_report_file}"
+
+    #Create a symlink as every other JSON file in tmp/deploy/images
+    ln -sf ${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.scouted.json ${DEPLOY_DIR_IMAGE}/${IMAGE_BASENAME}${IMAGE_MACHINE_SUFFIX}${IMAGE_NAME_SUFFIX}.scouted.json
+}
+do_scout_extra_kernel_vulns[nostamp] = "1"
+do_scout_extra_kernel_vulns[doc] = "Scout extra kernel vulnerabilities and create a new enhanced version of the cve_check file in the deploy directory"
+addtask scout_extra_kernel_vulns after do_create_image_sbom_spdx before do_build
\ No newline at end of file
Signature · 1 line
2.43.0
#1 lore raw

Hi,

The script also supports SPDX2, why have it SPDX3 specific?

More comments inline

Daniel

Quoted 54 lines

-----Original Message-----
From: [email protected] <openembedded- [email protected]> On Behalf Of vboudevin via lists.openembedded.org
Sent: Tuesday, 6 January 2026 20:42
To: [email protected]
Cc: ValentinBoudevin <[email protected]>
Subject: [OE-core] [PATCH] improve_kerne_cve_report: Add a bbclass support

The script improve_kernel_cve_report.py doesn't have a bbclass.
It can be usefull to have one to generate improved cve-check files at every run.

This new class can be used to generate a new file in tmp/deploy/images with a .scouted.json in addition to the existing .json cve-check file.

The new .scouted.json is based on the cve-check file and the SBOM (SPDX3 mandatory) to generate this improved cve-check file with extra entries found by the script improve_kernel_cve_report.py.

It only requires an inherit on an image recipe (e.g. "inherit improve_kernel_cve_report" in core-image-minimal).

It can be add to core-image-minimal in a second step if revelant.

---
 .../classes/improve_kernel_cve_report.bbclass | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 meta/classes/improve_kernel_cve_report.bbclass
meta/classes/improve_kernel_cve_report.bbclass new file +17 -0
new file mode 100644
index 0000000000..5c496252b4
@@ -0,0 +1,71 @@
+python do_clean:append() {
+    import os, glob
+    if bb.utils.contains('INHERIT', 'create-spdx-2.2', 'false', 'true', d):
+        deploy_dir = d.expand('${DEPLOY_DIR_IMAGE}')
+        for f in glob.glob(os.path.join(deploy_dir, '*scouted.json')):
+            bb.note("Removing " + f)
+            os.remove(f)
+}
+
+python do_clone_kernel_cve() {
+    import subprocess
+    import shutil, os
+    check_spdx = d.getVar("INHERIT")
+    rootdir = os.path.join(d.getVar("WORKDIR"), "vulns")
+    # Check if the feature is enabled and if SPDX 2.2 is not used
+    if "create-spdx-2.2" not in check_spdx:
+        d.setVar("SRC_URI",

"git://git.kernel.org/pub/scm/linux/security/vulns.git;branch=master;protocol=h ttps")

meta/classes/improve_kernel_cve_report.bbclass line 19

Quoted 2 lines
meta/classes/improve_kernel_cve_report.bbclass new file +2 -0
+        d.setVar("SRCREV", "${AUTOREV}")
+        src_uri = (d.getVar('SRC_URI') or "").split()

This will make the build non reproducible. It was one of the feedback that I got with the original series. Could it be possible to make it work with mirrors as well for offline builds?

Quoted 49 lines
meta/classes/improve_kernel_cve_report.bbclass new file +19 -0
+        # Fetch the kernel vulnerabilities sources
+        fetcher = bb.fetch2.Fetch(src_uri, d)
+        fetcher.download()
+        # Unpack into the standard work directory
+        fetcher.unpack(rootdir)
+        # Remove the folder ${PN} set by unpack
+        subdirs = [d for d in os.listdir(rootdir) if os.path.isdir(os.path.join(rootdir, d))]
+        if len(subdirs) == 1:
+            srcdir = os.path.join(rootdir, subdirs[0])
+            for f in os.listdir(srcdir):
+                shutil.move(os.path.join(srcdir, f), rootdir)
+            shutil.rmtree(srcdir)
+        bb.note("Vulnerabilities repo unpacked into: %s" % rootdir)
+    elif "create-spdx-2.2" in check_spdx:
+        bb.warn(f"improve_kernel_cve_report: Extra Kernel CVEs Scouting
+is desactivate because incompatible with SPDX 2.2.") }
+do_clone_kernel_cve[network] = "1"
+do_clone_kernel_cve[nostamp] = "1"
+do_clone_kernel_cve[doc] = "Clone the latest kernel vulnerabilities from

https://git.kernel/.
org%2Fpub%2Fscm%2Flinux%2Fsecurity%2Fvulns.git&data=05%7C02%7Cdaniel.t urull%40ericsson.com%7Ca26e06f7ba0c4992552008de4d5baddb%7C92e84ceb fbfd47abbe52080c6b87953f%7C0%7C0%7C639033253334668000%7CUnknown %7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJ XaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=Ql5W 0FA1uoB7iuuLEoNk4hVoc4vUAVWRROFzG1BWTLI%3D&reserved=0"

meta/classes/improve_kernel_cve_report.bbclass new file +5 -0
+addtask clone_kernel_cve after
+
+do_scout_extra_kernel_vulns() {
+    spdx_file="${SPDXIMAGEDEPLOYDIR}/${IMAGE_LINK_NAME}.spdx.json"
+

original_cve_check_file="${DEPLOY_DIR_IMAGE}/${IMAGE_LINK_NAME}.json" + new_cve_report_file="${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.scouted.json" + improve_kernel_cve_script="${COREBASE}/scripts/contrib/improve_kernel_cve_ report.py"

meta/classes/improve_kernel_cve_report.bbclass new file +3 -0
+
+    if ${@bb.utils.contains('INHERIT', 'create-spdx-2.2', 'true', 'false', d)}; then
+        bbwarn "improve_kernel_cve_report: Skipping extra kernel vulnerabilities

scouting because incompatible with SPDX 2."

meta/classes/improve_kernel_cve_report.bbclass new file +3 -0
+        return 0
+    elif [ ! -f "${spdx_file}" ]; then
+        bbwarn "improve_kernel_cve_report: SPDX file not found: ${spdx_file}.

Skipping extra kernel vulnerabilities scoutings."

meta/classes/improve_kernel_cve_report.bbclass new file +3 -0
+        return 0
+    elif [ ! -f "${original_cve_check_file}" ]; then
+        bbwarn "improve_kernel_cve_report: CVE_CHECK file not found:

${original_cve_check_file}. Skipping extra kernel vulnerabilities scouting."

meta/classes/improve_kernel_cve_report.bbclass line 64

Quoted 10 lines
meta/classes/improve_kernel_cve_report.bbclass new file +10 -0
+        return 0
+    fi
+
+    #Launch the new script to improve the cve report
+    python3 "${improve_kernel_cve_script}" \
+        --spdx "${spdx_file}" \
+        --old-cve-report "${original_cve_check_file}" \
+        --new-cve-report "${new_cve_report_file}" \
+        --datadir "${WORKDIR}/vulns"
+    bbplain "Improve CVE report with extra kernel cves: ${new_cve_report_file}"

You can also use the debug sources as input to be spdx independent.
For example, from the docs.
python3 openembedded-core/scripts/contrib/improve_kernel_cve_report.py \
--debug-sources tmp/pkgdata/qemux86_64/debugsources/linux-yocto-debugsources.json.zstd \
--datadir ~/vulns \
--old-cve-report build/tmp/log/cve/cve-summary.json

Quoted 14 lines
meta/classes/improve_kernel_cve_report.bbclass new file +3 -0
+    #Create a symlink as every other JSON file in tmp/deploy/images
+    ln -sf ${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.scouted.json
+${DEPLOY_DIR_IMAGE}/${IMAGE_BASENAME}${IMAGE_MACHINE_SUFFIX}${I

MAGE_NAM

meta/classes/improve_kernel_cve_report.bbclass new file +4 -0
+E_SUFFIX}.scouted.json
+}
+do_scout_extra_kernel_vulns[nostamp] = "1"
+do_scout_extra_kernel_vulns[doc] = "Scout extra kernel vulnerabilities and

create a new enhanced version of the cve_check file in the deploy directory"

meta/classes/improve_kernel_cve_report.bbclass new file +2 -1
+addtask scout_extra_kernel_vulns after do_create_image_sbom_spdx before
+do_build
\ No newline at end of file
--

2.43.0

author
#2 lore raw

Hi Daniel,

I just pushed a V2 of my patch here: https://lists.openembedded.org/g/openembedded-core/message/229419. ( https://lists.openembedded.org/g/openembedded-core/message/229419 ) I added variables to add a deterministic entry if wanted, an offline mode based on DL_DIR, and a second .bbclass for SPDX2.2.

I can't put SPDX 2.2 and SPDX3.0 in the same class as the task scheduling is very different and a single task won't be able to handle both. I want to add a third class for debug-source scenario but it is going to take me some time.

Do you see any other issue to solve for the current two bbclass?

#4 lore raw
In reply to a message not in the archive

Hi,
I can see duplicated code. Try to split it into smaller functions and put it into a common file, in a similar way how spdx or cve classes are implemented. If I do a diff between both file are almost identical. Did you commit all the changes?

diff meta/classes/improve_kernel_cve_report-spdx-2.2.bbclass meta/classes/improve_kernel_cve_report-spdx.bbclass 22,24c22,24
< # Check if the system is using SPDX 2.2
< if "create-spdx-2.2" not in check_spdx:
< bb.warn(f"improve_kernel_cve_report-spdx-2.2: Requires SPDX 2.2 enable.")
---

Quoted 3 lines

# Check if the system is using SPDX 3.0
if "create-spdx" not in check_spdx:
bb.warn(f"improve_kernel_cve_report-spdx: Requires SPDX 3.0 enable.")

82c82
< spdx_file=${DEPLOY_DIR}/spdx/2.2/${@d.getVar('MACHINE').replace('-', '_')}/recipes/recipe-${PREFERRED_PROVIDER_virtual/kernel}.spdx.json<mailto:$%7bDEPLOY_DIR%7d/spdx/2.2/$%[email protected]('MACHINE').replace('-',%20'_')%7d/recipes/recipe-$%7bPREFERRED_PROVIDER_virtual/kernel%7d.spdx.json>
---

Quoted 1 line
    spdx_file="${SPDXIMAGEDEPLOYDIR}/${IMAGE_LINK_NAME}.spdx.json"

86c86
< bbwarn "improve_kernel_cve_report-spdx-2.2: No SPDX 2.2 file found in ${spdx_file}."
---

Quoted 1 line
        bbwarn "improve_kernel_cve_report-spdx: No SPDX3.0 file found in ${spdx_file}."

90c90
< bbwarn "improve_kernel_cve_report-spdx-2.2: CVE_CHECK file not found: ${original_cve_check_file}. Skipping extra kernel vulnerabilities scouting."
---

Quoted 1 line
        bbwarn "improve_kernel_cve_report-spdx: CVE_CHECK file not found: ${original_cve_check_file}. Skipping extra kernel vulnerabilities scouting."

94c94
< bbwarn "improve_kernel_cve_report-spdx-2.2: improve_kernel_cve_report.py not found in ${COREBASE}."
---

Quoted 1 line
        bbwarn "improve_kernel_cve_report-spdx: improve_kernel_cve_report.py not found in ${COREBASE}."

98c98
< bbwarn "improve_kernel_cve_report-spdx-2.2: Vulnerabilities data not found in ${WORKDIR}/vulns."
---

Quoted 1 line
        bbwarn "improve_kernel_cve_report-spdx: Vulnerabilities data not found in ${WORKDIR}/vulns."

103c103
< bbplain "improve_kernel_cve_report-spdx-2.2: Using SPDX file for extra kernel vulnerabilities scouting: ${spdx_file}"
---

Quoted 1 line
    bbplain "improve_kernel_cve_report-spdx: Using SPDX file for extra kernel vulnerabilities scouting: ${spdx_file}"

116c116

Best regards,
Daniel

From: [email protected] <[email protected]> On Behalf Of vboudevin via lists.openembedded.org
Sent: Thursday, 15 January 2026 20:13
To: [email protected]
Subject: Re: [OE-core] [PATCH] improve_kerne_cve_report: Add a bbclass support

[Edited Message Follows]
Hi Daniel,

I just pushed a V2 of my patch here: https://lists.openembedded.org/g/openembedded-core/message/229434.
I added variables to add a deterministic entry if wanted, an offline mode based on DL_DIR, and a second .bbclass for SPDX2.2.

I can't put SPDX 2.2 and SPDX3.0 in the same class as the task scheduling is very different and a single task won't be able to handle both. I want to add a third class for debug-source scenario but it is going to take me some time.

Do you see any other issue to solve for the current two bbclass?