# (c) 2017, XYSec Labs
from collections import namedtuple
from dataclasses import dataclass
import datetime
import typing
[docs]def mapper_json_api(model: type, resource: dict) -> object:
"""
Returns an obj of type `model` from dictified JSON `resource` for JSON APIs
"""
attr = dict()
for field in model._fields:
if field == "id":
attr[field] = resource["data"]["id"]
else:
attr[field] = resource["data"]["attributes"][field.replace("_", "-")]
return model(**attr)
[docs]def mapper_drf_api(model: type, resource: dict) -> object:
"""
Returns an obj of type `model` from dictified JSON `resource` for DRF APIs
"""
accepted_params = {k: resource[k] for k in model._fields}
return model(**accepted_params)
User = namedtuple(
"User", ["id", "email", "first_name", "lang", "last_name", "username"]
)
Whoami = namedtuple("Whoami", ["id", "email", "username", "default_organization"])
Organization = namedtuple("Organization", ["id", "name"])
Project = namedtuple(
"Project",
["id", "created_on", "file_count", "package_name", "platform", "updated_on"],
)
File = namedtuple(
"File", ["id", "name", "version", "version_code", "static_scan_progress", "profile"]
)
Submission = namedtuple(
"Submission", ["id", "status", "file", "package_name", "created_on", "reason"]
)
Analysis = namedtuple(
"Analysis",
[
"id",
"risk",
"status",
"cvss_base",
"cvss_vector",
"cvss_version",
"cvss_metrics_humanized",
"findings",
"updated_on",
"vulnerability",
"owasp",
"pcidss",
"hipaa",
"cwe",
"mstg",
"masvs",
"asvs",
"gdpr",
"computed_risk",
"overridden_risk",
],
)
Vulnerability = namedtuple(
"Vulnerability",
[
"id",
"name",
"description",
"intro",
"related_to",
"business_implication",
"compliant",
"non_compliant",
"types",
],
)
OWASP = namedtuple("OWASP", ["id", "code", "title", "description", "year"])
PCIDSS = namedtuple("PCIDSS", ["id", "code", "title", "description"])
PersonalToken = namedtuple("AccessToken", ["name", "key"])
ReportPreferenceMapper = {
"show_pcidss": "pcidss",
"show_hipaa": "hipaa",
"show_gdpr": "gdpr",
}
[docs]@dataclass
class ProfileReportPreferenceConfig:
value: bool
[docs]@dataclass
class ProfileReportPreference:
show_gdpr: ProfileReportPreferenceConfig
show_hipaa: ProfileReportPreferenceConfig
show_pcidss: ProfileReportPreferenceConfig
@classmethod
def from_json(cls, data):
return cls(
show_gdpr=ProfileReportPreferenceConfig(value=data["show_gdpr"]["value"]),
show_hipaa=ProfileReportPreferenceConfig(value=data["show_hipaa"]["value"]),
show_pcidss=ProfileReportPreferenceConfig(
value=data["show_pcidss"]["value"]
),
)
[docs]@dataclass
class InheritedPreference:
_fields = ["value", "is_inherited"]
value: bool
is_inherited: bool
@classmethod
def from_json(cls, data: typing.Dict[str, bool]) -> "InheritedPreference":
return cls(value=data["value"], is_inherited=data["is_inherited"])
[docs]@dataclass
class ReportPreference:
_fields = [
"show_api_scan",
"show_manual_scan",
"show_static_scan",
"show_dynamic_scan",
"show_ignored_analyses",
"show_hipaa",
"show_pcidss",
]
show_api_scan: bool
show_manual_scan: bool
show_static_scan: bool
show_dynamic_scan: bool
show_ignored_analyses: bool
show_hipaa: InheritedPreference
show_pcidss: InheritedPreference
@classmethod
def from_json(cls, data: typing.Dict[str, typing.Any]) -> "ReportPreference":
return cls(
show_api_scan=data["show_api_scan"],
show_manual_scan=data["show_manual_scan"],
show_static_scan=data["show_static_scan"],
show_dynamic_scan=data["show_dynamic_scan"],
show_ignored_analyses=data["show_ignored_analyses"],
show_hipaa=InheritedPreference.from_json(data["show_hipaa"]),
show_pcidss=InheritedPreference.from_json(data["show_pcidss"]),
)
[docs]@dataclass
class Report:
_fields = [
"id",
"language",
"generated_on",
"progress",
"rating",
"preferences",
]
id: int
language: str
generated_on: datetime.datetime
progress: int
rating: str
preferences: ReportPreference
@classmethod
def from_json(cls, data: typing.Dict[str, typing.Any]) -> "Report":
return cls(
id=data["id"],
language=data["language"],
generated_on=data["generated_on"],
progress=data["progress"],
rating=data["rating"],
preferences=ReportPreference.from_json(data["preferences"]),
)
