Skip to contentSkip to conversation

classes/cve-check: Move get_patches_cves to library

PATCH In review Joshua Watt 2 participants 3 messages Aug 11, 2021 – Aug 19, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 classes/cve-check: Move get_patches_cves to library

Moving the function will allow other classes to capture which CVEs have been patched, in particular SBoM generation.

Also add a function to capture the CPE ID from the CVE Product and Version

---
 meta/classes/cve-check.bbclass | 62 +------------------------
 meta/lib/oe/cve_check.py       | 83 ++++++++++++++++++++++++++++++++++
 2 files changed, 85 insertions(+), 60 deletions(-)
meta/classes/cve-check.bbclass +2 -60
index 6582f97151..3c4c9218e3 100644
@@ -94,10 +94,11 @@ python do_cve_check () {
     """
     Check recipe for patched and unpatched CVEs
     """
+    from oe.cve_check import get_patched_cves
 
     if os.path.exists(d.getVar("CVE_CHECK_DB_FILE")):
         try:
-            patched_cves = get_patches_cves(d)
+            patched_cves = get_patched_cves(d)
         except FileNotFoundError:
             bb.fatal("Failure in searching patches")
         whitelisted, patched, unpatched = check_cves(d, patched_cves)
@@ -156,65 +157,6 @@ python cve_check_write_rootfs_manifest () {
 ROOTFS_POSTPROCESS_COMMAND:prepend = "${@'cve_check_write_rootfs_manifest; ' if d.getVar('CVE_CHECK_CREATE_MANIFEST') == '1' else ''}"
 do_rootfs[recrdeptask] += "${@'do_cve_check' if d.getVar('CVE_CHECK_CREATE_MANIFEST') == '1' else ''}"
 
-def get_patches_cves(d):
-    """
-    Get patches that solve CVEs using the "CVE: " tag.
-    """
-
-    import re
-
-    pn = d.getVar("PN")
-    cve_match = re.compile("CVE:( CVE\-\d{4}\-\d+)+")
-
-    # Matches the last "CVE-YYYY-ID" in the file name, also if written
-    # in lowercase. Possible to have multiple CVE IDs in a single
-    # file name, but only the last one will be detected from the file name.
-    # However, patch files contents addressing multiple CVE IDs are supported
-    # (cve_match regular expression)
-
-    cve_file_name_match = re.compile(".*([Cc][Vv][Ee]\-\d{4}\-\d+)")
-
-    patched_cves = set()
-    bb.debug(2, "Looking for patches that solves CVEs for %s" % pn)
-    for url in src_patches(d):
-        patch_file = bb.fetch.decodeurl(url)[2]
-
-        if not os.path.isfile(patch_file):
-            bb.error("File Not found: %s" % patch_file)
-            raise FileNotFoundError
-
-        # Check patch file name for CVE ID
-        fname_match = cve_file_name_match.search(patch_file)
-        if fname_match:
-            cve = fname_match.group(1).upper()
-            patched_cves.add(cve)
-            bb.debug(2, "Found CVE %s from patch file name %s" % (cve, patch_file))
-
-        with open(patch_file, "r", encoding="utf-8") as f:
-            try:
-                patch_text = f.read()
-            except UnicodeDecodeError:
-                bb.debug(1, "Failed to read patch %s using UTF-8 encoding"
-                        " trying with iso8859-1" %  patch_file)
-                f.close()
-                with open(patch_file, "r", encoding="iso8859-1") as f:
-                    patch_text = f.read()
-
-        # Search for one or more "CVE: " lines
-        text_match = False
-        for match in cve_match.finditer(patch_text):
-            # Get only the CVEs without the "CVE: " tag
-            cves = patch_text[match.start()+5:match.end()]
-            for cve in cves.split():
-                bb.debug(2, "Patch %s solves %s" % (patch_file, cve))
-                patched_cves.add(cve)
-                text_match = True
-
-        if not fname_match and not text_match:
-            bb.debug(2, "Patch %s doesn't solve CVEs" % patch_file)
-
-    return patched_cves
-
 def check_cves(d, patched_cves):
     """
     Connect to the NVD database and find unpatched cves.
meta/lib/oe/cve_check.py +83 -0

86 lines not on this page · raw message

Signature · 1 line
2.32.0
#1 lore raw
Quoted 7 lines · Joshua Watt

Moving the function will allow other classes to capture which CVEs have been patched, in particular SBoM generation.

Also add a function to capture the CPE ID from the CVE Product and Version

Do you have a link to some resource on how you plan to use it for SBOM generation?

Thanks,
Marta

#2 lore raw

I have a branch called jpew/sbom in poky-contrib with my WIP changes.

http://git.yoctoproject.org/cgit.cgi/poky-contrib/log/?h=jpew/sbom

Quoted 16 lines · Marta Rybczynska
Quoted 7 lines · Joshua Watt

Moving the function will allow other classes to capture which CVEs have been patched, in particular SBoM generation.

Also add a function to capture the CPE ID from the CVE Product and Version

Do you have a link to some resource on how you plan to use it for SBOM generation?

Thanks,
Marta