permdiff 0.1.0__tar.gz

permdiff-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+.venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.hypothesis/
+.coverage
+coverage.xml
+htmlcov/
+dist/
+build/
+*.egg-info/
+.DS_Store

permdiff-0.1.0/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.

permdiff-0.1.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.5
+Name: permdiff
+Version: 0.1.0
+Summary: terraform plan for AI agent permission changes: replay recorded tool calls against a policy at two git refs and report what changes
+Project-URL: Homepage, https://github.com/smhasan94/permdiff
+Project-URL: Repository, https://github.com/smhasan94/permdiff
+Project-URL: Issues, https://github.com/smhasan94/permdiff/issues
+Author: Sharukh Hasan
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agents,authorization,cedar,ci,mcp,opa,policy,rego
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.11.4
+Requires-Dist: click<9,>=8.1
+Requires-Dist: pydantic<3,>=2.7
+Requires-Dist: rich<16,>=13
+Provides-Extra: cedar
+Requires-Dist: cedarpy~=4.12; extra == 'cedar'
+Description-Content-Type: text/markdown
+
+# permdiff
+
+`terraform plan` for AI agent permission changes.
+
+permdiff replays a corpus of recorded agent tool calls against an authorization
+policy at two git refs and reports which calls change decision: what becomes
+denied, what becomes allowed, what now needs human approval, and what could not
+be evaluated. It never calls a model. It replays decisions.
+
+```
+$ permdiff diff --base origin/main --head HEAD --traces traces/*.jsonl
+
+permdiff: origin/main → HEAD   (4,812 calls, 2026-09-18 → 2026-09-25)
+  newly DENIED             37   aws.ec2.terminate_instance
+  newly ALLOWED             2   github.delete_branch          ⚠ widening
+  now REQUIRE_APPROVAL    118   stripe.refund
+  can't evaluate            9   missing context: principal.department
+  unchanged             4,646
+```
+
+## Status
+
+0.1.0, prepared and awaiting publication (see `docs/release.md`). Progress by epic is
+in `docs/03-epics.md`; changes in `CHANGELOG.md`.
+
+## Install
+
+```
+pip install permdiff
+```
+
+Python 3.11 or newer.
+
+## Quickstart
+
+**1. Try it on the bundled example (30 seconds).**
+
+```
+permdiff demo
+```
+
+This diffs two bundled policy versions over a synthetic 200-call corpus and
+prints one widening group (`github.delete_branch` newly allowed outside
+prod), two tightening groups, and a can't-evaluate group where the new policy
+needs a `department` attribute the traces lack. It exits `2` because a
+widening was found. Nothing is downloaded and no network is used.
+
+The demo uses the pinned OPA binary when it is installed and otherwise the
+bundled Python engine. To see the Rego version:
+
+```
+permdiff setup opa          # downloads opa 1.21.0 into your user cache, checksum verified
+permdiff demo --engine opa
+```
+
+**2. Point it at your own policy and traces.**
+
+```
+permdiff diff --base origin/main --head HEAD --policy policy/ \
+              --engine opa --decision data.agent.authz.decision \
+              --traces traces/*.jsonl
+```
+
+With `--engine opa` every trace becomes `input`, `time.now_ns()` returns the
+trace's timestamp, and the decision rule may return an object
+(`{"effect": "allow|deny|require_approval", "reason": "...", "rule": "..."}`),
+a boolean, or an effect string. `{"effect": "error", "kind": "missing_context",
+"reason": "principal.attrs.department"}` reports a call the policy cannot
+decide. Rules that stay undefined count as `deny` (`--undefined error` to
+flag them instead). OPA runs with `http.send`, `net.lookup_ip_addr`,
+`rand.intn`, `uuid.rfc4122`, and `opa.runtime` removed from its capabilities;
+a policy that uses one is reported as nondeterministic for every call unless
+you replay recorded values with `--nd-cache decision-log.json` (OPA's
+`nd_builtin_cache` shape). `permdiff check` validates traces and compiles both
+refs without diffing, which is what CI runs first.
+
+**3. Put it in CI.**
+
+```yaml
+name: permdiff
+on: pull_request
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  permdiff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with: { fetch-depth: 0 }
+      - uses: smhasan94/permdiff@v0
+        with:
+          traces: traces/*.jsonl
+```
+
+The action runs `permdiff check`, then `diff`, and upserts one PR comment marked
+`<!-- permdiff -->` that updates in place on every push. The check fails on
+widening (`fail-on: widen`). Fork PRs, whose token is read-only, get the same
+report in the job summary and as an artifact. `sarif: "true"` adds a SARIF file
+for `github/codeql-action/upload-sarif@v4`. Inputs and outputs are in
+[docs/action.md](docs/action.md). Save the flags once with `permdiff init` and
+commit `permdiff.toml`; flags override environment variables
+(`PERMDIFF_REPORT_FAIL_ON=none`) which override the file.
+
+For a Python policy adapter instead:
+
+```
+permdiff diff --base origin/main --head HEAD --policy policy/ \
+              --engine python:authz.permdiff_adapter:evaluate \
+              --traces traces/*.jsonl
+```
+
+`diff` replays every trace against the policy at both refs and prints the
+summary block above. Exit code `2` means the run matched `--fail-on`
+(`widen` by default), `1` means permdiff itself failed, `0` means nothing
+matched. `--head WORKTREE` uses the uncommitted policy in your working tree.
+
+Traces are JSONL, one `ToolCall` per line; `permdiff schema toolcall` prints
+the JSON Schema. Reports redact argument values by default; `--show-args`
+reveals named keys and `--redact none` shows everything for local use.
+
+`--format markdown|json|sarif` and `permdiff render --from-json` produce the
+other outputs; `permdiff schema report` prints the JSON report's schema. The
+Cedar engine and the Custody and OpenTelemetry importers arrive in the next
+epics. The design is in `docs/01-overview.md`.
+
+## Engines
+
+`--engine cedar` (`pip install "permdiff[cedar]"`) loads `*.cedar` files, one
+`*.cedarschema`, and `entities.json` from the policy path, validates the policies
+against the schema, and evaluates every trace as a Cedar request built from the
+`[cedar]` templates (`principal`, `action`, `resource`; defaults
+`User::"{principal.id}"`, `Action::"{tool.name}"`, `Resource::"{resource.id}"`).
+The request context is the call's arguments plus its trace context, plus
+`context.call.{principal,agent,tool,resource}` and `context.now` (the trace
+timestamp as a Cedar `datetime`). A deny whose forbids all carry
+`@require_approval("reason")` is reported as require-approval; a missing
+attribute or entity is can't-evaluate naming it. `permdiff demo --engine cedar`
+runs the bundled Cedar variant.
+
+## Performance
+
+100,000 calls end to end (import, both refs, classify, markdown) on an Apple
+M-series laptop, `python -m bench.run --n 100000`:
+
+| Engine | Import | Diff (both refs) | Report | Total | Peak RSS |
+|---|---:|---:|---:|---:|---:|
+| Python callable | 2.4 s | 2.8 s | 0.15 s | 6.5 s | 799 MB |
+| OPA 1.21.0 | 2.5 s | 8.0 s | 0.17 s | 11.8 s | 965 MB |
+
+Cedar evaluates 100,000 calls per ref in about 12 s through cedarpy. CI runs the
+benchmark on every push and fails on a 1.5x regression against `bench/baseline.json`.
+
+`--engine opa` runs a pinned OPA binary (1.21.0, SHA-256 verified on
+download; override with `--opa-bin` or `PERMDIFF_OPA_BIN`).
+
+`--engine python:module.path:callable` calls your own Python function with
+signature `(call: ToolCall, policy_dir: Path) -> Decision | str` for every
+trace. **This imports and runs arbitrary code from the current environment**
+with your permissions; point it only at code you would run directly.
+
+## License
+
+Apache-2.0.

permdiff-0.1.0/README.md

@@ -0,0 +1,164 @@
+# permdiff
+
+`terraform plan` for AI agent permission changes.
+
+permdiff replays a corpus of recorded agent tool calls against an authorization
+policy at two git refs and reports which calls change decision: what becomes
+denied, what becomes allowed, what now needs human approval, and what could not
+be evaluated. It never calls a model. It replays decisions.
+
+```
+$ permdiff diff --base origin/main --head HEAD --traces traces/*.jsonl
+
+permdiff: origin/main → HEAD   (4,812 calls, 2026-09-18 → 2026-09-25)
+  newly DENIED             37   aws.ec2.terminate_instance
+  newly ALLOWED             2   github.delete_branch          ⚠ widening
+  now REQUIRE_APPROVAL    118   stripe.refund
+  can't evaluate            9   missing context: principal.department
+  unchanged             4,646
+```
+
+## Status
+
+0.1.0, prepared and awaiting publication (see `docs/release.md`). Progress by epic is
+in `docs/03-epics.md`; changes in `CHANGELOG.md`.
+
+## Install
+
+```
+pip install permdiff
+```
+
+Python 3.11 or newer.
+
+## Quickstart
+
+**1. Try it on the bundled example (30 seconds).**
+
+```
+permdiff demo
+```
+
+This diffs two bundled policy versions over a synthetic 200-call corpus and
+prints one widening group (`github.delete_branch` newly allowed outside
+prod), two tightening groups, and a can't-evaluate group where the new policy
+needs a `department` attribute the traces lack. It exits `2` because a
+widening was found. Nothing is downloaded and no network is used.
+
+The demo uses the pinned OPA binary when it is installed and otherwise the
+bundled Python engine. To see the Rego version:
+
+```
+permdiff setup opa          # downloads opa 1.21.0 into your user cache, checksum verified
+permdiff demo --engine opa
+```
+
+**2. Point it at your own policy and traces.**
+
+```
+permdiff diff --base origin/main --head HEAD --policy policy/ \
+              --engine opa --decision data.agent.authz.decision \
+              --traces traces/*.jsonl
+```
+
+With `--engine opa` every trace becomes `input`, `time.now_ns()` returns the
+trace's timestamp, and the decision rule may return an object
+(`{"effect": "allow|deny|require_approval", "reason": "...", "rule": "..."}`),
+a boolean, or an effect string. `{"effect": "error", "kind": "missing_context",
+"reason": "principal.attrs.department"}` reports a call the policy cannot
+decide. Rules that stay undefined count as `deny` (`--undefined error` to
+flag them instead). OPA runs with `http.send`, `net.lookup_ip_addr`,
+`rand.intn`, `uuid.rfc4122`, and `opa.runtime` removed from its capabilities;
+a policy that uses one is reported as nondeterministic for every call unless
+you replay recorded values with `--nd-cache decision-log.json` (OPA's
+`nd_builtin_cache` shape). `permdiff check` validates traces and compiles both
+refs without diffing, which is what CI runs first.
+
+**3. Put it in CI.**
+
+```yaml
+name: permdiff
+on: pull_request
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  permdiff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with: { fetch-depth: 0 }
+      - uses: smhasan94/permdiff@v0
+        with:
+          traces: traces/*.jsonl
+```
+
+The action runs `permdiff check`, then `diff`, and upserts one PR comment marked
+`<!-- permdiff -->` that updates in place on every push. The check fails on
+widening (`fail-on: widen`). Fork PRs, whose token is read-only, get the same
+report in the job summary and as an artifact. `sarif: "true"` adds a SARIF file
+for `github/codeql-action/upload-sarif@v4`. Inputs and outputs are in
+[docs/action.md](docs/action.md). Save the flags once with `permdiff init` and
+commit `permdiff.toml`; flags override environment variables
+(`PERMDIFF_REPORT_FAIL_ON=none`) which override the file.
+
+For a Python policy adapter instead:
+
+```
+permdiff diff --base origin/main --head HEAD --policy policy/ \
+              --engine python:authz.permdiff_adapter:evaluate \
+              --traces traces/*.jsonl
+```
+
+`diff` replays every trace against the policy at both refs and prints the
+summary block above. Exit code `2` means the run matched `--fail-on`
+(`widen` by default), `1` means permdiff itself failed, `0` means nothing
+matched. `--head WORKTREE` uses the uncommitted policy in your working tree.
+
+Traces are JSONL, one `ToolCall` per line; `permdiff schema toolcall` prints
+the JSON Schema. Reports redact argument values by default; `--show-args`
+reveals named keys and `--redact none` shows everything for local use.
+
+`--format markdown|json|sarif` and `permdiff render --from-json` produce the
+other outputs; `permdiff schema report` prints the JSON report's schema. The
+Cedar engine and the Custody and OpenTelemetry importers arrive in the next
+epics. The design is in `docs/01-overview.md`.
+
+## Engines
+
+`--engine cedar` (`pip install "permdiff[cedar]"`) loads `*.cedar` files, one
+`*.cedarschema`, and `entities.json` from the policy path, validates the policies
+against the schema, and evaluates every trace as a Cedar request built from the
+`[cedar]` templates (`principal`, `action`, `resource`; defaults
+`User::"{principal.id}"`, `Action::"{tool.name}"`, `Resource::"{resource.id}"`).
+The request context is the call's arguments plus its trace context, plus
+`context.call.{principal,agent,tool,resource}` and `context.now` (the trace
+timestamp as a Cedar `datetime`). A deny whose forbids all carry
+`@require_approval("reason")` is reported as require-approval; a missing
+attribute or entity is can't-evaluate naming it. `permdiff demo --engine cedar`
+runs the bundled Cedar variant.
+
+## Performance
+
+100,000 calls end to end (import, both refs, classify, markdown) on an Apple
+M-series laptop, `python -m bench.run --n 100000`:
+
+| Engine | Import | Diff (both refs) | Report | Total | Peak RSS |
+|---|---:|---:|---:|---:|---:|
+| Python callable | 2.4 s | 2.8 s | 0.15 s | 6.5 s | 799 MB |
+| OPA 1.21.0 | 2.5 s | 8.0 s | 0.17 s | 11.8 s | 965 MB |
+
+Cedar evaluates 100,000 calls per ref in about 12 s through cedarpy. CI runs the
+benchmark on every push and fails on a 1.5x regression against `bench/baseline.json`.
+
+`--engine opa` runs a pinned OPA binary (1.21.0, SHA-256 verified on
+download; override with `--opa-bin` or `PERMDIFF_OPA_BIN`).
+
+`--engine python:module.path:callable` calls your own Python function with
+signature `(call: ToolCall, policy_dir: Path) -> Decision | str` for every
+trace. **This imports and runs arbitrary code from the current environment**
+with your permissions; point it only at code you would run directly.
+
+## License
+
+Apache-2.0.