@appthreat/cdx-proto
Version:
Library to serialize/deserialize CycloneDX BOM with protocol buffers
80 lines • 67.9 kB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CryptoProperties_AlgorithmProperties | 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.CryptoProperties_AlgorithmProperties.html">CryptoProperties_AlgorithmProperties</a></li></ul><h1>Class CryptoProperties_AlgorithmProperties</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from message cyclonedx.v1_6.CryptoProperties.AlgorithmProperties</p>
</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"><</span><a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">CryptoProperties_AlgorithmProperties</span></li></ul></li></ul></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#L9792">source/lib/bom-1.6_pb.ts:9792</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">Constructors</h3><div class="tsd-index-list"><a href="cdx_16.CryptoProperties_AlgorithmProperties.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="cdx_16.CryptoProperties_AlgorithmProperties.html#certificationLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>certification<wbr/>Level</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#classicalSecurityLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>classical<wbr/>Security<wbr/>Level?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#cryptoFunctions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>crypto<wbr/>Functions</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#curve" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>curve?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#executionEnvironment" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>execution<wbr/>Environment?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#implementationPlatform" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>implementation<wbr/>Platform?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#mode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#nistQuantumSecurityLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>nist<wbr/>Quantum<wbr/>Security<wbr/>Level?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#padding" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>padding?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#parameterSetIdentifier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parameter<wbr/>Set<wbr/>Identifier?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#primitive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primitive?</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#fields" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#runtime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runtime</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#typeName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Name</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="cdx_16.CryptoProperties_AlgorithmProperties.html#clone" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#equals" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#fromBinary" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Binary</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#fromJson" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#fromJsonString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json<wbr/>String</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#getType" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Type</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#toBinary" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Binary</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#toJSON" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#toJson-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Json</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#toJsonString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Json<wbr/>String</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#equals-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#fromBinary-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Binary</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#fromJson-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json</span></a>
<a href="cdx_16.CryptoProperties_AlgorithmProperties.html#fromJsonString-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json<wbr/>String</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_CryptoProperties_AlgorithmProperties" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Crypto<wbr/>Properties_<wbr/>Algorithm<wbr/>Properties</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a><a href="#constructor.new_CryptoProperties_AlgorithmProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">PartialMessage</span><span class="tsd-signature-symbol"><</span><a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a></h4><aside class="tsd-sources"><p>Overrides Message<CryptoProperties_AlgorithmProperties>.constructor</p><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L9870">source/lib/bom-1.6_pb.ts:9870</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="certificationLevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>certification<wbr/>Level</span><a href="#certificationLevel" 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-property">certification<wbr/>Level</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The certification that the implementation of the cryptographic algorithm has received, if any. Certifications include revisions and levels of FIPS 140 or Common Criteria of different Extended Assurance Levels (CC-EAL).</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated string certificationLevel = 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#L9833">source/lib/bom-1.6_pb.ts:9833</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="classicalSecurityLevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>classical<wbr/>Security<wbr/>Level</span><a href="#classicalSecurityLevel" 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-property">classical<wbr/>Security<wbr/>Level</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The classical security level that a cryptographic algorithm provides (in bits).</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional int32 classicalSecurityLevel = 10;</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#L9861">source/lib/bom-1.6_pb.ts:9861</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="cryptoFunctions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>crypto<wbr/>Functions</span><a href="#cryptoFunctions" 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-property">crypto<wbr/>Functions</span><span class="tsd-signature-symbol">:</span> <a href="../enums/cdx_16.CryptoProperties_AlgorithmProperties_CryptoAlgorithmFunction.html" class="tsd-signature-type tsd-kind-enum">CryptoProperties_AlgorithmProperties_CryptoAlgorithmFunction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The cryptographic functions implemented by the cryptographic algorithm.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.CryptoProperties.AlgorithmProperties.CryptoAlgorithmFunction cryptoFunctions = 9;</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#L9854">source/lib/bom-1.6_pb.ts:9854</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="curve" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>curve</span><a href="#curve" 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-property">curve</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends use of curve names as defined at <a href="https://neuromancer.sk/std/">https://neuromancer.sk/std/</a>, the source from which can be found at <a href="https://github.com/J08nY/std-curves">https://github.com/J08nY/std-curves</a>.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional string curve = 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#L9812">source/lib/bom-1.6_pb.ts:9812</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="executionEnvironment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>execution<wbr/>Environment</span><a href="#executionEnvironment" 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-property">execution<wbr/>Environment</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/cdx_16.CryptoProperties_AlgorithmProperties_CryptoExecutionEnvironment.html" class="tsd-signature-type tsd-kind-enum">CryptoProperties_AlgorithmProperties_CryptoExecutionEnvironment</a></div><div class="tsd-comment tsd-typography"><p>The target and execution environment in which the algorithm is implemented in.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional cyclonedx.v1_6.CryptoProperties.AlgorithmProperties.CryptoExecutionEnvironment executionEnvironment = 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#L9819">source/lib/bom-1.6_pb.ts:9819</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="implementationPlatform" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>implementation<wbr/>Platform</span><a href="#implementationPlatform" 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-property">implementation<wbr/>Platform</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/cdx_16.CryptoProperties_AlgorithmProperties_CryptoImplementationPlatform.html" class="tsd-signature-type tsd-kind-enum">CryptoProperties_AlgorithmProperties_CryptoImplementationPlatform</a></div><div class="tsd-comment tsd-typography"><p>The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional cyclonedx.v1_6.CryptoProperties.AlgorithmProperties.CryptoImplementationPlatform implementationPlatform = 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#L9826">source/lib/bom-1.6_pb.ts:9826</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>mode</span><a href="#mode" 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-property">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/cdx_16.CryptoProperties_AlgorithmProperties_CryptoAlgorithmMode.html" class="tsd-signature-type tsd-kind-enum">CryptoProperties_AlgorithmProperties_CryptoAlgorithmMode</a></div><div class="tsd-comment tsd-typography"><p>The mode of operation in which the cryptographic algorithm (block cipher) is used.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional cyclonedx.v1_6.CryptoProperties.AlgorithmProperties.CryptoAlgorithmMode mode = 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.6_pb.ts#L9840">source/lib/bom-1.6_pb.ts:9840</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="nistQuantumSecurityLevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>nist<wbr/>Quantum<wbr/>Security<wbr/>Level</span><a href="#nistQuantumSecurityLevel" 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-property">nist<wbr/>Quantum<wbr/>Security<wbr/>Level</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The NIST security strength category as defined in <a href="https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria)">https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria)</a>. A value of 0 indicates that none of the categories are met.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional int32 nistQuantumSecurityLevel = 11;</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#L9868">source/lib/bom-1.6_pb.ts:9868</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="padding" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>padding</span><a href="#padding" 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-property">padding</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/cdx_16.CryptoProperties_AlgorithmProperties_CryptoAlgorithmPadding.html" class="tsd-signature-type tsd-kind-enum">CryptoProperties_AlgorithmProperties_CryptoAlgorithmPadding</a></div><div class="tsd-comment tsd-typography"><p>The padding scheme that is used for the cryptographic algorithm.</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional cyclonedx.v1_6.CryptoProperties.AlgorithmProperties.CryptoAlgorithmPadding padding = 8;</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#L9847">source/lib/bom-1.6_pb.ts:9847</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="parameterSetIdentifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>parameter<wbr/>Set<wbr/>Identifier</span><a href="#parameterSetIdentifier" 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-property">parameter<wbr/>Set<wbr/>Identifier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205).</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional string parameterSetIdentifier = 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#L9805">source/lib/bom-1.6_pb.ts:9805</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="primitive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>primitive</span><a href="#primitive" 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-property">primitive</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/cdx_16.CryptoProperties_AlgorithmProperties_CryptoPrimitive.html" class="tsd-signature-type tsd-kind-enum">CryptoProperties_AlgorithmProperties_CryptoPrimitive</a></div><div class="tsd-comment tsd-typography"><p>Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms (combiner, e.g. SP800-56Cr2).</p>
</div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional cyclonedx.v1_6.CryptoProperties.AlgorithmProperties.CryptoPrimitive primitive = 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#L9798">source/lib/bom-1.6_pb.ts:9798</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>fields</span><a href="#fields" 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-property">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FieldList</span><span class="tsd-signature-symbol"> = ...</span></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#L9877">source/lib/bom-1.6_pb.ts:9877</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="runtime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>runtime</span><a href="#runtime" 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-property">runtime</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProtoRuntime</span><span class="tsd-signature-symbol"> = proto3</span></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#L9875">source/lib/bom-1.6_pb.ts:9875</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="typeName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>type<wbr/>Name</span><a href="#typeName" 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-property">type<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"cyclonedx.v1_6.CryptoProperties.AlgorithmProperties"</span><span class="tsd-signature-symbol"> = "cyclonedx.v1_6.CryptoProperties.AlgorithmProperties"</span></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#L9876">source/lib/bom-1.6_pb.ts:9876</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clone</span><a href="#clone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="clone.clone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clone</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a><a href="#clone.clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a deep copy.</p>
</div><h4 class="tsd-returns-title">Returns <a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.clone</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:27</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="equals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>equals</span><a href="#equals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="equals.equals-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">equals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#equals.equals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Compare with a message of the same type.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PlainMessage</span><span class="tsd-signature-symbol"><</span><a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.equals</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:23</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromBinary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Binary</span><a href="#fromBinary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromBinary.fromBinary-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Binary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bytes</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromBinary.fromBinary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse from binary data, merging fields.</p>
<p>Repeated fields are appended. Map entries are added, overwriting
existing keys.</p>
<p>If a message field is already present, it will be merged with the
new data.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bytes</span>: <span class="tsd-signature-type">Uint8Array</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BinaryReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromBinary</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:37</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromJson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Json</span><a href="#fromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromJson.fromJson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Json</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">jsonValue</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromJson.fromJson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse a message from a JSON value.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">jsonValue</span>: <span class="tsd-signature-type">JsonValue</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JsonReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromJson</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:41</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromJsonString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Json<wbr/>String</span><a href="#fromJsonString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromJsonString.fromJsonString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Json<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">jsonString</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromJsonString.fromJsonString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse a message from a JSON string.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">jsonString</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JsonReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromJsonString</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:45</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Type</span><a href="#getType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getType.getType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageType</span><span class="tsd-signature-symbol"><</span><a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a><span class="tsd-signature-symbol">></span><a href="#getType.getType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve the MessageType of this message - a singleton that represents
the protobuf message declaration and provides metadata for reflection-
based operations.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MessageType</span><span class="tsd-signature-symbol"><</span><a href="cdx_16.CryptoProperties_AlgorithmProperties.html" class="tsd-signature-type tsd-kind-class">CryptoProperties_AlgorithmProperties</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.getType</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:80</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toBinary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Binary</span><a href="#toBinary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toBinary.toBinary-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Binary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><a href="#toBinary.toBinary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Serialize the message to binary data.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BinaryWriteOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.toBinary</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:49</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toJSON.toJSON-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JsonValue</span><a href="#toJSON.toJSON-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Override for serialization behavior. This will be invoked when calling
JSON.stringify on this message (i.e. JSON.stringify(msg)).</p>
<p>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.</p>
<p>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.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JsonValue</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.toJSON</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:74</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJson-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Json</span><a href="#toJson-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toJson-2.toJson-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Json</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JsonValue</span><a href="#toJson-2.toJson-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Serialize the message to a JSON value, a JavaScript value that can be
passed to JSON.stringify().</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JsonWriteOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JsonValue</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.toJson</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:54</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toJsonString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Json<wbr/>String</span><a href="#toJsonString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toJsonString.toJsonString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Json<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toJsonString.toJsonString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Serialize the message to a JSON string.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JsonWriteStringOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>I