Class VulnerabilityAnalysis

Generated

from message cyclonedx.v1_5.VulnerabilityAnalysis

Hierarchy

Constructors

Properties

detail?: string

Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability.

Generated

from field: optional string detail = 4;

firstIssued?: Timestamp

The date and time (timestamp) when the analysis was first issued.

Generated

from field: optional google.protobuf.Timestamp firstIssued = 5;

The rationale of why the impact analysis state was asserted.

Generated

from field: optional cyclonedx.v1_5.ImpactAnalysisJustification justification = 2;

lastUpdated?: Timestamp

The date and time (timestamp) when the analysis was last updated.

Generated

from field: optional google.protobuf.Timestamp lastUpdated = 6;

response: cdx_15.VulnerabilityResponse[] = []

A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable.

Generated

from field: repeated cyclonedx.v1_5.VulnerabilityResponse response = 3;

Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.

Generated

from field: optional cyclonedx.v1_5.ImpactAnalysisState state = 1;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cyclonedx.v1_5.VulnerabilityAnalysis" = "cyclonedx.v1_5.VulnerabilityAnalysis"

Methods

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<cdx_15.VulnerabilityAnalysis>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string