logos-messaging/docs.waku.org
1
0
Fork 0
mirror of https://github.com/logos-messaging/docs.waku.org.git synced 2026-01-05 22:33:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

restore -> store renaming

Browse Source
This commit is contained in:
LordGhostX 2023-12-08 14:35:38 +01:00
parent bc4828004f
commit 37f900b4ce
No known key found for this signature in database
GPG Key ID: 520CC5DC4F94FCC7
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/guides/js-waku/message-encryption.md
View File

@ -48,7 +48,7 @@ const symKey = generateSymmetricKey();
To send encrypted messages, create a `Symmetric` message `encoder` and send the message as usual: To send encrypted messages, create a `Symmetric` message `encoder` and send the message as usual:
```js ```js title="Sender client"
import { createEncoder } from "@waku/message-encryption/symmetric"; import { createEncoder } from "@waku/message-encryption/symmetric";
// Create a symmetric message encoder // Create a symmetric message encoder
@ -63,7 +63,7 @@ await node.lightPush.send(encoder, { payload });
To decrypt the messages you receive, create a symmetric message `decoder` and process the messages as usual: To decrypt the messages you receive, create a symmetric message `decoder` and process the messages as usual:
```js ```js title="Receiver client"
import { createDecoder } from "@waku/message-encryption/symmetric"; import { createDecoder } from "@waku/message-encryption/symmetric";
// Create a symmetric message decoder // Create a symmetric message decoder
@ -97,7 +97,7 @@ const publicKey = getPublicKey(privateKey);
To send encrypted messages, create an `ECIES` message `encoder` with the public key and send the message as usual: To send encrypted messages, create an `ECIES` message `encoder` with the public key and send the message as usual:
```js ```js title="Sender client"
import { createEncoder } from "@waku/message-encryption/ecies"; import { createEncoder } from "@waku/message-encryption/ecies";
// Create an ECIES message encoder // Create an ECIES message encoder
@ -112,7 +112,7 @@ 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: To decrypt the messages you receive, create an `ECIES` message `decoder` with the private key and process the messages as usual:
```js ```js title="Receiver client"
import { createDecoder } from "@waku/message-encryption/ecies"; import { createDecoder } from "@waku/message-encryption/ecies";
// Create an ECIES message decoder // Create an ECIES message decoder
@ -140,7 +140,7 @@ Signing messages is only possible when encrypted, but if your application does n
The `sigPrivKey` option allows the `Symmetric` and `ECIES` message `encoders` to sign the message before encryption using an `ECDSA` private key: The `sigPrivKey` option allows the `Symmetric` and `ECIES` message `encoders` to sign the message before encryption using an `ECDSA` private key:
```js title="Alice (Sender) Client" ```js title="Alice (sender) client"
import { generatePrivateKey, getPublicKey } from "@waku/message-encryption"; import { generatePrivateKey, getPublicKey } from "@waku/message-encryption";
import { createEncoder as createSymmetricEncoder } from "@waku/message-encryption/symmetric"; import { createEncoder as createSymmetricEncoder } from "@waku/message-encryption/symmetric";
import { createEncoder as createECIESEncoder } from "@waku/message-encryption/ecies"; import { createEncoder as createECIESEncoder } from "@waku/message-encryption/ecies";
@ -175,7 +175,7 @@ await node.lightPush.send(ECIESEncoder, { payload });
You can extract the `signature` and its public key (`signaturePublicKey`) from the [DecodedMessage](https://js.waku.org/classes/_waku_message_encryption.DecodedMessage.html) and compare it with the expected public key to verify the message origin: You can extract the `signature` and its public key (`signaturePublicKey`) from the [DecodedMessage](https://js.waku.org/classes/_waku_message_encryption.DecodedMessage.html) and compare it with the expected public key to verify the message origin:
```js title="Bob (Receiver) Client" ```js title="Bob (receiver) client"
import { generatePrivateKey } from "@waku/message-encryption"; import { generatePrivateKey } from "@waku/message-encryption";
import { createEncoder } from "@waku/message-encryption/symmetric"; import { createEncoder } from "@waku/message-encryption/symmetric";
import { equals } from "uint8arrays/equals"; import { equals } from "uint8arrays/equals";
@ -209,11 +209,11 @@ const callback = (wakuMessage) => {
await subscription.subscribe([encoder], callback); await subscription.subscribe([encoder], callback);
``` ```
## Restoring encryption keys ## Storing encryption keys
We used randomly generated keys for encryption and message signing in the provided examples, but real-world applications require consistent keys among clients. Have a look at the [Key Pair Handling](https://github.com/waku-org/js-waku-examples/tree/master/examples/eth-pm/src/key_pair_handling) example, which demonstrates the secure storage and retrieval of key information from local storage using [Subtle Crypto](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto). We used randomly generated keys for encryption and message signing in the provided examples, but real-world applications require consistent keys among clients. Have a look at the [Key Pair Handling](https://github.com/waku-org/js-waku-examples/tree/master/examples/eth-pm/src/key_pair_handling) example, which demonstrates the secure storage and retrieval of key information from local storage using [Subtle Crypto](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto).
You can also use the [@waku/utils](https://www.npmjs.com/package/@waku/utils) package to convert keys into hexadecimal format: You can also use the [@waku/utils](https://www.npmjs.com/package/@waku/utils) package to store keys in hexadecimal format:
```js ```js
import { bytesToHex, hexToBytes } from "@waku/utils/bytes"; import { bytesToHex, hexToBytes } from "@waku/utils/bytes";
@ -222,7 +222,7 @@ import { bytesToHex, hexToBytes } from "@waku/utils/bytes";
const symKey = generateSymmetricKey(); const symKey = generateSymmetricKey();
const privateKey = generatePrivateKey(); const privateKey = generatePrivateKey();
// Convert the keys to hexadecimal format // Store the keys in hexadecimal format
const symKeyHex = bytesToHex(symKey); const symKeyHex = bytesToHex(symKey);
const privateKeyHex = bytesToHex(privateKey); const privateKeyHex = bytesToHex(privateKey);