diff --git a/CHANGELOG.md b/CHANGELOG.md index bb32033..81838e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,15 @@ recorded here; their history is the git log. ## [Unreleased] +## [4.37.0] - 2026-11-12 + +### Added +- `UpdateMixin.get_installed_advisory_cves()` (declared): the CVEs a host's installed + security advisories close, per package. With `DNF_INSTALLED_CVES_COMMAND` (dnf 4, + read from the cache) and `parse_dnf_installed_cves()`, the parser every dnf driver + shares. netOrk reads it where its knowledge base holds no records of the host's + release, as the distribution's word that a backport is in (netOrk #2394). + ## [4.36.2] - 2026-11-12 ### Fixed diff --git a/napalm_device_types/__init__.py b/napalm_device_types/__init__.py index 3bd5a45..0e7efe6 100644 --- a/napalm_device_types/__init__.py +++ b/napalm_device_types/__init__.py @@ -217,8 +217,10 @@ from napalm_device_types.os import OSDriver from napalm_device_types.ospf import OspfMixin from napalm_device_types.package_updates import ( APT_UPGRADABLE_COMMAND, + DNF_INSTALLED_CVES_COMMAND, DNF_SECURITY_COMMAND, parse_apt_upgradable, + parse_dnf_installed_cves, parse_dnf_security, ) from napalm_device_types.packages import PackageManagementMixin @@ -432,8 +434,10 @@ __all__ = [ "OSDriver", "PackageManagementMixin", "APT_UPGRADABLE_COMMAND", + "DNF_INSTALLED_CVES_COMMAND", "DNF_SECURITY_COMMAND", "parse_apt_upgradable", + "parse_dnf_installed_cves", "parse_dnf_security", "parse_host_status", "strip_terminal_codes", diff --git a/napalm_device_types/package_updates.py b/napalm_device_types/package_updates.py index 2d1b69f..60856f2 100644 --- a/napalm_device_types/package_updates.py +++ b/napalm_device_types/package_updates.py @@ -36,11 +36,24 @@ DNF_SECURITY_COMMAND = ( " echo __DNF_RC=$?; } | cat" ) +#: Read-only. Every advisory whose fix the installed packages carry, one line per +#: CVE it names (``CVE SEVERITY/Sec. NEVRA``): the distribution's own word that a +#: backport is in, where netOrk's knowledge base holds no records of the release +#: (netOrk #2394). dnf 4 only: dnf 5 reads ``--with-cve`` as a filter, and +#: Fedora's advisories reference bugs rather than CVEs. From the cache, as +#: :data:`DNF_SECURITY_COMMAND` reads it; the output is long (90 000 lines on an +#: Oracle Linux 9 host), so a caller reads it seldom. +DNF_INSTALLED_CVES_COMMAND = ( + "{ LC_ALL=C dnf --cacheonly updateinfo list --installed --with-cve --quiet 2>/dev/null;" + " echo __DNF_RC=$?; } | cat" +) + # openssl/noble-updates,noble-security 3.0.13-0ubuntu3.6 amd64 [upgradable from: 3.0.13-0ubuntu3.5] _APT_LINE = re.compile(r"^(\S+)/(\S+)\s+(\S+)\s+\S+\s+\[upgradable from:\s+(\S+)\]") _SECURITY_SUITE = "-security" _APT_STATUS = re.compile(r"^__APT_RC=(\d+)\s*$", re.MULTILINE) _DNF_STATUS = re.compile(r"^__DNF_RC=(\d+)\s*$", re.MULTILINE) +_CVE_ID = re.compile(r"^CVE-\d{4}-\d{4,}$") def _joined_lines(output: str) -> list[str]: @@ -118,3 +131,21 @@ def parse_dnf_security(output: str) -> set[str]: if len(parts) >= 3 and parts[1].endswith("/Sec."): names.add(nevra_name(parts[-1])) return names + + +def parse_dnf_installed_cves(output: str) -> dict[str, list[str]]: + """The CVEs the installed advisories close, per package name, each once and sorted. + + Parses :data:`DNF_INSTALLED_CVES_COMMAND`'s ``CVE SEVERITY/Sec. NEVRA`` lines; + a line that names no CVE (a key prompt, an advisory id) is no statement. + + :raises ValueError: when dnf failed or its exit status never arrived -- "could + not read" must not look like "no advisory installed". + """ + by_name: dict[str, set[str]] = {} + listing = _listing(output, _DNF_STATUS, "dnf updateinfo list --installed --with-cve") + for line in listing.splitlines(): + parts = line.split() + if len(parts) >= 3 and _CVE_ID.match(parts[0]): + by_name.setdefault(nevra_name(parts[-1]), set()).add(parts[0]) + return {name: sorted(cves) for name, cves in by_name.items()} diff --git a/napalm_device_types/updates.py b/napalm_device_types/updates.py index 7660181..1d5d44e 100644 --- a/napalm_device_types/updates.py +++ b/napalm_device_types/updates.py @@ -50,6 +50,28 @@ class UpdateMixin: """ ... + def get_installed_advisory_cves(self) -> dict[str, list[str]]: + """ + The CVEs the host's installed security advisories close, per package + name: the distribution's own word that a fix is in the installed build, + although its upstream version did not move (a backport). + + netOrk asks for it only where its knowledge base holds no records of + the host's release (netOrk #2394), since the answer can be long. A + package manager whose advisories name no CVEs has nothing to say here. + + **An empty dict means no installed advisory names a CVE.** A reader + that cannot read raises, as :meth:`get_available_updates` does. + ``NotImplementedError`` where the host's package manager keeps no such + advisories (:data:`~napalm_device_types.package_updates.DNF_INSTALLED_CVES_COMMAND` + is dnf 4's). + + Example:: + + {"glibc-common": ["CVE-2023-4911"], "curl": ["CVE-2023-38545"]} + """ + ... + def refresh_available_updates(self) -> dict[str, Any]: """ Refreshes the host's package index, so that :meth:`get_available_updates` diff --git a/pyproject.toml b/pyproject.toml index 9ebfb5e..128ac8b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "napalm-device-types" -version = "4.36.2" +version = "4.37.0" description = "Abstract device-type base classes for NAPALM drivers" readme = "README.md" requires-python = ">=3.12" diff --git a/tests/test_package_updates.py b/tests/test_package_updates.py index b12a796..7730f09 100644 --- a/tests/test_package_updates.py +++ b/tests/test_package_updates.py @@ -18,9 +18,11 @@ import pytest from napalm_device_types.package_updates import ( APT_UPGRADABLE_COMMAND, + DNF_INSTALLED_CVES_COMMAND, DNF_SECURITY_COMMAND, nevra_name, parse_apt_upgradable, + parse_dnf_installed_cves, parse_dnf_security, ) @@ -198,3 +200,75 @@ __DNF_RC=0 ) def test_the_name_of_a_nevra(self, nevra, name): assert nevra_name(nevra) == name + + +class TestDnfInstalledCves: + """The CVEs the host's installed advisories close, per package (netOrk #2394). + + Where netOrk's knowledge base holds no records of a release, the host's own + advisories are the distribution's word that a backport is in. Lines from real + hosts: Oracle Linux 9.8 (dnf 4.14, aarch64) and Amazon Linux 2023 (dnf 4.14). + """ + + ORACLE = """\ +CVE-2024-6501 Low/Sec. NetworkManager-1:1.48.10-2.0.1.el9_5.aarch64 +CVE-2024-3661 Moderate/Sec. NetworkManager-1:1.48.10-5.0.1.el9_5.aarch64 +CVE-2023-38545 Important/Sec. curl-7.76.1-23.el9_2.4.aarch64 +CVE-2023-38545 Important/Sec. curl-7.76.1-26.el9_3.2.aarch64 +CVE-2023-4911 Important/Sec. glibc-common-2.34-60.0.3.el9.aarch64 +CVE-2023-4911 Important/Sec. glibc-common-2.34-60.0.3.el9_2.7.aarch64 +__DNF_RC=0 +""" + + AMAZON = """\ +CVE-2022-3715 Medium/Sec. bash-5.2.15-1.amzn2023.0.2.x86_64 +CVE-2022-23491 Important/Sec. ca-certificates-2021.2.50-1.0.amzn2023.0.6.noarch +CVE-2023-32803 Important/Sec. ca-certificates-2023.2.60-1.0.amzn2023.0.2.noarch +__DNF_RC=0 +""" + + def test_cves_per_package_once_each_and_sorted(self): + assert parse_dnf_installed_cves(self.ORACLE) == { + "NetworkManager": ["CVE-2024-3661", "CVE-2024-6501"], + "curl": ["CVE-2023-38545"], + "glibc-common": ["CVE-2023-4911"], + } + + def test_amazon_linux(self): + assert parse_dnf_installed_cves(self.AMAZON) == { + "bash": ["CVE-2022-3715"], + "ca-certificates": ["CVE-2022-23491", "CVE-2023-32803"], + } + + def test_lines_that_name_no_cve_are_left_out(self): + """A GPG prompt a repository without its key prints, an advisory id.""" + out = ( + "Importing GPG key 0x6E93CD0C:\n" + ' Userid : "https://packagecloud.io/crowdsec/crowdsec"\n' + "ELSA-2023-5453 Important/Sec. glibc-2.34-60.0.3.el9_2.7.aarch64\n" + "__DNF_RC=0\n" + ) + assert parse_dnf_installed_cves(out) == {} + + def test_a_failed_dnf_raises_instead_of_reading_as_no_advisories(self): + with pytest.raises(ValueError, match="exit status 1"): + parse_dnf_installed_cves("__DNF_RC=1\n") + + def test_output_cut_short_raises(self): + with pytest.raises(ValueError, match="no exit status"): + parse_dnf_installed_cves(self.ORACLE.replace("__DNF_RC=0\n", "")) + + def test_the_command_lists_installed_advisories_with_their_cves_from_the_cache(self, tmp_path): + args = tmp_path / "args" + dnf = tmp_path / "dnf" + dnf.write_text(f"#!/bin/sh\nprintf '%s\\n' \"$@\" > {args}\n") + dnf.chmod(0o755) + env = {"PATH": f"{tmp_path}:{os.environ.get('PATH', '/usr/bin:/bin')}"} + out = subprocess.run( + ["sh", "-c", DNF_INSTALLED_CVES_COMMAND], capture_output=True, text=True, env=env + ).stdout + + assert {"--cacheonly", "updateinfo", "list", "--installed", "--with-cve"} <= set( + args.read_text().split() + ) + assert out == "__DNF_RC=0\n"