waku-org
/
js-waku
mirror of https://github.com/waku-org/js-waku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
js-waku/modules/_waku_message_encryption.html

95 lines
28 KiB
HTML
Raw Normal View History

Updates
2023-11-02 22:35:12 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@waku/message-encryption - v0.0.23 | Documentation</title><meta name="description" content="Documentation for Documentation"/><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/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"</script><header class="tsd-page-toolbar">
Updates
2022-12-06 00:06:29 +00:00
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base="..">
Updates
2023-09-21 08:59:21 +00:00
<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="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
Updates
2022-12-06 00:06:29 +00:00
<div class="field">
<div id="tsd-toolbar-links"></div></div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
Updates
2023-09-21 08:59:21 +00:00
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Documentation</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="#icon-menu"></use></svg></a></div></div></header>
Updates
2022-12-06 00:06:29 +00:00
<div class="container container-main">
Updates
2023-09-21 08:59:21 +00:00
<div class="col-content">
Updates
2022-12-06 00:06:29 +00:00
<div class="tsd-page-title">
<ul class="tsd-breadcrumb">
Updates
2023-09-21 08:59:21 +00:00
<li><a href="../index.html">Documentation</a></li>
Updates
2022-12-06 00:06:29 +00:00
<li><a href="_waku_message_encryption.html">@waku/message-encryption</a></li></ul>
Updates
2023-11-02 22:35:12 +00:00
<h1>Module @waku/message-encryption - v0.0.23</h1></div>
Updates
2023-09-21 08:59:21 +00:00
<section class="tsd-panel tsd-typography"><a id="md:wakumessage-encryption" class="tsd-anchor"></a><h1><a href="#md:wakumessage-encryption"><code>@waku/message-encryption</code></a></h1><p>Provide Waku Message Version 1 payload encryption as defined in <a href="https://rfc.vac.dev/spec/26/">26/WAKU2-PAYLOAD</a>.</p>
<a id="md:symmetric-encryption" class="tsd-anchor"></a><h2><a href="#md:symmetric-encryption">Symmetric Encryption</a></h2><p>Symmetric encryption uses a unique key to encrypt and decrypt messages.</p>
<pre><code class="language-typescript"><span class="hl-5">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">createDecoder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">createEncoder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">generateSymmetricKey</span><br/><span class="hl-1">} </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@waku/message-encryption/symmetric&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-7">// Generate a random key</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-4">key</span><span class="hl-1"> = </span><span class="hl-0">generateSymmetricKey</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// To send messages, create an encoder</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-4">encoder</span><span class="hl-1"> = </span><span class="hl-0">createEncoder</span><span class="hl-1">(</span><span class="hl-3">contentTopic</span><span class="hl-1">, </span><span class="hl-3">key</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// For example</span><br/><span class="hl-3">waku</span><span class="hl-1">.</span><span class="hl-3">lightPush</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-3">encoder</span><span class="hl-1">, { </span><span class="hl-3">payload</span><span class="hl-1"> });</span><br/><br/><span class="hl-7">// To receive messages, create a decoder</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-4">decoder</span><span class="hl-1"> = </span><span class="hl-0">createDecoder</span><span class="hl-1">(</span><span class="hl-3">contentTopic</span><span class="hl-1">, </span><span class="hl-3">key</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// For example</span><br/><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-3">waku</span><span class="hl-1">.</span><span class="hl-3">store</span><span class="hl-1">.</span><span class="hl-0">queryOrderedCallback</span><span class="hl-1">([</span><span class="hl-3">decoder</span><span class="hl-1">], (</span><span class="hl-3">msg</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// ...</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
<a id="md:ecies-encryption" class="tsd-anchor"></a><h2><a href="#md:ecies-encryption">ECIES Encryption</a></h2><p>ECIES encryption enables encryption for a public key and decryption using a private key.</p>
<pre><code class="language-typescript"><span class="hl-5">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">createDecoder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">createEncoder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">generatePrivateKey</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">getPublicKey</span><br/><span class="hl-1">} </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@waku/message-encryption/ecies&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-7">// Generate a random private key</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-4">privateKey</span><span class="hl-1"> = </span><span class="hl-0">generatePrivateKey</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// Keep the private key secure, provide the public key to the sender</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-4">publicKey</span><span class="hl-1"> = </span><span class="hl-0">getPublicKey</span><span class="hl-1">(</span><span class="hl-3">privateKey</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// To send messages, create an encoder</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-4">encoder</span><span class="hl-1"> = </span><span class="hl-0">createEncoder</span><span class="hl-1">(</span><span class="hl-3">contentTopic</span><span class="hl-1">, </span><span class="hl-3">publicKey</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// For example</span><br/><span class="hl-3">waku</span><span class="hl-1">.</span><span class="hl-3">lightPush</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-3">encoder</span><span class="hl-1">, { </span><span class="hl-3">payload</span><span class="hl-1"> });</span><br/><br/><span class="hl-7">// To receive messages, create a decoder</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-4">decoder</span><span class="hl-1"> = </span><span class="hl-0">createDecoder</span><span class="hl-1">(</span><span class="hl-3">contentTopic</span><span class="hl-1">, </span><span class="hl-3">privateKey</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// For example</span><br/><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-3">waku</span><span class="hl-1">.</span><span class="hl-3">store</span><span class="hl-1">.</span><span class="hl-0">queryOrderedCallback</span><span class="hl-1">([</span><span class="hl-3">decoder</span><span class="hl-1">], (</span><span class="hl-3">msg</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// ...</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
</section>
Updates
2022-12-06 00:06:29 +00:00
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<h3 class="tsd-index-heading uppercase">Index</h3>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Namespaces</h3>
Updates
2023-09-21 08:59:21 +00:00
<div class="tsd-index-list"><a href="_waku_message_encryption.ecies.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>ecies</span></a>
<a href="_waku_message_encryption.symmetric.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>symmetric</span></a>
Updates
2022-12-06 00:06:29 +00:00
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Classes</h3>
Updates
2023-09-21 08:59:21 +00:00
<div class="tsd-index-list"><a href="../classes/_waku_message_encryption.DecodedMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Decoded<wbr/>Message</span></a>
Updates
2022-12-06 00:06:29 +00:00
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Type Aliases</h3>
Updates
2023-09-21 08:59:21 +00:00
<div class="tsd-index-list"><a href="../types/_waku_message_encryption.Signature.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Signature</span></a>
Updates
2022-12-06 00:06:29 +00:00
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Variables</h3>
Updates
2023-09-21 08:59:21 +00:00
<div class="tsd-index-list"><a href="../variables/_waku_message_encryption.OneMillion.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>One<wbr/>Million</span></a>
<a href="../variables/_waku_message_encryption.Version.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Version</span></a>
Updates
2022-12-06 00:06:29 +00:00
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Functions</h3>
Updates
2023-09-21 08:59:21 +00:00
<div class="tsd-index-list"><a href="../functions/_waku_message_encryption.generatePrivateKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>generate<wbr/>Private<wbr/>Key</span></a>
<a href="../functions/_waku_message_encryption.generateSymmetricKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>generate<wbr/>Symmetric<wbr/>Key</span></a>
<a href="../functions/_waku_message_encryption.getPublicKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Public<wbr/>Key</span></a>
Updates
2022-12-06 00:06:29 +00:00
</div></section></section></section></div>
Updates
2023-09-21 08:59:21 +00:00
<div class="col-sidebar">
<div class="page-menu">
Updates
2022-12-06 00:06:29 +00:00
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Updates
2023-09-21 08:59:21 +00:00
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary>
Updates
2022-12-06 00:06:29 +00:00
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility">
<h4 class="uppercase">Member Visibility</h4><form>
<ul id="tsd-filter-options">
Updates
2023-09-21 08:59:21 +00:00
<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"><use href="#icon-checkbox"></use></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"><use href="#icon-checkbox"></use></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"><use href="#icon-checkbox"></use></svg><span>Inherited</span></label></li></ul></form></div>
Updates
2022-12-06 00:06:29 +00:00
<div class="tsd-theme-toggle">
Updates
2023-09-21 08:59:21 +00:00
<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="#icon-chevronDown"></use></svg>On This Page</h3></summary>
Updates
2022-12-06 00:06:29 +00:00
<div class="tsd-accordion-details">
<ul>
Updates
2023-09-21 08:59:21 +00:00
<li>
<ul>
<li><a href="#md:wakumessage-encryption"><span>@waku/message-<wbr/>encryption</span></a></li>
<li>
<ul>
<li><a href="#md:symmetric-encryption"><span>Symmetric <wbr/>Encryption</span></a></li>
<li><a href="#md:ecies-encryption"><span>ECIES <wbr/>Encryption</span></a></li></ul></li></ul></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Documentation</span></a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
Updates
2023-11-02 22:35:12 +00:00
<li><a href="_waku_interfaces.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/interfaces - v0.0.20</a></li>
<li><a href="_waku_utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/utils - v0.0.13</a></li>
Updates
2023-09-21 08:59:21 +00:00
<li><a href="_waku_proto.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/proto - v0.0.5</a></li>
Updates
2023-11-02 22:35:12 +00:00
<li><a href="_waku_enr.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/enr - v0.0.19</a></li>
<li><a href="_waku_core.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/core - v0.0.25</a></li>
<li><a href="_waku_relay.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/relay - v0.0.8</a></li>
<li><a href="_waku_message_hash.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/message-hash - v0.1.9</a></li>
<li><a href="_waku_peer_exchange.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/peer-exchange - v0.0.18</a></li>
<li><a href="_waku_dns_discovery.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/dns-discovery - v0.0.19</a></li>
<li><a href="_waku_message_encryption.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/message-encryption - v0.0.23</a></li>
<li><a href="_waku_sdk.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/sdk - v0.0.21</a></li>
Updates
2023-09-22 12:36:18 +00:00
<li><a href="_waku_browser_tests.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>@waku/browser-tests</a></li></ul></nav></div></div></div>
Updates
2023-09-21 08:59:21 +00:00
<div class="tsd-generator">
<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.120