Skip to content

findings

SupportsVulns

Bases: Protocol

Any object that has a .vulnerabilities: list[Vulnerability].

Examples:

>>> import wintermute.peripherals
>>> from wintermute.utils.findings import (
...     add_vulnerability,
...     get_vulnerability,
...     remove_vulnerability,
...     add_reproduction_step,
... )
>>> uart = UART(name="UART0")
>>> v = add_vulnerability(
...     uart,
...     title="UART console exposed",
...     description="The UART console is exposed and allows access to the system.",
...     cvss=7,
...     risk={"likelihood": "High", "impact": "High", "severity": "Critical"},
... )
>>> add_reproduction_step(
...     uart,
...     title="UART console exposed",
...     step={
...         "title": "Probe pins",
...         "description": "Connect to T/RX/GND at 115200 8N1 and observe root prompt.",
...         "tool": "USB-UART",
...         "action": "connect",
...         "confidence": 90,
...     },
... )
True
>>> remove_vulnerability(uart, title="UART console exposed")
True
Source code in wintermute/utils/findings.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class SupportsVulns(Protocol):
    """Any object that has a .vulnerabilities: list[Vulnerability].


    Examples:
        >>> import wintermute.peripherals
        >>> from wintermute.utils.findings import (
        ...     add_vulnerability,
        ...     get_vulnerability,
        ...     remove_vulnerability,
        ...     add_reproduction_step,
        ... )
        >>> uart = UART(name="UART0")
        >>> v = add_vulnerability(
        ...     uart,
        ...     title="UART console exposed",
        ...     description="The UART console is exposed and allows access to the system.",
        ...     cvss=7,
        ...     risk={"likelihood": "High", "impact": "High", "severity": "Critical"},
        ... )
        >>> add_reproduction_step(
        ...     uart,
        ...     title="UART console exposed",
        ...     step={
        ...         "title": "Probe pins",
        ...         "description": "Connect to T/RX/GND at 115200 8N1 and observe root prompt.",
        ...         "tool": "USB-UART",
        ...         "action": "connect",
        ...         "confidence": 90,
        ...     },
        ... )
        True
        >>> remove_vulnerability(uart, title="UART console exposed")
        True
    """

    vulnerabilities: List[Vulnerability]