|
| 1 | +# |
| 2 | +# Copyright (c) nexB Inc. and others. All rights reserved. |
| 3 | +# VulnerableCode is a trademark of nexB Inc. |
| 4 | +# SPDX-License-Identifier: Apache-2.0 |
| 5 | +# See http://www.apache.org/licenses/LICENSE-2.0 for the license text. |
| 6 | +# See https://github.com/aboutcode-org/vulnerablecode for support or download. |
| 7 | +# See https://aboutcode.org for more information about nexB OSS projects. |
| 8 | +# |
| 9 | + |
| 10 | +import json |
| 11 | +import re |
| 12 | +from typing import Iterable |
| 13 | + |
| 14 | +from packageurl import PackageURL |
| 15 | +from univers.version_range import RANGE_CLASS_BY_SCHEMES |
| 16 | + |
| 17 | +from vulnerabilities.importer import AdvisoryDataV2 |
| 18 | +from vulnerabilities.importer import AffectedPackageV2 |
| 19 | +from vulnerabilities.importer import VulnerabilitySeverity |
| 20 | +from vulnerabilities.pipelines import VulnerableCodeBaseImporterPipelineV2 |
| 21 | +from vulnerabilities.severity_systems import CVSSV3 |
| 22 | +from vulnerabilities.utils import fetch_response |
| 23 | + |
| 24 | +PHOTON_URLS = [ |
| 25 | + "https://packages.vmware.com/photon/photon_cve_metadata/cve_data_photon1.0.json", |
| 26 | + "https://packages.vmware.com/photon/photon_cve_metadata/cve_data_photon2.0.json", |
| 27 | + "https://packages.vmware.com/photon/photon_cve_metadata/cve_data_photon3.0.json", |
| 28 | + "https://packages.vmware.com/photon/photon_cve_metadata/cve_data_photon4.0.json", |
| 29 | + "https://packages.vmware.com/photon/photon_cve_metadata/cve_data_photon5.0.json", |
| 30 | +] |
| 31 | + |
| 32 | + |
| 33 | +class VmwarePhotonImporterPipeline(VulnerableCodeBaseImporterPipelineV2): |
| 34 | + """Collect advisories from Vmware Photon Advisory. |
| 35 | +
|
| 36 | + Example of advisory |
| 37 | + { |
| 38 | + "cve_id": "CVE-2020-11979", |
| 39 | + "pkg": "apache-ant", |
| 40 | + "cve_score": 7.5, |
| 41 | + "aff_ver": "all versions before 1.10.8-2.ph1 are vulnerable", |
| 42 | + "res_ver": "1.10.8-2.ph1" |
| 43 | + } |
| 44 | + """ |
| 45 | + |
| 46 | + pipeline_id = "vmware_photon_importer_v2" |
| 47 | + spdx_license_expression = "CC BY-SA 4.0" |
| 48 | + license_url = "https://creativecommons.org/licenses/by-sa/4.0" |
| 49 | + repo_url = "https://packages.vmware.com/photon/photon_cve_metadata" |
| 50 | + |
| 51 | + precedence = 100 |
| 52 | + |
| 53 | + @classmethod |
| 54 | + def steps(cls): |
| 55 | + return ( |
| 56 | + cls.fetch, |
| 57 | + cls.group_records_by_cve, |
| 58 | + cls.collect_and_store_advisories, |
| 59 | + ) |
| 60 | + |
| 61 | + def fetch(self): |
| 62 | + self.records = [] |
| 63 | + for url in PHOTON_URLS: |
| 64 | + self.log(f"Fetching `{url}`") |
| 65 | + response = fetch_response(url) |
| 66 | + if response: |
| 67 | + self.records.extend(response.json()) |
| 68 | + self.log(f"Fetched {len(self.records):,d} total records from {len(PHOTON_URLS)} sources") |
| 69 | + |
| 70 | + def group_records_by_cve(self): |
| 71 | + """ |
| 72 | + A particular CVE may have more than one record. This method groups records by CVE ID and filters "Not Affected" records. |
| 73 | + """ |
| 74 | + self.cve_to_records = {} |
| 75 | + skipped_non_affected = 0 |
| 76 | + |
| 77 | + for record in self.records: |
| 78 | + cve_id = record.get("cve_id") |
| 79 | + |
| 80 | + # Skip records that are marked as "Not Affected" |
| 81 | + if record.get("status") == "Not Affected": |
| 82 | + skipped_non_affected += 1 |
| 83 | + continue |
| 84 | + |
| 85 | + self.cve_to_records.setdefault(cve_id, []).append(record) |
| 86 | + |
| 87 | + self.log( |
| 88 | + f"Grouped {len(self.records):,d} records into {len(self.cve_to_records):,d} unique CVEs " |
| 89 | + f"(skipped {skipped_non_affected:,d} non-affected)" |
| 90 | + ) |
| 91 | + |
| 92 | + def advisories_count(self) -> int: |
| 93 | + return len(self.cve_to_records) |
| 94 | + |
| 95 | + def collect_advisories(self) -> Iterable[AdvisoryDataV2]: |
| 96 | + rpm_range_cls = RANGE_CLASS_BY_SCHEMES["rpm"] |
| 97 | + |
| 98 | + for cve_id, records in self.cve_to_records.items(): |
| 99 | + affected_packages = [] |
| 100 | + |
| 101 | + for record in records: |
| 102 | + pkg_name = record.get("pkg") |
| 103 | + aff_ver = record.get("aff_ver") |
| 104 | + res_ver = record.get("res_ver") |
| 105 | + |
| 106 | + # Example PURL Format: pkg:rpm/vmware/apache-ant?distro=photon |
| 107 | + purl = PackageURL( |
| 108 | + type="rpm", |
| 109 | + namespace="vmware", |
| 110 | + name=pkg_name, |
| 111 | + qualifiers={"distro": "photon"}, |
| 112 | + ) |
| 113 | + |
| 114 | + ver_match = re.match(r"all versions before (.+) are vulnerable", aff_ver) |
| 115 | + if ver_match: |
| 116 | + affected_version_range = rpm_range_cls.from_string( |
| 117 | + f"vers:{rpm_range_cls.scheme}/<{ver_match.group(1)}" |
| 118 | + ) |
| 119 | + |
| 120 | + fixed_version_range = rpm_range_cls.from_versions([res_ver]) |
| 121 | + |
| 122 | + affected_packages.append( |
| 123 | + AffectedPackageV2( |
| 124 | + package=purl, |
| 125 | + affected_version_range=affected_version_range, |
| 126 | + fixed_version_range=fixed_version_range, |
| 127 | + ) |
| 128 | + ) |
| 129 | + |
| 130 | + severities = [] |
| 131 | + cve_score = records[0].get("cve_score") |
| 132 | + severities.append( |
| 133 | + VulnerabilitySeverity( |
| 134 | + system=CVSSV3, |
| 135 | + value=str(cve_score), |
| 136 | + scoring_elements="", |
| 137 | + ) |
| 138 | + ) |
| 139 | + |
| 140 | + yield AdvisoryDataV2( |
| 141 | + advisory_id=cve_id, |
| 142 | + affected_packages=affected_packages, |
| 143 | + severities=severities, |
| 144 | + url=f"https://nvd.nist.gov/vuln/detail/{cve_id}", |
| 145 | + original_advisory_text=json.dumps(records, indent=2, ensure_ascii=False), |
| 146 | + ) |
0 commit comments