@openlfcp/wire 0.1.0-rc.1

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 @@
+# @openlfcp/wire
+
+LFCP-WIRE-01 structures and codecs: deterministic CBOR (`@openlfcp/wire/cbor`), COSE_Sign1, Principal Descriptors, Control Records and chain validation, Data Units, Key Packages, Snapshots, invitations and the wire messages with the session handshake.
+
+```sh
+npm install @openlfcp/wire@next
+```
+
+ESM only; Node.js 24 or later (browsers and Electron for every package except `@openlfcp/storage-node`).
+
+## Scope
+
+Part of the OpenLFCP TypeScript SDK, which implements the OpenLFCP MVP 0.1
+subset of [LFCP-WIRE-01](https://github.com/openlfcp/spec/blob/main/wire/LFCP-WIRE-01.md)
+at `mvp-0.1-baseline.8`, not every deferred WIRE-01 feature. It does not
+claim full LFCP-WIRE-01 conformance. This is a release candidate
+(`0.1.0-rc.1`, npm dist-tag `next`): APIs may still change.
+
+## Links
+
+- Specification: [openlfcp/spec](https://github.com/openlfcp/spec)
+- Source and the other SDK packages: [openlfcp/sdk-ts](https://github.com/openlfcp/sdk-ts)
+- Issues: [openlfcp/sdk-ts/issues](https://github.com/openlfcp/sdk-ts/issues)
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

package/dist/capability.d.ts

@@ -0,0 +1,143 @@
+import { type ControlRecordId, type DataEpoch, type PrincipalId } from "@openlfcp/core";
+import type { ControlState } from "./chain.js";
+import { type ControlRecord } from "./control.js";
+import type { PrincipalDescriptor } from "./principal.js";
+/**
+ * The LFCP capability engine (LFCP-WIRE-01 §17, §18, §20, §19, §25.2).
+ *
+ * Authority comes only from the validated Control Chain: a Principal ID
+ * holds an ability at a Control Head H because of the owner rule or of
+ * grants and claims committed through H. There is no server account,
+ * user table or hosting identity anywhere in this module, and nothing
+ * here takes one.
+ *
+ * Everything is a pure function of a ControlState (the state at some head
+ * H). Evaluating at an older H means using the state at that H (see
+ * `stateAt` on a linear chain result), so a later revocation never
+ * changes an earlier answer.
+ */
+/** §17.1 standard ability codes. */
+export declare const ABILITY: Readonly<{
+    DATA_READ: 1n;
+    DATA_WRITE: 2n;
+    SNAPSHOT_PUBLISH: 3n;
+    CAPABILITY_GRANT: 4n;
+    CAPABILITY_REVOKE: 5n;
+    KEY_DISTRIBUTE: 6n;
+    KEY_ROTATE: 7n;
+    ROUTE_UPDATE: 8n;
+    OWNER_TRANSFER_OFFER: 9n;
+    RESOURCE_TOMBSTONE: 10n;
+    INVITE_CLAIM: 11n;
+}>;
+/** §17.1 names of the standard codes. */
+export declare const ABILITY_NAMES: ReadonlyMap<bigint, string>;
+/**
+ * Whether `ability` is a §17.1 standard code. §17.1: "A code that is not in
+ * the table above is kept as received and confers nothing", so an unknown
+ * code is kept in its record but is never held.
+ */
+export declare const isStandardAbility: (ability: bigint) => boolean;
+/** A grant created by a CAPABILITY_GRANT record or by a successful claim (§17.2, §18.1). */
+export interface Grant {
+    /** The ID of the Control Record that created it (§17.2). */
+    readonly id: ControlRecordId;
+    readonly source: "grant" | "claim";
+    readonly issuer: PrincipalId;
+    readonly subject: PrincipalId;
+    readonly abilities: readonly bigint[];
+    readonly delegable: readonly bigint[];
+    readonly parentGrantId: ControlRecordId | null;
+    /** §17.2 claim_limit, for invitation grants; null when absent. */
+    readonly claimLimit: bigint | null;
+    /** Claims consumed so far, counted in linear chain order (§18.1). */
+    readonly claimsUsed: bigint;
+    /** The revoking record, or null while not revoked (§17.3). */
+    readonly revokedBy: ControlRecordId | null;
+}
+/** The capability part of ControlState. */
+export interface CapabilityState {
+    /** Every grant created through this head, by grant ID hex, active or not. */
+    readonly grants: ReadonlyMap<string, Grant>;
+}
+/**
+ * Whether a grant is active at this state. §17.2: "A grant is active while
+ * it has not been revoked and, when it has a parent grant, while that
+ * parent is active. Revoking a grant therefore also deactivates every grant
+ * delegated from it, directly or through further delegations."
+ */
+export declare function isGrantActive(state: CapabilityState, grantId: Uint8Array): boolean;
+/**
+ * Whether `principal` holds `ability` at the head of `state`: the owner
+ * holds every standard ability implicitly (§17.1, no self-grant); anyone
+ * else holds it through an active grant that confers it. Unknown codes and
+ * the reserved ability 9 are held by no one (§17.1, §23.1).
+ */
+export declare function hasAbility(state: ControlState, principal: PrincipalId, ability: bigint): boolean;
+/** Every standard ability `principal` holds at the head of `state`, ascending. */
+export declare function abilitiesOf(state: ControlState, principal: PrincipalId): readonly bigint[];
+/**
+ * An authorization decision; a refusal names the rule. `code` marks the
+ * refusals callers must tell apart: INVITE_CLAIM_EXHAUSTED (§18.1 rule 3,
+ * which LFCP-022 reports separately; still AUTHORIZATION_FAILED on the
+ * wire) and INVALID_SIGNATURE (§23.3: a transfer offer or acceptance whose
+ * signature does not verify, INVALID_SIGNATURE on the wire).
+ */
+export type Authorization = {
+    readonly allowed: true;
+} | {
+    readonly allowed: false;
+    readonly reason: string;
+    readonly code?: "INVITE_CLAIM_EXHAUSTED" | "INVALID_SIGNATURE";
+};
+/**
+ * Whether the issuer of `record` had the authority the record needs, at
+ * the state before it (the chain's previous head). Genesis is authorized by
+ * verifyGenesis. Coordinator Recovery and Resource Tombstone records never
+ * get here: the chain refuses them first (DV1).
+ */
+export declare function authorizeControlRecord(record: ControlRecord, state: ControlState): Authorization;
+/** The capability transitions of an applied record (called by applyRecord). */
+export declare function applyCapabilities(grants: ReadonlyMap<string, Grant>, record: ControlRecord): ReadonlyMap<string, Grant>;
+/**
+ * §25.2 Key Package authority at the package's referenced Control Head:
+ * the sender must hold key/distribute, and the recipient must hold
+ * data/read, "except for an Invitation Principal explicitly authorized by
+ * an active invite grant: a recipient that is the subject of an active
+ * grant that includes and still confers invite/claim". `epoch` is the
+ * package's Data Epoch; whether that epoch is recognized at the head is
+ * checked with the epoch rules (LFCP-023, LFCP-024).
+ */
+export declare function canDistributeKey(state: ControlState, sender: PrincipalId, recipient: PrincipalId, _epoch: DataEpoch): Authorization;
+/** A verified ownership transfer: the new owner's descriptor, from the offer. */
+export interface VerifiedOwnerTransfer {
+    readonly authorization: Authorization;
+    readonly newOwner?: PrincipalDescriptor;
+}
+/**
+ * The §23.3 verifier for an OWNER_TRANSFER_COMMIT, at the state before it.
+ * Verification only: there is no transfer UI or flow (deferred from MVP 0.1).
+ *
+ * §23.3 "A verifier MUST confirm":
+ *  1. the offer is signed by the current owner;
+ *  2. the offer references the current Control Head;
+ *  3. the offer names the accepting Principal;
+ *  4. the acceptance is signed by that Principal;
+ *  5. the commit itself is signed by that Principal (here: issued by it;
+ *     the chain verifies the signature against the issuer);
+ *  6. the expected next Control Sequence matches the commit sequence.
+ * Also, from §23.1 and §23.2: the offer and accept are canonical signed
+ * objects of this Resource, and the accept names the exact offer ID (the
+ * §10.6 object ID of the offer bytes). §23.3: "A commit that fails any of
+ * these checks is rejected with AUTHORIZATION_FAILED, except that an offer
+ * or acceptance whose signature does not verify is rejected with
+ * INVALID_SIGNATURE" (the refusal's code).
+ */
+export declare function verifyOwnerTransfer(record: ControlRecord, state: ControlState): VerifiedOwnerTransfer;
+/**
+ * The descriptor a transfer commit carries for its own issuer: the offer's
+ * proposed owner (self-certifying, §7), so a new owner never granted
+ * before can still be verified. Undefined for other records.
+ */
+export declare function transferIssuerDescriptor(record: ControlRecord): PrincipalDescriptor | undefined;
+//# sourceMappingURL=capability.d.ts.map