Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor generic parser #9922

Merged
merged 5 commits into from
May 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions dojo/tools/generic/csv_parser.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
import csv
import hashlib
import io

from cvss import parser as cvss_parser
from dateutil.parser import parse

from dojo.models import Endpoint, Finding


class GenericCSVParser:
ID = "Generic Findings Import"

def _get_findings_csv(self, filename):
content = filename.read()
if isinstance(content, bytes):
content = content.decode("utf-8")
reader = csv.DictReader(
io.StringIO(content), delimiter=",", quotechar='"'
)

dupes = {}
for row in reader:
finding = Finding(
title=row["Title"],
description=row["Description"],
date=parse(row["Date"]).date(),
severity=self.get_severity(row["Severity"]),
duplicate=self._convert_bool(
row.get("Duplicate", "FALSE")
), # bool False by default
nb_occurences=1,
)
# manage active
if "Active" in row:
finding.active = self._convert_bool(row.get("Active"))
# manage mitigation
if "Mitigation" in row:
finding.mitigation = row["Mitigation"]
# manage impact
if "Impact" in row:
finding.impact = row["Impact"]
# manage impact
if "References" in row:
finding.references = row["References"]
# manage verified
if "Verified" in row:
finding.verified = self._convert_bool(row.get("Verified"))
# manage false positives
if "FalsePositive" in row:
finding.false_p = self._convert_bool(row.get("FalsePositive"))
# manage CVE
if "CVE" in row and [row["CVE"]]:
finding.unsaved_vulnerability_ids = [row["CVE"]]
# manage Vulnerability Id
if "Vulnerability Id" in row and row["Vulnerability Id"]:
if finding.unsaved_vulnerability_ids:
finding.unsaved_vulnerability_ids.append(
row["Vulnerability Id"]
)
else:
finding.unsaved_vulnerability_ids = [
row["Vulnerability Id"]
]
# manage CWE
if "CweId" in row:
finding.cwe = int(row["CweId"])

if "CVSSV3" in row:
cvss_objects = cvss_parser.parse_cvss_from_text(row["CVSSV3"])
if len(cvss_objects) > 0:
finding.cvssv3 = cvss_objects[0].clean_vector()

# manage endpoints
if "Url" in row:
finding.unsaved_endpoints = [
Endpoint.from_uri(row["Url"])
if "://" in row["Url"]
else Endpoint.from_uri("//" + row["Url"])
]

# manage internal de-duplication
key = hashlib.sha256(
f"{finding.severity}|{finding.title}|{finding.description}".encode()
).hexdigest()
if key in dupes:
find = dupes[key]
find.unsaved_endpoints.extend(finding.unsaved_endpoints)
if find.unsaved_vulnerability_ids:
find.unsaved_vulnerability_ids.extend(
finding.unsaved_vulnerability_ids
)
else:
find.unsaved_vulnerability_ids = (
finding.unsaved_vulnerability_ids
)
find.nb_occurences += 1
else:
dupes[key] = finding
return list(dupes.values())

def _convert_bool(self, val):
return val.lower()[0:1] == "t" # bool False by default

def get_severity(self, input):
if input in ["Info", "Low", "Medium", "High", "Critical"]:
return input
else:
return "Info"
119 changes: 119 additions & 0 deletions dojo/tools/generic/json_parser.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
from dojo.models import Endpoint, Finding
from dojo.tools.parser_test import ParserTest


class GenericJSONParser:
ID = "Generic Findings Import"

def _get_test_json(self, data):
test_internal = ParserTest(
name=data.get("name", self.ID),
type=data.get("type", self.ID),
version=data.get("version"),
)
test_internal.findings = []
for item in data.get("findings", []):
# remove endpoints of the dictionnary
unsaved_endpoints = None
if "endpoints" in item:
unsaved_endpoints = item["endpoints"]
del item["endpoints"]
# remove files of the dictionnary
unsaved_files = None
if "files" in item:
unsaved_files = item["files"]
del item["files"]
# remove vulnerability_ids of the dictionnary
unsaved_vulnerability_ids = None
if "vulnerability_ids" in item:
unsaved_vulnerability_ids = item["vulnerability_ids"]
del item["vulnerability_ids"]

# check for required keys
required = {"title", "severity", "description"}
missing = sorted(required.difference(item))
if missing:
msg = f"Required fields are missing: {missing}"
raise ValueError(msg)

# check for allowed keys
allowed = {
"date",
"cwe",
"cve",
"cvssv3",
"cvssv3_score",
"mitigation",
"impact",
"steps_to_reproduce",
"severity_justification",
"references",
"active",
"verified",
"false_p",
"out_of_scope",
"risk_accepted",
"under_review",
"is_mitigated",
"thread_id",
"mitigated",
"numerical_severity",
"param",
"payload",
"line",
"file_path",
"component_name",
"component_version",
"static_finding",
"dynamic_finding",
"scanner_confidence",
"unique_id_from_tool",
"vuln_id_from_tool",
"sast_source_object",
"sast_sink_object",
"sast_source_line",
"sast_source_file_path",
"nb_occurences",
"publish_date",
"service",
"planned_remediation_date",
"planned_remediation_version",
"effort_for_fixing",
"tags",
}.union(required)
not_allowed = sorted(set(item).difference(allowed))
if not_allowed:
msg = f"Not allowed fields are present: {not_allowed}"
raise ValueError(msg)
finding = Finding(**item)

# manage endpoints
if unsaved_endpoints:
finding.unsaved_endpoints = []
for endpoint_item in unsaved_endpoints:
if isinstance(endpoint_item, str):
if "://" in endpoint_item: # is the host full uri?
endpoint = Endpoint.from_uri(endpoint_item)
# can raise exception if the host is not valid URL
else:
endpoint = Endpoint.from_uri("//" + endpoint_item)
# can raise exception if there is no way to parse
# the host
else:
endpoint = Endpoint(**endpoint_item)
finding.unsaved_endpoints.append(endpoint)
if unsaved_files:
finding.unsaved_files = unsaved_files
if finding.cve:
finding.unsaved_vulnerability_ids = [finding.cve]
if unsaved_vulnerability_ids:
if finding.unsaved_vulnerability_ids:
finding.unsaved_vulnerability_ids.append(
unsaved_vulnerability_ids
)
else:
finding.unsaved_vulnerability_ids = (
unsaved_vulnerability_ids
)
test_internal.findings.append(finding)
return test_internal
Loading
Loading