dogwood-py 0.0.1.dev6__tar.gz

dogwood_py-0.0.1.dev6/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.

dogwood_py-0.0.1.dev6/NOTICE

@@ -0,0 +1,4 @@
+dogwood-py
+Copyright 2026 Abhishek Tiwari
+
+Licensed under the Apache License, Version 2.0.

dogwood_py-0.0.1.dev6/PKG-INFO

@@ -0,0 +1,381 @@
+Metadata-Version: 2.4
+Name: dogwood-py
+Version: 0.0.1.dev6
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Requires-Dist: maturin>=1.7,<2 ; extra == 'dev'
+Requires-Dist: pytest>=8 ; extra == 'dev'
+Requires-Dist: setuptools-scm[toml]>=8 ; extra == 'dev'
+Requires-Dist: twine>=5 ; extra == 'dev'
+Requires-Dist: fastapi>=0.115 ; extra == 'examples'
+Requires-Dist: httpx2>=0.28 ; extra == 'examples'
+Requires-Dist: uvicorn[standard]>=0.30 ; extra == 'examples'
+Provides-Extra: dev
+Provides-Extra: examples
+License-File: LICENSE
+License-File: NOTICE
+Summary: Python SDK and reference-compatible interpreter surface for Dogwood policies
+Keywords: dogwood,policy,authorization,cedar
+Author-email: Abhishek Tiwari <abhishek@abhishek-tiwari.com>
+License: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# Dogwood Policy Python SDK
+
+Python SDK and PyO3 binding for the [Dogwood](https://github.com/dogwood-policy/dogwood) policy language. Dogwood is a policy language for fine-grained authorization decisions that depend on history or patterns of events over time - not just a single request. It adds temporal conditions (since, formerly, once, aggregations) and information providers (computed guardrail facts) on top of Cedar policy syntax, then lowers everything back to Cedar for evaluation. Existing Cedar policies stay valid as-is.
+
+
+![GitHub Release](https://img.shields.io/github/v/release/abhishektiwari/dogwood-py)
+![GitHub Actions Test Workflow Status](https://img.shields.io/github/actions/workflow/status/abhishektiwari/dogwood-py/test.yml?label=tests)
+![PyPI - Version](https://img.shields.io/pypi/v/dogwood-py)
+![Python Wheels](https://img.shields.io/pypi/wheel/dogwood-py)
+![Python Versions](https://img.shields.io/pypi/pyversions/dogwood-py?logo=python&logoColor=white)
+![GitHub last commit](https://img.shields.io/github/last-commit/abhishektiwari/dogwood-py)
+![PyPI - Status](https://img.shields.io/pypi/status/dogwood-py)
+![Conda Version](https://img.shields.io/conda/v/dogwood-py/dogwood-py)
+![License](https://img.shields.io/github/license/abhishektiwari/dogwood-py)
+![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/abhishektiwari/dogwood-py/total?label=GitHub%20Downloads)
+![PyPI Downloads](https://img.shields.io/pepy/dt/dogwood-py?label=PyPI%20Downloads)
+
+The public API is modeled after the Rust `dogwood-language` lifecycle:
+
+1. Build a `ServiceSchema` and `PolicySchema`.
+2. Parse and lower policy source into a `LoweredPolicySet`.
+3. Validate it.
+4. Feed `Event` values to a stateful `Authorizer`.
+
+This package uses PyO3/maturin to bind the Rust `dogwood-language` reference
+for schema-backed lowering, validation, and trace replay. The Python SDK also
+keeps a temporary pure-Python fallback only for source-tree examples that omit
+a full Cedar action schema. Schema-backed workflows require the native
+extension.
+
+## Install For Development
+
+The project uses a local `.venv` and maturin editable installs:
+
+```bash
+make setup
+make develop
+make test
+```
+
+The native extension imports as `dogwood._dogwood_native`; convenience wrappers
+live in `dogwood.native`.
+
+## Native vs. Non-Native Execution
+
+This package has two execution paths.
+
+**Native path**
+
+The native path is the PyO3 extension built by maturin. It calls the Rust
+`dogwood-language` reference implementation.
+
+Used for:
+
+- schema-backed policy lowering
+- schema-backed validation
+- schema-backed trace replay
+- augmented Cedar schema export
+
+This is the path to use for compatibility with the Rust reference. It requires
+a real Cedar action schema.
+
+You can check whether it is available:
+
+```python
+from dogwood import native
+
+assert native.available()
+```
+
+For repeated decisions, use a persistent native authorizer so policy lowering
+happens once:
+
+```python
+from dogwood import native
+
+authorizer = native.NativeAuthorizer(policy_source, cedar_schema_source)
+
+decision = authorizer.authorize_request(
+    "Drupe::Action::SellShares",
+    'Drupe::OAuthUser::"alice"',
+    'Drupe::Gateway::"trading"',
+    {"shares": 25, "stock": "AMZN"},
+)
+
+assert decision == "Allow"
+```
+
+**Non-native fallback**
+
+The fallback path is pure Python. It exists only so SDK examples can run
+without a full Cedar schema while the native API surface is still being built
+out.
+
+It supports only a small subset:
+
+- basic `permit` / `forbid`
+- `when` / `unless` checks over `context.*`
+- simple trace parsing
+- simple `formerly within` temporal checks
+
+It is not a replacement for the Rust reference implementation.
+
+The SDK requires native behavior when a non-empty `PolicySchema` is supplied.
+It will raise a clear error if the native extension is missing. If the schema is
+empty, examples may still use the Python fallback.
+
+## Event Schema
+
+Dogwood has two schema layers:
+
+- The **policy/action schema** is the Cedar `.cedarschema` file. It defines
+  entities, actions, and request context types such as
+  `context.input.amount`.
+- The **event schema** tells Dogwood how actions become historical events:
+  which event kinds exist (`request`, `response`, `error`), which fields are
+  recorded in the temporal history, and which event kinds produce authorization
+  decisions.
+
+The examples use Dogwood's default event schema. Under that default,
+`request` events are decision points, and the event history records request
+`input` fields plus reserved fields like `callerPrincipal`,
+`callerResource`, and `requestId`. That is why a temporal policy can ask about
+past events such as:
+
+```text
+Drupe::Action::"Transfer"::request{ input.user: context.input.user }
+```
+
+In other words, the Cedar schema says what a `Transfer` request looks like;
+the event schema says that `Transfer::request` is both authorizable and stored
+in history for later temporal checks.
+
+## Python API
+
+```python
+from dogwood import Authorizer, Event, LoweredPolicySet, PolicySchema, ServiceSchema
+
+policy = '''
+@id("sell_small_only")
+permit (
+    principal,
+    action == Drupe::Action::"SellShares",
+    resource
+)
+when { context.input.shares <= 50 };
+'''
+
+policies = LoweredPolicySet.from_str(policy, ServiceSchema.defaults(), PolicySchema(""))
+authorizer = Authorizer(policies)
+
+event = (
+    Event.builder('Drupe::Action::"SellShares"', "request")
+    .principal('Drupe::OAuthUser::"alice"')
+    .resource('Drupe::Gateway::"gw1"')
+    .field("input", "shares", 50)
+    .request_context("input", "shares", 50)
+    .build()
+)
+
+assert authorizer.is_authorized(event).allowed()
+```
+
+There is also a runnable example:
+
+```bash
+make example
+```
+
+## FastAPI Native Example
+
+The FastAPI example uses the native binding and a real Cedar schema. It loads
+its own `examples/fastapi_simple/policy.dw` and
+`examples/fastapi_simple/schema.cedarschema`, creates a persistent
+`native.NativeAuthorizer`, and exposes an authorization endpoint.
+
+The policy enforces a `$50` daily transfer limit per user. Three `$20`
+transfers by the same user produce:
+
+```text
+Allow, Allow, Deny
+```
+
+Run it:
+
+```bash
+make develop
+make examples-deps
+make fastapi-example
+```
+
+First transfer:
+
+```bash
+curl -s http://127.0.0.1:8000/authorize \
+  -H 'content-type: application/json' \
+  -d '{"user":"alice","amount":20}'
+```
+
+Expected response:
+
+```json
+{"decision":"Allow","allowed":true,"daily_limit":50}
+```
+
+Second transfer:
+
+```bash
+curl -s http://127.0.0.1:8000/authorize \
+  -H 'content-type: application/json' \
+  -d '{"user":"alice","amount":20}'
+```
+
+Expected response:
+
+```json
+{"decision":"Allow","allowed":true,"daily_limit":50}
+```
+
+Third transfer:
+
+```bash
+curl -s http://127.0.0.1:8000/authorize \
+  -H 'content-type: application/json' \
+  -d '{"user":"alice","amount":20}'
+```
+
+Expected response:
+
+```json
+{"decision":"Deny","allowed":false,"daily_limit":50}
+```
+
+Dogwood authorizers are stateful. The example keeps one shared native
+authorizer and protects it with a lock. For high-throughput services, use a
+pool or request-partitioned authorizers based on your temporal semantics.
+
+The same FastAPI app also includes a quota-based rate limit endpoint:
+
+```bash
+curl -s http://127.0.0.1:8000/authorize/quota \
+  -H 'content-type: application/json' \
+  -d '{"user":"carol","amount":1}'
+```
+
+That endpoint uses `examples/fastapi_simple/quota_policy.dw`, which permits fewer
+than three transfers by the same user within one hour. For one user, the first
+two requests are allowed and the third is denied.
+
+## CLI
+
+```bash
+dogwood-py validate policy.dw --policy-schema schema.cedarschema
+dogwood-py replay policy.dw --policy-schema schema.cedarschema --trace trace.log
+dogwood-py lower policy.dw --policy-schema schema.cedarschema
+```
+
+When using the local virtualenv directly:
+
+```bash
+.venv/bin/dogwood-py validate policy.dw --policy-schema schema.cedarschema
+```
+
+Run the checked-in CLI example:
+
+```bash
+make cli-example
+```
+
+Equivalent command:
+
+```bash
+.venv/bin/dogwood-py replay examples/cli/policy.dw \
+  --policy-schema examples/cli/schema.cedarschema \
+  --trace examples/cli/trace.log
+```
+
+Expected output:
+
+```text
+@0 (time point 0): true
+@1 (time point 1): false
+```
+
+## Make Targets
+
+- `make setup` creates `.venv` and installs development tools.
+- `make develop` builds and installs the PyO3 extension in editable mode.
+- `make examples-deps` installs optional dependencies used by examples.
+- `make test` runs the Python test suite.
+- `make perf-test` runs the opt-in native-vs-Python replay performance check.
+- `make example` runs `examples/api_usage.py`.
+- `make cli-example` runs the `dogwood-py replay` example.
+- `make fastapi-example` starts the native-backed FastAPI server.
+- `make build` builds a wheel with maturin.
+- `make clean` removes generated caches and Rust build output.
+
+The performance test is a coarse regression guard, not a precise benchmark. It
+uses `DOGWOOD_PERF_TESTS=1`, prints native and pure-Python replay timings, and
+asserts the Rust-backed end-to-end path is not catastrophically slower than the
+fallback on the same generated trace. Tune the ceiling with
+`DOGWOOD_NATIVE_MAX_RATIO` when needed.
+
+Latest local performance check:
+
+```text
+native replay: 0.4793s
+python fallback replay: 0.0708s
+ratio native/python: 6.77
+
+persistent native authorizer: 0.4424s
+python fallback authorizer: 0.0147s
+ratio native/python: 30.14
+```
+
+This result does not mean the Rust implementation is slower in general. The
+test compares the full native Dogwood path, including real schema-backed Rust
+lowering/replay semantics, against the intentionally minimal Python fallback.
+The value of the test is detecting large accidental regressions in the binding
+path, not benchmarking the Rust engine in isolation.
+
+The persistent native authorizer avoids repeated policy lowering, but each
+request still crosses the Python/Rust boundary, converts Python input into
+Dogwood values, and runs the full Cedar-backed decision path. The fallback
+remains much faster for this tiny policy because it evaluates only a narrow
+regex-parsed subset with no real Cedar schema semantics.
+
+## GitHub Actions
+
+The repository includes workflows adapted for this PyO3/maturin package:
+
+- `Tests` runs on pull requests and pushes to `main`. It builds the native
+  extension with `maturin develop`, runs `pytest`, and checks the CLI example
+  across Python 3.10-3.13 on Linux and macOS.
+- `Build and Release` runs on pull requests and pushes to `main`. Pull requests
+  build source/wheel artifacts for review. Pushes to `main` build the same
+  artifacts and create a GitHub release.
+- `Security Checks` runs workflow linting, dependency review, hidden Unicode
+  scanning, and flags workflow-file changes for review.
+- Dependabot checks GitHub Actions, Cargo, and Python dependency updates weekly.
+
+PyPI publishing is opt-in. Configure trusted publishing for the `pypi`
+environment and set the repository variable `PUBLISH_PYPI=true` to publish
+distributions on pushes to `main`.
+
+## Current Scope
+
+Rust-backed operations cover schema-backed lowering, validation, and trace
+replay. The Python fallback is temporary and schema-less only. The intended end
+state is to remove it once the Rust-backed SDK objects cover the same ergonomic
+surface.
+