|
| 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/nexB/vulnerablecode for support or download. |
| 7 | +# See https://aboutcode.org for more information about nexB OSS projects. |
| 8 | +# |
| 9 | + |
| 10 | +import logging |
| 11 | +from typing import Iterable |
| 12 | +from typing import List |
| 13 | + |
| 14 | +import requests |
| 15 | +from fetchcode.package_versions import versions |
| 16 | +from packageurl import PackageURL |
| 17 | +from univers.version_range import PypiVersionRange |
| 18 | +from univers.versions import PypiVersion |
| 19 | + |
| 20 | +from vulntotal.validator import DataSource |
| 21 | +from vulntotal.validator import InvalidCVEError |
| 22 | +from vulntotal.validator import VendorData |
| 23 | + |
| 24 | +logger = logging.getLogger(__name__) |
| 25 | + |
| 26 | + |
| 27 | +class SafetydbDataSource(DataSource): |
| 28 | + spdx_license_expression = "CC-BY-NC-4.0" |
| 29 | + license_url = "https://github.com/pyupio/safety-db/blob/master/LICENSE.txt" |
| 30 | + url = "https://raw.githubusercontent.com/pyupio/safety-db/master/data/insecure_full.json" |
| 31 | + |
| 32 | + def fetch_advisory(self): |
| 33 | + """ |
| 34 | + Fetch entire JSON advisory from pyupio repository |
| 35 | +
|
| 36 | + Parameters: |
| 37 | +
|
| 38 | + Returns: |
| 39 | + A JSON object containing the advisory information for insecure packages, or None if an error occurs while fetching data from safetydb repo's URL. |
| 40 | + """ |
| 41 | + |
| 42 | + response = requests.get(self.url) |
| 43 | + try: |
| 44 | + response.raise_for_status() |
| 45 | + except requests.exceptions.HTTPError as e: |
| 46 | + logger.error(f"Error while fetching safetydb advisories: {e}") |
| 47 | + return |
| 48 | + |
| 49 | + return response.json() |
| 50 | + |
| 51 | + def datasource_advisory(self, purl) -> Iterable[VendorData]: |
| 52 | + if purl.type != "pypi": |
| 53 | + return [] |
| 54 | + advisory = self.fetch_advisory() |
| 55 | + self._raw_dump.append(advisory) |
| 56 | + self._versions = sorted([PypiVersion(ver.value) for ver in versions(str(purl))]) |
| 57 | + return parse_advisory(advisory, purl, self._versions) |
| 58 | + |
| 59 | + def datasource_advisory_from_cve(self, cve: str) -> Iterable[VendorData]: |
| 60 | + if not cve.upper().startswith("CVE-"): |
| 61 | + raise InvalidCVEError |
| 62 | + advisory = self.fetch_advisory() |
| 63 | + self._raw_dump.append(advisory) |
| 64 | + return parse_advisory_for_cve(advisory, cve) |
| 65 | + |
| 66 | + @classmethod |
| 67 | + def supported_ecosystem(cls): |
| 68 | + # source - @TODO |
| 69 | + return {"pypi": "PyPI"} |
| 70 | + |
| 71 | + |
| 72 | +def parse_advisory( |
| 73 | + response, purl: PackageURL, all_versions: List[PypiVersion] |
| 74 | +) -> Iterable[VendorData]: |
| 75 | + """ |
| 76 | + Parse response from safetydb API and yield VendorData |
| 77 | +
|
| 78 | + Parameters: |
| 79 | + response: A JSON object containing the response data from the safetydb datasource. |
| 80 | +
|
| 81 | + Yields: |
| 82 | + VendorData instance containing the advisory information for the package. |
| 83 | + """ |
| 84 | + |
| 85 | + for advisory in response.get(purl.name): |
| 86 | + vulnerable_version_range_string = "vers:pypi/" + advisory.get("v").replace(",", "|") |
| 87 | + vulnerable_version_range = PypiVersionRange.from_string(vulnerable_version_range_string) |
| 88 | + |
| 89 | + yield VendorData( |
| 90 | + purl=PackageURL(purl.type, purl.namespace, purl.name), |
| 91 | + aliases=[advisory.get("cve"), advisory.get("id")], |
| 92 | + affected_versions=sorted(advisory.get("specs")), |
| 93 | + fixed_versions=get_patched_versions(all_versions, vulnerable_version_range), |
| 94 | + ) |
| 95 | + |
| 96 | + |
| 97 | +def parse_advisory_for_cve(response, cve: str) -> Iterable[VendorData]: |
| 98 | + """ |
| 99 | + Parse response from safetydb API and yield VendorData with specified CVE |
| 100 | +
|
| 101 | + Parameters: |
| 102 | + response: A JSON object containing the response data from the safetydb datasource. |
| 103 | +
|
| 104 | + Yields: |
| 105 | + VendorData instance containing the advisory information for the package. |
| 106 | + """ |
| 107 | + |
| 108 | + for package, advisories in response.items(): |
| 109 | + if package == "$meta": |
| 110 | + continue |
| 111 | + |
| 112 | + all_versions = sorted( |
| 113 | + [PypiVersion(ver.value) for ver in versions(str(PackageURL(type="pypi", name=package)))] |
| 114 | + ) |
| 115 | + |
| 116 | + for advisory in advisories: |
| 117 | + if advisory.get("cve") == cve: |
| 118 | + vulnerable_version_range_string = "vers:pypi/" + advisory.get("v").replace(",", "|") |
| 119 | + vulnerable_version_range = PypiVersionRange.from_string( |
| 120 | + vulnerable_version_range_string |
| 121 | + ) |
| 122 | + |
| 123 | + yield VendorData( |
| 124 | + purl=PackageURL(type="pypi", name=package), |
| 125 | + aliases=[advisory.get("cve"), advisory.get("id")], |
| 126 | + affected_versions=sorted(advisory.get("specs")), |
| 127 | + fixed_versions=get_patched_versions(all_versions, vulnerable_version_range), |
| 128 | + ) |
| 129 | + |
| 130 | + |
| 131 | +def get_patched_versions( |
| 132 | + all_versions: List[PypiVersion], |
| 133 | + vulnerable_version_range: PypiVersionRange, |
| 134 | +): |
| 135 | + """ |
| 136 | + Get the first patched version from the list of all versions of a package |
| 137 | +
|
| 138 | + Parameters: |
| 139 | + all_versions: A list containing PackageVersion of a package |
| 140 | + vulnerable_version_range: A PypiVersionRange object specifying the vulnerable version range |
| 141 | +
|
| 142 | + Returns: |
| 143 | + A PackageVersion object containing the first patched version of the package |
| 144 | + """ |
| 145 | + |
| 146 | + # last_patched = None |
| 147 | + # for version in reversed(all_versions): |
| 148 | + # if version in vulnerable_version_range: |
| 149 | + # if last_patched is not None: |
| 150 | + # return [str(last_patched.value)] |
| 151 | + # return [] |
| 152 | + # last_patched = version |
| 153 | + # return [] |
| 154 | + |
| 155 | + patched_version_ranges: List[str] = [] |
| 156 | + current_patched_range_start: PypiVersion = None |
| 157 | + current_patched_range_latest: PypiVersion = None |
| 158 | + |
| 159 | + def resolve_patched_range(): |
| 160 | + if current_patched_range_start is not None: |
| 161 | + if current_patched_range_latest == current_patched_range_start: |
| 162 | + patched_version_ranges.append(str(current_patched_range_start.value)) |
| 163 | + else: |
| 164 | + patched_version_ranges.append( |
| 165 | + f">={current_patched_range_start.value},<={current_patched_range_latest.value}" |
| 166 | + ) |
| 167 | + |
| 168 | + for version in all_versions: |
| 169 | + if version in vulnerable_version_range: |
| 170 | + resolve_patched_range() |
| 171 | + current_patched_range_start = None |
| 172 | + current_patched_range_latest = None |
| 173 | + else: |
| 174 | + if current_patched_range_start is None: |
| 175 | + current_patched_range_start = version |
| 176 | + current_patched_range_latest = version |
| 177 | + resolve_patched_range() |
| 178 | + |
| 179 | + # Remove upper bound from the last fixed range |
| 180 | + if len(patched_version_ranges) > 0: |
| 181 | + patched_version_ranges[-1] = patched_version_ranges[-1].split(",")[0] |
| 182 | + |
| 183 | + # Ensure that >= is only present if there are fragmented fixed ranges |
| 184 | + # eg. For vulnerable spec "<2.2.5 >=2.3.0 <2.3.2",,fixed range => "2.2.5, >=2.3.2" |
| 185 | + # eg. For vulnerable spec "<2.2.5", fixed range => "2.2.5 |
| 186 | + if len(patched_version_ranges) == 1: |
| 187 | + patched_version_ranges[-1] = patched_version_ranges[-1][2:] |
| 188 | + |
| 189 | + return patched_version_ranges |
0 commit comments