@enc-protocol/plugin-ecdh-envelope 0.9.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Zhenyu Sun, Tomoya Nagasawa, and WEAVEDB LTD.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,60 @@
+# @enc-protocol/plugin-ecdh-envelope
+
+**The spec-compliant `ecdh-envelope` implementation** (`EcdhEnvelopeCryptoFn`), per
+[`spec/app/plugins/ecdh-envelope.md`](https://github.com/enc-protocol/spec) — the
+complete wire-and-key contract for one-shot sender→recipient confidentiality on
+Personal-enclave `notice` content (group/DM invites), plus the inner `handoff`
+sub-encryption that carries a group's bootstrap `root_secret`.
+
+## Source = codegen
+
+The crypto is **generated from the Lean spec** (`Enc.DSL.Modules.EcdhEnvelope` →
+`@enc-protocol/core/ecdh-envelope.js`) and composes only the verified core
+primitives — **secp256k1 `ecdh`, HKDF-SHA256 `deriveKey`, XChaCha20-Poly1305
+(24-byte nonce)**. There is no hand-rolled `@noble`. This package is a thin
+adapter: it re-exports the codegen API and declares the plugin-contract slot.
+
+## Primitives (spec §1, fixed)
+
+| | |
+|---|---|
+| AEAD | XChaCha20-Poly1305 — 24-byte nonce, 16-byte tag |
+| KDF | HKDF-SHA-256 — empty salt, info = ASCII domain separator, L = 32 |
+| ECDH | secp256k1 — 32-byte x-coordinate, x-only inputs 0x02-extended |
+| Domain separators | `enc:personal:notice` (outer), `enc:personal:notice:epoch` (handoff) |
+
+## API
+
+```js
+import {
+  ecdhEnvelopeSeal, ecdhEnvelopeOpen,
+  ecdhEnvelopeWrapHandoff, ecdhEnvelopeUnwrapHandoff,
+} from '@enc-protocol/plugin-ecdh-envelope'
+
+// Sender seals a notice to the recipient's operating pubkey (hex, x-only):
+const envelope = ecdhEnvelopeSeal(senderOpPriv, recipientOpPubHex, payload)
+// → { ciphertext, nonce, sender_pub, scheme: 'personal:notice', encrypted: true }
+
+// Recipient opens it under their operating priv (tries each op-key):
+const payload = ecdhEnvelopeOpen(myOpPriv, envelope)
+
+// Group invite: wrap the 32-byte root_secret as a handoff entry:
+const handoff = ecdhEnvelopeWrapHandoff(committerPriv, recipientOpPubHex, rootSecret)
+const secret  = ecdhEnvelopeUnwrapHandoff(myOpPriv, myOpPubHex, handoff) // 32 bytes | null
+```
+
+`*WithNonce` variants take an explicit 24-byte nonce for deterministic
+(byte-for-byte) output — used by the §9 compliance vectors.
+
+## Compliance
+
+`test/ecdh-envelope.test.mjs` runs the spec's §9 KAT vectors (byte-for-byte
+reference envelope + handoff parent/sub distinctness + wrong-sender reject +
+wrong-recipient skip) and the §7 rejection rules. Vectors fixture:
+`test/ecdh-envelope.vectors.json`.
+
+## Not to be confused with
+
+- `plugin-envelope-dm` — a **non-canonical** X25519 + ChaCha20-Poly1305(12) *demo*
+  for DM content; a different construction and wire format, **not** this spec.
+- `plugin-dm-ratchet` (`ratchet-pair`) — the canonical forward-secret DM plugin.

package/ecdh-envelope.js

@@ -0,0 +1,46 @@
+/**
+ * ecdh-envelope.js
+ *
+ * ENC Protocol — EncDSL v4 generated
+ *
+ * Spec-compliant ecdh-envelope (spec-formatted/app/plugins/ecdh-envelope.md): one-shot
+ * sender→recipient Personal-notice confidentiality + group-invite handoff. Composes ONLY
+ * the verified ./crypto.js (ecdh secp256k1 / deriveKey HKDF-SHA256 / XChaCha20-Poly1305
+ * 24-byte nonce) — byte-for-byte per the §1 primitives + §2 domain separators. The
+ * `*WithNonce` entry points are deterministic (for the §9 KAT vectors).
+ */
+
+
+import { ecdh, deriveKey, derivePublicKey, encryptSeparatedWithNonce, decryptSeparated, encryptSeparatedBytesWithNonce, decryptSeparatedBytes, csprngBytes, bytesToHex, hexToBytes } from '@enc-protocol/core/crypto.js'
+
+export function ecdhEnvelopeIsEnvelope(content) {
+  return (() => { return !!content && typeof content === 'object' && typeof content.ciphertext === 'string' && typeof content.nonce === 'string' && typeof content.sender_pub === 'string' && content.scheme === 'personal:notice' && content.encrypted === true; })()
+}
+
+export function ecdhEnvelopeValidatePayload(payload) {
+  return (() => { if (!payload || typeof payload !== 'object') throw new Error('ecdh-envelope: payload is not an object'); if (typeof payload.kind !== 'string' || typeof payload.enclave_id !== 'string' || typeof payload.enclave_kind !== 'string' || typeof payload.inviter !== 'string') throw new Error('ecdh-envelope: payload missing required field (kind/enclave_id/enclave_kind/inviter)'); const hasHandoff = payload.handoff !== undefined && payload.handoff !== null; const noEpoch = payload.epoch_n === undefined || payload.epoch_n === null; if (payload.kind === 'group_invite' && noEpoch) throw new Error('ecdh-envelope: group_invite payload missing epoch_n'); if (hasHandoff && noEpoch) throw new Error('ecdh-envelope: handoff present but epoch_n missing'); return payload; })()
+}
+
+export function ecdhEnvelopeSealWithNonce(senderOpPriv, recipientOpPubHex, payload, nonce) {
+  return (() => { const shared = ecdh(senderOpPriv, hexToBytes(recipientOpPubHex)); const envelopeKey = deriveKey(shared, 'enc:personal:notice'); const sealed = encryptSeparatedWithNonce(envelopeKey, JSON.stringify(payload), nonce); return { ciphertext: sealed.ciphertext, nonce: sealed.nonce, sender_pub: bytesToHex(derivePublicKey(senderOpPriv)), scheme: 'personal:notice', encrypted: true }; })()
+}
+
+export function ecdhEnvelopeSeal(senderOpPriv, recipientOpPubHex, payload) {
+  return ecdhEnvelopeSealWithNonce(senderOpPriv, recipientOpPubHex, payload, csprngBytes(24))
+}
+
+export function ecdhEnvelopeOpen(myOpPriv, envelope) {
+  return (() => { if (!ecdhEnvelopeIsEnvelope(envelope)) throw new Error('ecdh-envelope: malformed envelope'); const shared = ecdh(myOpPriv, hexToBytes(envelope.sender_pub)); const envelopeKey = deriveKey(shared, 'enc:personal:notice'); const plaintext = decryptSeparated(envelopeKey, envelope.ciphertext, envelope.nonce); const payload = JSON.parse(plaintext); return ecdhEnvelopeValidatePayload(payload); })()
+}
+
+export function ecdhEnvelopeWrapHandoffWithNonce(committerPriv, recipientOpPubHex, rootSecret, nonce) {
+  return (() => { const shared = ecdh(committerPriv, hexToBytes(recipientOpPubHex)); const distKey = deriveKey(shared, 'enc:personal:notice:epoch'); const sealed = encryptSeparatedBytesWithNonce(distKey, rootSecret, nonce); return { recipient: recipientOpPubHex.toLowerCase(), ecdh_pub: bytesToHex(derivePublicKey(committerPriv)), ciphertext: sealed.ciphertext, nonce: sealed.nonce }; })()
+}
+
+export function ecdhEnvelopeWrapHandoff(committerPriv, recipientOpPubHex, rootSecret) {
+  return ecdhEnvelopeWrapHandoffWithNonce(committerPriv, recipientOpPubHex, rootSecret, csprngBytes(24))
+}
+
+export function ecdhEnvelopeUnwrapHandoff(myOpPriv, myOpPubHex, handoff) {
+  return (() => { if (!handoff || typeof handoff !== 'object' || handoff.recipient !== myOpPubHex.toLowerCase()) return null; const shared = ecdh(myOpPriv, hexToBytes(handoff.ecdh_pub)); const distKey = deriveKey(shared, 'enc:personal:notice:epoch'); const secret = decryptSeparatedBytes(distKey, handoff.ciphertext, handoff.nonce); if (!(secret instanceof Uint8Array) || secret.length !== 32) throw new Error('ecdh-envelope: handoff secret must be exactly 32 bytes'); return secret; })()
+}

package/index.mjs

@@ -0,0 +1,70 @@
+/**
+ * @enc-protocol/plugin-ecdh-envelope — EcdhEnvelopeCryptoFn (client-side).
+ *
+ * The SPEC-COMPLIANT implementation of `spec/app/plugins/ecdh-envelope.md`:
+ * one-shot sender→recipient confidentiality for Personal-enclave `notice`
+ * content (group/DM invites) + the inner `handoff` sub-encryption carrying a
+ * group's bootstrap `root_secret`. This is the complete wire-and-key contract;
+ * two compliant impls agree byte-for-byte.
+ *
+ * SOURCE = CODEGEN. The crypto is generated from the Lean spec
+ * (`Enc.DSL.Modules.EcdhEnvelope` → `@enc-protocol/core/ecdh-envelope.js`),
+ * composing ONLY the verified core primitives — secp256k1 `ecdh`,
+ * HKDF-SHA256 `deriveKey`, XChaCha20-Poly1305 (24-byte nonce). ZERO raw @noble.
+ * This file is a thin adapter: it re-exports the codegen API and declares the
+ * plugin-contract slot (app glue, not crypto).
+ *
+ * Primitives (spec §1, fixed): AEAD XChaCha20-Poly1305 24-byte nonce; KDF
+ * HKDF-SHA256 empty-salt L=32; ECDH secp256k1 32-byte x-coord (0x02-extended).
+ * Domain separators (§2): `enc:personal:notice` (outer), `enc:personal:notice:epoch`
+ * (handoff). NOT the X25519/ChaCha20-12 demo in `plugin-envelope-dm` — that is a
+ * different (non-canonical) construction and wire format.
+ *
+ * API:
+ *   ecdhEnvelopeSeal(senderOpPriv, recipientOpPubHex, payload)      → envelope (§3)
+ *   ecdhEnvelopeOpen(myOpPriv, envelope)                           → payload   (§3)
+ *   ecdhEnvelopeWrapHandoff(committerPriv, recipientOpPubHex, secret) → handoff (§5)
+ *   ecdhEnvelopeUnwrapHandoff(myOpPriv, myOpPubHex, handoff)       → 32-byte secret | null (§5)
+ *   ecdhEnvelopeIsEnvelope / ecdhEnvelopeValidatePayload           → §7 guards
+ *   *WithNonce variants                                           → deterministic (§9 KAT)
+ */
+
+import {
+  ecdhEnvelopeSeal,
+  ecdhEnvelopeSealWithNonce,
+  ecdhEnvelopeOpen,
+  ecdhEnvelopeWrapHandoff,
+  ecdhEnvelopeWrapHandoffWithNonce,
+  ecdhEnvelopeUnwrapHandoff,
+  ecdhEnvelopeIsEnvelope,
+  ecdhEnvelopeValidatePayload,
+} from './ecdh-envelope.js'
+
+export const slot = Object.freeze({
+  id: 'EcdhEnvelopeCryptoFn',
+  side: 'client',
+  signature: '(senderOpPriv, recipientOpPubHex, payload) → { ciphertext, nonce, sender_pub, scheme, encrypted }',
+})
+
+export {
+  ecdhEnvelopeSeal,
+  ecdhEnvelopeSealWithNonce,
+  ecdhEnvelopeOpen,
+  ecdhEnvelopeWrapHandoff,
+  ecdhEnvelopeWrapHandoffWithNonce,
+  ecdhEnvelopeUnwrapHandoff,
+  ecdhEnvelopeIsEnvelope,
+  ecdhEnvelopeValidatePayload,
+}
+
+export default {
+  slot,
+  ecdhEnvelopeSeal,
+  ecdhEnvelopeSealWithNonce,
+  ecdhEnvelopeOpen,
+  ecdhEnvelopeWrapHandoff,
+  ecdhEnvelopeWrapHandoffWithNonce,
+  ecdhEnvelopeUnwrapHandoff,
+  ecdhEnvelopeIsEnvelope,
+  ecdhEnvelopeValidatePayload,
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@enc-protocol/plugin-ecdh-envelope",
+  "version": "0.9.0",
+  "type": "module",
+  "description": "EcdhEnvelopeCryptoFn: spec-compliant one-shot ECDH envelope for Personal-enclave notices (group/DM invites) + group-invite handoff. secp256k1 ECDH + HKDF-SHA256 + XChaCha20-Poly1305 (24-byte nonce), sourced from the verified @enc-protocol/core codegen. Implements spec/app/plugins/ecdh-envelope.md byte-for-byte.",
+  "scripts": {
+    "test": "node --test test/*.test.mjs"
+  },
+  "main": "./index.mjs",
+  "exports": {
+    ".": "./index.mjs"
+  },
+  "files": [
+    "ecdh-envelope.js",
+    "index.mjs",
+    "README.md"
+  ],
+  "dependencies": {
+    "@enc-protocol/plugin-contract": "^0.9.0",
+    "@enc-protocol/core": "^0.9.0"
+  },
+  "encPlugin": {
+    "slotIds": [
+      "EcdhEnvelopeCryptoFn"
+    ],
+    "side": "client",
+    "implementsSpec": "app/plugins/ecdh-envelope.md",
+    "cf": {
+      "primitives": [
+        "worker"
+      ],
+      "cpu_class": "O(1)",
+      "memory_class": "O(1)",
+      "state": "stateless",
+      "egress": "none",
+      "deterministic": false,
+      "cf_compatible": true,
+      "forbidden": []
+    }
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "license": "Apache-2.0",
+  "keywords": [
+    "core",
+    "public"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}