From 5e0d46ab1d3f1759163f60b44aa8e3e47ef4e84a Mon Sep 17 00:00:00 2001 From: Luciano Dittgen Date: Fri, 13 Nov 2026 16:50:08 -0300 Subject: [PATCH] cve-filter: Remove the class and its Python library OE-Core removed cve-check (00de455f8d), whose JSON report this class filtered, so it cannot run on blacksail or wrynose. The README now points at OE-Core's sbom-cve-check fragment. Tested with bitbake -p (0 errors). Signed-off-by: Luciano Dittgen --- README | 14 ++ classes/cve-filter.bbclass | 109 ----------- conf/layer.conf | 2 - lib/ossystems/__init__.py | 4 - lib/ossystems/cve_filter.py | 357 ------------------------------------ 5 files changed, 14 insertions(+), 472 deletions(-) delete mode 100644 classes/cve-filter.bbclass delete mode 100644 lib/ossystems/__init__.py delete mode 100644 lib/ossystems/cve_filter.py diff --git a/README b/README index ffdd9fb..5efb0bc 100644 --- a/README +++ b/README @@ -11,6 +11,20 @@ URI: git://git.openembedded.org/openembedded-core branch: master revision: HEAD +CVE checking +------------ + +The layer no longer ships a CVE filter class: OE-Core dropped the +cve-check class it relied on. Use OE-Core's SBOM-based checker instead, +which reads the image SPDX and writes VEX-aware reports to the deploy +directory: + + bitbake-config-build enable-fragment core/yocto/sbom-cve-check + +or, in local.conf: + + OE_FRAGMENTS += "core/yocto/sbom-cve-check" + Contributing ------------ diff --git a/classes/cve-filter.bbclass b/classes/cve-filter.bbclass deleted file mode 100644 index aff2968..0000000 --- a/classes/cve-filter.bbclass +++ /dev/null @@ -1,109 +0,0 @@ -# nooelint: oelint.bbclass.underscores oelint.file.inlinesuppress_na no EXPORT_FUNCTIONS here, so the dash is harmless -# Copyright (c) 2024 O.S. Systems Software LTDA. -# Usage Instructions for the Yocto CVE Filter Class - -# This class is designed to filter CVEs (Common Vulnerabilities -# and Exposures) from CVE files. It should be used in conjunction -# with the cve-check class from the openembedded-core. - -# Steps to Use This Class - -# 1. Add the following lines to your distro configuration file: - -# include conf/distro/include/cve-extra-exclusions.inc -# INHERIT += "cve-check" - -# 2. Inherit the cve-filter class in the image recipe. -# -# -------- Configuration Variables ---------------------------- - -# The cve-filter class provides several configurable variables: - -# CVE_FILTER_PREVIOUS_FILE: Specifies the previous version of -# the CVE JSON file. If no file is provided, only the current -# file will be considered. -# Default: empty - -# CVE_FILTER_PREVIOUS_VERSION: Specifies the distro version of -# the previous CVE JSON file. The CVE_FILTER_PREVIOUS_FILE must -# be defined, otherwise the value 0 will be used. -# Example: "1.0.0" -# Default: "0.0.0" - -# CVE_FILTER_MARKDOWN_FILE_NAME: Specifies the name of the -# output Markdown file containing the list of detected CVEs. -# Default: "${IMAGE_NAME}.md" - -# CVE_FILTER_IGNORED_CVES: Lists the CVEs that should be ignored by the filter. -# Example: "CVE-2017-6264 CVE-2023-1234" -# Default: empty - -# CVE_FILTER_SCOREV2_CUTTOFF and CVE_FILTER_SCOREV3_CUTTOFF: -# Set the value of cut off CVE Score to SCOREV2 and V3. CVEs below the value -# set here will no be considered. -# Example: "9" -# Default: "0" - -# Set the PATH to find the old CVE Json list -CVE_FILTER_PREVIOUS_FILE ??= "" -CVE_FILTER_PREVIOUS_VERSION ??= "0.0.0" - -CVE_FILTER_CURRENT_FILE = "${IMGDEPLOYDIR}/${IMAGE_NAME}.json" -CVE_FILTER_CURRENT_VERSION = "${DISTRO_VERSION}" - -# Set the name of markdown output file -CVE_FILTER_MARKDOWN_FILE_NAME ?= "${IMAGE_NAME}.md" -CVE_FILTER_MARKDOWN_FILE = "${IMGDEPLOYDIR}/${CVE_FILTER_MARKDOWN_FILE_NAME}" - -# List of CVE should be ignored Eg: CVE-2023-1234 -CVE_FILTER_IGNORED_CVES ??= "" - -# Cut off score V2 and V3 value -CVE_FILTER_SCOREV2_CUTOFF ??= "0" -CVE_FILTER_SCOREV3_CUTOFF ??= "0" - -inherit python3native - -python do_cve_filter (){ - from ossystems.cve_filter import Cve - - previousFile = d.getVar("CVE_FILTER_PREVIOUS_FILE") - previousVersion = d.getVar("CVE_FILTER_PREVIOUS_VERSION") - cveIgnoreList = d.getVar("CVE_FILTER_IGNORED_CVES").split() - scoreV2CutOff = int(d.getVar("CVE_FILTER_SCOREV2_CUTOFF")) - scoreV3CutOff = int(d.getVar("CVE_FILTER_SCOREV3_CUTOFF")) - - cve_prev = Cve() - cve_prev.setMarkdonFileName(d.getVar("CVE_FILTER_MARKDOWN_FILE")) - cve_curr = Cve() - - if previousFile: - cve_prev.loadCVEfile(previousFile) - cve_prev.setCVEVersion(previousVersion) - cve_prev.setScoreV2CutOff(scoreV2CutOff) - cve_prev.setScoreV3CutOff(scoreV3CutOff) - cve_prev.setIgnoreCVEList(cveIgnoreList) - cve_prev.loadCVEData() - else: - bb.warn("Previous CVE File Not Defined!!!") - - cve_curr.loadCVEfile(d.getVar("CVE_FILTER_CURRENT_FILE")) - cve_curr.setCVEVersion(d.getVar("CVE_FILTER_CURRENT_VERSION")) - cve_curr.setScoreV2CutOff(scoreV2CutOff) - cve_curr.setScoreV3CutOff(scoreV3CutOff) - cve_curr.setIgnoreCVEList(cveIgnoreList) - cve_curr.loadCVEData() - cve_prev.compareCVes(cve_curr) - bb.plain("DONE!!") -} - -do_cve_filter[doc] = "Compare the image CVE report against a previous version and emit a filtered Markdown summary of the new CVEs." -addtask cve_filter after do_rootfs before do_image - -# nooelint: oelint.var.rootfspostcmd the trailing space keeps this prepend apart from the next function -ROOTFS_POSTPROCESS_COMMAND:prepend = "link_cvefilter_markdownfile " - -link_cvefilter_markdownfile[doc] = "Create a stable-named symlink to the CVE filter Markdown report in the deploy directory." -link_cvefilter_markdownfile () { - ln -sf ${CVE_FILTER_MARKDOWN_FILE_NAME} ${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.md -} diff --git a/conf/layer.conf b/conf/layer.conf index 3053dc8..394db43 100644 --- a/conf/layer.conf +++ b/conf/layer.conf @@ -10,8 +10,6 @@ BBFILE_PATTERN_ossystems-base := "^${LAYERDIR}/" BBFILE_PRIORITY_ossystems-base = "8" LAYERDEPENDS_ossystems-base = "core" -addpylib ${LAYERDIR}/lib ossystems - LAYERSERIES_COMPAT_ossystems-base = "blacksail" LICENSE_PATH += "${LAYERDIR}/conf/licenses" diff --git a/lib/ossystems/__init__.py b/lib/ossystems/__init__.py deleted file mode 100644 index 8e5d5cb..0000000 --- a/lib/ossystems/__init__.py +++ /dev/null @@ -1,4 +0,0 @@ -from pkgutil import extend_path -__path__ = extend_path(__path__, __name__) - -BBIMPORTS = ["cve_filter"] diff --git a/lib/ossystems/cve_filter.py b/lib/ossystems/cve_filter.py deleted file mode 100644 index 6ea3b34..0000000 --- a/lib/ossystems/cve_filter.py +++ /dev/null @@ -1,357 +0,0 @@ -import argparse -import json -import sys - - -# Class to store the CVE data -class Issue: - def __init__(self, id, summary, scorev2, scorev3, vector, status, link): - self.id = id - self.summary = summary - self.scorev2 = scorev2 - self.scorev3 = scorev3 - self.vector = vector - self.status = status - self.link = link - - def __eq__(self, other): - return self.id == other.id - - def __hash__(self): - return hash(self.id) - - def __str__(self): - return self.id - - def toTuple(self): - return ( - self.id, - self.summary, - self.scorev2, - self.scorev3, - self.vector, - self.status, - self.link, - ) - - -# Class to store the filtered and ready to print CVes -class CVEFilter: - def __init__(self, name, status): - self.name = name - self.status = status - self.both = [] - self.patched = [] - self.old = [] - self.new = [] - - def setVersion(self, version1, version2=0): - self.version1 = version1 - self.version2 = version2 - - def addCVEBoth(self, issue): - self.both.append(issue) - - def addCVEPatched(self, issue): - self.patched.append(issue) - - def addCVEOld(self, issue): - self.old.append(issue) - - def addCVENew(self, issue): - self.new.append(issue) - - -# Class to store the Package with the list of Issues -class Package: - def __init__(self, name, version): - self.name = name - self.version = version - self.cve = [] - - def addCVE(self, cve): - self.cve.append(cve) - - -# Class to handle CVEs -class Cve: - def __init__(self): - self.__markdownFileName = "output.md" - self.__packages = [] - self.__printIssues = [] - self.__ignored_cves = [] - self.__version = 0 - self.__scoreV2cf = 0 - self.__scoreV3cf = 0 - - # def __del__ (self): - # self.__cveJsonFile.close() - - def loadCVEfile(self, fileName): - try: - self.__cveJsonFile = open(fileName, "r") - try: - self.__jsonData = json.load(self.__cveJsonFile) - except ValueError as e: - print("Fail on JSON file: " + fileName) - print(e) - self.__jsonPackages = self.__jsonData["package"] - - except FileNotFoundError: - print("File not found or wrong file name! " + fileName) - exit(1) - except: - print("Error to open file!") - exit(1) - - def setMarkdonFileName(self, name): - if name: - self.__markdownFileName = name - - def setIgnoreCVEList(self, listcve): - self.__ignored_cves = list(listcve) - - def setCVEVersion(self, version=0): - self.__version = version - - def setScoreV2CutOff(self, score): - self.__scoreV2cf = score - - def setScoreV3CutOff(self, score): - self.__scoreV3cf = score - - def getCVEPackages(self): - return self.__packages - - def getCVEVersion(self): - return self.__version - - def printCVEs(self): - print(self.__jsonData["package"]) - - def loadCVEData(self): - for pack in self.__jsonPackages: - p = Package(pack["name"], pack["version"]) - entry = False - for id in pack["issue"]: - if (float(id["scorev2"]) >= self.__scoreV2cf or float(id["scorev3"]) >= self.__scoreV3cf) and id[ - "status" - ] != "Ignored": - if not (id["id"] in self.__ignored_cves): - p.addCVE( - Issue( - id["id"], - id["summary"], - id["scorev2"], - id["scorev3"], - id["vector"], - id["status"], - id["link"], - ) - ) - entry = True - if entry: - self.__packages.append(p) - - def __creatMarkdownFile(self): - try: - self.__markdownFile = open(self.__markdownFileName, "w") - except: - print("ERROR to create the Markdown output file") - exit(1) - - def printUnpatchedListCVEs(self): - for package in self.__packages: - print("--------------- PACKAGE -----------------") - print(package.name) - print(package.version) - print("=============== ISSUES ==================") - for id in package.cve: - if id.status != "Patched": - print(id.id) - print(id.scorev2) - print(id.scorev3) - print(id.status) - - def compareCVes(self, compCVE): - self.__creatMarkdownFile() - packagesNew = compCVE.getCVEPackages() - for packageOld in self.__packages: - contain = False - for packageNew in packagesNew: - if packageOld.name == packageNew.name: - # This case if the package has the same version - if packageOld.version == packageNew.version: - cveOutput = CVEFilter(packageOld.name, "Kept") - cveOutput.setVersion(packageOld.version) - self.__checkIssues(cveOutput, packageOld.cve, packageNew.cve) - self.__printIssues.append(cveOutput) - # remove package that has comparated - packagesNew.remove(packageNew) - contain = True - break - - # This case if the package was upgrated - elif packageOld.version < packageNew.version: - cveOutput = CVEFilter(packageOld.name, "Updated") - cveOutput.setVersion(packageOld.version, packageNew.version) - self.__checkIssues(cveOutput, packageOld.cve, packageNew.cve) - self.__printIssues.append(cveOutput) - # remove package that has comparated - packagesNew.remove(packageNew) - contain = True - break - - # This case if the package was Downgrade - else: - cveOutput = CVEFilter(packageOld.name, "Downgraded") - cveOutput.setVersion(packageOld.version, packageNew.version) - self.__checkIssues(cveOutput, packageOld.cve, packageNew.cve) - self.__printIssues.append(cveOutput) - # remove package that has comparated - packagesNew.remove(packageNew) - contain = True - break - - # This case is when the package was removed - if not contain: - cveOutput = CVEFilter(packageOld.name, "Removed") - cveOutput.setVersion(packageOld.version) - self.__checkIssues(cveOutput, packageOld.cve, []) - self.__printIssues.append(cveOutput) - # remove package that has comparated - # For all cases that packages was added - for newpackage in packagesNew: - cveOutput = CVEFilter(newpackage.name, "Added") - cveOutput.setVersion(newpackage.version) - self.__checkIssues(cveOutput, [], newpackage.cve) - self.__printIssues.append(cveOutput) - # remove package that has comparated - self.__printCVEs( - self.__printIssues, self.getCVEVersion(), compCVE.getCVEVersion() - ) - - def __checkIssues(self, cveOut, cveListOld, cveListNew): - cveOut.new = cveListNew.copy() - if cveListOld and cveListNew: - for cveold in cveListOld: - contain = False - for cvenew in cveOut.new: - if cveold.id == cvenew.id: - if (cveold.status == cvenew.status) and ( - cvenew.status == "Unpatched" - ): - cveOut.addCVEBoth(cveold) - cveOut.new.remove(cvenew) - contain = True - break - elif (cveold.status == cvenew.status) and ( - cvenew.status == "Patched" - ): - cveOut.new.remove(cvenew) - contain = True - break - elif (cveold.status != cvenew.status) and ( - cvenew.status == "Patched" - ): - cveOut.addCVEPatched(cvenew) - cveOut.new.remove(cvenew) - contain = True - break - elif (cveold.status != cvenew.status) and ( - cvenew.status == "Unpatched" - ): - cveOut.addCVENew(cvenew) - cveOut.new.remove(cvenew) - contain = True - break - if not contain: - cveOut.addCVEOld(cveold) - elif cveListNew: - for cveNew in cveListNew: - if cveNew.status == "Patched": - cveOut.new.remove(cveNew) - else: - for cveOld in cveListOld: - if cveOld.status != "Patched": - cveOut.addCVEOld(cveOld) - - def __printCVEs(self, cvePrint, v1, v2): - self.__markdownFile.write(f"# {v1} -> {v2}") - for cve in cvePrint: - if cve.old or cve.both or cve.patched or cve.new: - if cve.status == "Updated" or cve.status == "Downgraded": - self.__markdownFile.write("\n") - self.__markdownFile.write( - "## " - + cve.name - + ": " - + cve.version1 - + " -> " - + cve.version2 - + " : " - + cve.status - + "\n" - ) - else: - self.__markdownFile.write("\n") - self.__markdownFile.write( - "## " - + cve.name - + ": " - + cve.version1 - + " : " - + cve.status - + "\n" - ) - self.__printIs(cve) - - def __printIs(self, issue): - if issue.both: - if issue.status == "Updated" or issue.status == "Downgraded": - self.__markdownFile.write("\n### Affect both versions\n") - else: - self.__markdownFile.write("\n### Unsolved\n") - self.__markdownFile.write("| CVE | STATUS | SCORE V2 | SCORE V3 |\n") - self.__markdownFile.write("|:--|:--:|:--:|:---:|\n") - s = ' Vulnerable ' - for i in issue.both: - self.__markdownFile.write( - f"|[{i.id}]({i.link})|{s}|{i.scorev2}|{i.scorev3}|\n" - ) - - if issue.patched: - self.__markdownFile.write("\n### Fixed in new revision\n") - self.__markdownFile.write("| CVE | STATUS | SCORE V2 | SCORE V3 |\n") - self.__markdownFile.write("|:--|:--:|:--:|:---:|\n") - s = ' Patched ' - for i in issue.patched: - self.__markdownFile.write( - f"|[{i.id}]({i.link})|{s}|{i.scorev2}|{i.scorev3}|\n" - ) - - if issue.old: - if issue.status == "Removed": - self.__markdownFile.write("\n### Affected the removed version\n") - else: - self.__markdownFile.write("\n### Affect the old version\n") - self.__markdownFile.write("| CVE | STATUS | SCORE V2 | SCORE V3 |\n") - self.__markdownFile.write("|:--|:--:|:--:|:---:|\n") - s = ' Vulnerable ' - for i in issue.old: - self.__markdownFile.write( - f"|[{i.id}]({i.link})|{s}|{i.scorev2}|{i.scorev3}|\n" - ) - - if issue.new: - if issue.status == "Updated" or issue.status == "Downgraded": - self.__markdownFile.write("\n### New Issues added\n") - else: - self.__markdownFile.write("\n### Affect only new revision\n") - self.__markdownFile.write("| CVE | STATUS | SCORE V2 | SCORE V3 |\n") - self.__markdownFile.write("|:--|:--:|:--:|:---:|\n") - s = ' Vulnerable ' - for i in issue.new: - self.__markdownFile.write( - f"|[{i.id}]({i.link})|{s}|{i.scorev2}|{i.scorev3}|\n" - )