Skip to content

harborapi.ext.cve

The harborapi.ext.cve module provides functionality for working with CVSSv3 data.

CVSSData

Bases: BaseModel

Key CVSS statistics for a scanned artifact.

Source code in harborapi/ext/cve.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
73
74
75
class CVSSData(BaseModel):
    """Key CVSS statistics for a scanned artifact."""

    mean: float
    median: float
    stdev: float
    min: float
    max: float

    @classmethod
    def from_artifactinfo(cls, artifact: "ArtifactInfo") -> "CVSSData":
        """Create a CVSSData instance from an ArtifactInfo object.

        Parameters
        ----------
        artifact : ArtifactInfo
            The artifact to extract CVSS data from.

        Returns
        -------
        CVSSData
            The CVSS data for the artifact.

        See Also
        --------
        [ArtifactInfo.cvss][harborapi.ext.artifact.ArtifactInfo.cvss]
        """
        scores = artifact.report.cvss_scores
        return cls(
            mean=stats.mean(scores),
            median=stats.median(scores),
            stdev=stats.stdev(scores),
            min=stats.min(scores),
            max=stats.max(scores),
        )

    @classmethod
    def from_report(cls, report: "ArtifactReport") -> "CVSSData":
        """Create a CVSSData instance from an ArtifactReport object.

        Parameters
        ----------
        report : ArtifactReport
            The report to extract CVSS data from.

        Returns
        -------
        CVSSData
            The CVSS data for the report.
        """
        # Wrap generator in list to allow for re-use
        scores = list(
            chain.from_iterable([a.report.cvss_scores for a in report.artifacts])
        )
        return cls(
            mean=stats.mean(scores),
            median=stats.median(scores),
            stdev=stats.stdev(scores),
            min=stats.min(scores),
            max=stats.max(scores),
        )

from_artifactinfo(artifact) classmethod

Create a CVSSData instance from an ArtifactInfo object.

Parameters:

Name Type Description Default
artifact ArtifactInfo

The artifact to extract CVSS data from.

 required

Returns:

Type Description
CVSSData

The CVSS data for the artifact.
See Also

ArtifactInfo.cvss

Source code in harborapi/ext/cve.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
@classmethod
def from_artifactinfo(cls, artifact: "ArtifactInfo") -> "CVSSData":
    """Create a CVSSData instance from an ArtifactInfo object.

    Parameters
    ----------
    artifact : ArtifactInfo
        The artifact to extract CVSS data from.

    Returns
    -------
    CVSSData
        The CVSS data for the artifact.

    See Also
    --------
    [ArtifactInfo.cvss][harborapi.ext.artifact.ArtifactInfo.cvss]
    """
    scores = artifact.report.cvss_scores
    return cls(
        mean=stats.mean(scores),
        median=stats.median(scores),
        stdev=stats.stdev(scores),
        min=stats.min(scores),
        max=stats.max(scores),
    )

from_report(report) classmethod

Create a CVSSData instance from an ArtifactReport object.

Parameters:

Name Type Description Default
report ArtifactReport

The report to extract CVSS data from.

 required

Returns:

Type Description
CVSSData

The CVSS data for the report.
Source code in harborapi/ext/cve.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@classmethod
def from_report(cls, report: "ArtifactReport") -> "CVSSData":
    """Create a CVSSData instance from an ArtifactReport object.

    Parameters
    ----------
    report : ArtifactReport
        The report to extract CVSS data from.

    Returns
    -------
    CVSSData
        The CVSS data for the report.
    """
    # Wrap generator in list to allow for re-use
    scores = list(
        chain.from_iterable([a.report.cvss_scores for a in report.artifacts])
    )
    return cls(
        mean=stats.mean(scores),
        median=stats.median(scores),
        stdev=stats.stdev(scores),
        min=stats.min(scores),
        max=stats.max(scores),
    )