@peac/policy-kit 0.9.18 → 0.10.0

package/LICENSE

@@ -0,0 +1,190 @@
+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
+
+Copyright 2025 PEAC Protocol Contributors
+
+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/dist/enforce.d.ts

@@ -0,0 +1,256 @@
+/**
+ * Decision Enforcement
+ *
+ * Helpers for enforcing policy decisions with explicit semantics.
+ *
+ * The `review` decision means "challenge unless requirement is satisfied".
+ * By default, this means a valid receipt is required.
+ *
+ * @example
+ * ```typescript
+ * import { evaluate, enforceDecision } from '@peac/policy-kit';
+ *
+ * const result = evaluate(policy, context);
+ * const enforcement = enforceDecision(result.decision, {
+ *   receiptVerified: hasValidReceipt,
+ * });
+ *
+ * if (enforcement.allowed) {
+ *   // proceed
+ * } else {
+ *   // return enforcement.statusCode (402 or 403)
+ * }
+ * ```
+ *
+ * @packageDocumentation
+ */
+import type { ControlDecision } from './types';
+/**
+ * Context for enforcement decision
+ */
+export interface EnforcementContext {
+    /**
+     * Whether a valid PEAC receipt has been verified.
+     * If true, `review` decisions are allowed.
+     *
+     * This is the only requirement for `review` decisions in v0.9.23.
+     * Future versions may add additional attestation models.
+     */
+    receiptVerified?: boolean;
+}
+/**
+ * Result of enforcement decision
+ */
+export interface EnforcementResult {
+    /**
+     * Whether access should be allowed
+     */
+    allowed: boolean;
+    /**
+     * Recommended HTTP status code
+     * - 200: OK (allowed)
+     * - 402: Payment Required (review decision, receipt needed)
+     * - 403: Forbidden (deny decision)
+     */
+    statusCode: 200 | 402 | 403;
+    /**
+     * Reason for the decision
+     */
+    reason: string;
+    /**
+     * Whether a challenge should be issued (for review decisions)
+     */
+    challenge: boolean;
+    /**
+     * The original decision that was enforced
+     */
+    decision: ControlDecision;
+}
+/**
+ * Enforce a policy decision with explicit semantics.
+ *
+ * Decision meanings:
+ * - `allow`: Access is permitted (200)
+ * - `deny`: Access is forbidden (403)
+ * - `review`: Challenge unless requirement is satisfied (default: receipt required)
+ *
+ * The `review` decision is a "soft deny" that becomes "allow" when the
+ * requirement (typically a valid receipt) is satisfied.
+ *
+ * @param decision - The policy decision to enforce
+ * @param context - Enforcement context with requirement flags
+ * @returns Enforcement result with allowed status and HTTP code
+ *
+ * @example
+ * ```typescript
+ * // Allow decision
+ * enforceDecision('allow', {});
+ * // { allowed: true, statusCode: 200, challenge: false }
+ *
+ * // Deny decision
+ * enforceDecision('deny', {});
+ * // { allowed: false, statusCode: 403, challenge: false }
+ *
+ * // Review without receipt
+ * enforceDecision('review', { receiptVerified: false });
+ * // { allowed: false, statusCode: 402, challenge: true }
+ *
+ * // Review with valid receipt
+ * enforceDecision('review', { receiptVerified: true });
+ * // { allowed: true, statusCode: 200, challenge: false }
+ * ```
+ */
+export declare function enforceDecision(decision: ControlDecision, context?: EnforcementContext): EnforcementResult;
+/**
+ * Check if an enforcement result requires a challenge response
+ *
+ * @param result - Enforcement result
+ * @returns true if a challenge should be issued
+ */
+export declare function requiresChallenge(result: EnforcementResult): boolean;
+/**
+ * Get the WWW-Authenticate header value for a challenge
+ *
+ * @param result - Enforcement result requiring challenge
+ * @returns WWW-Authenticate header value or undefined if no challenge needed
+ *
+ * @example
+ * ```typescript
+ * const result = enforceDecision('review', { receiptVerified: false });
+ * const header = getChallengeHeader(result);
+ * // 'PEAC realm="receipt", error="receipt_required"'
+ * ```
+ */
+export declare function getChallengeHeader(result: EnforcementResult): string | undefined;
+/**
+ * Convenience function to enforce and get HTTP response details
+ *
+ * @param decision - Policy decision
+ * @param context - Enforcement context
+ * @returns Object with status code and headers for HTTP response
+ *
+ * @example
+ * ```typescript
+ * const { status, headers, allowed } = enforceForHttp('review', {
+ *   receiptVerified: false,
+ * });
+ * // { status: 402, headers: { 'WWW-Authenticate': '...' }, allowed: false }
+ * ```
+ */
+export declare function enforceForHttp(decision: ControlDecision, context?: EnforcementContext): {
+    status: number;
+    headers: Record<string, string>;
+    allowed: boolean;
+    reason: string;
+};
+/**
+ * Result of purpose-specific enforcement
+ *
+ * Purpose enforcement NEVER uses 402. 402 is reserved for payment/receipt challenges.
+ * Purpose decisions use:
+ * - 200: OK (purpose allowed)
+ * - 400: Bad Request (invalid purpose token)
+ * - 403: Forbidden (purpose denied by policy)
+ */
+export interface PurposeEnforcementResult {
+    /**
+     * Whether access should be allowed based on purpose
+     */
+    allowed: boolean;
+    /**
+     * HTTP status code for purpose enforcement
+     * - 200: OK (allowed)
+     * - 400: Bad Request (invalid purpose token, explicit "undeclared")
+     * - 403: Forbidden (purpose denied by policy)
+     *
+     * NOTE: 402 is NEVER returned. 402 is reserved for payment/receipt challenges.
+     */
+    statusCode: 200 | 400 | 403;
+    /**
+     * Reason for the decision
+     */
+    reason: string;
+    /**
+     * The purpose decision that was enforced
+     */
+    decision: ControlDecision;
+}
+/**
+ * Context for purpose enforcement
+ */
+export interface PurposeEnforcementContext {
+    /**
+     * Whether the purpose token(s) passed grammar validation.
+     * If false, returns 400 Bad Request.
+     */
+    purposeValid: boolean;
+    /**
+     * Whether the request explicitly included "undeclared" as a purpose.
+     * If true, returns 400 Bad Request.
+     */
+    explicitUndeclared?: boolean;
+    /**
+     * Optional list of invalid tokens for error messaging
+     */
+    invalidTokens?: string[];
+}
+/**
+ * Enforce a policy decision for purpose-based access control.
+ *
+ * This function is specifically for purpose enforcement and NEVER returns 402.
+ * 402 is reserved for payment/receipt challenges (use `enforceDecision` for that).
+ *
+ * Status code semantics:
+ * - 200: Purpose allowed
+ * - 400: Invalid purpose token (grammar violation or explicit "undeclared")
+ * - 403: Purpose denied by policy
+ *
+ * @param decision - The policy decision to enforce
+ * @param context - Purpose enforcement context
+ * @returns Purpose enforcement result with HTTP status code
+ *
+ * @example
+ * ```typescript
+ * import { enforcePurposeDecision } from '@peac/policy-kit';
+ *
+ * // Valid purpose, allowed
+ * enforcePurposeDecision('allow', { purposeValid: true });
+ * // { allowed: true, statusCode: 200, decision: 'allow' }
+ *
+ * // Valid purpose, denied by policy
+ * enforcePurposeDecision('deny', { purposeValid: true });
+ * // { allowed: false, statusCode: 403, decision: 'deny' }
+ *
+ * // Invalid purpose token
+ * enforcePurposeDecision('allow', { purposeValid: false, invalidTokens: ['train-'] });
+ * // { allowed: false, statusCode: 400, reason: 'Invalid purpose token(s): train-' }
+ *
+ * // Explicit "undeclared" in request (forbidden)
+ * enforcePurposeDecision('allow', { purposeValid: true, explicitUndeclared: true });
+ * // { allowed: false, statusCode: 400, reason: '"undeclared" is not a valid purpose token' }
+ * ```
+ */
+export declare function enforcePurposeDecision(decision: ControlDecision, context: PurposeEnforcementContext): PurposeEnforcementResult;
+/**
+ * Get HTTP status code for a purpose decision (low-level helper).
+ *
+ * This helper maps policy decisions to HTTP status codes for purpose enforcement.
+ * It NEVER returns 402 - that is reserved for payment/receipt challenges.
+ *
+ * For evaluating purpose with profiles, use getPurposeStatusCode from enforcement-profiles
+ * which takes a PurposeEvaluationResult directly.
+ *
+ * @param decision - Policy decision
+ * @param purposeValid - Whether the purpose token(s) passed validation
+ * @returns HTTP status code (200, 400, or 403)
+ *
+ * @example
+ * ```typescript
+ * getPurposeDecisionStatusCode('allow', true);  // 200
+ * getPurposeDecisionStatusCode('deny', true);   // 403
+ * getPurposeDecisionStatusCode('review', true); // 403 (NOT 402!)
+ * getPurposeDecisionStatusCode('allow', false); // 400 (invalid token)
+ * ```
+ */
+export declare function getPurposeDecisionStatusCode(decision: ControlDecision, purposeValid: boolean): 200 | 400 | 403;
+//# sourceMappingURL=enforce.d.ts.map

package/dist/enforce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enforce.d.ts","sourceRoot":"","sources":["../src/enforce.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;;OAKG;IACH,UAAU,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,kBAAuB,GAC/B,iBAAiB,CAuDnB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAEpE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAMhF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,kBAAuB,GAC/B;IACD,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAiBA;AAMD;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;;;;OAOG;IACH,UAAU,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,eAAe,EACzB,OAAO,EAAE,yBAAyB,GACjC,wBAAwB,CA4D1B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,eAAe,EACzB,YAAY,EAAE,OAAO,GACpB,GAAG,GAAG,GAAG,GAAG,GAAG,CAgBjB"}