UNPKG

@appthreat/cdx-proto

Version:

Library to serialize/deserialize CycloneDX BOM with protocol buffers

18 lines 17.1 kB
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EvidenceFieldType | 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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdx-proto</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdx-proto</a></li><li><a href="../modules/cdx_15.html">cdx_15</a></li><li><a href="cdx_15.EvidenceFieldType.html">EvidenceFieldType</a></li></ul><h1>Enumeration EvidenceFieldType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum cyclonedx.v1_5.EvidenceFieldType</p> </div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L978">source/lib/bom-1.5_pb.ts:978</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="cdx_15.EvidenceFieldType.html#EVIDENCE_FIELD_CPE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>CPE</span></a> <a href="cdx_15.EvidenceFieldType.html#EVIDENCE_FIELD_GROUP" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>GROUP</span></a> <a href="cdx_15.EvidenceFieldType.html#EVIDENCE_FIELD_HASH" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>HASH</span></a> <a href="cdx_15.EvidenceFieldType.html#EVIDENCE_FIELD_NAME" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>NAME</span></a> <a href="cdx_15.EvidenceFieldType.html#EVIDENCE_FIELD_NULL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>NULL</span></a> <a href="cdx_15.EvidenceFieldType.html#EVIDENCE_FIELD_PURL" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>PURL</span></a> <a href="cdx_15.EvidenceFieldType.html#EVIDENCE_FIELD_SWID" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>SWID</span></a> <a href="cdx_15.EvidenceFieldType.html#EVIDENCE_FIELD_VERSION" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>VERSION</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="EVIDENCE_FIELD_CPE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVIDENCE_<wbr/>FIELD_<wbr/>CPE</span><a href="#EVIDENCE_FIELD_CPE" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVIDENCE_<wbr/>FIELD_<wbr/>CPE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">5</span></div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: EVIDENCE_FIELD_CPE = 5;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L1007">source/lib/bom-1.5_pb.ts:1007</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EVIDENCE_FIELD_GROUP" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVIDENCE_<wbr/>FIELD_<wbr/>GROUP</span><a href="#EVIDENCE_FIELD_GROUP" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVIDENCE_<wbr/>FIELD_<wbr/>GROUP</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: EVIDENCE_FIELD_GROUP = 1;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L987">source/lib/bom-1.5_pb.ts:987</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EVIDENCE_FIELD_HASH" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVIDENCE_<wbr/>FIELD_<wbr/>HASH</span><a href="#EVIDENCE_FIELD_HASH" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVIDENCE_<wbr/>FIELD_<wbr/>HASH</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">7</span></div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: EVIDENCE_FIELD_HASH = 7;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L1017">source/lib/bom-1.5_pb.ts:1017</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EVIDENCE_FIELD_NAME" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVIDENCE_<wbr/>FIELD_<wbr/>NAME</span><a href="#EVIDENCE_FIELD_NAME" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVIDENCE_<wbr/>FIELD_<wbr/>NAME</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: EVIDENCE_FIELD_NAME = 2;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L992">source/lib/bom-1.5_pb.ts:992</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EVIDENCE_FIELD_NULL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVIDENCE_<wbr/>FIELD_<wbr/>NULL</span><a href="#EVIDENCE_FIELD_NULL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVIDENCE_<wbr/>FIELD_<wbr/>NULL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: EVIDENCE_FIELD_NULL = 0;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L982">source/lib/bom-1.5_pb.ts:982</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EVIDENCE_FIELD_PURL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVIDENCE_<wbr/>FIELD_<wbr/>PURL</span><a href="#EVIDENCE_FIELD_PURL" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVIDENCE_<wbr/>FIELD_<wbr/>PURL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span></div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: EVIDENCE_FIELD_PURL = 4;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L1002">source/lib/bom-1.5_pb.ts:1002</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EVIDENCE_FIELD_SWID" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVIDENCE_<wbr/>FIELD_<wbr/>SWID</span><a href="#EVIDENCE_FIELD_SWID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVIDENCE_<wbr/>FIELD_<wbr/>SWID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">6</span></div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: EVIDENCE_FIELD_SWID = 6;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L1012">source/lib/bom-1.5_pb.ts:1012</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EVIDENCE_FIELD_VERSION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVIDENCE_<wbr/>FIELD_<wbr/>VERSION</span><a href="#EVIDENCE_FIELD_VERSION" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVIDENCE_<wbr/>FIELD_<wbr/>VERSION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: EVIDENCE_FIELD_VERSION = 3;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L997">source/lib/bom-1.5_pb.ts:997</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#EVIDENCE_FIELD_CPE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>CPE</span></a><a href="#EVIDENCE_FIELD_GROUP" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>GROUP</span></a><a href="#EVIDENCE_FIELD_HASH" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>HASH</span></a><a href="#EVIDENCE_FIELD_NAME" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>NAME</span></a><a href="#EVIDENCE_FIELD_NULL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>NULL</span></a><a href="#EVIDENCE_FIELD_PURL" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>PURL</span></a><a href="#EVIDENCE_FIELD_SWID" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>SWID</span></a><a href="#EVIDENCE_FIELD_VERSION" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVIDENCE_<wbr/>FIELD_<wbr/>VERSION</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>cdx-proto</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>