[Refactor] Rename vuln_references to references

docs/how-to-guides/add_new_importer.rst

@@ -36,7 +36,7 @@ The Building Blocks A.K.A Prerequisites
         summary: str
         impacted_package_urls: Iterable[PackageURL]
         resolved_package_urls: Iterable[PackageURL] = dataclasses.field(default_factory=list)
-        vuln_references: List[Reference] = dataclasses.field(default_factory=list)
+        references: List[Reference] = dataclasses.field(default_factory=list)
         vulnerability_id: Optional[str] = None
 
     class Reference:

vulnerabilities/data_source.py

@@ -86,23 +86,23 @@ class Advisory:
     vulnerability_id: Optional[str] = None
     impacted_package_urls: Iterable[PackageURL] = dataclasses.field(default_factory=list)
     resolved_package_urls: Iterable[PackageURL] = dataclasses.field(default_factory=list)
-    vuln_references: List[Reference] = dataclasses.field(default_factory=list)
+    references: List[Reference] = dataclasses.field(default_factory=list)
 
     def normalized(self):
         impacted_package_urls = {package_url for package_url in self.impacted_package_urls}
         resolved_package_urls = {package_url for package_url in self.resolved_package_urls}
-        vuln_references = sorted(
-            self.vuln_references, key=lambda reference: (reference.reference_id, reference.url)
+        references = sorted(
+            self.references, key=lambda reference: (reference.reference_id, reference.url)
         )
-        for index, _ in enumerate(self.vuln_references):
-            vuln_references[index] = vuln_references[index].normalized()
+        for index, _ in enumerate(self.references):
+            references[index] = references[index].normalized()
 
         return Advisory(
             summary=self.summary,
             vulnerability_id=self.vulnerability_id,
             impacted_package_urls=impacted_package_urls,
             resolved_package_urls=resolved_package_urls,
-            vuln_references=vuln_references,
+            references=references,
         )
 
 
@@ -566,7 +566,7 @@ def get_data_from_xml_doc(self, xml_doc: ET.ElementTree, pkg_metadata={}) -> Lis
                     impacted_package_urls=affected_purls,
                     resolved_package_urls=safe_purls,
                     vulnerability_id=vuln_id,
-                    vuln_references=references,
+                    references=references,
                 )
             )
         return all_adv

vulnerabilities/import_runner.py

@@ -123,7 +123,7 @@ def process_advisories(data_source: DataSource) -> None:
         for advisory in batch:
             try:
                 vuln, vuln_created = _get_or_create_vulnerability(advisory)
-                for vuln_ref in advisory.vuln_references:
+                for vuln_ref in advisory.references:
                     ref, _ = models.VulnerabilityReference.objects.get_or_create(
                         vulnerability=vuln, reference_id=vuln_ref.reference_id, url=vuln_ref.url
                     )

vulnerabilities/importers/alpine_linux.py

@@ -192,7 +192,7 @@ def _load_advisories(
                         summary="",
                         impacted_package_urls=[],
                         resolved_package_urls=resolved_purls,
-                        vuln_references=references,
+                        references=references,
                         vulnerability_id=vuln_ids[0] if vuln_ids[0] != "CVE-????-?????" else "",
                     )
                 )

vulnerabilities/importers/apache_kafka.py

@@ -86,7 +86,7 @@ def to_advisory(self, advisory_page):
                     summary=cve_description_paragraph.text,
                     impacted_package_urls=affected_packages,
                     resolved_package_urls=fixed_packages,
-                    vuln_references=[
+                    references=[
                         Reference(url=ASF_PAGE_URL),
                         Reference(
                             url=f"https://cve.mitre.org/cgi-bin/cvename.cgi?name={cve_id}",

vulnerabilities/importers/apache_tomcat.py

@@ -117,7 +117,7 @@ def to_advisories(self, apache_tomcat_advisory_html):
                         impacted_package_urls=affected_packages,
                         resolved_package_urls=fixed_package,
                         vulnerability_id=cve_id,
-                        vuln_references=references,
+                        references=references,
                     )
                 )
 

vulnerabilities/importers/archlinux.py

@@ -108,8 +108,8 @@ def _parse(self, record) -> List[Advisory]:
                         )
                     )
 
-            vuln_references = []
-            vuln_references.append(
+            references = []
+            references.append(
                 Reference(
                     reference_id=record["name"],
                     url="https://security.archlinux.org/{}".format(record["name"]),
@@ -122,7 +122,7 @@ def _parse(self, record) -> List[Advisory]:
             )
 
             for ref in record["advisories"]:
-                vuln_references.append(
+                references.append(
                     Reference(
                         reference_id=ref,
                         url="https://security.archlinux.org/{}".format(ref),
@@ -135,7 +135,7 @@ def _parse(self, record) -> List[Advisory]:
                     summary="",
                     impacted_package_urls=impacted_purls,
                     resolved_package_urls=resolved_purls,
-                    vuln_references=vuln_references,
+                    references=references,
                 )
             )
 

vulnerabilities/importers/debian.py

@@ -155,7 +155,7 @@ def _parse(self, pkg_name: str, records: Mapping[str, Any]) -> List[Advisory]:
                     summary=record.get("description", ""),
                     impacted_package_urls=impacted_purls,
                     resolved_package_urls=resolved_purls,
-                    vuln_references=references,
+                    references=references,
                 )
             )
 

vulnerabilities/importers/elixir_security.py

@@ -126,7 +126,7 @@ def process_file(self, path):
             PackageURL(name=pkg_name, type="hex", version=version) for version in vuln_pkg_versions
         }
 
-        vuln_references = [
+        references = [
             Reference(
                 reference_id=yaml_file["id"],
             ),
@@ -140,5 +140,5 @@ def process_file(self, path):
             impacted_package_urls=vuln_purls,
             resolved_package_urls=safe_purls,
             vulnerability_id=cve_id,
-            vuln_references=vuln_references,
+            references=references,
         )

vulnerabilities/importers/gentoo.py

@@ -81,7 +81,7 @@ def process_file(self, file):
                 summary=xml_data["description"],
                 impacted_package_urls=xml_data["affected_purls"],
                 resolved_package_urls=xml_data["unaffected_purls"],
-                vuln_references=vuln_reference,
+                references=vuln_reference,
             )
             advisory_list.append(advisory)
         return advisory_list

vulnerabilities/importers/github.py

@@ -216,7 +216,7 @@ def process_response(self) -> List[Advisory]:
                         unaffected_purls = set()
 
                     cve_ids = set()
-                    vuln_references = self.extract_references(adv["node"]["advisory"]["references"])
+                    references = self.extract_references(adv["node"]["advisory"]["references"])
                     vuln_desc = adv["node"]["advisory"]["summary"]
 
                     for identifier in adv["node"]["advisory"]["identifiers"]:
@@ -226,7 +226,7 @@ def process_response(self) -> List[Advisory]:
 
                         # attach the GHSA with severity score
                         if identifier["type"] == "GHSA":
-                            for ref in vuln_references:
+                            for ref in references:
                                 if ref.reference_id == identifier["value"]:
                                     ref.severities = [
                                         VulnerabilitySeverity(
@@ -245,7 +245,7 @@ def process_response(self) -> List[Advisory]:
                                 summary=vuln_desc,
                                 impacted_package_urls=affected_purls,
                                 resolved_package_urls=unaffected_purls,
-                                vuln_references=vuln_references,
+                                references=references,
                             )
                         )
         return adv_list

vulnerabilities/importers/kaybee.py

@@ -70,5 +70,5 @@ def yaml_file_to_advisory(yaml_path):
         summary=summary,
         impacted_package_urls=impacted_packages,
         resolved_package_urls=resolved_packages,
-        vuln_references=references,
+        references=references,
     )

vulnerabilities/importers/npm.py

@@ -109,7 +109,7 @@ def process_file(self, file) -> List[Advisory]:
                     vulnerability_id=cve_id,
                     impacted_package_urls=impacted_purls,
                     resolved_package_urls=resolved_purls,
-                    vuln_references=vuln_reference,
+                    references=vuln_reference,
                 )
             )
         return advisories

vulnerabilities/importers/nvd.py

@@ -91,7 +91,7 @@ def to_advisories(self, nvd_data):
             yield Advisory(
                 vulnerability_id=cve_id,
                 summary=summary,
-                vuln_references=references,
+                references=references,
                 impacted_package_urls=[],  # nopep8
             )
 

vulnerabilities/importers/openssl.py

@@ -115,7 +115,7 @@ def to_advisories(xml_response: str) -> Set[Advisory]:
                     summary=summary,
                     impacted_package_urls=vuln_purls,
                     resolved_package_urls=safe_purls,
-                    vuln_references=ref_urls,
+                    references=ref_urls,
                 )
                 advisories.append(advisory)
 

vulnerabilities/importers/postgresql.py

@@ -107,7 +107,7 @@ def to_advisories(data):
             Advisory(
                 vulnerability_id=cve_id,
                 summary=summary,
-                vuln_references=references,
+                references=references,
                 impacted_package_urls=affected_packages,
                 resolved_package_urls=fixed_packages,
             )

vulnerabilities/importers/project_kb_msr2019.py

@@ -81,7 +81,7 @@ def to_advisories(csv_reader):
                 Advisory(
                     summary="",
                     impacted_package_urls=[],
-                    vuln_references=[reference],
+                    references=[reference],
                     cve_id=vuln_id,
                 )
             )

vulnerabilities/importers/redhat.py

@@ -154,7 +154,7 @@ def to_advisory(advisory_data):
         vulnerability_id=advisory_data["CVE"],
         summary=advisory_data["bugzilla_description"],
         impacted_package_urls=affected_purls,
-        vuln_references=references,
+        references=references,
     )
 
 

vulnerabilities/importers/retiredotnet.py

@@ -98,5 +98,5 @@ def process_file(self, path) -> List[Advisory]:
                 impacted_package_urls=affected_purls,
                 resolved_package_urls=fixed_purls,
                 vulnerability_id=vuln_id,
-                vuln_references=vuln_reference,
+                references=vuln_reference,
             )

vulnerabilities/importers/ruby.py

@@ -129,7 +129,7 @@ def process_file(self, path) -> List[Advisory]:
             summary=record.get("description", ""),
             impacted_package_urls=impacted_purls,
             resolved_package_urls=resolved_purls,
-            vuln_references=references,
+            references=references,
             vulnerability_id=cve_id,
         )
 

vulnerabilities/importers/rust.py

@@ -136,7 +136,7 @@ def _load_advisory(self, path: str) -> Optional[Advisory]:
             impacted_package_urls=impacted_purls,
             resolved_package_urls=resolved_purls,
             vulnerability_id=cve_id,
-            vuln_references=references,
+            references=references,
         )
 
 

vulnerabilities/importers/safety_db.py

@@ -136,7 +136,7 @@ def updated_advisories(self) -> Set[Advisory]:
                         Advisory(
                             vulnerability_id=cve_id,
                             summary=advisory["advisory"],
-                            vuln_references=reference,
+                            references=reference,
                             impacted_package_urls=impacted_purls,
                             resolved_package_urls=resolved_purls,
                         )

vulnerabilities/importers/suse_scores.py

@@ -76,7 +76,7 @@ def to_advisory(score_data):
                     vulnerability_id=cve_id,
                     summary="",
                     impacted_package_urls=[],
-                    vuln_references=[Reference(url=URL, severities=severities)],
+                    references=[Reference(url=URL, severities=severities)],
                 )
             )
         return advisories

vulnerabilities/importers/ubuntu_usn.py

@@ -83,7 +83,7 @@ def to_advisories(usn_db):
                         impacted_package_urls=[],
                         resolved_package_urls=safe_purls,
                         summary="",
-                        vuln_references=[reference],
+                        references=[reference],
                     )
                 )
 

vulnerabilities/tests/test_alpine.py

@@ -56,7 +56,7 @@ def test__process_link(self):
                         subpath=None,
                     )
                 },
-                vuln_references=[],
+                references=[],
                 vulnerability_id="CVE-2019-14904",
             ),
             Advisory(
@@ -72,7 +72,7 @@ def test__process_link(self):
                         subpath=None,
                     )
                 },
-                vuln_references=[],
+                references=[],
                 vulnerability_id="CVE-2019-14905",
             ),
             Advisory(
@@ -88,7 +88,7 @@ def test__process_link(self):
                         subpath=None,
                     )
                 },
-                vuln_references=[],
+                references=[],
                 vulnerability_id="CVE-2019-14846",
             ),
             Advisory(
@@ -104,7 +104,7 @@ def test__process_link(self):
                         subpath=None,
                     )
                 },
-                vuln_references=[],
+                references=[],
                 vulnerability_id="CVE-2019-14856",
             ),
             Advisory(
@@ -120,7 +120,7 @@ def test__process_link(self):
                         subpath=None,
                     )
                 },
-                vuln_references=[],
+                references=[],
                 vulnerability_id="CVE-2019-14858",
             ),
             Advisory(
@@ -136,7 +136,7 @@ def test__process_link(self):
                         subpath=None,
                     )
                 },
-                vuln_references=[
+                references=[
                     Reference(
                         url="https://xenbits.xen.org/xsa/advisory-295.html", reference_id="XSA-295"
                     )

vulnerabilities/tests/test_apache_kafka.py

@@ -84,7 +84,7 @@ def test_to_advisory(self):
                         subpath=None,
                     )
                 ],
-                vuln_references=[
+                references=[
                     Reference(url="https://kafka.apache.org/cve-list", reference_id=""),
                     Reference(
                         url="https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-17196",

vulnerabilities/tests/test_apache_tomcat.py

@@ -78,7 +78,7 @@ def test_to_advisories(self):
                         subpath=None,
                     )
                 ],
-                vuln_references=[
+                references=[
                     Reference(
                         url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-0763",
                         reference_id="",
@@ -112,7 +112,7 @@ def test_to_advisories(self):
                         subpath=None,
                     )
                 ],
-                vuln_references=[
+                references=[
                     Reference(
                         url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2015-5351",
                         reference_id="",
@@ -158,7 +158,7 @@ def test_to_advisories(self):
                         subpath=None,
                     )
                 ],
-                vuln_references=[
+                references=[
                     Reference(
                         url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-0706",
                         reference_id="",
@@ -192,7 +192,7 @@ def test_to_advisories(self):
                         subpath=None,
                     )
                 ],
-                vuln_references=[
+                references=[
                     Reference(
                         url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-0714",
                         reference_id="",

vulnerabilities/tests/test_elixir_security.py

@@ -123,7 +123,7 @@ def test_process_file(self):
                     version="0.5.2",
                 ),
             },
-            vuln_references=[
+            references=[
                 Reference(
                     reference_id="2aae6e3a-24a3-4d5f-86ff-b964eaf7c6d1",
                 ),