@derec-alliance/nodejs 0.0.1-alpha.6

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 [yyyy] [name of copyright owner]
+
+   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,214 @@
+# DeRec NodeJS SDK
+
+Node.js bindings for `derec-library`, the Rust SDK implementing the DeRec protocol.
+
+DeRec enables decentralized recovery of secrets by distributing encrypted shares across trusted helpers.
+
+---
+
+## Installation
+
+```bash
+npm install @derec-alliance/nodejs
+```
+
+or with yarn:
+
+```bash
+yarn add @derec-alliance/nodejs
+```
+
+---
+
+## Requirements
+
+- Node.js 18+
+- TypeScript (optional)
+
+No native dependencies are required.
+
+---
+
+## Design Overview
+
+The NodeJS SDK is a **thin binding layer** over the Rust implementation.
+
+All core logic is executed in Rust:
+
+- Protobuf serialization / deserialization
+- Cryptography (pairing, encryption, verification)
+- DeRecMessage envelope construction
+- Protocol validation
+
+The JavaScript / TypeScript API operates exclusively on:
+
+```ts
+Uint8Array
+```
+
+These represent **opaque wire-level protocol messages**.
+
+---
+
+## Quick Example
+
+```ts
+import * as derec from "@derec-alliance/nodejs";
+
+const version = derec.derec_protocol_version();
+
+console.log(version.major, version.minor);
+```
+
+---
+
+## Pairing Flow
+
+```ts
+import * as derec from "@derec-alliance/nodejs";
+
+// Step 1: Owner creates contact message (out-of-band)
+const contact = derec.create_contact_message(
+  1n,
+  new TextEncoder().encode("wss://owner.example.com")
+);
+
+// Step 2: Helper produces pairing request
+const request = derec.produce_pairing_request_message(
+  2, // SenderKind.Helper
+  new TextEncoder().encode("wss://helper.example.com"),
+  contact.wire_bytes
+);
+
+// Step 3: Owner produces pairing response
+const response = derec.produce_pairing_response_message(
+  0, // SenderKind.SharerNonRecovery
+  request.wire_bytes,
+  request.secret_key_material
+);
+
+// Step 4: Helper processes response and derives shared key
+const result = derec.process_pairing_response_message(
+  contact.wire_bytes,
+  response.wire_bytes,
+  request.secret_key_material
+);
+
+console.log("Shared key length:", result.shared_key.length);
+```
+
+---
+
+## Share Distribution (Sharing Flow)
+
+```ts
+import * as derec from "@derec-alliance/nodejs";
+
+const result = derec.protect_secret(
+  new Uint8Array([1, 2, 3]),                // secret ID
+  new TextEncoder().encode("super-secret"), // secret bytes
+  [1n, 2n, 3n],                             // helper channel IDs
+  2,                                        // threshold
+  1                                         // version
+);
+
+const shareMessages = result.share_message_wire_bytes_array;
+
+console.log(shareMessages);
+```
+
+---
+
+## Recovery Flow
+
+```ts
+import * as derec from "@derec-alliance/nodejs";
+
+// Owner requests shares from helpers
+const request = derec.generate_share_request(
+  new Uint8Array([1, 2, 3]), // secret ID
+  1                          // version
+);
+
+// Helper responds with its share
+const response = derec.generate_share_response(
+  request,
+  new Uint8Array() // share content
+);
+
+// Owner reconstructs secret from aggregated responses
+const secret = derec.recover_from_share_responses(
+  new Uint8Array(), // aggregated responses
+  new Uint8Array([1, 2, 3]),
+  1
+);
+
+console.log(secret);
+```
+
+---
+
+## Verification Flow
+
+```ts
+import * as derec from "@derec-alliance/nodejs";
+
+// Owner challenges helper
+const request = derec.generate_verification_request(
+  new Uint8Array([1, 2, 3]),
+  1
+);
+
+// Helper proves it still holds the share
+const response = derec.generate_verification_response(
+  new Uint8Array(), // share content
+  request
+);
+
+const isValid = derec.verify_share_response(
+  new Uint8Array(), // share content
+  request,
+  response
+);
+
+console.log("Valid:", isValid);
+```
+
+---
+
+## Key Principles
+
+- All protocol messages are opaque `Uint8Array`
+- No protobuf types are exposed
+- No cryptographic operations occur in JavaScript
+- Rust is the single source of truth
+
+---
+
+## Package Contents
+
+```text
+derec_library_bg.wasm
+derec_library.js
+derec_library.d.ts
+```
+
+- `.wasm` — compiled Rust core
+- `.js` — bindings
+- `.d.ts` — TypeScript definitions
+
+---
+
+## Documentation
+
+- DeRec Alliance: https://derecalliance.org
+- Protocol specification: https://derec-alliance.gitbook.io/docs/protocol-specification/protocol-overview
+- Rust SDK: https://github.com/derecalliance/lib-derec
+
+---
+
+## License
+
+Apache License 2.0
+
+See `LICENSE` for details.

package/derec_library.d.ts

@@ -0,0 +1,264 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Creates a serialized `ContactMessage` used to bootstrap pairing.
+ *
+ * # Arguments
+ *
+ * * `channel_id` - Channel identifier associated with the generated pairing material
+ * * `transport_uri` - Transport endpoint that the peer should use for subsequent traffic
+ *
+ * # Returns
+ *
+ * A JS object with:
+ *
+ * - `wire_bytes`: serialized `ContactMessage` protobuf bytes
+ * - `secret_key_material`: serialized `PairingSecretKeyMaterial`
+ */
+export function create_contact_message(channel_id: bigint, transport_uri: string): any;
+
+/**
+ * Generates a recovery request envelope.
+ *
+ * # Arguments
+ *
+ * * `channel_id` - Helper channel identifier
+ * * `secret_id` - Secret identifier being recovered
+ * * `version` - Share version being requested
+ * * `shared_key` - 32-byte symmetric key established during pairing
+ *
+ * # Returns
+ *
+ * Serialized outer `DeRecMessage` bytes carrying an encrypted inner
+ * `GetShareRequestMessage`.
+ */
+export function generate_share_request(channel_id: bigint, secret_id: Uint8Array, version: number, shared_key: Uint8Array): Uint8Array;
+
+/**
+ * Generates a recovery response envelope.
+ *
+ * # Arguments
+ *
+ * * `secret_id` - Secret identifier being recovered
+ * * `channel_id` - Helper channel identifier
+ * * `stored_share_request_wire_bytes` - Serialized outer `DeRecMessage` bytes
+ *   carrying the encrypted inner `StoreShareRequestMessage` previously produced
+ *   by the sharing flow for this helper
+ * * `request_wire_bytes` - Serialized outer `DeRecMessage` bytes carrying the
+ *   encrypted inner `GetShareRequestMessage`
+ * * `shared_key` - 32-byte symmetric key established during pairing
+ *
+ * # Returns
+ *
+ * Serialized outer `DeRecMessage` bytes carrying an encrypted inner
+ * `GetShareResponseMessage`.
+ */
+export function generate_share_response(secret_id: Uint8Array, channel_id: bigint, stored_share_request_wire_bytes: Uint8Array, request_wire_bytes: Uint8Array, shared_key: Uint8Array): Uint8Array;
+
+/**
+ * Generates a verification request envelope.
+ *
+ * # Arguments
+ *
+ * * `secret_id` - Secret identifier
+ * * `channel_id` - Helper channel identifier
+ * * `version` - Share-distribution version being verified
+ * * `shared_key` - 32-byte symmetric key established during pairing
+ *
+ * # Returns
+ *
+ * A JS object with:
+ *
+ * - `wire_bytes`: serialized outer `DeRecMessage` bytes carrying an encrypted
+ *   inner `VerifyShareRequestMessage`
+ */
+export function generate_verification_request(secret_id: Uint8Array, channel_id: bigint, version: number, shared_key: Uint8Array): any;
+
+/**
+ * Generates a verification response envelope.
+ *
+ * # Arguments
+ *
+ * * `secret_id` - Secret identifier
+ * * `channel_id` - Helper channel identifier
+ * * `shared_key` - 32-byte symmetric key established during pairing
+ * * `share_content` - Share bytes whose possession is being proven
+ * * `request_bytes` - Serialized outer `DeRecMessage` bytes carrying encrypted
+ *   inner `VerifyShareRequestMessage`
+ *
+ * # Returns
+ *
+ * A JS object with:
+ *
+ * - `wire_bytes`: serialized outer `DeRecMessage` bytes carrying an encrypted
+ *   inner `VerifyShareResponseMessage`
+ */
+export function generate_verification_response(secret_id: Uint8Array, channel_id: bigint, shared_key: Uint8Array, share_content: Uint8Array, request_bytes: Uint8Array): any;
+
+/**
+ * Processes a serialized pairing response envelope and derives the responder-side shared key.
+ *
+ * This is the **responder-side** finalization step: the party that created the pairing request
+ * processes the pairing response and derives the same final shared key.
+ *
+ * # Arguments
+ *
+ * * `contact_message_bytes` - Plain serialized `ContactMessage` bytes
+ * * `pair_response_wire_bytes` - Serialized outer `DeRecMessage` carrying encrypted inner response bytes
+ * * `pairing_secret_key_material` - Serialized responder-side `PairingSecretKeyMaterial`
+ *
+ * # Returns
+ *
+ * A JS object with:
+ *
+ * - `pairing_shared_key`: final shared pairing key
+ */
+export function process_pairing_response_message(contact_message_bytes: Uint8Array, pair_response_wire_bytes: Uint8Array, pairing_secret_key_material: Uint8Array): any;
+
+/**
+ * Produces a serialized pairing request envelope from a contact message.
+ *
+ * This is the **responder-side** step: the party that received the out-of-band
+ * contact creates the pairing request.
+ *
+ * # Arguments
+ *
+ * * `kind` - Sender role encoded as:
+ *   - `0` => `SharerNonRecovery`
+ *   - `1` => `SharerRecovery`
+ *   - `2` => `Helper`
+ * * `transport_uri` - Transport endpoint the responder can use to receive follow-up traffic
+ * * `contact_message_bytes` - Plain serialized `ContactMessage` bytes
+ *
+ * # Returns
+ *
+ * A JS object with:
+ *
+ * - `wire_bytes`: serialized outer `DeRecMessage` bytes
+ * - `secret_key_material`: serialized responder-side `PairingSecretKeyMaterial`
+ */
+export function produce_pairing_request_message(kind: number, transport_uri: string, contact_message_bytes: Uint8Array): any;
+
+/**
+ * Produces a serialized pairing response envelope and derives the initiator-side shared key.
+ *
+ * This is the **initiator-side** step: the party that originally created the contact
+ * processes the incoming pairing request and returns the pairing response.
+ *
+ * # Arguments
+ *
+ * * `kind` - Sender role encoded as:
+ *   - `0` => `SharerNonRecovery`
+ *   - `1` => `SharerRecovery`
+ *   - `2` => `Helper`
+ * * `pair_request_wire_bytes` - Serialized outer `DeRecMessage` carrying encrypted inner request bytes
+ * * `pairing_secret_key_material` - Serialized initiator-side `PairingSecretKeyMaterial`
+ *
+ * # Returns
+ *
+ * A JS object with:
+ *
+ * - `wire_bytes`: serialized outer `DeRecMessage` bytes carrying encrypted inner response bytes
+ * - `transport_protocol`: transport information extracted from the pairing request
+ * - `pairing_shared_key`: final shared pairing key
+ */
+export function produce_pairing_response_message(kind: number, pair_request_wire_bytes: Uint8Array, pairing_secret_key_material: Uint8Array): any;
+
+/**
+ * Generates verifiable secret shares and returns one serialized outer `DeRecMessage`
+ * envelope per helper channel.
+ *
+ * # JavaScript input shape
+ *
+ * The `channels` argument must be a JS array of objects like:
+ *
+ * ```ts
+ * [
+ *   { channel_id: 1, shared_key: new Uint8Array(32) },
+ *   { channel_id: 2, shared_key: new Uint8Array(32) },
+ * ]
+ * ```
+ *
+ * Each `shared_key` must be exactly 32 bytes.
+ *
+ * The `keep_list` argument may be:
+ *
+ * - `undefined` or `null`, meaning no keep-list is provided
+ * - an array of integers, for example:
+ *
+ * ```ts
+ * [1, 2, 3]
+ * ```
+ *
+ * The `description` argument may be:
+ *
+ * - `undefined` or `null`, meaning no description is provided
+ * - a string, for example:
+ *
+ * ```ts
+ * "initial distribution"
+ * ```
+ *
+ * # Returns
+ *
+ * A JS object of the form:
+ *
+ * ```ts
+ * {
+ *   value: {
+ *     [channelId: number]: Uint8Array
+ *   }
+ * }
+ * ```
+ *
+ * where each value is a serialized outer `DeRecMessage` envelope.
+ *
+ * # Arguments
+ *
+ * * `secret_id` - Secret identifier embedded into each generated share
+ * * `secret_data` - Secret bytes to split and distribute
+ * * `channels` - JS array of `{ channel_id, shared_key }` entries
+ * * `threshold` - Minimum number of shares required for reconstruction
+ * * `version` - Share-distribution version embedded into the generated messages
+ * * `keep_list` - Optional JS array of versions helpers should retain
+ * * `description` - Optional version description
+ */
+export function protect_secret(secret_id: Uint8Array, secret_data: Uint8Array, channels: any, threshold: number, version: number, keep_list: any, description?: string | null): any;
+
+/**
+ * Recovers the original secret from helper recovery responses.
+ *
+ * # Arguments
+ *
+ * * `responses` - JS array of recovery response inputs. Each entry must contain:
+ *   - `response_bytes`: serialized outer `DeRecMessage` response envelope
+ *   - `shared_key`: 32-byte symmetric key for decrypting that response
+ * * `secret_id` - Secret identifier being recovered
+ * * `version` - Secret version being recovered
+ *
+ * # Returns
+ *
+ * The reconstructed secret bytes.
+ */
+export function recover_from_share_responses(responses: any, secret_id: Uint8Array, version: number): Uint8Array;
+
+/**
+ * Verifies a verification response envelope.
+ *
+ * # Arguments
+ *
+ * * `secret_id` - Secret identifier
+ * * `channel_id` - Helper channel identifier
+ * * `shared_key` - 32-byte symmetric key established during pairing
+ * * `share_content` - Expected share bytes
+ * * `response_bytes` - Serialized outer `DeRecMessage` bytes carrying encrypted
+ *   inner `VerifyShareResponseMessage`
+ *
+ * # Returns
+ *
+ * `true` if the verification response is valid, otherwise `false`.
+ */
+export function verify_share_response(secret_id: Uint8Array, channel_id: bigint, shared_key: Uint8Array, share_content: Uint8Array, response_bytes: Uint8Array): boolean;
+
+export function wasm_start(): void;