@saihm/erasure-receipt 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,78 @@
+# @saihm/erasure-receipt
+
+**Prove a record was erased — not hidden.** Build and verify tamper-evident **cryptographic-erasure
+receipts** (GDPR Art. 17) for [SAIHM](https://saihm.coti.global). Zero dependencies (`node:crypto` only).
+
+SAIHM erases a record by destroying the *wrapped key* that decrypts it: the stored ciphertext
+becomes unrecoverable noise, so the record is *gone, not merely de-indexed*. This library turns the
+protocol's own seal + `forget` results into a small, portable receipt a compliance reviewer can
+read, **re-verify**, and archive.
+
+```bash
+npm install @saihm/erasure-receipt
+```
+
+## Usage
+
+```js
+import { buildErasureReceipt, verifyReceipt } from '@saihm/erasure-receipt';
+
+// After you seal a record and honour an erasure request via @saihm/client-pro:
+const receipt = buildErasureReceipt({
+  cellId,           // the erased record's public id
+  commitmentHash,   // the record's public commitment (e.g. remember().commitmentHash)
+  forget,           // the forget() result: { complete, steps: [{ success }], epoch }
+                    //   epoch is the SAIHM protocol epoch, in HOURS (as the endpoint reports it)
+  copiesRemaining,  // records with this id still readable after erasure (you verify == 0)
+  endpoint,         // 'local blind sandbox' or your hosted endpoint host
+});
+
+const { valid, reasons } = verifyReceipt(receipt);
+// valid === true only when the hash matches the body AND the erasure is irreversible
+// (wrapped key destroyed AND zero copies remain). Otherwise `reasons` explains why.
+```
+
+## What's in a receipt
+
+The receipt carries only **public** material — no plaintext, no secret:
+
+```json
+{
+  "schema": "saihm.erasure-receipt/v1",
+  "action": "cryptographic-erasure",
+  "basis": "GDPR Art. 17 (right to erasure)",
+  "record": { "cellId": "9c29fce8…", "commitmentHash": "c3999ac2…" },
+  "result": { "keyDestroyed": true, "copiesRemaining": 0, "irreversible": true },
+  "erasedAt": "2026-06-24T05:28:08.000Z",
+  "endpoint": "local blind sandbox",
+  "note": "The endpoint holds ciphertext only; destroying the wrapped key leaves the stored bytes as unrecoverable noise…",
+  "receiptHash": "31228b4b…"
+}
+```
+
+- **`receiptHash`** is a SHA-256 over a **canonical (key-sorted)** serialization of the body, so the
+  receipt is **tamper-evident** — any change to the body changes the hash. `verifyReceipt`
+  re-serializes canonically and re-hashes; never re-hash pretty-printed JSON.
+- The core claim is also **reproducible**: re-read the store with this `cellId` and confirm nothing
+  survives.
+- `verifyReceipt` returns `{ valid: false, reasons: [...] }` if the hash doesn't match the body, if
+  any copy survives, or if the wrapped key was not destroyed.
+
+## Why this matters
+
+For real personal data, "removed from search" is not erasure — the bytes are still there. This
+library records erasure with the properties a compliance reviewer asks about: **key-destruction, not
+de-indexing**; **targeted** (only the requested record); **provable** (a portable, tamper-evident,
+reproducible receipt an auditor can re-verify); **non-custodial** (records are sealed client-side;
+the endpoint only ever holds ciphertext).
+
+## See also
+
+- [`@saihm/client-pro`](https://www.npmjs.com/package/@saihm/client-pro) — the sealing client that
+  produces the `remember` / `forget` results this receipt is built from.
+- Runnable demo + all SAIHM demos: <https://citw2.github.io/saihm-demos/>.
+- Join the protocol: <https://saihm.coti.global/join>.
+
+## License
+
+Apache-2.0 © SAIHM

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@saihm/erasure-receipt",
+  "version": "0.1.0",
+  "description": "Tamper-evident, verifiable cryptographic-erasure receipts (GDPR Art. 17) for SAIHM: build a receipt from a seal + forget, and verify any receipt you are handed. Zero-dependency (node:crypto only).",
+  "type": "module",
+  "license": "Apache-2.0",
+  "author": "SAIHM",
+  "main": "./src/receipt.mjs",
+  "types": "./src/receipt.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/receipt.d.ts",
+      "import": "./src/receipt.mjs"
+    }
+  },
+  "files": [
+    "src/receipt.mjs",
+    "src/receipt.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "test": "node --test"
+  },
+  "keywords": [
+    "saihm",
+    "gdpr",
+    "erasure",
+    "right-to-be-forgotten",
+    "crypto-shred",
+    "receipt",
+    "compliance",
+    "audit",
+    "tamper-evident"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SAIHM-Admin/saihm-erasure-receipt.git"
+  },
+  "homepage": "https://saihm.coti.global",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/receipt.d.ts

@@ -0,0 +1,61 @@
+// Type definitions for @saihm/erasure-receipt
+
+/** The receipt schema identifier embedded in every receipt. */
+export const RECEIPT_SCHEMA: "saihm.erasure-receipt/v1";
+
+/** The `forget()` result shape this module reads (from @saihm/client-pro). */
+export interface ForgetResult {
+  /** Whether the erasure completed end to end. */
+  complete?: boolean;
+  /** Per-operation steps; the wrapped key is treated as destroyed only if every step succeeded. */
+  steps?: Array<{ success?: boolean }>;
+  /** SAIHM protocol epoch (HOURS since the unix epoch) of the erasure, as reported by the endpoint. */
+  epoch?: number | string | null;
+}
+
+export interface BuildErasureReceiptArgs {
+  /** Public id of the erased record. Required. */
+  cellId: string;
+  /** The record's public commitment (endpoint-reported; offline it equals the client-sealed sha256 of the ciphertext). */
+  commitmentHash?: string | null;
+  /** The `forget()` result. */
+  forget: ForgetResult;
+  /** Count of records with this id still readable after erasure — you verify this is 0. */
+  copiesRemaining: number;
+  /** 'local blind sandbox' or the hosted endpoint host. */
+  endpoint: string;
+}
+
+export interface ErasureReceipt {
+  schema: typeof RECEIPT_SCHEMA;
+  action: "cryptographic-erasure";
+  basis: string;
+  record: { cellId: string; commitmentHash: string | null };
+  result: {
+    keyDestroyed: boolean;
+    copiesRemaining: number;
+    irreversible: boolean;
+  };
+  erasedAt: string;
+  endpoint: string;
+  note: string;
+  /** SHA-256 over a canonical (key-sorted) serialization of the receipt body — tamper-evident. */
+  receiptHash: string;
+}
+
+export interface VerifyResult {
+  valid: boolean;
+  reasons: string[];
+}
+
+/**
+ * Build a tamper-evident erasure receipt from the protocol's seal + forget results.
+ * Throws if `cellId` is missing or `copiesRemaining` is not a non-negative integer.
+ */
+export function buildErasureReceipt(args: BuildErasureReceiptArgs): ErasureReceipt;
+
+/**
+ * Verify a receipt: its hash must match its body, and it must attest an irreversible erasure
+ * (wrapped key destroyed AND zero copies remaining).
+ */
+export function verifyReceipt(receipt: unknown): VerifyResult;

package/src/receipt.mjs

@@ -0,0 +1,104 @@
+// A public, tamper-evident erasure receipt for SAIHM.
+//
+// SAIHM erases a record by destroying the *wrapped key* that decrypts it: the stored
+// ciphertext becomes unrecoverable noise, so the record is gone, not merely de-indexed.
+// This module turns the protocol's own seal + forget results into a small, portable
+// receipt that a compliance reviewer can read, re-verify, and archive.
+//
+// The receipt contains ONLY public material — the cell id and the record's public commitment (the
+// endpoint-reported commitment for the record; offline it is the client-sealed sha256 of the
+// ciphertext), plus the verifiable outcome. It carries no plaintext and no secret.
+// Integrity is self-checking (`receiptHash`), and the core claim is *reproducible*: re-read
+// the store after erasure and confirm zero copies survive.
+
+import { createHash } from 'node:crypto';
+
+export const RECEIPT_SCHEMA = 'saihm.erasure-receipt/v1';
+
+// The protocol epoch is counted in hours; these bound what a receipt will accept as an erasure
+// time. Anything outside the window falls back to the current time rather than being trusted.
+const SECONDS_PER_EPOCH = 3600;
+const EPOCH_FLOOR_SEC = Date.UTC(2020, 0, 1) / 1000;
+const EPOCH_SKEW_SEC = 86400;
+
+/**
+ * Build an erasure receipt from the protocol's seal + forget results.
+ *
+ * @param {object} a
+ * @param {string} a.cellId            - public id of the erased record
+ * @param {string|null} [a.commitmentHash] - the record's public commitment (endpoint-reported; offline it equals the client-sealed sha256 of the ciphertext). Verify it via verifyEnvelope() if you must trust it on a hosted endpoint
+ * @param {object} a.forget            - the `forget()` result ({ complete, steps:[{success}], epoch }); `epoch` is the SAIHM protocol epoch, in hours
+ * @param {number} a.copiesRemaining   - records with this id still readable after erasure (verified by re-reading)
+ * @param {string} a.endpoint          - 'local blind sandbox' or the hosted endpoint host
+ * @returns {object} the receipt, including a `receiptHash` that makes it tamper-evident
+ */
+export function buildErasureReceipt({ cellId, commitmentHash = null, forget, copiesRemaining, endpoint }) {
+  if (!cellId) throw new Error('buildErasureReceipt: cellId is required');
+  if (!Number.isInteger(copiesRemaining) || copiesRemaining < 0) {
+    throw new Error('buildErasureReceipt: copiesRemaining must be a non-negative integer');
+  }
+  const steps = Array.isArray(forget?.steps) ? forget.steps : [];
+  const keyDestroyed = Boolean(forget?.complete) && steps.length > 0 && steps.every((s) => s?.success === true);
+  const nowSec = Math.floor(Date.now() / 1000);
+  // `forget.epoch` is the SAIHM protocol epoch: HOURS since the unix epoch. That is what the
+  // blind operator endpoint reports and what the runtime itself multiplies by an hour to get
+  // milliseconds. Reading it as seconds lands the receipt in 1970 while every other field still
+  // checks out -- a receipt that verifies true and misstates when the erasure happened, which is
+  // the one outcome this artifact must never produce.
+  const epochSec = Number(forget?.epoch) * SECONDS_PER_EPOCH;
+  // Fail closed to now unless the result is a plausible erasure time. The floor is what makes the
+  // 1970 case unreachable; the ceiling catches the opposite mistake, a unix-seconds value passed
+  // in by hand, which overshoots by orders of magnitude. Either unit error degrades to "now"
+  // rather than to a date that would misstate the erasure. null/""/0, negative, NaN and Infinity
+  // all fall outside the window too, so a malformed or hostile epoch never throws.
+  const safeEpoch =
+    Number.isFinite(epochSec) && epochSec >= EPOCH_FLOOR_SEC && epochSec <= nowSec + EPOCH_SKEW_SEC
+      ? epochSec
+      : nowSec;
+  const erasedAt = new Date(safeEpoch * 1000).toISOString();
+
+  const body = {
+    schema: RECEIPT_SCHEMA,
+    action: 'cryptographic-erasure',          // key destruction, not de-indexing
+    basis: 'GDPR Art. 17 (right to erasure)',
+    record: { cellId, commitmentHash },        // public anchors for the erased record (endpoint-reported commitment)
+    result: {
+      keyDestroyed,                            // the wrapped key that decrypts this record was destroyed
+      copiesRemaining,                         // verified by re-reading the store after erasure
+      irreversible: keyDestroyed && copiesRemaining === 0,
+    },
+    erasedAt,
+    endpoint,
+    note: 'The endpoint named in this receipt holds ciphertext only and reports destroying the wrapped '
+      + 'key, which leaves the stored bytes as unrecoverable noise. This receipt is tamper-evident '
+      + '(receiptHash), and its zero-copies outcome is reproducible — re-read the store with this cellId '
+      + 'and confirm none survive.',
+  };
+  return { ...body, receiptHash: sha256Hex(canonical(body)) };
+}
+
+/**
+ * Verify a receipt: its hash must match its body, and it must attest an irreversible erasure
+ * (wrapped key destroyed AND zero copies remaining). Returns a structured result.
+ */
+export function verifyReceipt(receipt) {
+  const reasons = [];
+  if (!receipt || typeof receipt !== 'object') return { valid: false, reasons: ['not an object'] };
+  if (receipt.schema !== RECEIPT_SCHEMA) reasons.push(`unexpected schema: ${receipt.schema}`);
+  const { receiptHash, ...body } = receipt;
+  if (typeof receiptHash !== 'string') reasons.push('missing receiptHash');
+  else if (receiptHash !== sha256Hex(canonical(body))) reasons.push('receiptHash does not match body (tampered)');
+  if (receipt.result?.keyDestroyed !== true) reasons.push('keyDestroyed is not true');
+  if (receipt.result?.copiesRemaining !== 0) reasons.push('copiesRemaining is not zero');
+  if (receipt.result?.irreversible !== true) reasons.push('not marked irreversible');
+  return { valid: reasons.length === 0, reasons };
+}
+
+// --- helpers: a canonical (key-sorted) JSON so the hash is stable across runs/parsers ---
+function canonical(o) { return JSON.stringify(sortKeys(o)); }
+function sortKeys(v) {
+  if (Array.isArray(v)) return v.map(sortKeys);
+  if (v && typeof v === 'object') return Object.fromEntries(Object.keys(v).sort().map((k) => [k, sortKeys(v[k])]));
+  return v;
+}
+function sha256Hex(s) { return createHash('sha256').update(s, 'utf8').digest('hex'); }