@waku/message-encryption 0.0.1

package/dist/index.js

@@ -0,0 +1,325 @@
+import * as secp from "@noble/secp256k1";
+import { concat, hexToBytes } from "@waku/byte-utils";
+import { DecoderV0, MessageV0, proto, } from "@waku/core/lib/waku_message/version_0";
+import debug from "debug";
+import { Symmetric } from "./constants.js";
+import { generatePrivateKey, generateSymmetricKey, getPublicKey, keccak256, randomBytes, sign, } from "./crypto.js";
+import * as ecies from "./ecies.js";
+import * as symmetric from "./symmetric.js";
+const log = debug("waku:message:version-1");
+const FlagsLength = 1;
+const FlagMask = 3; // 0011
+const IsSignedMask = 4; // 0100
+const PaddingTarget = 256;
+const SignatureLength = 65;
+const OneMillion = BigInt(1000000);
+export { generatePrivateKey, generateSymmetricKey, getPublicKey };
+export const Version = 1;
+export class MessageV1 extends MessageV0 {
+    constructor(proto, decodedPayload, signature, signaturePublicKey) {
+        super(proto);
+        this.signature = signature;
+        this.signaturePublicKey = signaturePublicKey;
+        this._decodedPayload = decodedPayload;
+    }
+    get payload() {
+        return this._decodedPayload;
+    }
+}
+export class AsymEncoder {
+    constructor(contentTopic, publicKey, sigPrivKey) {
+        this.contentTopic = contentTopic;
+        this.publicKey = publicKey;
+        this.sigPrivKey = sigPrivKey;
+    }
+    async toWire(message) {
+        const protoMessage = await this.toProtoObj(message);
+        if (!protoMessage)
+            return;
+        return proto.WakuMessage.encode(protoMessage);
+    }
+    async toProtoObj(message) {
+        const timestamp = message.timestamp ?? new Date();
+        if (!message.payload) {
+            log("No payload to encrypt, skipping: ", message);
+            return;
+        }
+        const preparedPayload = await preCipher(message.payload, this.sigPrivKey);
+        const payload = await encryptAsymmetric(preparedPayload, this.publicKey);
+        return {
+            payload,
+            version: Version,
+            contentTopic: this.contentTopic,
+            timestamp: BigInt(timestamp.valueOf()) * OneMillion,
+            rateLimitProof: message.rateLimitProof,
+        };
+    }
+}
+export class SymEncoder {
+    constructor(contentTopic, symKey, sigPrivKey) {
+        this.contentTopic = contentTopic;
+        this.symKey = symKey;
+        this.sigPrivKey = sigPrivKey;
+    }
+    async toWire(message) {
+        const protoMessage = await this.toProtoObj(message);
+        if (!protoMessage)
+            return;
+        return proto.WakuMessage.encode(protoMessage);
+    }
+    async toProtoObj(message) {
+        const timestamp = message.timestamp ?? new Date();
+        if (!message.payload) {
+            log("No payload to encrypt, skipping: ", message);
+            return;
+        }
+        const preparedPayload = await preCipher(message.payload, this.sigPrivKey);
+        const payload = await encryptSymmetric(preparedPayload, this.symKey);
+        return {
+            payload,
+            version: Version,
+            contentTopic: this.contentTopic,
+            timestamp: BigInt(timestamp.valueOf()) * OneMillion,
+            rateLimitProof: message.rateLimitProof,
+        };
+    }
+}
+export class AsymDecoder extends DecoderV0 {
+    constructor(contentTopic, privateKey) {
+        super(contentTopic);
+        this.privateKey = privateKey;
+    }
+    async fromProtoObj(protoMessage) {
+        const cipherPayload = protoMessage.payload;
+        if (protoMessage.version !== Version) {
+            log("Failed to decrypt due to incorrect version, expected:", Version, ", actual:", protoMessage.version);
+            return;
+        }
+        let payload;
+        if (!cipherPayload) {
+            log(`No payload to decrypt for contentTopic ${this.contentTopic}`);
+            return;
+        }
+        try {
+            payload = await decryptAsymmetric(cipherPayload, this.privateKey);
+        }
+        catch (e) {
+            log(`Failed to decrypt message using asymmetric decryption for contentTopic: ${this.contentTopic}`, e);
+            return;
+        }
+        if (!payload) {
+            log(`Failed to decrypt payload for contentTopic ${this.contentTopic}`);
+            return;
+        }
+        const res = await postCipher(payload);
+        if (!res) {
+            log(`Failed to decode payload for contentTopic ${this.contentTopic}`);
+            return;
+        }
+        log("Message decrypted", protoMessage);
+        return new MessageV1(protoMessage, res.payload, res.sig?.signature, res.sig?.publicKey);
+    }
+}
+export class SymDecoder extends DecoderV0 {
+    constructor(contentTopic, symKey) {
+        super(contentTopic);
+        this.symKey = symKey;
+    }
+    async fromProtoObj(protoMessage) {
+        const cipherPayload = protoMessage.payload;
+        if (protoMessage.version !== Version) {
+            log("Failed to decrypt due to incorrect version, expected:", Version, ", actual:", protoMessage.version);
+            return;
+        }
+        let payload;
+        if (!cipherPayload) {
+            log(`No payload to decrypt for contentTopic ${this.contentTopic}`);
+            return;
+        }
+        try {
+            payload = await decryptSymmetric(cipherPayload, this.symKey);
+        }
+        catch (e) {
+            log(`Failed to decrypt message using asymmetric decryption for contentTopic: ${this.contentTopic}`, e);
+            return;
+        }
+        if (!payload) {
+            log(`Failed to decrypt payload for contentTopic ${this.contentTopic}`);
+            return;
+        }
+        const res = await postCipher(payload);
+        if (!res) {
+            log(`Failed to decode payload for contentTopic ${this.contentTopic}`);
+            return;
+        }
+        log("Message decrypted", protoMessage);
+        return new MessageV1(protoMessage, res.payload, res.sig?.signature, res.sig?.publicKey);
+    }
+}
+function getSizeOfPayloadSizeField(message) {
+    const messageDataView = new DataView(message.buffer);
+    return messageDataView.getUint8(0) & FlagMask;
+}
+function getPayloadSize(message, sizeOfPayloadSizeField) {
+    let payloadSizeBytes = message.slice(1, 1 + sizeOfPayloadSizeField);
+    // int 32 == 4 bytes
+    if (sizeOfPayloadSizeField < 4) {
+        // If less than 4 bytes pad right (Little Endian).
+        payloadSizeBytes = concat([payloadSizeBytes, new Uint8Array(4 - sizeOfPayloadSizeField)], 4);
+    }
+    const payloadSizeDataView = new DataView(payloadSizeBytes.buffer);
+    return payloadSizeDataView.getInt32(0, true);
+}
+function isMessageSigned(message) {
+    const messageDataView = new DataView(message.buffer);
+    return (messageDataView.getUint8(0) & IsSignedMask) == IsSignedMask;
+}
+/**
+ * Proceed with Asymmetric encryption of the data as per [26/WAKU-PAYLOAD](https://rfc.vac.dev/spec/26/).
+ * The data MUST be flags | payload-length | payload | [signature].
+ * The returned result  can be set to `WakuMessage.payload`.
+ *
+ * @internal
+ */
+export async function encryptAsymmetric(data, publicKey) {
+    return ecies.encrypt(hexToBytes(publicKey), data);
+}
+/**
+ * Proceed with Asymmetric decryption of the data as per [26/WAKU-PAYLOAD](https://rfc.vac.dev/spec/26/).
+ * The returned data is expected to be `flags | payload-length | payload | [signature]`.
+ *
+ * @internal
+ */
+export async function decryptAsymmetric(payload, privKey) {
+    return ecies.decrypt(privKey, payload);
+}
+/**
+ * Proceed with Symmetric encryption of the data as per [26/WAKU-PAYLOAD](https://rfc.vac.dev/spec/26/).
+ *
+ * @param data The data to encrypt, expected to be `flags | payload-length | payload | [signature]`.
+ * @param key The key to use for encryption.
+ * @returns The decrypted data, `cipherText | tag | iv` and can be set to `WakuMessage.payload`.
+ *
+ * @internal
+ */
+export async function encryptSymmetric(data, key) {
+    const iv = symmetric.generateIv();
+    // Returns `cipher | tag`
+    const cipher = await symmetric.encrypt(iv, hexToBytes(key), data);
+    return concat([cipher, iv]);
+}
+/**
+ * Proceed with Symmetric decryption of the data as per [26/WAKU-PAYLOAD](https://rfc.vac.dev/spec/26/).
+ *
+ * @param payload The cipher data, it is expected to be `cipherText | tag | iv`.
+ * @param key The key to use for decryption.
+ * @returns The decrypted data, expected to be `flags | payload-length | payload | [signature]`.
+ *
+ * @internal
+ */
+export async function decryptSymmetric(payload, key) {
+    const ivStart = payload.length - Symmetric.ivSize;
+    const cipher = payload.slice(0, ivStart);
+    const iv = payload.slice(ivStart);
+    return symmetric.decrypt(iv, hexToBytes(key), cipher);
+}
+/**
+ * Computes the flags & auxiliary-field as per [26/WAKU-PAYLOAD](https://rfc.vac.dev/spec/26/).
+ */
+function addPayloadSizeField(msg, payload) {
+    const fieldSize = computeSizeOfPayloadSizeField(payload);
+    let field = new Uint8Array(4);
+    const fieldDataView = new DataView(field.buffer);
+    fieldDataView.setUint32(0, payload.length, true);
+    field = field.slice(0, fieldSize);
+    msg = concat([msg, field]);
+    msg[0] |= fieldSize;
+    return msg;
+}
+/**
+ * Returns the size of the auxiliary-field which in turns contains the payload size
+ */
+function computeSizeOfPayloadSizeField(payload) {
+    let s = 1;
+    for (let i = payload.length; i >= 256; i /= 256) {
+        s++;
+    }
+    return s;
+}
+function validateDataIntegrity(value, expectedSize) {
+    if (value.length !== expectedSize) {
+        return false;
+    }
+    return expectedSize <= 3 || value.findIndex((i) => i !== 0) !== -1;
+}
+function getSignature(message) {
+    return message.slice(message.length - SignatureLength, message.length);
+}
+function getHash(message, isSigned) {
+    if (isSigned) {
+        return keccak256(message.slice(0, message.length - SignatureLength));
+    }
+    return keccak256(message);
+}
+function ecRecoverPubKey(messageHash, signature) {
+    const recoveryDataView = new DataView(signature.slice(64).buffer);
+    const recovery = recoveryDataView.getUint8(0);
+    const _signature = secp.Signature.fromCompact(signature.slice(0, 64));
+    return secp.recoverPublicKey(messageHash, _signature, recovery, false);
+}
+/**
+ * Prepare the payload pre-encryption.
+ *
+ * @internal
+ * @returns The encoded payload, ready for encryption using {@link encryptAsymmetric}
+ * or {@link encryptSymmetric}.
+ */
+export async function preCipher(messagePayload, sigPrivKey) {
+    let envelope = new Uint8Array([0]); // No flags
+    envelope = addPayloadSizeField(envelope, messagePayload);
+    envelope = concat([envelope, messagePayload]);
+    // Calculate padding:
+    let rawSize = FlagsLength +
+        computeSizeOfPayloadSizeField(messagePayload) +
+        messagePayload.length;
+    if (sigPrivKey) {
+        rawSize += SignatureLength;
+    }
+    const remainder = rawSize % PaddingTarget;
+    const paddingSize = PaddingTarget - remainder;
+    const pad = randomBytes(paddingSize);
+    if (!validateDataIntegrity(pad, paddingSize)) {
+        throw new Error("failed to generate random padding of size " + paddingSize);
+    }
+    envelope = concat([envelope, pad]);
+    if (sigPrivKey) {
+        envelope[0] |= IsSignedMask;
+        const hash = keccak256(envelope);
+        const bytesSignature = await sign(hash, sigPrivKey);
+        envelope = concat([envelope, bytesSignature]);
+    }
+    return envelope;
+}
+/**
+ * Decode a decrypted payload.
+ *
+ * @internal
+ */
+export function postCipher(message) {
+    const sizeOfPayloadSizeField = getSizeOfPayloadSizeField(message);
+    if (sizeOfPayloadSizeField === 0)
+        return;
+    const payloadSize = getPayloadSize(message, sizeOfPayloadSizeField);
+    const payloadStart = 1 + sizeOfPayloadSizeField;
+    const payload = message.slice(payloadStart, payloadStart + payloadSize);
+    const isSigned = isMessageSigned(message);
+    let sig;
+    if (isSigned) {
+        const signature = getSignature(message);
+        const hash = getHash(message, isSigned);
+        const publicKey = ecRecoverPubKey(hash, signature);
+        sig = { signature, publicKey };
+    }
+    return { payload, sig };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EACL,SAAS,EACT,SAAS,EACT,KAAK,GACN,MAAM,uCAAuC,CAAC;AAQ/C,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACT,WAAW,EACX,IAAI,GACL,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAE5C,MAAM,GAAG,GAAG,KAAK,CAAC,wBAAwB,CAAC,CAAC;AAE5C,MAAM,WAAW,GAAG,CAAC,CAAC;AACtB,MAAM,QAAQ,GAAG,CAAC,CAAC,CAAC,OAAO;AAC3B,MAAM,YAAY,GAAG,CAAC,CAAC,CAAC,OAAO;AAC/B,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,UAAU,GAAG,MAAM,CAAC,OAAS,CAAC,CAAC;AAErC,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,YAAY,EAAE,CAAC;AAElE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC;AAOzB,MAAM,OAAO,SAAU,SAAQ,SAAS;IAGtC,YACE,KAAwB,EACxB,cAA0B,EACnB,SAAsB,EACtB,kBAA+B;QAEtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAHN,cAAS,GAAT,SAAS,CAAa;QACtB,uBAAkB,GAAlB,kBAAkB,CAAa;QAGtC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IACxC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,WAAW;IACtB,YACS,YAAoB,EACnB,SAAqB,EACrB,UAAuB;QAFxB,iBAAY,GAAZ,YAAY,CAAQ;QACnB,cAAS,GAAT,SAAS,CAAY;QACrB,eAAU,GAAV,UAAU,CAAa;IAC9B,CAAC;IAEJ,KAAK,CAAC,MAAM,CAAC,OAAyB;QACpC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,YAAY;YAAE,OAAO;QAE1B,OAAO,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,UAAU,CACd,OAAyB;QAEzB,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;QAClD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACpB,GAAG,CAAC,mCAAmC,EAAE,OAAO,CAAC,CAAC;YAClD,OAAO;SACR;QACD,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE1E,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEzE,OAAO;YACL,OAAO;YACP,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,UAAU;YACnD,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,UAAU;IACrB,YACS,YAAoB,EACnB,MAAkB,EAClB,UAAuB;QAFxB,iBAAY,GAAZ,YAAY,CAAQ;QACnB,WAAM,GAAN,MAAM,CAAY;QAClB,eAAU,GAAV,UAAU,CAAa;IAC9B,CAAC;IAEJ,KAAK,CAAC,MAAM,CAAC,OAAyB;QACpC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,YAAY;YAAE,OAAO;QAE1B,OAAO,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,UAAU,CACd,OAAyB;QAEzB,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;QAClD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACpB,GAAG,CAAC,mCAAmC,EAAE,OAAO,CAAC,CAAC;YAClD,OAAO;SACR;QACD,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE1E,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACrE,OAAO;YACL,OAAO;YACP,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,UAAU;YACnD,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,SAAS;IACxC,YAAY,YAAoB,EAAU,UAAsB;QAC9D,KAAK,CAAC,YAAY,CAAC,CAAC;QADoB,eAAU,GAAV,UAAU,CAAY;IAEhE,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,YAA0B;QAE1B,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC;QAE3C,IAAI,YAAY,CAAC,OAAO,KAAK,OAAO,EAAE;YACpC,GAAG,CACD,uDAAuD,EACvD,OAAO,EACP,WAAW,EACX,YAAY,CAAC,OAAO,CACrB,CAAC;YACF,OAAO;SACR;QAED,IAAI,OAAO,CAAC;QACZ,IAAI,CAAC,aAAa,EAAE;YAClB,GAAG,CAAC,0CAA0C,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACnE,OAAO;SACR;QAED,IAAI;YACF,OAAO,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SACnE;QAAC,OAAO,CAAC,EAAE;YACV,GAAG,CACD,2EAA2E,IAAI,CAAC,YAAY,EAAE,EAC9F,CAAC,CACF,CAAC;YACF,OAAO;SACR;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,GAAG,CAAC,8CAA8C,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACvE,OAAO;SACR;QAED,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,CAAC,6CAA6C,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACtE,OAAO;SACR;QAED,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;QACvC,OAAO,IAAI,SAAS,CAClB,YAAY,EACZ,GAAG,CAAC,OAAO,EACX,GAAG,CAAC,GAAG,EAAE,SAAS,EAClB,GAAG,CAAC,GAAG,EAAE,SAAS,CACnB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,UAAW,SAAQ,SAAS;IACvC,YAAY,YAAoB,EAAU,MAAkB;QAC1D,KAAK,CAAC,YAAY,CAAC,CAAC;QADoB,WAAM,GAAN,MAAM,CAAY;IAE5D,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,YAA0B;QAE1B,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC;QAE3C,IAAI,YAAY,CAAC,OAAO,KAAK,OAAO,EAAE;YACpC,GAAG,CACD,uDAAuD,EACvD,OAAO,EACP,WAAW,EACX,YAAY,CAAC,OAAO,CACrB,CAAC;YACF,OAAO;SACR;QAED,IAAI,OAAO,CAAC;QACZ,IAAI,CAAC,aAAa,EAAE;YAClB,GAAG,CAAC,0CAA0C,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACnE,OAAO;SACR;QAED,IAAI;YACF,OAAO,GAAG,MAAM,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SAC9D;QAAC,OAAO,CAAC,EAAE;YACV,GAAG,CACD,2EAA2E,IAAI,CAAC,YAAY,EAAE,EAC9F,CAAC,CACF,CAAC;YACF,OAAO;SACR;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,GAAG,CAAC,8CAA8C,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACvE,OAAO;SACR;QAED,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,CAAC,6CAA6C,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACtE,OAAO;SACR;QAED,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;QACvC,OAAO,IAAI,SAAS,CAClB,YAAY,EACZ,GAAG,CAAC,OAAO,EACX,GAAG,CAAC,GAAG,EAAE,SAAS,EAClB,GAAG,CAAC,GAAG,EAAE,SAAS,CACnB,CAAC;IACJ,CAAC;CACF;AAED,SAAS,yBAAyB,CAAC,OAAmB;IACpD,MAAM,eAAe,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;AAChD,CAAC;AAED,SAAS,cAAc,CACrB,OAAmB,EACnB,sBAA8B;IAE9B,IAAI,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,sBAAsB,CAAC,CAAC;IACpE,oBAAoB;IACpB,IAAI,sBAAsB,GAAG,CAAC,EAAE;QAC9B,kDAAkD;QAClD,gBAAgB,GAAG,MAAM,CACvB,CAAC,gBAAgB,EAAE,IAAI,UAAU,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,EAC9D,CAAC,CACF,CAAC;KACH;IACD,MAAM,mBAAmB,GAAG,IAAI,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClE,OAAO,mBAAmB,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,eAAe,CAAC,OAAmB;IAC1C,MAAM,eAAe,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,IAAI,YAAY,CAAC;AACtE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,IAAgB,EAChB,SAA8B;IAE9B,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;AACpD,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAmB,EACnB,OAAmB;IAEnB,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,IAAgB,EAChB,GAAwB;IAExB,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;IAElC,yBAAyB;IACzB,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;IAClE,OAAO,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAmB,EACnB,GAAwB;IAExB,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;IAClD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACzC,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAElC,OAAO,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;AACxD,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAAC,GAAe,EAAE,OAAmB;IAC/D,MAAM,SAAS,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;IACzD,IAAI,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC9B,MAAM,aAAa,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjD,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IAClC,GAAG,GAAG,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3B,GAAG,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;IACpB,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;GAEG;AACH,SAAS,6BAA6B,CAAC,OAAmB;IACxD,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE;QAC/C,CAAC,EAAE,CAAC;KACL;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,qBAAqB,CAC5B,KAAiB,EACjB,YAAoB;IAEpB,IAAI,KAAK,CAAC,MAAM,KAAK,YAAY,EAAE;QACjC,OAAO,KAAK,CAAC;KACd;IAED,OAAO,YAAY,IAAI,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,YAAY,CAAC,OAAmB;IACvC,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,eAAe,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,OAAO,CAAC,OAAmB,EAAE,QAAiB;IACrD,IAAI,QAAQ,EAAE;QACZ,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;KACtE;IACD,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,eAAe,CACtB,WAAuB,EACvB,SAAqB;IAErB,MAAM,gBAAgB,GAAG,IAAI,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IAClE,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAEtE,OAAO,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,cAA0B,EAC1B,UAAuB;IAEvB,IAAI,QAAQ,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW;IAC/C,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IACzD,QAAQ,GAAG,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC;IAE9C,qBAAqB;IACrB,IAAI,OAAO,GACT,WAAW;QACX,6BAA6B,CAAC,cAAc,CAAC;QAC7C,cAAc,CAAC,MAAM,CAAC;IAExB,IAAI,UAAU,EAAE;QACd,OAAO,IAAI,eAAe,CAAC;KAC5B;IAED,MAAM,SAAS,GAAG,OAAO,GAAG,aAAa,CAAC;IAC1C,MAAM,WAAW,GAAG,aAAa,GAAG,SAAS,CAAC;IAC9C,MAAM,GAAG,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IAErC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE;QAC5C,MAAM,IAAI,KAAK,CAAC,4CAA4C,GAAG,WAAW,CAAC,CAAC;KAC7E;IAED,QAAQ,GAAG,MAAM,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;IACnC,IAAI,UAAU,EAAE;QACd,QAAQ,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC;QAC5B,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACpD,QAAQ,GAAG,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC;KAC/C;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,OAAmB;IAEnB,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAClE,IAAI,sBAAsB,KAAK,CAAC;QAAE,OAAO;IAEzC,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;IACpE,MAAM,YAAY,GAAG,CAAC,GAAG,sBAAsB,CAAC;IAChD,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,GAAG,WAAW,CAAC,CAAC;IAExE,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAE1C,IAAI,GAAG,CAAC;IACR,IAAI,QAAQ,EAAE;QACZ,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACnD,GAAG,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;KAChC;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAC1B,CAAC"}

package/dist/symmetric.d.ts

@@ -0,0 +1,3 @@
+export declare function encrypt(iv: Uint8Array, key: Uint8Array, clearText: Uint8Array): Promise<Uint8Array>;
+export declare function decrypt(iv: Uint8Array, key: Uint8Array, cipherText: Uint8Array): Promise<Uint8Array>;
+export declare function generateIv(): Uint8Array;

package/dist/symmetric.js

@@ -0,0 +1,18 @@
+import { Symmetric } from "./constants";
+import { getSubtle, randomBytes } from "./crypto.js";
+export async function encrypt(iv, key, clearText) {
+    return getSubtle()
+        .importKey("raw", key, Symmetric.algorithm, false, ["encrypt"])
+        .then((cryptoKey) => getSubtle().encrypt({ iv, ...Symmetric.algorithm }, cryptoKey, clearText))
+        .then((cipher) => new Uint8Array(cipher));
+}
+export async function decrypt(iv, key, cipherText) {
+    return getSubtle()
+        .importKey("raw", key, Symmetric.algorithm, false, ["decrypt"])
+        .then((cryptoKey) => getSubtle().decrypt({ iv, ...Symmetric.algorithm }, cryptoKey, cipherText))
+        .then((clear) => new Uint8Array(clear));
+}
+export function generateIv() {
+    return randomBytes(Symmetric.ivSize);
+}
+//# sourceMappingURL=symmetric.js.map

package/dist/symmetric.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"symmetric.js","sourceRoot":"","sources":["../src/symmetric.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAErD,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,EAAc,EACd,GAAe,EACf,SAAqB;IAErB,OAAO,SAAS,EAAE;SACf,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,CAAC;SAC9D,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAClB,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,SAAS,CAAC,CAC1E;SACA,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,EAAc,EACd,GAAe,EACf,UAAsB;IAEtB,OAAO,SAAS,EAAE;SACf,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,CAAC;SAC9D,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAClB,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,UAAU,CAAC,CAC3E;SACA,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,OAAO,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC"}

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "@waku/message-encryption",
+  "version": "0.0.1",
+  "description": "Waku Message Payload Encryption",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "type": "module",
+  "author": "Waku Team",
+  "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/message-encryption#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/waku-org/js-waku.git"
+  },
+  "bugs": {
+    "url": "https://github.com/waku-org/js-waku/issues"
+  },
+  "license": "MIT OR Apache-2.0",
+  "keywords": [
+    "waku",
+    "decentralized",
+    "secure",
+    "communication",
+    "web3",
+    "ethereum",
+    "dapps",
+    "privacy"
+  ],
+  "scripts": {
+    "build": "run-s build:**",
+    "build:esm": "tsc",
+    "build:bundle": "rollup --config rollup.config.js",
+    "fix": "run-s fix:*",
+    "fix:prettier": "prettier . --write",
+    "fix:lint": "eslint src --ext .ts --ext .cjs --fix",
+    "check": "run-s check:*",
+    "check:lint": "eslint src --ext .ts",
+    "check:prettier": "prettier . --list-different",
+    "check:spelling": "cspell \"{README.md,src/**/*.ts}\"",
+    "check:tsc": "tsc -p tsconfig.dev.json",
+    "test": "run-s test:*",
+    "test:node": "TS_NODE_PROJECT=./tsconfig.dev.json mocha",
+    "test:browser": "karma start karma.conf.cjs",
+    "prepublish": "npm run build",
+    "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build",
+    "release": "semantic-release"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "browser": {
+    "crypto": false
+  },
+  "dependencies": {
+    "@noble/secp256k1": "^1.3.4",
+    "@waku/byte-utils": "*",
+    "@waku/interfaces": "*",
+    "js-sha3": "^0.8.0"
+  },
+  "devDependencies": {
+    "fast-check": "^2.14.0",
+    "@rollup/plugin-commonjs": "^22.0.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@typescript-eslint/eslint-plugin": "^5.8.1",
+    "@typescript-eslint/parser": "^5.8.1",
+    "chai": "^4.3.6",
+    "cspell": "^5.14.0",
+    "eslint": "^8.6.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-functional": "^4.0.2",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-prettier": "^4.0.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.1.1",
+    "rollup": "^2.75.0",
+    "ts-loader": "^9.4.1",
+    "typescript": "^4.6.3"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
+  },
+  "files": [
+    "dist",
+    "bundle",
+    "src/**/*.ts",
+    "!**/*.spec.*",
+    "!**/*.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ]
+}

package/src/constants.ts

@@ -0,0 +1,10 @@
+export const Symmetric = {
+  keySize: 32,
+  ivSize: 12,
+  tagSize: 16,
+  algorithm: { name: "AES-GCM", length: 128 },
+};
+
+export const Asymmetric = {
+  keySize: 32,
+};

package/src/crypto.ts

@@ -0,0 +1,76 @@
+import nodeCrypto from "crypto";
+
+import * as secp from "@noble/secp256k1";
+import { concat } from "@waku/byte-utils";
+import sha3 from "js-sha3";
+
+import { Asymmetric, Symmetric } from "./constants.js";
+
+declare const self: Record<string, any> | undefined;
+const crypto: { node?: any; web?: any } = {
+  node: nodeCrypto,
+  web: typeof self === "object" && "crypto" in self ? self.crypto : undefined,
+};
+
+export function getSubtle(): SubtleCrypto {
+  if (crypto.web) {
+    return crypto.web.subtle;
+  } else if (crypto.node) {
+    return crypto.node.webcrypto.subtle;
+  } else {
+    throw new Error(
+      "The environment doesn't have Crypto Subtle API (if in the browser, be sure to use to be in a secure context, ie, https)"
+    );
+  }
+}
+
+export const randomBytes = secp.utils.randomBytes;
+export const sha256 = secp.utils.sha256;
+
+/**
+ * Generate a new private key to be used for asymmetric encryption.
+ *
+ * Use {@link getPublicKey} to get the corresponding Public Key.
+ */
+export function generatePrivateKey(): Uint8Array {
+  return randomBytes(Asymmetric.keySize);
+}
+
+/**
+ * Generate a new symmetric key to be used for symmetric encryption.
+ */
+export function generateSymmetricKey(): Uint8Array {
+  return randomBytes(Symmetric.keySize);
+}
+
+/**
+ * Return the public key for the given private key, to be used for asymmetric
+ * encryption.
+ */
+export const getPublicKey = secp.getPublicKey;
+
+/**
+ * ECDSA Sign a message with the given private key.
+ *
+ *  @param message The message to sign, usually a hash.
+ *  @param privateKey The ECDSA private key to use to sign the message.
+ *
+ *  @returns The signature and the recovery id concatenated.
+ */
+export async function sign(
+  message: Uint8Array,
+  privateKey: Uint8Array
+): Promise<Uint8Array> {
+  const [signature, recoveryId] = await secp.sign(message, privateKey, {
+    recovered: true,
+    der: false,
+  });
+  return concat(
+    [signature, new Uint8Array([recoveryId])],
+    signature.length + 1
+  );
+}
+
+export function keccak256(input: Uint8Array): Uint8Array {
+  return new Uint8Array(sha3.keccak256.arrayBuffer(input));
+}