@appthreat/cdx-proto
Version:
Library to serialize/deserialize CycloneDX BOM with protocol buffers
15 lines (14 loc) • 12.4 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VulnerabilityAnalysis | cdx-proto</title><meta name="description" content="Documentation for cdx-proto"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdx-proto</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">VulnerabilityAnalysis</a></li></ul><h1>Type Alias VulnerabilityAnalysis</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VulnerabilityAnalysis</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">"cyclonedx.v1_6.VulnerabilityAnalysis"</span><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">firstIssued</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Timestamp</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">justification</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/ImpactAnalysisJustification.html" class="tsd-signature-type tsd-kind-enum">ImpactAnalysisJustification</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">lastUpdated</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Timestamp</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">:</span> <a href="../enums/VulnerabilityResponse.html" class="tsd-signature-type tsd-kind-enum">VulnerabilityResponse</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/ImpactAnalysisState.html" class="tsd-signature-type tsd-kind-enum">ImpactAnalysisState</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Detailed description of the impact, including methods used during the 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.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-generated"><h4 class="tsd-anchor-link" id="generated">Generated<a href="#generated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>from field: optional string detail = 4;</p>
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">firstIssued</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Timestamp</span></h5><div class="tsd-comment tsd-typography"><p>The date and time (timestamp) when the analysis was first issued.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-generated"><h4 class="tsd-anchor-link" id="generated-1">Generated<a href="#generated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>from field: optional google.protobuf.Timestamp firstIssued = 5;</p>
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">justification</span><span class="tsd-signature-symbol">?: </span><a href="../enums/ImpactAnalysisJustification.html" class="tsd-signature-type tsd-kind-enum">ImpactAnalysisJustification</a></h5><div class="tsd-comment tsd-typography"><p>The rationale of why the impact analysis state was asserted.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-generated"><h4 class="tsd-anchor-link" id="generated-2">Generated<a href="#generated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>from field: optional cyclonedx.v1_6.ImpactAnalysisJustification justification = 2;</p>
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">lastUpdated</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Timestamp</span></h5><div class="tsd-comment tsd-typography"><p>The date and time (timestamp) when the analysis was last updated.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-generated"><h4 class="tsd-anchor-link" id="generated-3">Generated<a href="#generated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>from field: optional google.protobuf.Timestamp lastUpdated = 6;</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">response</span><span class="tsd-signature-symbol">: </span><a href="../enums/VulnerabilityResponse.html" class="tsd-signature-type tsd-kind-enum">VulnerabilityResponse</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>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.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-generated"><h4 class="tsd-anchor-link" id="generated-4">Generated<a href="#generated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>from field: repeated cyclonedx.v1_6.VulnerabilityResponse response = 3;</p>
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">?: </span><a href="../enums/ImpactAnalysisState.html" class="tsd-signature-type tsd-kind-enum">ImpactAnalysisState</a></h5><div class="tsd-comment tsd-typography"><p>Declares the current state of an occurrence of a vulnerability after automated or manual analysis.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-generated"><h4 class="tsd-anchor-link" id="generated-5">Generated<a href="#generated-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>from field: optional cyclonedx.v1_6.ImpactAnalysisState state = 1;</p>
</div></div></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-generated"><h4 class="tsd-anchor-link" id="generated-6">Generated<a href="#generated-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>from message cyclonedx.v1_6.VulnerabilityAnalysis</p>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/ee0eb327d1a2138d9d5ffcf4f868b93ffd2f7190/source/lib/bom-1.6_pb.ts#L2294">bom-1.6_pb.ts:2294</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdx-proto</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>