Components

avidtools.datamodels.components

Component data classes used in AVID report and vulnerability datamodels.

class LangValue(*, lang: str, value: str)

Bases: BaseModel

Generic class to store a string with its language specified.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Artifact(*, type: ArtifactTypeEnum, name: str)

Bases: BaseModel

Type and name of an affected artifact.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Detection(*, type: MethodEnum, name: str)

Bases: BaseModel

Method to detect a specific issue.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Affects(*, developer: List[str], deployer: List[str], artifacts: List[Artifact])

Bases: BaseModel

Information on Artifact(s) affected by this report.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Problemtype(*, classof: ClassEnum, type: TypeEnum | None = None, description: LangValue)

Bases: BaseModel

Description of the problem a report/vuln is concerned with.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Metric(*, name: str, detection_method: Detection, results: Dict)

Bases: BaseModel

Quantification of the issue in a specific report.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Reference(*, type: str | None = None, label: str, url: str)

Bases: BaseModel

Details for a reference of a report/vulnerability.

model_config = {'fields': {'type': {'exclude': True}}}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class AtlasTaxonomy(*, tactic: str | None = None, technique: str | None = None, description: str | None = None)

Bases: BaseModel

ATLAS taxonomy mappings representing attack procedure steps.

model_config = {'fields': {'description': {'exclude': True}, 'tactic': {'exclude': True}, 'technique': {'exclude': True}}}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class AvidTaxonomy(*, vuln_id: str | None = None, risk_domain: List[str], sep_view: List[SepEnum], lifecycle_view: List[LifecycleEnum], taxonomy_version: str)

Bases: BaseModel

AVID taxonomy mappings of a report/vulnerability.

model_config = {'fields': {'vuln_id': {'exclude': True}}}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CVSSScores(*, version: str, vectorString: str, baseScore: float, baseSeverity: str, attackVector: str | None = None, attackComplexity: str | None = None, privilegesRequired: str | None = None, userInteraction: str | None = None, scope: str | None = None, confidentialityImpact: str | None = None, integrityImpact: str | None = None, availabilityImpact: str | None = None)

Bases: BaseModel

CVSS v3.0/v3.1 severity metrics.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CWETaxonomy(*, cweId: str, description: str | None = None, lang: str | None = None)

Bases: BaseModel

CWE (Common Weakness Enumeration) taxonomy mapping.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class JailbreakTaxonomyItem(*, Category: str | None = None, Strategy: str | None = None, Technique: str | None = None)

Bases: BaseModel

0DIN Jailbreak Taxonomy item with Category, Strategy, and Technique.

model_config = {'fields': {'Category': {'exclude': True}, 'Strategy': {'exclude': True}, 'Technique': {'exclude': True}}}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class OdinTaxonomy(*, SocialImpactScore: str | None = None, JailbreakTaxonomy: List[JailbreakTaxonomyItem] | None = None)

Bases: BaseModel

0DIN taxonomy mapping for AI security disclosures.

model_config = {'fields': {'JailbreakTaxonomy': {'exclude': True}, 'SocialImpactScore': {'exclude': True}}}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Impact(*, avid: AvidTaxonomy | None = None, atlas: List[AtlasTaxonomy] | None = None, cvss: CVSSScores | None = None, cwe: List[CWETaxonomy] | None = None, odin: OdinTaxonomy | None = None)

Bases: BaseModel

Impact information of a report/vulnerability.

E.g. different taxonomy mappings, harm and severity scores.

model_config = {'fields': {'atlas': {'exclude': True}, 'avid': {'exclude': True}, 'cvss': {'exclude': True}, 'cwe': {'exclude': True}, 'odin': {'exclude': True}}}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].