@appthreat/cdx-proto
Version:
Library to serialize/deserialize CycloneDX BOM with protocol buffers
24 lines • 17.2 kB
HTML
<html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LifecyclePhase | 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_16.html">cdx_16</a></li><li><a href="cdx_16.LifecyclePhase.html">LifecyclePhase</a></li></ul><h1>Enumeration LifecyclePhase</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum cyclonedx.v1_6.LifecyclePhase</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.6_pb.ts#L828">source/lib/bom-1.6_pb.ts:828</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_16.LifecyclePhase.html#BUILD" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BUILD</span></a>
<a href="cdx_16.LifecyclePhase.html#DECOMMISSION" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DECOMMISSION</span></a>
<a href="cdx_16.LifecyclePhase.html#DESIGN" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DESIGN</span></a>
<a href="cdx_16.LifecyclePhase.html#DISCOVERY" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DISCOVERY</span></a>
<a href="cdx_16.LifecyclePhase.html#OPERATIONS" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPERATIONS</span></a>
<a href="cdx_16.LifecyclePhase.html#POST_BUILD" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>POST_<wbr/>BUILD</span></a>
<a href="cdx_16.LifecyclePhase.html#PRE_BUILD" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PRE_<wbr/>BUILD</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="BUILD" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>BUILD</span><a href="#BUILD" 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">BUILD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><div class="tsd-comment tsd-typography"><p>BOM consisting of information obtained during a build process where component inventory is available for use. The precise versions of resolved components are usually available at this time as well as the provenance of where the components were retrieved from.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: LIFECYCLE_PHASE_BUILD = 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.6_pb.ts#L849">source/lib/bom-1.6_pb.ts:849</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DECOMMISSION" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DECOMMISSION</span><a href="#DECOMMISSION" 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">DECOMMISSION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">6</span></div><div class="tsd-comment tsd-typography"><p>BOM containing inventory that will be, or has been retired from operations.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: LIFECYCLE_PHASE_DECOMMISSION = 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.6_pb.ts#L877">source/lib/bom-1.6_pb.ts:877</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DESIGN" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DESIGN</span><a href="#DESIGN" 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">DESIGN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><div class="tsd-comment tsd-typography"><p>BOM produced early in the development lifecycle containing an inventory of components and services that are proposed or planned to be used. The inventory may need to be procured, retrieved, or resourced prior to use.
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value <code>0</code> is a fallback(meaning "unspecified") in protobuf3. this usage here is an error; it shall be fixed with v2.0 of this very schema</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: LIFECYCLE_PHASE_DESIGN = 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.6_pb.ts#L835">source/lib/bom-1.6_pb.ts:835</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="DISCOVERY" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DISCOVERY</span><a href="#DISCOVERY" 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">DISCOVERY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">5</span></div><div class="tsd-comment tsd-typography"><p>BOM consisting of information observed through network discovery providing point-in-time enumeration of embedded, on-premise, and cloud-native services such as server applications, connected devices, microservices, and serverless functions.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: LIFECYCLE_PHASE_DISCOVERY = 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.6_pb.ts#L870">source/lib/bom-1.6_pb.ts:870</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="OPERATIONS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>OPERATIONS</span><a href="#OPERATIONS" 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">OPERATIONS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span></div><div class="tsd-comment tsd-typography"><p>BOM produced that represents inventory that is running and operational. This may include staging or production environments and will generally encompass multiple SBOMs describing the applications and operating system, along with HBOMs describing the hardware that makes up the system. Operations Bill of Materials (OBOM) can provide full-stack inventory of runtime environments, configurations, and additional dependencies.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: LIFECYCLE_PHASE_OPERATIONS = 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.6_pb.ts#L863">source/lib/bom-1.6_pb.ts:863</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="POST_BUILD" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>POST_<wbr/>BUILD</span><a href="#POST_BUILD" 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">POST_<wbr/>BUILD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><div class="tsd-comment tsd-typography"><p>BOM consisting of information obtained after a build process has completed and the resulting components(s) are available for further analysis. Built components may exist as the result of a CI/CD process, may have been installed or deployed to a system or device, and may need to be retrieved or extracted from the system or device.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: LIFECYCLE_PHASE_POST_BUILD = 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.6_pb.ts#L856">source/lib/bom-1.6_pb.ts:856</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="PRE_BUILD" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PRE_<wbr/>BUILD</span><a href="#PRE_BUILD" 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">PRE_<wbr/>BUILD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><div class="tsd-comment tsd-typography"><p>BOM consists of information obtained prior to a build process and may contain source files, development artifacts, and manifests. The inventory may need to be resolved and retrieved prior to use.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from enum value: LIFECYCLE_PHASE_PRE_BUILD = 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.6_pb.ts#L842">source/lib/bom-1.6_pb.ts:842</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="#BUILD" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>BUILD</span></a><a href="#DECOMMISSION" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DECOMMISSION</span></a><a href="#DESIGN" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DESIGN</span></a><a href="#DISCOVERY" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>DISCOVERY</span></a><a href="#OPERATIONS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPERATIONS</span></a><a href="#POST_BUILD" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>POST_<wbr/>BUILD</span></a><a href="#PRE_BUILD" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>PRE_<wbr/>BUILD</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>