js-waku/packages/message-encryption
Sasha 90fc9a3e94
chore: fix export of crypto submodule (#1849)
2024-02-14 01:57:52 +01:00
..
src chore: fix export of crypto submodule (#1849) 2024-02-14 01:57:52 +01:00
.eslintrc.cjs chore: upgrade libp2p and related deps (#1482) 2023-08-16 20:18:13 +05:30
.mocha.reporters.json chore: allure test reporting (#1668) 2023-10-23 17:53:56 +03:00
.mocharc.cjs chore: allure test reporting (#1668) 2023-10-23 17:53:56 +03:00
CHANGELOG.md chore: release master (#1721) 2024-01-10 23:27:39 +01:00
README.md chore: upgrade libp2p and related deps (#1482) 2023-08-16 20:18:13 +05:30
karma.conf.cjs feat: add Firefox and Webkit to karma (#1598) 2023-09-22 17:48:07 +02:00
package.json chore(deps)(deps-dev): bump mocha from 10.2.0 to 10.3.0 (#1847) 2024-02-13 22:21:57 +05:30
rollup.config.js chore: upgrade libp2p and related deps (#1482) 2023-08-16 20:18:13 +05:30
tsconfig.dev.json chore: merge tsconfig 2022-12-02 15:54:30 +11:00
tsconfig.json chore: merge tsconfig 2022-12-02 15:54:30 +11:00
typedoc.json chore: update typescript (#1528) 2023-09-21 10:57:37 +02:00

README.md

@waku/message-encryption

Provide Waku Message Version 1 payload encryption as defined in 26/WAKU2-PAYLOAD.

Symmetric Encryption

Symmetric encryption uses a unique key to encrypt and decrypt messages.

import {
  createDecoder,
  createEncoder,
  generateSymmetricKey
} from "@waku/message-encryption/symmetric";

// Generate a random key
const key = generateSymmetricKey();

// To send messages, create an encoder
const encoder = createEncoder(contentTopic, key);

// For example
waku.lightPush.push(encoder, { payload });

// To receive messages, create a decoder
const decoder = createDecoder(contentTopic, key);

// For example
await waku.store.queryOrderedCallback([decoder], (msg) => {
  // ...
});

ECIES Encryption

ECIES encryption enables encryption for a public key and decryption using a private key.

import {
  createDecoder,
  createEncoder,
  generatePrivateKey,
  getPublicKey
} from "@waku/message-encryption/ecies";

// Generate a random private key
const privateKey = generatePrivateKey();

// Keep the private key secure, provide the public key to the sender
const publicKey = getPublicKey(privateKey);

// To send messages, create an encoder
const encoder = createEncoder(contentTopic, publicKey);

// For example
waku.lightPush.push(encoder, { payload });

// To receive messages, create a decoder
const decoder = createDecoder(contentTopic, privateKey);

// For example
await waku.store.queryOrderedCallback([decoder], (msg) => {
  // ...
});