@ctxfile/relay 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,56 @@
+# @ctxfile/relay
+
+The ctxfile relay: an always-on MCP endpoint over an encrypted vault. **Hosted, it is the Sync tier** (`sync.ctxfile.dev`). **Self-hosted, the same build is the Team/Enterprise hub.** One image, every SKU.
+
+The relay is open source on purpose: it is the component that momentarily holds plaintext in Standard mode, so it is the component you must be able to audit. See [ctxfile.dev/security](https://ctxfile.dev/security).
+
+## What it does
+
+- **Stores ciphertext.** Devices encrypt every record client-side (XChaCha20-Poly1305, keys derived via Argon2id) and sync blobs up under opaque ids. The datastore never contains plaintext, and blob names leak nothing.
+- **Serves the five ctxfile tools over Streamable HTTP** (`get_context`, `save_session`, `continue_thread`, `list_threads`, `ingest_context`) so any MCP-capable client surface — phone, web, chat app, another machine — can save and resume threads. Standard-mode vaults only: serve-time decryption happens in memory, per request, under a key wrapped by the keyring; nothing decrypted is persisted or logged.
+- **Strict vaults are a wall:** the relay holds ciphertext it can never decrypt. Sync works; `/mcp` refuses; that refusal is the feature.
+- **Handoff grants:** thread-scoped, read-only (or read+ingest), expiring, revocable bearer tokens — "take over my project while I'm out", enforced server-side.
+- **Federation (Enterprise):** org identities (Ed25519), signed org-to-org grants, invite-only trusted-peer redemption, pull-model thread exchange between two hubs. No central server in the data path.
+- **Append-only audit:** every vault event, blob push, MCP call, grant issue/redeem/denial, with actor and org attribution. `audit export` emits JSONL for your SIEM.
+
+## Run
+
+```bash
+node dist/cli.js start --data-dir ~/ctxfile-relay      # or: ctxfile-relay start
+```
+
+All state (SQLite, keyring master key, org identity) lives in the data dir: one folder to volume-mount, one folder to back up. Defaults: `127.0.0.1:5959`, registration open (self-host mode). Environment: `CTXFILE_RELAY_DATA`, `CTXFILE_RELAY_HOST`, `CTXFILE_RELAY_PORT`, `CTXFILE_RELAY_ORG`, `CTXFILE_RELAY_REGISTRATION` (`closed` for hosted deployments where the subscription flow provisions vaults), `CTXFILE_RELAY_PUBLIC_URL`.
+
+Docker (build from the repo root; this is the Team hub artifact):
+
+```bash
+docker build -f packages/relay/Dockerfile -t ctxfile-relay .
+docker run -p 5959:5959 -v ctxfile-relay-data:/data ctxfile-relay
+```
+
+Fly.io: `fly deploy -c packages/relay/fly.toml` (see the file's header for secrets).
+
+## HTTP API
+
+| Route | Auth | Purpose |
+|---|---|---|
+| `GET /healthz` | none | Liveness + org id |
+| `POST /v1/vaults` | none (when registration is open) | Create a vault: salt, KDF params, passphrase/recovery key wraps; returns vault id + device token |
+| `GET /v1/vaults/me` | bearer | Vault metadata a new device needs to unlock (salt, wraps) |
+| `POST /v1/vaults/enroll-key` | bearer (write) | Standard mode only: the data key, immediately wrapped by the keyring |
+| `GET /v1/blobs`, `GET/PUT /v1/blobs/:id` | bearer (read/write) | Ciphertext sync; LWW versions enforced server-side too; 512KB cap, per-token rate limits |
+| `POST /v1/grants`, `GET /v1/grants`, `POST /v1/grants/:id/revoke` | bearer (write to issue) | Handoff grants |
+| `POST /v1/federation/grants` | bearer (write) | Org-signed federation grant for an audience org |
+| `POST /v1/federation/redeem` | signatures, not bearer | Trusted-peer redemption; every denial is audited |
+| `GET /v1/audit` | bearer | The vault's audit rows |
+| `/mcp` | bearer (vault or grant token) | Streamable HTTP MCP; one session per client, session bound to its token |
+
+Tokens are stored as SHA-256 hashes and carry scopes (`read:context`, `write:sessions`). CLI: `vaults`, `tokens list|create|revoke`, `grants issue`, `org show|trust`, `federation issue|redeem`, `audit tail|export`.
+
+## Security model, in one paragraph
+
+Clients encrypt before upload; the relay stores ciphertext under opaque ids; Standard-mode serving unwraps a per-vault data key through the `KeyProvider` seam (local keyring file when self-hosted, cloud KMS when hosted, the customer's own KMS for BYOK — same two-method interface, which is why key revocation is crypto-shredding), decrypts in memory for one request, and discards; Strict mode never enrolls a key at all; no plaintext is ever written to logs (log lines carry ids and counts only); grants are least-privilege by default (single thread, read-only, 7-day expiry); federation is invite-only by exchanged org identity and every redemption or denial is an audit row. Production deployments terminate TLS in front (Fly edge, Caddy, nginx); hub-to-hub mTLS is on the deploy checklist.
+
+## Boundary note (for the repo split)
+
+The data path in this package (crypto, blob storage, vault serving) is Apache-2.0 and stays open — it is the trust story. The planned multi-org/team management layer (org member administration, policy workflows, SSO glue, managed-hub tooling) is the commercial module and will live in the private repo, plugging in the way `@ctxfile/pro` plugs into the core. What exists here today, including grants, federation primitives, and audit, is open.

package/dist/chunk-DKK4LTPB.js

@@ -0,0 +1,58 @@
+#!/usr/bin/env node
+
+// src/org.ts
+import { createPrivateKey, createPublicKey, generateKeyPairSync, sign, verify } from "crypto";
+import { chmodSync, existsSync, readFileSync, writeFileSync } from "fs";
+import path from "path";
+function loadOrCreateOrgIdentity(dataDir, orgId) {
+  const filePath = path.join(dataDir, "org-identity.json");
+  if (existsSync(filePath)) {
+    const stored = JSON.parse(readFileSync(filePath, "utf8"));
+    return {
+      orgId: stored.orgId,
+      publicKeyPem: stored.publicKeyPem,
+      privateKey: createPrivateKey(stored.privateKeyPem)
+    };
+  }
+  const { publicKey, privateKey } = generateKeyPairSync("ed25519");
+  const publicKeyPem = publicKey.export({ type: "spki", format: "pem" }).toString();
+  const privateKeyPem = privateKey.export({ type: "pkcs8", format: "pem" }).toString();
+  writeFileSync(filePath, `${JSON.stringify({ orgId, publicKeyPem, privateKeyPem }, null, 2)}
+`, "utf8");
+  chmodSync(filePath, 384);
+  console.error(`ctxfile-relay: generated org identity "${orgId}" at ${filePath} (mode 600)`);
+  return { orgId, publicKeyPem, privateKey };
+}
+function canonicalJson(value) {
+  return JSON.stringify(value, Object.keys(value).sort());
+}
+function signGrantDoc(identity, doc) {
+  return sign(null, Buffer.from(canonicalJson({ ...doc })), identity.privateKey).toString("base64");
+}
+function verifyGrantSig(publicKeyPem, doc, sigB64) {
+  try {
+    return verify(null, Buffer.from(canonicalJson({ ...doc })), createPublicKey(publicKeyPem), Buffer.from(sigB64, "base64"));
+  } catch {
+    return false;
+  }
+}
+function signRedemption(identity, gid) {
+  return sign(null, Buffer.from(`redeem:${gid}`), identity.privateKey).toString("base64");
+}
+function verifyRedemption(publicKeyPem, gid, sigB64) {
+  try {
+    return verify(null, Buffer.from(`redeem:${gid}`), createPublicKey(publicKeyPem), Buffer.from(sigB64, "base64"));
+  } catch {
+    return false;
+  }
+}
+
+export {
+  loadOrCreateOrgIdentity,
+  canonicalJson,
+  signGrantDoc,
+  verifyGrantSig,
+  signRedemption,
+  verifyRedemption
+};
+//# sourceMappingURL=chunk-DKK4LTPB.js.map

package/dist/chunk-DKK4LTPB.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/org.ts"],"sourcesContent":["import { createPrivateKey, createPublicKey, generateKeyPairSync, sign, verify, type KeyObject } from \"node:crypto\";\nimport { chmodSync, existsSync, readFileSync, writeFileSync } from \"node:fs\";\nimport path from \"node:path\";\n\n/**\n * Org identity (Enterprise PRD §4.1): every hub carries an org_id and an\n * Ed25519 keypair. Federation grants are signed by the issuing org and\n * redeemed only by orgs whose public keys this hub explicitly trusts —\n * invite-only federation, by exchanged identity, no discovery.\n */\n\nexport interface OrgIdentity {\n  orgId: string;\n  publicKeyPem: string;\n  privateKey: KeyObject;\n}\n\nexport function loadOrCreateOrgIdentity(dataDir: string, orgId: string): OrgIdentity {\n  const filePath = path.join(dataDir, \"org-identity.json\");\n  if (existsSync(filePath)) {\n    const stored = JSON.parse(readFileSync(filePath, \"utf8\")) as {\n      orgId: string;\n      publicKeyPem: string;\n      privateKeyPem: string;\n    };\n    return {\n      orgId: stored.orgId,\n      publicKeyPem: stored.publicKeyPem,\n      privateKey: createPrivateKey(stored.privateKeyPem),\n    };\n  }\n  const { publicKey, privateKey } = generateKeyPairSync(\"ed25519\");\n  const publicKeyPem = publicKey.export({ type: \"spki\", format: \"pem\" }).toString();\n  const privateKeyPem = privateKey.export({ type: \"pkcs8\", format: \"pem\" }).toString();\n  writeFileSync(filePath, `${JSON.stringify({ orgId, publicKeyPem, privateKeyPem }, null, 2)}\\n`, \"utf8\");\n  chmodSync(filePath, 0o600);\n  console.error(`ctxfile-relay: generated org identity \"${orgId}\" at ${filePath} (mode 600)`);\n  return { orgId, publicKeyPem, privateKey };\n}\n\n/** A federation grant document; signed canonically (sorted keys) so both\n    hubs compute identical bytes. */\nexport interface FederationGrantDoc {\n  gid: string;\n  issuer_org: string;\n  issuer_url: string;\n  audience_org: string;\n  vault_id: string;\n  thread_title: string;\n  permission: \"read\" | \"read+ingest\";\n  exp: number;\n}\n\nexport function canonicalJson(value: Record<string, unknown>): string {\n  return JSON.stringify(value, Object.keys(value).sort());\n}\n\nexport function signGrantDoc(identity: OrgIdentity, doc: FederationGrantDoc): string {\n  return sign(null, Buffer.from(canonicalJson({ ...doc })), identity.privateKey).toString(\"base64\");\n}\n\nexport function verifyGrantSig(publicKeyPem: string, doc: FederationGrantDoc, sigB64: string): boolean {\n  try {\n    return verify(null, Buffer.from(canonicalJson({ ...doc })), createPublicKey(publicKeyPem), Buffer.from(sigB64, \"base64\"));\n  } catch {\n    return false;\n  }\n}\n\n/** Signature a requesting hub makes over a grant id, proving it holds the\n    audience org's key when redeeming. */\nexport function signRedemption(identity: OrgIdentity, gid: string): string {\n  return sign(null, Buffer.from(`redeem:${gid}`), identity.privateKey).toString(\"base64\");\n}\n\nexport function verifyRedemption(publicKeyPem: string, gid: string, sigB64: string): boolean {\n  try {\n    return verify(null, Buffer.from(`redeem:${gid}`), createPublicKey(publicKeyPem), Buffer.from(sigB64, \"base64\"));\n  } catch {\n    return false;\n  }\n}\n"],"mappings":";;;AAAA,SAAS,kBAAkB,iBAAiB,qBAAqB,MAAM,cAA8B;AACrG,SAAS,WAAW,YAAY,cAAc,qBAAqB;AACnE,OAAO,UAAU;AAeV,SAAS,wBAAwB,SAAiB,OAA4B;AACnF,QAAM,WAAW,KAAK,KAAK,SAAS,mBAAmB;AACvD,MAAI,WAAW,QAAQ,GAAG;AACxB,UAAM,SAAS,KAAK,MAAM,aAAa,UAAU,MAAM,CAAC;AAKxD,WAAO;AAAA,MACL,OAAO,OAAO;AAAA,MACd,cAAc,OAAO;AAAA,MACrB,YAAY,iBAAiB,OAAO,aAAa;AAAA,IACnD;AAAA,EACF;AACA,QAAM,EAAE,WAAW,WAAW,IAAI,oBAAoB,SAAS;AAC/D,QAAM,eAAe,UAAU,OAAO,EAAE,MAAM,QAAQ,QAAQ,MAAM,CAAC,EAAE,SAAS;AAChF,QAAM,gBAAgB,WAAW,OAAO,EAAE,MAAM,SAAS,QAAQ,MAAM,CAAC,EAAE,SAAS;AACnF,gBAAc,UAAU,GAAG,KAAK,UAAU,EAAE,OAAO,cAAc,cAAc,GAAG,MAAM,CAAC,CAAC;AAAA,GAAM,MAAM;AACtG,YAAU,UAAU,GAAK;AACzB,UAAQ,MAAM,0CAA0C,KAAK,QAAQ,QAAQ,aAAa;AAC1F,SAAO,EAAE,OAAO,cAAc,WAAW;AAC3C;AAeO,SAAS,cAAc,OAAwC;AACpE,SAAO,KAAK,UAAU,OAAO,OAAO,KAAK,KAAK,EAAE,KAAK,CAAC;AACxD;AAEO,SAAS,aAAa,UAAuB,KAAiC;AACnF,SAAO,KAAK,MAAM,OAAO,KAAK,cAAc,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,SAAS,UAAU,EAAE,SAAS,QAAQ;AAClG;AAEO,SAAS,eAAe,cAAsB,KAAyB,QAAyB;AACrG,MAAI;AACF,WAAO,OAAO,MAAM,OAAO,KAAK,cAAc,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,gBAAgB,YAAY,GAAG,OAAO,KAAK,QAAQ,QAAQ,CAAC;AAAA,EAC1H,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAIO,SAAS,eAAe,UAAuB,KAAqB;AACzE,SAAO,KAAK,MAAM,OAAO,KAAK,UAAU,GAAG,EAAE,GAAG,SAAS,UAAU,EAAE,SAAS,QAAQ;AACxF;AAEO,SAAS,iBAAiB,cAAsB,KAAa,QAAyB;AAC3F,MAAI;AACF,WAAO,OAAO,MAAM,OAAO,KAAK,UAAU,GAAG,EAAE,GAAG,gBAAgB,YAAY,GAAG,OAAO,KAAK,QAAQ,QAAQ,CAAC;AAAA,EAChH,QAAQ;AACN,WAAO;AAAA,EACT;AACF;","names":[]}