mirror of
https://github.com/logos-messaging/docs.waku.org.git
synced 2026-01-02 21:03:13 +00:00
add symmetric and ECIES encryption
This commit is contained in:
LordGhostX
parent
f355e66e55
commit
15612cbfbd
@ -85,6 +85,7 @@ Have a look at the quick start guide and comprehensive tutorials to learn how to
|
||||
| - | - |
|
||||
| [Send and Receive Messages Using Light Push and Filter](/guides/js-waku/light-send-receive) | Learn how to send and receive messages on light nodes using the [Light Push](/learn/concepts/protocols#light-push) and [Filter](/learn/concepts/protocols#filter) protocols |
|
||||
| [Retrieve Messages Using Store Protocol](/guides/js-waku/store-retrieve-messages) | Learn how to retrieve and filter historical messages on light nodes using the [Store protocol](/learn/concepts/protocols#store) |
|
||||
| [Encrypt and Decrypt Your Waku Messages](/guides/js-waku/message-encryption) | Learn how to use the [@waku/message-encryption](https://www.npmjs.com/package/@waku/message-encryption) package to encrypt and decrypt your messages |
|
||||
| [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) | Learn how to use the [@waku/react](https://www.npmjs.com/package/@waku/react) package seamlessly integrate `@waku/sdk` into a React application |
|
||||
| [Scaffold DApps Using @waku/create-app](/guides/js-waku/use-waku-create-app) | Learn how to use the [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) package to bootstrap your next `@waku/sdk` project from various example templates |
|
||||
| [Bootstrap Nodes and Discover Peers](/guides/js-waku/configure-discovery) | Learn how to bootstrap your node using [Static Peers](/learn/concepts/static-peers) and discover peers using [DNS Discovery](/learn/concepts/dns-discovery) |
|
||||
|
||||
@ -128,7 +128,7 @@ const callback = (wakuMessage) => {
|
||||
console.log(messageObj);
|
||||
};
|
||||
|
||||
// Create a filter subscription
|
||||
// Create a Filter subscription
|
||||
const subscription = await node.filter.createSubscription();
|
||||
|
||||
// Subscribe to content topics and process new messages
|
||||
|
||||
@ -3,7 +3,7 @@ title: Manage Your Filter Subscriptions
|
||||
hide_table_of_contents: true
|
||||
---
|
||||
|
||||
This guide provides detailed steps to manage [Filter](/learn/concepts/protocols#filter) subscriptions and handle node disconnections in your application. Have a look at the [Filter guide](/guides/js-waku/light-send-receive) for receiving messages with the `Light Push` and `Filter` protocol.
|
||||
This guide provides detailed steps to manage [Filter](/learn/concepts/protocols#filter) subscriptions and handle node disconnections in your application. Have a look at the [Send and Receive Messages Using Light Push and Filter](/guides/js-waku/light-send-receive) guide for using the `Light Push` and `Filter` protocols.
|
||||
|
||||
## Overview
|
||||
|
||||
|
||||
127
docs/guides/js-waku/message-encryption.md
Normal file
127
docs/guides/js-waku/message-encryption.md
Normal file
@ -0,0 +1,127 @@
|
||||
---
|
||||
title: Encrypt and Decrypt Your Waku Messages
|
||||
hide_table_of_contents: true
|
||||
---
|
||||
|
||||
This guide provides detailed steps to use the [@waku/message-encryption](https://www.npmjs.com/package/@waku/message-encryption) package to encrypt and decrypt your messages using [Waku message payload encryption](/learn/glossary#waku-message-payload-encryption) methods.
|
||||
|
||||
:::info
|
||||
Waku lacks protocol-level message encryption because it does not know the communication parties. This design choice enhances Waku's encryption flexibility, encouraging developers to freely use custom protocols or [Waku message payload encryption](/learn/glossary#waku-message-payload-encryption) methods.
|
||||
:::
|
||||
|
||||
## Installation
|
||||
|
||||
Install the `@waku/message-encryption` package using your preferred package manager:
|
||||
|
||||
```mdx-code-block
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
```
|
||||
|
||||
<Tabs groupId="package-manager">
|
||||
<TabItem value="npm" label="NPM">
|
||||
|
||||
```shell
|
||||
npm install @waku/message-encryption
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="yarn" label="Yarn">
|
||||
|
||||
```shell
|
||||
yarn add @waku/message-encryption
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Symmetric encryption
|
||||
|
||||
Symmetric encryption uses a single, shared key for message encryption and decryption. Use the `generateSymmetricKey()` function to generate a random symmetric key:
|
||||
|
||||
```js
|
||||
import { generateSymmetricKey } from "@waku/message-encryption";
|
||||
|
||||
// Generate a random symmetric key
|
||||
const symKey = generateSymmetricKey();
|
||||
```
|
||||
|
||||
To send encrypted messages, create a symmetric message `encoder` and send the message as usual:
|
||||
|
||||
```js
|
||||
import { createEncoder } from "@waku/message-encryption/symmetric";
|
||||
|
||||
// Create a symmetric message encoder
|
||||
const encoder = createEncoder({
|
||||
contentTopic: contentTopic, // message content topic
|
||||
symKey: symKey, // symmetric key for encrypting messages
|
||||
});
|
||||
|
||||
// Send the message using Light Push
|
||||
await node.lightPush.send(encoder, { payload });
|
||||
```
|
||||
|
||||
To decrypt the messages you receive, create a symmetric message `decoder` and process the messages as usual:
|
||||
|
||||
```js
|
||||
import { createDecoder } from "@waku/message-encryption/symmetric";
|
||||
|
||||
// Create a symmetric message decoder
|
||||
const decoder = createDecoder(contentTopic, symKey);
|
||||
|
||||
// Receive messages from a Filter subscription
|
||||
const subscription = await node.filter.createSubscription();
|
||||
await subscription.subscribe([decoder], callback);
|
||||
|
||||
// Retrieve messages from Store peers
|
||||
await node.store.queryWithOrderedCallback([decoder], callback);
|
||||
```
|
||||
|
||||
## ECIES encryption
|
||||
|
||||
ECIES encryption uses a public key for encryption and a private key for decryption. Use the `generatePrivateKey()` function to generate a random private key:
|
||||
|
||||
```js
|
||||
import { generatePrivateKey, getPublicKey } from "@waku/message-encryption";
|
||||
|
||||
// Generate a random private key, keep secure
|
||||
const privateKey = generatePrivateKey();
|
||||
|
||||
// Generate a public key from the private key, provide to the sender
|
||||
const publicKey = getPublicKey(privateKey);
|
||||
```
|
||||
|
||||
To send encrypted messages, create an ECIES message `encoder` with the public key and send the message as usual:
|
||||
|
||||
```js
|
||||
import { createEncoder } from "@waku/message-encryption/ecies";
|
||||
|
||||
// Create an ECIES message encoder
|
||||
const encoder = createEncoder({
|
||||
contentTopic: contentTopic, // message content topic
|
||||
publicKey: publicKey, // ECIES public key for encrypting messages
|
||||
});
|
||||
|
||||
// Send the message using Light Push
|
||||
await node.lightPush.send(encoder, { payload });
|
||||
```
|
||||
|
||||
To decrypt the messages you receive, create an ECIES message `decoder` with the private key and process the messages as usual:
|
||||
|
||||
```js
|
||||
import { createDecoder } from "@waku/message-encryption/ecies";
|
||||
|
||||
// Create an ECIES message decoder
|
||||
const decoder = createDecoder(contentTopic, privateKey);
|
||||
|
||||
// Receive messages from a Filter subscription
|
||||
const subscription = await node.filter.createSubscription();
|
||||
await subscription.subscribe([decoder], callback);
|
||||
|
||||
// Retrieve messages from Store peers
|
||||
await node.store.queryWithOrderedCallback([decoder], callback);
|
||||
```
|
||||
|
||||
:::tip Congratulations!
|
||||
You have successfully encrypted and decrypted your messages using `symmetric` and `ECIES` encryption methods. Have a look at the [flush-notes](https://github.com/waku-org/js-waku-examples/tree/master/examples/flush-notes) example for a working demo.
|
||||
:::
|
||||
@ -3,10 +3,6 @@ title: The Waku Network
|
||||
hide_table_of_contents: true
|
||||
---
|
||||
|
||||
:::info
|
||||
The public Waku Network replaces the previous experimental shared routing layer based on a default pubsub topic (`/waku/2/default-waku/proto`). If your project currently uses this or any other shared pubsub topics, we encourage you to migrate to the public Waku Network with built-in DoS protection, with built-in DoS protection, scalability and reasonable bandwidth usage.
|
||||
:::
|
||||
|
||||
The Waku Network is a shared p2p messaging network that is open-access, useful for generalized messaging, privacy-preserving, scalable and accessible even to resource-restricted devices. Some of the most prominent features include:
|
||||
|
||||
1. DoS/spam protection with privacy-preserving [Rate-Limiting Nullifiers](https://rfc.vac.dev/spec/64/#rln-rate-limiting).
|
||||
@ -16,6 +12,10 @@ The Waku Network is a shared p2p messaging network that is open-access, useful f
|
||||
|
||||
If you want to learn more about the Waku Network, the [WAKU2-NETWORK RFC](https://rfc.vac.dev/spec/64/) provides an in-depth look under the hood.
|
||||
|
||||
:::info
|
||||
The public Waku Network replaces the previous experimental shared routing layer based on a default pubsub topic (`/waku/2/default-waku/proto`). If your project currently uses this or any other shared pubsub topics, we encourage you to migrate to the public Waku Network with built-in DoS protection, with built-in DoS protection, scalability, and reasonable bandwidth usage.
|
||||
:::
|
||||
|
||||
## Why join the Waku network?
|
||||
|
||||
1. Applications or projects can build decentralized communication components on this network, gaining from the fault-tolerance of shared infrastructure, the out-of-the-box censorship resistance of a p2p network and the privacy-preservation of Waku protocols.
|
||||
|
||||
@ -150,6 +150,10 @@ const config = {
|
||||
href: "https://rfc.vac.dev/",
|
||||
label: "Vac RFCs",
|
||||
},
|
||||
{
|
||||
href: "https://github.com/waku-org/awesome-waku/",
|
||||
label: "Awesome Waku",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
@ -35,6 +35,7 @@ const sidebars = {
|
||||
items: [
|
||||
"guides/js-waku/light-send-receive",
|
||||
"guides/js-waku/store-retrieve-messages",
|
||||
"guides/js-waku/message-encryption",
|
||||
"guides/js-waku/use-waku-react",
|
||||
"guides/js-waku/use-waku-create-app",
|
||||
"guides/js-waku/configure-discovery",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user