@appthreat/cdx-proto
Version:
Library to serialize/deserialize CycloneDX BOM with protocol buffers
15 lines (14 loc) • 13 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CryptoProperties | 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">CryptoProperties</a></li></ul><h1>Type Alias CryptoProperties</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">CryptoProperties</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.CryptoProperties"</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">algorithmProperties</span><span class="tsd-signature-symbol">?:</span> <a href="CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-type-alias">CryptoProperties_AlgorithmProperties</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">assetType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/CryptoProperties_CryptoAssetType.html" class="tsd-signature-type tsd-kind-enum">CryptoProperties_CryptoAssetType</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">certificateProperties</span><span class="tsd-signature-symbol">?:</span> <a href="CryptoProperties_CertificateProperties.html" class="tsd-signature-type tsd-kind-type-alias">CryptoProperties_CertificateProperties</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">oid</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">protocolProperties</span><span class="tsd-signature-symbol">?:</span> <a href="CryptoProperties_ProtocolProperties.html" class="tsd-signature-type tsd-kind-type-alias">CryptoProperties_ProtocolProperties</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">relatedCryptoMaterialProperties</span><span class="tsd-signature-symbol">?:</span> <a href="CryptoProperties_RelatedCryptoMaterialProperties.html" class="tsd-signature-type tsd-kind-type-alias">CryptoProperties_RelatedCryptoMaterialProperties</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">algorithmProperties</span><span class="tsd-signature-symbol">?: </span><a href="CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-type-alias">CryptoProperties_AlgorithmProperties</a></h5><div class="tsd-comment tsd-typography"><p>Additional properties specific to a cryptographic algorithm.</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 cyclonedx.v1_6.CryptoProperties.AlgorithmProperties algorithmProperties = 2;</p>
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">assetType</span><span class="tsd-signature-symbol">: </span><a href="../enums/CryptoProperties_CryptoAssetType.html" class="tsd-signature-type tsd-kind-enum">CryptoProperties_CryptoAssetType</a></h5><div class="tsd-comment tsd-typography"><p>Cryptographic assets occur in several forms. Algorithms and protocols are most commonly implemented in specialized cryptographic libraries. They may, however, also be 'hardcoded' in software components. Certificates and related cryptographic material like keys, tokens, secrets or passwords are other cryptographic assets to be modelled.</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: cyclonedx.v1_6.CryptoProperties.CryptoAssetType assetType = 1;</p>
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">certificateProperties</span><span class="tsd-signature-symbol">?: </span><a href="CryptoProperties_CertificateProperties.html" class="tsd-signature-type tsd-kind-type-alias">CryptoProperties_CertificateProperties</a></h5><div class="tsd-comment tsd-typography"><p>Properties for cryptographic assets of asset type 'certificate'</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.CryptoProperties.CertificateProperties certificateProperties = 3;</p>
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">oid</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The object identifier (OID) of the cryptographic asset.</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 string oid = 6;</p>
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">protocolProperties</span><span class="tsd-signature-symbol">?: </span><a href="CryptoProperties_ProtocolProperties.html" class="tsd-signature-type tsd-kind-type-alias">CryptoProperties_ProtocolProperties</a></h5><div class="tsd-comment tsd-typography"><p>Properties specific to cryptographic assets of type: <code>protocol</code>.</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: optional cyclonedx.v1_6.CryptoProperties.ProtocolProperties protocolProperties = 5;</p>
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">relatedCryptoMaterialProperties</span><span class="tsd-signature-symbol">?: </span><a href="CryptoProperties_RelatedCryptoMaterialProperties.html" class="tsd-signature-type tsd-kind-type-alias">CryptoProperties_RelatedCryptoMaterialProperties</a></h5><div class="tsd-comment tsd-typography"><p>Properties for cryptographic assets of asset type: <code>related-crypto-material</code></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.CryptoProperties.RelatedCryptoMaterialProperties relatedCryptoMaterialProperties = 4;</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.CryptoProperties</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#L5428">bom-1.6_pb.ts:5428</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>