Metadata-Version: 2.4
Name: canon-gate
Version: 0.5.5
Summary: Reference implementation of a policy-enforced execution layer for AI and automation runtimes.
Author-email: Christopher Mariani <contact@aureliuscanon.com>
License:                        Copyright 2026 Aurelius Canon LLC
        
                                        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 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
        
Project-URL: Homepage, https://www.aureliuscanon.com
Project-URL: Repository, https://github.com/Aurelius-Canon/canon-gate
Project-URL: Bug Tracker, https://github.com/Aurelius-Canon/canon-gate/issues
Keywords: api,fastapi,governance,llm,agent,policy
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: fastapi
Requires-Dist: starlette
Requires-Dist: uvicorn[standard]
Requires-Dist: pydantic
Requires-Dist: toml
Requires-Dist: requests
Requires-Dist: typer
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: httpx; extra == "dev"
Dynamic: license-file

# Canon Gate

Canon Gate is a reference implementation of a policy-enforced execution layer designed to sit between systems that generate structured actions (including agents, automation workflows, and other upstream runtimes) and the systems that execute them. It provides a deterministic governance layer to ensure that all actions are validated against a clear policy before they are performed.

## Why does it exist?

As AI-driven and autonomous systems become more capable, the need for a "strong middle" layer to govern their actions becomes critical. Canon Gate provides this layer, ensuring that even as agentic systems become more complex, their actions remain constrained by human-defined policy. It separates the *probabilistic* world of AI reasoning from the *deterministic* world of execution.

## How do I experience it? (The Golden Path)

The recommended first experience of Canon Gate is to run the flagship demonstration, which shows how an external **Runtime Host** uses the **Runtime Protocol** to have its actions governed by Canon Gate. You will observe this entire process live in the **Operator Console**.

This journey has three parts: an **"Allowed"** scenario, an **"Unsatisfiable"** scenario, and an **"Egress Governance Denial"** scenario.

### Reference Demonstration

To keep Canon Gate itself incredibly lightweight and unopinionated, the demonstration separates the core governance service from the reasoning engine:

*   **Reasoning Engine:** Gemini CLI
*   **Purpose:** Demonstrates one possible Runtime Host implementation.
*   **Replaceable?** Yes. Canon Gate never communicates directly with a reasoning engine. It governs the structured `ActionProposal` produced upstream. Any system capable of producing a valid `ActionProposal` may replace the reasoning engine.

#### Component Requirements Matrix

| Component          |  Canon Gate  | Reference Demo |
| ------------------ | :----------: | :------------: |
| Canon Gate Service |      ✅     |        ✅       |
| Operator Console   |   Optional   |        ✅       |
| Runtime Host       |   Optional   |        ✅       |
| Gemini CLI         | Not Required |        ✅       |
| Node.js            | Not Required |        ✅       |

Note: Gemini CLI and Node.js are only required for the reference Runtime Host demonstration. Canon Gate itself is reasoning-engine agnostic and can be integrated with any system capable of producing a valid `ActionProposal`.

The Canon Gate CLI is a convenience interface for running the reference implementation. It is not required for integrating Canon Gate into your own applications. Most production integrations typically communicate directly with the Canon Gate HTTP API using the Runtime Protocol.

---

### Step 1 — Install Dependencies

Install Canon Gate into your Python environment.

```bash
pip install canon-gate
```
*(The reference demonstration also requires the Gemini CLI. If you do not have it, run `npm install -g @google/gemini-cli`)*.

### Step 2 — Initialize Project Configuration

Navigate to (or create) the directory that will contain your Canon Gate project configuration.

Initialize the project with example policy templates:
```bash
canon-gate init
```

This creates the local project configuration (`policy.toml` and `adapter_policy.toml`) that Canon Gate will use for policy evaluation.

> **Important:** Canon Gate loads project configuration (`policy.toml` and `adapter_policy.toml`) from the current working directory. Continue running the CLI commands below from this same directory unless you intentionally create another Canon Gate project. 

*The generated files (`policy.toml` and `adapter_policy.toml`) are configured for local project governance. The provided templates are intentionally designed to support the reference demonstration out of the box. Always review and customize these policies before deploying in production.*

### Step 3 — Run the Demonstration

The reference demonstration uses **two terminal windows**.

#### Terminal 1 — Canon Gate Service

From the same project directory above, start the Canon Gate server:

```bash
canon-gate serve
```

Leave this terminal running.

The Operator Console will automatically open in your browser.

---

#### Terminal 2 — Runtime Host

Open a second terminal.

Navigate to the **same project directory**.

If using a virtual environment, activate the same environment used to start the Canon Gate service.

For example (Windows):

```bash
.\test_env\Scripts\Activate.ps1
```

Then run:

```bash
canon-gate demo
```

> 💡 **Note on Probabilistic Outputs**
>
> The reference Runtime Host relies on an external reasoning engine (LLM). Because LLMs are probabilistic, they may occasionally return malformed or incomplete JSON instead of a valid ActionProposal.
>
> The Runtime Host treats this output as untrusted input. It validates the response before submitting anything to Canon Gate. If validation fails, the workflow stops and no request is sent to Runtime Enforcement.
>
> You can observe this behavior in the Operator Console. A RuntimeSession will be recorded, but its timeline will end at the Reasoning or ActionProposal Validation stage. No Runtime Enforcement stage will be present because Canon Gate was never invoked.
>
> This behavior is intentional and demonstrates the separation of responsibilities between the Runtime Host and Canon Gate. The Runtime Host is responsible for validating probabilistic model output before deterministic policy enforcement begins.

The Runtime Host will execute three scenarios against the running Canon Gate service:

1. **Allowed Action**: The host requests to write a demonstration artifact. This action is allowed by policy, and the script runs to successfully write a file to `demonstration_output/canon_gate_demonstration.md` on your local filesystem.
2. **Unsatisfiable Objective**: The host requests to delete that same artifact. The Runtime Host correctly identifies that no available capability can satisfy this objective, and it terminates gracefully *before* contacting Canon Gate, leaving the artifact untouched.
3. **Egress Governance Denial**: The host requests to run a health check in quiet mode. The reasoning engine proposes a semantically valid health check action, but because it attempts to pass an unapproved parameter (`--quiet` instead of the allowed `--verbose`), Canon Gate's Egress validation deterministically blocks execution.

After completion, inspect all three Runtime Sessions in the Operator Console.

You will see the full, three-scenario demonstration run in your terminal. When it's complete, the Operator Console (which was automatically opened) will contain the detailed `RuntimeSession` logs for all three scenarios, ready for your inspection.

This is the core value of Canon Gate: deterministic governance of agentic behavior.

## Where do I learn more?

Now that you have seen Canon Gate in action, explore the documentation to understand its architecture, configure and extend its capabilities, or begin contributing to the project.

### 🧠 Learn the Architecture
These documents establish the core vocabulary, protocol interactions, runtime contracts, and design principles of the framework:
-   **[Core Concepts](./docs/CoreConcepts.md)**: The canonical glossary defining the system's core terminology.
-   **[Runtime Protocol](./docs/RuntimeProtocol.md)**: The sequential interaction flow between the Runtime Host and Canon Gate.
-   **[Manifest](./docs/Manifest.md)**: How Canon Gate exposes its policy surface for dynamic `Runtime Discovery`.
-   **[Architecture](./docs/Architecture.md)**: A deeper dive into the "Strong Middle" and `Two-Phase Validation` design.

### 🔌 Build with Canon Gate
These documents explain how to configure, integrate, extend, observe, and experiment with Canon Gate:
-   **[Configuration](./docs/Configuration.md)**: How to configure Ingress policies (`policy.toml`) and Egress policies (`adapter_policy.toml`).
-   **[Integration Guide](./docs/IntegrationGuide.md)**: The primary patterns for connecting Canon Gate to your own applications.
-   **[Adapters](./docs/Adapters.md)**: The guide for writing custom, schema-driven execution adapters.
-   **[Examples](./docs/Examples.md)**: A guide to the primary ways to experience, evaluate, and test the HTTP API.
-   **[Operator Console](./docs/OperatorConsole.md)**: The reference workspace for observing protocol execution.

### 🤝 Contribute
These documents explain how contributors should validate changes and participate in active development:
-   **[Testing Guide](./docs/Testing.md)**: How to activate the virtual environment and validate changes using `pytest`.
-   **[Contributing](./docs/Contributing.md)**: The contribution philosophy, development workflows, and internal state guidelines.

