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

15 lines
14 KiB
HTML
Raw Normal View History

Updates
2024-04-09 11:12:55 +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.26 | 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/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">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="../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="../index.html">Documentation</a></li><li><a href="_waku_message_encryption.html">@waku/message-encryption</a></li></ul><h1>Module @waku/message-encryption - v0.0.26</h1></div><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>
Updates
2023-09-21 08:59:21 +00:00
<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>
Updates
2023-11-27 23:43:06 +00:00
<pre><code class="language-typescript"><span class="hl-6">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">createDecoder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">createEncoder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">generateSymmetricKey</span><br/><span class="hl-1">} </span><span class="hl-6">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-3">const</span><span class="hl-1"> </span><span class="hl-5">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-3">const</span><span class="hl-1"> </span><span class="hl-5">encoder</span><span class="hl-1"> = </span><span class="hl-0">createEncoder</span><span class="hl-1">(</span><span class="hl-4">contentTopic</span><span class="hl-1">, </span><span class="hl-4">key</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// For example</span><br/><span class="hl-4">waku</span><span class="hl-1">.</span><span class="hl-4">lightPush</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-4">encoder</span><span class="hl-1">, { </span><span class="hl-4">payload</span><span class="hl-1"> });</span><br/><br/><span class="hl-7">// To receive messages, create a decoder</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">decoder</span><span class="hl-1"> = </span><span class="hl-0">createDecoder</span><span class="hl-1">(</span><span class="hl-4">contentTopic</span><span class="hl-1">, </span><span class="hl-4">key</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// For example</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">waku</span><span class="hl-1">.</span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">queryOrderedCallback</span><span class="hl-1">([</span><span class="hl-4">decoder</span><span class="hl-1">], (</span><span class="hl-4">msg</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// ...</span><br/><span class="hl-1">});</span>
Updates
2023-09-21 08:59:21 +00:00
</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>
Updates
2023-11-27 23:43:06 +00:00
<pre><code class="language-typescript"><span class="hl-6">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">createDecoder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">createEncoder</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">generatePrivateKey</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">getPublicKey</span><br/><span class="hl-1">} </span><span class="hl-6">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-3">const</span><span class="hl-1"> </span><span class="hl-5">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-3">const</span><span class="hl-1"> </span><span class="hl-5">publicKey</span><span class="hl-1"> = </span><span class="hl-0">getPublicKey</span><span class="hl-1">(</span><span class="hl-4">privateKey</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// To send messages, create an encoder</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">encoder</span><span class="hl-1"> = </span><span class="hl-0">createEncoder</span><span class="hl-1">(</span><span class="hl-4">contentTopic</span><span class="hl-1">, </span><span class="hl-4">publicKey</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// For example</span><br/><span class="hl-4">waku</span><span class="hl-1">.</span><span class="hl-4">lightPush</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-4">encoder</span><span class="hl-1">, { </span><span class="hl-4">payload</span><span class="hl-1"> });</span><br/><br/><span class="hl-7">// To receive messages, create a decoder</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">decoder</span><span class="hl-1"> = </span><span class="hl-0">createDecoder</span><span class="hl-1">(</span><span class="hl-4">contentTopic</span><span class="hl-1">, </span><span class="hl-4">privateKey</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// For example</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">waku</span><span class="hl-1">.</span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">queryOrderedCallback</span><span class="hl-1">([</span><span class="hl-4">decoder</span><span class="hl-1">], (</span><span class="hl-4">msg</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">// ...</span><br/><span class="hl-1">});</span>
Updates
2023-09-21 08:59:21 +00:00
</code><button>Copy</button></pre>
Updates
2024-04-07 07:56:46 +00:00
</section><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><div class="tsd-index-list"><a href="_waku_message_encryption.crypto.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4"></use></svg><span>crypto</span></a>
<a href="_waku_message_encryption.ecies.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#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="../assets/icons.svg#icon-4"></use></svg><span>symmetric</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><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="../assets/icons.svg#icon-128"></use></svg><span>Decoded<wbr/>Message</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><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="../assets/icons.svg#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="../assets/icons.svg#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="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Public<wbr/>Key</span></a>
</div></section></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></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="#md:wakumessage-encryption"><span>@waku/message-<wbr/>encryption</span></a><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></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="../assets/icons.svg#icon-1"></use></svg><span>Documentation</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>