@rindle/affinity 0.6.3

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,27 @@
+# @rindle/affinity
+
+The TypeScript twin of the `rindle-affinity` Rust crate: mint and verify the **follower-affinity
+ticket** — the HMAC-signed placement token that pins a browser session to one follower machine so
+its live-query ws stream and its api-server-issued lease co-locate. Used by the local dev-edge and
+any JS-side verify; production daemons mint/verify with the Rust crate.
+
+A ticket is `aff.<base64url(payload)>.<base64url(hmac_sha256(base64url(payload), key))>`. `mint` here
+is **byte-for-byte identical** to the crate for the same input (pinned by a shared frozen test
+vector), so a Rust-minted ticket verifies here and vice-versa. It is **placement, not
+authorization**: a forged ticket only aims a connection at a machine, granting no data access.
+
+Full docs — regional followers and the Fly-edge routing this drives:
+**[rindle.sh/docs/cloud-scaling](https://rindle.sh/docs/cloud-scaling)** · for agents:
+[llms.txt](https://rindle.sh/llms.txt)
+
+```ts
+import { mint, verify } from "@rindle/affinity";
+
+const ticket = mint(
+  { app, mid, region, sub: clientId, iat: now, exp: now + 3600, gen: 0 },
+  process.env.RINDLE_AFFINITY_KEY!,
+);
+
+const result = verify(ticket, [currentKey, previousKey], { app, now, minGen: 0 });
+if (result.ok) routeTo(result.payload.mid);
+```

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+/** The token namespace marker — the first dot-segment of every ticket. */
+export declare const TICKET_PREFIX = "aff";
+/** The base ws subprotocol offered alongside the `aff.*` ticket; the daemon echoes it on the 101. */
+export declare const WS_SUBPROTOCOL = "rindle.v1";
+/** The api-server → fleet control-plane header carrying the ticket on `/materialize` and `/query`. */
+export declare const HEADER_NAME = "Rindle-Affinity";
+/**
+ * The signed ticket body. Field order here is the canonical mint order — it is exactly the compact
+ * JSON that gets base64url-encoded and signed, so it must match the Rust `Payload` struct order.
+ */
+export interface Payload {
+    /** Fly app id the ticket is scoped to. */
+    app: string;
+    /** Fly machine id — the placement target (`fly-replay: instance=<mid>`). */
+    mid: string;
+    /** Fly region code of `mid`. */
+    region: string;
+    /** Subject: the connection identity (clientInstanceId). */
+    sub: string;
+    /** Issued-at, unix seconds (informational). */
+    iat: number;
+    /** Expiry, unix seconds. `verify` rejects once `now > exp`. */
+    exp: number;
+    /** Generation minted under; a fleet-wide bump drains older tickets. */
+    gen: number;
+}
+/** What {@link verify} holds a ticket against, supplied by the verifier. */
+export interface Expect {
+    /** The verifier's app id; must equal `payload.app`. */
+    app: string;
+    /** Current wall-clock, unix seconds. `exp < now` ⇒ rejected. */
+    now: number;
+    /** Minimum accepted generation; `gen < minGen` ⇒ rejected. `0` accepts any. */
+    minGen: number;
+}
+/** Why a ticket failed {@link verify}. Every variant is a terminal reject (fall back to re-pin). */
+export type VerifyError = "malformed" | "bad-signature" | "wrong-app" | "expired" | "stale-generation";
+/** {@link verify}'s result: the authenticated payload, or a reason. */
+export type VerifyResult = {
+    readonly ok: true;
+    readonly payload: Payload;
+} | {
+    readonly ok: false;
+    readonly error: VerifyError;
+};
+type Key = string | Uint8Array;
+/**
+ * Mint a ticket over `payload`, signed with `key`. Deterministic (no randomness): the same
+ * `(payload, key)` always yields the same token. The compact JSON is built in the fixed field order
+ * so the bytes match the Rust crate's `serde_json` compact output.
+ */
+export declare function mint(payload: Payload, key: Key): string;
+/**
+ * Verify `token` against `keys` (current first, then rotation-window predecessors) and `expect`.
+ * The HMAC is checked (constant-time) over the transmitted base64url payload segment before the
+ * payload is parsed, so a tampered payload fails as `bad-signature`, never as a parse of attacker
+ * bytes.
+ */
+export declare function verify(token: string, keys: readonly Key[], expect: Expect): VerifyResult;
+/**
+ * Extract the `aff.*` ticket from a `Sec-WebSocket-Protocol` header value (a comma list, e.g.
+ * `rindle.v1, aff.<…>`). Returns the raw ticket segment for {@link verify}, or `null`. Does not verify.
+ */
+export declare function wsSubprotocolTicket(header: string): string | null;
+/** Whether the header offers the base {@link WS_SUBPROTOCOL} — the daemon must echo it on the 101. */
+export declare function wsOffersBase(header: string): boolean;
+/** Extract the ticket from a {@link HEADER_NAME} value. Returns the raw segment, or `null`. */
+export declare function headerTicket(value: string): string | null;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAkBA,0EAA0E;AAC1E,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC,qGAAqG;AACrG,eAAO,MAAM,cAAc,cAAc,CAAC;AAE1C,sGAAsG;AACtG,eAAO,MAAM,WAAW,oBAAoB,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,4EAA4E;IAC5E,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,GAAG,EAAE,MAAM,CAAC;IACZ,+CAA+C;IAC/C,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,GAAG,EAAE,MAAM,CAAC;IACZ,uEAAuE;IACvE,GAAG,EAAE,MAAM,CAAC;CACb;AAED,4EAA4E;AAC5E,MAAM,WAAW,MAAM;IACrB,uDAAuD;IACvD,GAAG,EAAE,MAAM,CAAC;IACZ,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,oGAAoG;AACpG,MAAM,MAAM,WAAW,GACnB,WAAW,GACX,eAAe,GACf,WAAW,GACX,SAAS,GACT,kBAAkB,CAAC;AAEvB,uEAAuE;AACvE,MAAM,MAAM,YAAY,GACpB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAAE,GAChD;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAA;CAAE,CAAC;AAExD,KAAK,GAAG,GAAG,MAAM,GAAG,UAAU,CAAC;AAY/B;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,MAAM,CAavD;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,YAAY,CAoBxF;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAMjE;AAED,sGAAsG;AACtG,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED,+FAA+F;AAC/F,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAGzD"}

package/dist/index.js

@@ -0,0 +1,138 @@
+// Follower-affinity tickets — the TypeScript twin of the `rindle-affinity` Rust crate
+// (`rust/rindle-affinity/src/lib.rs`; `designs/FOLLOWER-AFFINITY-DESIGN.md` §3, §9). Used by the
+// local dev-edge (S4) and any JS-side verify; the daemon mints/verifies with the Rust crate.
+//
+// # Byte-compatibility
+//
+// A ticket is `aff.<base64url(payload)>.<base64url(hmac_sha256(base64url(payload), key))>` where
+// `payload` is COMPACT JSON with the field order below. `mint` here produces byte-for-byte the same
+// token as the Rust crate for the same input — pinned by the shared `frozenTestVector` in the tests
+// (mirrored from the crate's `frozen_test_vector`). Because `verify` authenticates the transmitted
+// base64url payload segment BEFORE parsing it, a Rust-minted ticket verifies here and vice-versa
+// regardless of either side's JSON handling.
+//
+// Placement, not authorization (design §3, §9): a forged ticket only *aims* a connection at a
+// machine, granting no data access. The key is a symmetric per-fleet secret.
+import { createHmac, timingSafeEqual } from "node:crypto";
+/** The token namespace marker — the first dot-segment of every ticket. */
+export const TICKET_PREFIX = "aff";
+/** The base ws subprotocol offered alongside the `aff.*` ticket; the daemon echoes it on the 101. */
+export const WS_SUBPROTOCOL = "rindle.v1";
+/** The api-server → fleet control-plane header carrying the ticket on `/materialize` and `/query`. */
+export const HEADER_NAME = "Rindle-Affinity";
+const B64URL = /^[A-Za-z0-9_-]+$/;
+function keyBytes(key) {
+    return typeof key === "string" ? new TextEncoder().encode(key) : key;
+}
+function b64url(bytes) {
+    return Buffer.from(bytes).toString("base64url");
+}
+/**
+ * Mint a ticket over `payload`, signed with `key`. Deterministic (no randomness): the same
+ * `(payload, key)` always yields the same token. The compact JSON is built in the fixed field order
+ * so the bytes match the Rust crate's `serde_json` compact output.
+ */
+export function mint(payload, key) {
+    const json = JSON.stringify({
+        app: payload.app,
+        mid: payload.mid,
+        region: payload.region,
+        sub: payload.sub,
+        iat: payload.iat,
+        exp: payload.exp,
+        gen: payload.gen,
+    });
+    const payloadB64 = Buffer.from(json, "utf8").toString("base64url");
+    const sig = createHmac("sha256", keyBytes(key)).update(payloadB64).digest();
+    return `${TICKET_PREFIX}.${payloadB64}.${b64url(sig)}`;
+}
+/**
+ * Verify `token` against `keys` (current first, then rotation-window predecessors) and `expect`.
+ * The HMAC is checked (constant-time) over the transmitted base64url payload segment before the
+ * payload is parsed, so a tampered payload fails as `bad-signature`, never as a parse of attacker
+ * bytes.
+ */
+export function verify(token, keys, expect) {
+    const parts = splitToken(token);
+    if (!parts)
+        return { ok: false, error: "malformed" };
+    const [payloadB64, sigB64] = parts;
+    if (!B64URL.test(payloadB64) || !B64URL.test(sigB64))
+        return { ok: false, error: "malformed" };
+    const sig = Buffer.from(sigB64, "base64url");
+    const msg = Buffer.from(payloadB64, "utf8");
+    const matches = keys.some((k) => {
+        const mac = createHmac("sha256", keyBytes(k)).update(msg).digest();
+        return mac.length === sig.length && timingSafeEqual(mac, sig);
+    });
+    if (!matches)
+        return { ok: false, error: "bad-signature" };
+    const payload = parsePayload(payloadB64);
+    if (!payload)
+        return { ok: false, error: "malformed" };
+    if (payload.app !== expect.app)
+        return { ok: false, error: "wrong-app" };
+    if (expect.now > payload.exp)
+        return { ok: false, error: "expired" };
+    if (payload.gen < expect.minGen)
+        return { ok: false, error: "stale-generation" };
+    return { ok: true, payload };
+}
+/**
+ * Extract the `aff.*` ticket from a `Sec-WebSocket-Protocol` header value (a comma list, e.g.
+ * `rindle.v1, aff.<…>`). Returns the raw ticket segment for {@link verify}, or `null`. Does not verify.
+ */
+export function wsSubprotocolTicket(header) {
+    for (const raw of header.split(",")) {
+        const p = raw.trim();
+        if (isTicketShape(p))
+            return p;
+    }
+    return null;
+}
+/** Whether the header offers the base {@link WS_SUBPROTOCOL} — the daemon must echo it on the 101. */
+export function wsOffersBase(header) {
+    return header.split(",").some((p) => p.trim() === WS_SUBPROTOCOL);
+}
+/** Extract the ticket from a {@link HEADER_NAME} value. Returns the raw segment, or `null`. */
+export function headerTicket(value) {
+    const v = value.trim();
+    return isTicketShape(v) ? v : null;
+}
+/** A syntactic ticket = `aff.<seg>.<seg>` with non-empty segments. Cheap prefilter, like the crate. */
+function isTicketShape(s) {
+    return splitToken(s) !== null;
+}
+/** Split into (payloadB64, sigB64), validating the `aff.` prefix and exact 3-segment shape. */
+function splitToken(token) {
+    const parts = token.split(".");
+    if (parts.length !== 3)
+        return null;
+    const [prefix, payloadB64, sigB64] = parts;
+    if (prefix !== TICKET_PREFIX || payloadB64.length === 0 || sigB64.length === 0)
+        return null;
+    return [payloadB64, sigB64];
+}
+function parsePayload(payloadB64) {
+    let value;
+    try {
+        value = JSON.parse(Buffer.from(payloadB64, "base64url").toString("utf8"));
+    }
+    catch {
+        return null;
+    }
+    if (typeof value !== "object" || value === null)
+        return null;
+    const p = value;
+    if (typeof p.app !== "string" ||
+        typeof p.mid !== "string" ||
+        typeof p.region !== "string" ||
+        typeof p.sub !== "string" ||
+        typeof p.iat !== "number" ||
+        typeof p.exp !== "number" ||
+        typeof p.gen !== "number") {
+        return null;
+    }
+    return { app: p.app, mid: p.mid, region: p.region, sub: p.sub, iat: p.iat, exp: p.exp, gen: p.gen };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AACtF,iGAAiG;AACjG,6FAA6F;AAC7F,EAAE;AACF,uBAAuB;AACvB,EAAE;AACF,iGAAiG;AACjG,oGAAoG;AACpG,oGAAoG;AACpG,mGAAmG;AACnG,iGAAiG;AACjG,6CAA6C;AAC7C,EAAE;AACF,8FAA8F;AAC9F,6EAA6E;AAE7E,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE1D,0EAA0E;AAC1E,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAC;AAEnC,qGAAqG;AACrG,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC;AAE1C,sGAAsG;AACtG,MAAM,CAAC,MAAM,WAAW,GAAG,iBAAiB,CAAC;AAgD7C,MAAM,MAAM,GAAG,kBAAkB,CAAC;AAElC,SAAS,QAAQ,CAAC,GAAQ;IACxB,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AACvE,CAAC;AAED,SAAS,MAAM,CAAC,KAAiB;IAC/B,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAC,OAAgB,EAAE,GAAQ;IAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnE,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5E,OAAO,GAAG,aAAa,IAAI,UAAU,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa,EAAE,IAAoB,EAAE,MAAc;IACxE,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IACrD,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAE/F,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;QAC9B,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QACnE,OAAO,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;IAE3D,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;IACzC,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IACvD,IAAI,OAAO,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IACzE,IAAI,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACrE,IAAI,OAAO,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;IACjF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC/B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAc;IAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;QACrB,IAAI,aAAa,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,sGAAsG;AACtG,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,cAAc,CAAC,CAAC;AACpE,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IACvB,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACrC,CAAC;AAED,uGAAuG;AACvG,SAAS,aAAa,CAAC,CAAS;IAC9B,OAAO,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAChC,CAAC;AAED,+FAA+F;AAC/F,SAAS,UAAU,CAAC,KAAa;IAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;IAC3C,IAAI,MAAM,KAAK,aAAa,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5F,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,YAAY,CAAC,UAAkB;IACtC,IAAI,KAAc,CAAC;IACnB,IAAI,CAAC;QACH,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC7D,MAAM,CAAC,GAAG,KAAgC,CAAC;IAC3C,IACE,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;QACzB,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;QACzB,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ;QAC5B,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;QACzB,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;QACzB,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;QACzB,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ,EACzB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;AACtG,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@rindle/affinity",
+  "version": "0.6.3",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rindle-sh/rindle.git",
+    "directory": "packages/affinity"
+  },
+  "type": "module",
+  "description": "Follower-affinity ticket: mint/verify the HMAC placement token, byte-compatible with the rindle-affinity Rust crate.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "@rindle/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "typescript": "^5.7.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "tsc --noEmit && node --conditions=@rindle/source --test test/*.test.ts"
+  }
+}

package/src/index.ts

@@ -0,0 +1,190 @@
+// Follower-affinity tickets — the TypeScript twin of the `rindle-affinity` Rust crate
+// (`rust/rindle-affinity/src/lib.rs`; `designs/FOLLOWER-AFFINITY-DESIGN.md` §3, §9). Used by the
+// local dev-edge (S4) and any JS-side verify; the daemon mints/verifies with the Rust crate.
+//
+// # Byte-compatibility
+//
+// A ticket is `aff.<base64url(payload)>.<base64url(hmac_sha256(base64url(payload), key))>` where
+// `payload` is COMPACT JSON with the field order below. `mint` here produces byte-for-byte the same
+// token as the Rust crate for the same input — pinned by the shared `frozenTestVector` in the tests
+// (mirrored from the crate's `frozen_test_vector`). Because `verify` authenticates the transmitted
+// base64url payload segment BEFORE parsing it, a Rust-minted ticket verifies here and vice-versa
+// regardless of either side's JSON handling.
+//
+// Placement, not authorization (design §3, §9): a forged ticket only *aims* a connection at a
+// machine, granting no data access. The key is a symmetric per-fleet secret.
+
+import { createHmac, timingSafeEqual } from "node:crypto";
+
+/** The token namespace marker — the first dot-segment of every ticket. */
+export const TICKET_PREFIX = "aff";
+
+/** The base ws subprotocol offered alongside the `aff.*` ticket; the daemon echoes it on the 101. */
+export const WS_SUBPROTOCOL = "rindle.v1";
+
+/** The api-server → fleet control-plane header carrying the ticket on `/materialize` and `/query`. */
+export const HEADER_NAME = "Rindle-Affinity";
+
+/**
+ * The signed ticket body. Field order here is the canonical mint order — it is exactly the compact
+ * JSON that gets base64url-encoded and signed, so it must match the Rust `Payload` struct order.
+ */
+export interface Payload {
+  /** Fly app id the ticket is scoped to. */
+  app: string;
+  /** Fly machine id — the placement target (`fly-replay: instance=<mid>`). */
+  mid: string;
+  /** Fly region code of `mid`. */
+  region: string;
+  /** Subject: the connection identity (clientInstanceId). */
+  sub: string;
+  /** Issued-at, unix seconds (informational). */
+  iat: number;
+  /** Expiry, unix seconds. `verify` rejects once `now > exp`. */
+  exp: number;
+  /** Generation minted under; a fleet-wide bump drains older tickets. */
+  gen: number;
+}
+
+/** What {@link verify} holds a ticket against, supplied by the verifier. */
+export interface Expect {
+  /** The verifier's app id; must equal `payload.app`. */
+  app: string;
+  /** Current wall-clock, unix seconds. `exp < now` ⇒ rejected. */
+  now: number;
+  /** Minimum accepted generation; `gen < minGen` ⇒ rejected. `0` accepts any. */
+  minGen: number;
+}
+
+/** Why a ticket failed {@link verify}. Every variant is a terminal reject (fall back to re-pin). */
+export type VerifyError =
+  | "malformed"
+  | "bad-signature"
+  | "wrong-app"
+  | "expired"
+  | "stale-generation";
+
+/** {@link verify}'s result: the authenticated payload, or a reason. */
+export type VerifyResult =
+  | { readonly ok: true; readonly payload: Payload }
+  | { readonly ok: false; readonly error: VerifyError };
+
+type Key = string | Uint8Array;
+
+const B64URL = /^[A-Za-z0-9_-]+$/;
+
+function keyBytes(key: Key): Uint8Array {
+  return typeof key === "string" ? new TextEncoder().encode(key) : key;
+}
+
+function b64url(bytes: Uint8Array): string {
+  return Buffer.from(bytes).toString("base64url");
+}
+
+/**
+ * Mint a ticket over `payload`, signed with `key`. Deterministic (no randomness): the same
+ * `(payload, key)` always yields the same token. The compact JSON is built in the fixed field order
+ * so the bytes match the Rust crate's `serde_json` compact output.
+ */
+export function mint(payload: Payload, key: Key): string {
+  const json = JSON.stringify({
+    app: payload.app,
+    mid: payload.mid,
+    region: payload.region,
+    sub: payload.sub,
+    iat: payload.iat,
+    exp: payload.exp,
+    gen: payload.gen,
+  });
+  const payloadB64 = Buffer.from(json, "utf8").toString("base64url");
+  const sig = createHmac("sha256", keyBytes(key)).update(payloadB64).digest();
+  return `${TICKET_PREFIX}.${payloadB64}.${b64url(sig)}`;
+}
+
+/**
+ * Verify `token` against `keys` (current first, then rotation-window predecessors) and `expect`.
+ * The HMAC is checked (constant-time) over the transmitted base64url payload segment before the
+ * payload is parsed, so a tampered payload fails as `bad-signature`, never as a parse of attacker
+ * bytes.
+ */
+export function verify(token: string, keys: readonly Key[], expect: Expect): VerifyResult {
+  const parts = splitToken(token);
+  if (!parts) return { ok: false, error: "malformed" };
+  const [payloadB64, sigB64] = parts;
+  if (!B64URL.test(payloadB64) || !B64URL.test(sigB64)) return { ok: false, error: "malformed" };
+
+  const sig = Buffer.from(sigB64, "base64url");
+  const msg = Buffer.from(payloadB64, "utf8");
+  const matches = keys.some((k) => {
+    const mac = createHmac("sha256", keyBytes(k)).update(msg).digest();
+    return mac.length === sig.length && timingSafeEqual(mac, sig);
+  });
+  if (!matches) return { ok: false, error: "bad-signature" };
+
+  const payload = parsePayload(payloadB64);
+  if (!payload) return { ok: false, error: "malformed" };
+  if (payload.app !== expect.app) return { ok: false, error: "wrong-app" };
+  if (expect.now > payload.exp) return { ok: false, error: "expired" };
+  if (payload.gen < expect.minGen) return { ok: false, error: "stale-generation" };
+  return { ok: true, payload };
+}
+
+/**
+ * Extract the `aff.*` ticket from a `Sec-WebSocket-Protocol` header value (a comma list, e.g.
+ * `rindle.v1, aff.<…>`). Returns the raw ticket segment for {@link verify}, or `null`. Does not verify.
+ */
+export function wsSubprotocolTicket(header: string): string | null {
+  for (const raw of header.split(",")) {
+    const p = raw.trim();
+    if (isTicketShape(p)) return p;
+  }
+  return null;
+}
+
+/** Whether the header offers the base {@link WS_SUBPROTOCOL} — the daemon must echo it on the 101. */
+export function wsOffersBase(header: string): boolean {
+  return header.split(",").some((p) => p.trim() === WS_SUBPROTOCOL);
+}
+
+/** Extract the ticket from a {@link HEADER_NAME} value. Returns the raw segment, or `null`. */
+export function headerTicket(value: string): string | null {
+  const v = value.trim();
+  return isTicketShape(v) ? v : null;
+}
+
+/** A syntactic ticket = `aff.<seg>.<seg>` with non-empty segments. Cheap prefilter, like the crate. */
+function isTicketShape(s: string): boolean {
+  return splitToken(s) !== null;
+}
+
+/** Split into (payloadB64, sigB64), validating the `aff.` prefix and exact 3-segment shape. */
+function splitToken(token: string): [string, string] | null {
+  const parts = token.split(".");
+  if (parts.length !== 3) return null;
+  const [prefix, payloadB64, sigB64] = parts;
+  if (prefix !== TICKET_PREFIX || payloadB64.length === 0 || sigB64.length === 0) return null;
+  return [payloadB64, sigB64];
+}
+
+function parsePayload(payloadB64: string): Payload | null {
+  let value: unknown;
+  try {
+    value = JSON.parse(Buffer.from(payloadB64, "base64url").toString("utf8"));
+  } catch {
+    return null;
+  }
+  if (typeof value !== "object" || value === null) return null;
+  const p = value as Record<string, unknown>;
+  if (
+    typeof p.app !== "string" ||
+    typeof p.mid !== "string" ||
+    typeof p.region !== "string" ||
+    typeof p.sub !== "string" ||
+    typeof p.iat !== "number" ||
+    typeof p.exp !== "number" ||
+    typeof p.gen !== "number"
+  ) {
+    return null;
+  }
+  return { app: p.app, mid: p.mid, region: p.region, sub: p.sub, iat: p.iat, exp: p.exp, gen: p.gen };
+}