@waku/message-encryption 0.0.24-678635e.0 → 0.0.24

package/CHANGELOG.md

@@ -68,6 +68,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     * @waku/interfaces bumped from 0.0.17 to 0.0.18
     * @waku/utils bumped from 0.0.10 to 0.0.11
 
+## [0.0.24](https://github.com/waku-org/js-waku/compare/message-encryption-v0.0.23...message-encryption-v0.0.24) (2024-01-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* add support for sharded pubsub topics & remove support for named pubsub topics ([#1697](https://github.com/waku-org/js-waku/issues/1697))
+* export crypto primitives ([#1728](https://github.com/waku-org/js-waku/issues/1728))
+* change all instances of `PubSubTopic` to `PubsubTopic` ([#1703](https://github.com/waku-org/js-waku/issues/1703))
+
+### Features
+
+* Add support for autosharded pubsub topics ([2bc3735](https://github.com/waku-org/js-waku/commit/2bc3735e4dcf85f06b3dee542024d7f20a40fac2))
+* Add support for sharded pubsub topics & remove support for named pubsub topics ([#1697](https://github.com/waku-org/js-waku/issues/1697)) ([4cf2ffe](https://github.com/waku-org/js-waku/commit/4cf2ffefa75e0571805036b71644d2cdd4fe3192))
+* Export crypto primitives ([#1728](https://github.com/waku-org/js-waku/issues/1728)) ([7eb3375](https://github.com/waku-org/js-waku/commit/7eb3375f50265240096d70bd2814549c8156a0eb))
+* New `verifySignature` ([2f67a3b](https://github.com/waku-org/js-waku/commit/2f67a3baffc085d61b057f9fdb5ab404bfd70a1b))
+
+
+### Miscellaneous Chores
+
+* Change all instances of `PubSubTopic` to `PubsubTopic` ([#1703](https://github.com/waku-org/js-waku/issues/1703)) ([3166a51](https://github.com/waku-org/js-waku/commit/3166a5135e77583da4fa722ee2aa47c785854a38))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @waku/core bumped from 0.0.25 to 0.0.26
+    * @waku/interfaces bumped from 0.0.20 to 0.0.21
+    * @waku/proto bumped from 0.0.5 to 0.0.6
+    * @waku/utils bumped from 0.0.13 to 0.0.14
+
 ## [0.0.23](https://github.com/waku-org/js-waku/compare/message-encryption-v0.0.22...message-encryption-v0.0.23) (2023-11-01)
 
 

package/bundle/crypto.js

@@ -0,0 +1 @@
+export { e as ecies, g as generatePrivateKey, a as generateSymmetricKey, b as getPublicKey, c as getSubtle, k as keccak256, r as randomBytes, s as sha256, d as sign, f as symmetric } from './symmetric-CXVjdTdV.js';

package/bundle/ecies-R65pUoo3.js

@@ -0,0 +1,124 @@
+import { L as Logger, d as determinePubsubTopic, D as DefaultPubsubTopic, W as WakuMessage, p as preCipher, e as encryptAsymmetric, a as Decoder$1, b as decryptAsymmetric, c as postCipher, f as DecodedMessage } from './encryption-zFGfcjHZ.js';
+import { V as Version, O as OneMillion, g as generatePrivateKey } from './symmetric-CXVjdTdV.js';
+
+const log = new Logger("message-encryption:ecies");
+class Encoder {
+    pubsubTopic;
+    contentTopic;
+    publicKey;
+    sigPrivKey;
+    ephemeral;
+    metaSetter;
+    constructor(pubsubTopic, contentTopic, publicKey, sigPrivKey, ephemeral = false, metaSetter) {
+        this.pubsubTopic = pubsubTopic;
+        this.contentTopic = contentTopic;
+        this.publicKey = publicKey;
+        this.sigPrivKey = sigPrivKey;
+        this.ephemeral = ephemeral;
+        this.metaSetter = metaSetter;
+        if (!contentTopic || contentTopic === "") {
+            throw new Error("Content topic must be specified");
+        }
+    }
+    async toWire(message) {
+        const protoMessage = await this.toProtoObj(message);
+        if (!protoMessage)
+            return;
+        return WakuMessage.encode(protoMessage);
+    }
+    async toProtoObj(message) {
+        const timestamp = message.timestamp ?? new Date();
+        const preparedPayload = await preCipher(message.payload, this.sigPrivKey);
+        const payload = await encryptAsymmetric(preparedPayload, this.publicKey);
+        const protoMessage = {
+            payload,
+            version: Version,
+            contentTopic: this.contentTopic,
+            timestamp: BigInt(timestamp.valueOf()) * OneMillion,
+            meta: undefined,
+            rateLimitProof: message.rateLimitProof,
+            ephemeral: this.ephemeral
+        };
+        if (this.metaSetter) {
+            const meta = this.metaSetter(protoMessage);
+            return { ...protoMessage, meta };
+        }
+        return protoMessage;
+    }
+}
+/**
+ * Creates an encoder that encrypts messages using ECIES for the given public,
+ * as defined in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
+ *
+ * An encoder is used to encode messages in the [`14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
+ * format to be sent over the Waku network. The resulting encoder can then be
+ * pass to { @link @waku/interfaces!ISender.send } or
+ * { @link @waku/interfaces!ISender.send } to automatically encrypt
+ * and encode outgoing messages.
+ * The payload can optionally be signed with the given private key as defined
+ * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
+ */
+function createEncoder({ pubsubTopic, pubsubTopicShardInfo, contentTopic, publicKey, sigPrivKey, ephemeral = false, metaSetter }) {
+    return new Encoder(determinePubsubTopic(contentTopic, pubsubTopic ?? pubsubTopicShardInfo), contentTopic, publicKey, sigPrivKey, ephemeral, metaSetter);
+}
+class Decoder extends Decoder$1 {
+    privateKey;
+    constructor(pubsubTopic, contentTopic, privateKey) {
+        super(pubsubTopic, contentTopic);
+        this.privateKey = privateKey;
+    }
+    async fromProtoObj(pubsubTopic, protoMessage) {
+        const cipherPayload = protoMessage.payload;
+        if (protoMessage.version !== Version) {
+            log.error("Failed to decrypt due to incorrect version, expected:", Version, ", actual:", protoMessage.version);
+            return;
+        }
+        let payload;
+        try {
+            payload = await decryptAsymmetric(cipherPayload, this.privateKey);
+        }
+        catch (e) {
+            log.error(`Failed to decrypt message using asymmetric decryption for contentTopic: ${this.contentTopic}`, e);
+            return;
+        }
+        if (!payload) {
+            log.error(`Failed to decrypt payload for contentTopic ${this.contentTopic}`);
+            return;
+        }
+        const res = postCipher(payload);
+        if (!res) {
+            log.error(`Failed to decode payload for contentTopic ${this.contentTopic}`);
+            return;
+        }
+        log.info("Message decrypted", protoMessage);
+        return new DecodedMessage(pubsubTopic, protoMessage, res.payload, res.sig?.signature, res.sig?.publicKey);
+    }
+}
+/**
+ * Creates a decoder that decrypts messages using ECIES, using the given private
+ * key as defined in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
+ *
+ * A decoder is used to decode messages from the [14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
+ * format when received from the Waku network. The resulting decoder can then be
+ * pass to { @link @waku/interfaces!IReceiver.subscribe } to automatically decrypt and
+ * decode incoming messages.
+ *
+ * @param contentTopic The resulting decoder will only decode messages with this content topic.
+ * @param privateKey The private key used to decrypt the message.
+ */
+function createDecoder(contentTopic, privateKey, pubsubTopicShardInfo = DefaultPubsubTopic) {
+    return new Decoder(determinePubsubTopic(contentTopic, pubsubTopicShardInfo), contentTopic, privateKey);
+}
+
+var ecies = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    createDecoder: createDecoder,
+    createEncoder: createEncoder,
+    decryptAsymmetric: decryptAsymmetric,
+    encryptAsymmetric: encryptAsymmetric,
+    generatePrivateKey: generatePrivateKey,
+    postCipher: postCipher,
+    preCipher: preCipher
+});
+
+export { createDecoder as a, createEncoder as c, ecies as e };

package/bundle/ecies.js

@@ -1 +1,3 @@
-export { b as createDecoder, c as createEncoder, g as generatePrivateKey, a as getPublicKey } from './index-62691783.js';
+export { b as decryptAsymmetric, e as encryptAsymmetric, c as postCipher, p as preCipher } from './encryption-zFGfcjHZ.js';
+export { g as generatePrivateKey } from './symmetric-CXVjdTdV.js';
+export { a as createDecoder, c as createEncoder } from './ecies-R65pUoo3.js';