panoptes-observe 0.1.0__tar.gz

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

panoptes_observe-0.1.0/PKG-INFO

@@ -0,0 +1,359 @@
+Metadata-Version: 2.4
+Name: panoptes-observe
+Version: 0.1.0
+Summary: Adapter-based agent observability, local audit trails, and policy gates.
+Author-email: Miggy <miguel@throttlai.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/miggy-code/Panoptes
+Project-URL: Repository, https://github.com/miggy-code/Panoptes
+Project-URL: Issues, https://github.com/miggy-code/Panoptes/issues
+Project-URL: Changelog, https://github.com/miggy-code/Panoptes/blob/main/CHANGELOG.md
+Project-URL: Security, https://github.com/miggy-code/Panoptes/security/policy
+Keywords: agent,ai,audit,security,observability,claude-code,codex,hermes,antigravity,policy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Security
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: PyYAML<7,>=6
+Provides-Extra: dev
+Requires-Dist: pytest<9,>=8; extra == "dev"
+Provides-Extra: release
+Requires-Dist: build<2,>=1.2; extra == "release"
+Requires-Dist: twine<7,>=6; extra == "release"
+Dynamic: license-file
+
+# Panoptes
+
+<p align="center">
+  <strong>Agent observability, local audit trails, and policy gates.</strong><br>
+  A local-first view of OpenAI-, Anthropic-, Gemini-, and Hermes-based workflows.
+</p>
+
+<p align="center">
+  <a href="https://github.com/miggy-code/Panoptes/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/miggy-code/Panoptes/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="LICENSE"><img alt="Apache 2.0" src="https://img.shields.io/badge/license-Apache%202.0-blue.svg"></a>
+  <img alt="Python 3.10+" src="https://img.shields.io/badge/python-3.10%2B-3776AB.svg">
+</p>
+
+Panoptes gives AI-agent traffic one place to land. Point a supported model
+client at the local reverse proxy and Panoptes turns requests, responses, tool
+instructions, policy decisions, and cost data into a queryable SQLite audit
+trail. Hermes integrations can also report lifecycle events and ask Panoptes
+for a synchronous pre-tool decision.
+
+Panoptes runs locally with no external service. It records model API traffic
+and host-reported lifecycle events; tool calls emitted by a model remain
+requests unless the host reports an execution outcome.
+
+## Why
+
+Agent logs tend to be provider-specific, short-lived, and hard to compare.
+Panoptes is built to answer a smaller set of operational questions well:
+
+- Which model requests and tool instructions crossed the controlled API path?
+- Which tool requests did a native adapter authorize or deny?
+- Which policy snapshot informed each recorded authorization decision or violation?
+- Has the locally stored event history changed since a checkpoint?
+
+Every supported adapter writes the same event shape. Every event carries
+capture metadata describing where it came from and how strong that observation
+is. That gives you one dependable record for tracing agent behavior, reviewing
+policy decisions, investigating incidents, and testing ideas—without the
+operational weight of a distributed observability stack.
+
+## Quick Start
+
+Install Panoptes as an isolated command-line application:
+
+```bash
+pipx install panoptes-observe
+```
+
+Or use `uv`:
+
+```bash
+uv tool install panoptes-observe
+```
+
+The distribution is named `panoptes-observe`; the installed command remains
+`panoptes`. To work on the source instead:
+
+```bash
+git clone https://github.com/miggy-code/Panoptes.git
+cd Panoptes
+python -m pip install -e ".[dev]"
+```
+
+### Capture model API traffic
+
+Start Panoptes in one terminal:
+
+```bash
+panoptes proxy --port 8081
+```
+
+Then point a supported client at it from another terminal:
+
+```bash
+ANTHROPIC_BASE_URL=http://127.0.0.1:8081 claude
+```
+
+After the run, inspect what Panoptes recorded:
+
+```bash
+panoptes status
+panoptes query --event-type tool_call --limit 10
+```
+
+Observation is fail-open by default. For enforcement, provide a valid policy
+directory and choose `fail_closed` explicitly:
+
+```bash
+panoptes proxy \
+  --port 8081 \
+  --policies-dir ~/.panoptes/policies \
+  --policy-failure-mode fail_closed
+```
+
+The proxy only binds to loopback. Client sockets have a 30-second I/O timeout
+and the server accepts at most 64 concurrent requests by default; tune these
+with `--client-timeout` and `--max-concurrent-requests`.
+
+### Install Hermes lifecycle hooks
+
+```bash
+python -m panoptes.install_hermes_plugin
+```
+
+The installer adds lifecycle hooks for `agent:start`, `agent:step`, and
+`agent:end`. Those hooks observe; they do not block. Local tool enforcement
+requires the Hermes host to call `authorize_tool_call()` synchronously and
+honor `allowed=False`. In `fail_closed` mode, an authorization whose evidence
+cannot be stored is denied.
+
+### Query and verify
+
+```bash
+panoptes query --agent hermes --event-type agent_step --limit 50
+panoptes query --agent hermes --event-type decision_point --limit 50
+panoptes session <session-id>
+panoptes evidence <event-id>
+
+# Verify local hash links and export a checkpoint for separate storage
+panoptes verify
+panoptes checkpoint > checkpoint.json
+
+# Later, prove that separately stored checkpoint is a prefix of current history
+panoptes verify --checkpoint checkpoint.json
+```
+
+Read-only database commands require an existing initialized audit database. A
+missing, mistyped, or empty `--db-path` exits with status 2 instead of creating
+a new database.
+
+## Architecture
+
+```text
+Enforcement plane: adapter → normalize → policy gate → model/API boundary
+                                     │
+Audit plane:       adapter → normalized event → SQLite → CLI
+```
+
+The design has two intentionally small paths. The enforcement path makes a
+decision before a controlled boundary. The audit path commits normalized
+evidence to SQLite and keeps it available through the CLI. `capture.py`
+describes each adapter's fidelity so consumers can distinguish a model
+instruction from a host-reported or pre-authorized action.
+
+### Capture adapters
+
+| Adapter | Observes | Enforcement boundary |
+|---------|----------|----------------------|
+| Reverse proxy | Supported model requests, responses, tool instructions, and client-reported tool results | Request preflight and fully buffered model responses |
+| Hermes plugin | Host-reported `agent_start`, `agent_step`, and `agent_end` events | Optional host-callable pre-tool authorizer, recorded as `decision_point` |
+
+The reverse proxy is a real boundary only for traffic that crosses it. It
+cannot see an arbitrary local file read after the agent receives a response,
+and an agent can bypass it if it still holds provider credentials. Stronger
+deployments must isolate those credentials and block direct provider egress.
+At the boundary itself, Panoptes rejects ambiguous JSON instead of guessing
+which duplicate value should inform a policy decision.
+
+For reliable cross-request timelines, adapters should send
+`X-Panoptes-Session: <stable-session-id>`. Without it, each exchange is
+isolated. `X-Panoptes-Agent` and session headers are client assertions, not
+authenticated workload identities, and are removed before upstream forwarding.
+
+### Audit schema
+
+```json
+{
+  "event_id": "uuid",
+  "timestamp": "2026-07-17T14:30:00.000Z",
+  "agent": {
+    "type": "claude_code",
+    "session_id": "abc123",
+    "run_id": "run456"
+  },
+  "event_type": "tool_call",
+  "action": {
+    "tool_name": "terminal",
+    "parameters": {"command": "kubectl get pods -n prod"},
+    "data_accessed": ["infra", "prod"]
+  },
+  "outcome": {
+    "status": "pending",
+    "summary": "Model proposed this tool call; local execution was not observed"
+  },
+  "context": {
+    "turn_number": 12,
+    "capture": {
+      "adapter": "http_proxy",
+      "observation_boundary": "model_api",
+      "execution_observed": false
+    }
+  },
+  "cost": {"tokens_in": 800, "tokens_out": 150}
+}
+```
+
+Before an event reaches disk, Panoptes validates its identifiers, timestamps,
+outcomes, and costs; redacts common secret forms; and derives heuristic
+data-access tags from the action. Those tags are useful inputs for local policy
+and investigation, but they can be wrong. Treat both redaction and
+classification as defense in depth, not as complete data-loss prevention.
+
+Request events include complete bounded summaries of requested client-side,
+provider-hosted, and unknown tool capabilities. Client-executed model tool
+proposals remain `pending`; recognized provider-hosted actions record whether
+they completed, failed, or remain pending upstream. Hosted result excerpts are
+redacted and bounded. Unknown requested tool types are denied in
+`fail_closed`; `fail_open` records and logs a warning.
+
+### Policy engine
+
+Policies are YAML files in `~/.panoptes/policies/`:
+
+```yaml
+name: "no-prod-access"
+description: "Block tool calls classified as production access"
+enabled: true
+scope:
+  agents: ["*"]
+rule:
+  event_type: "tool_call"
+  conditions:
+    - field: "action.data_accessed"
+      operator: "contains"
+      value: "prod"
+  logic: "AND"
+action: block
+message: "Production access blocked. Request approval first."
+```
+
+- Operators: `==`, `!=`, `contains`, `in`, `matches`, `gt`, `lt`, `gte`, `lte`
+- Logic: `AND` / `OR`
+- Scopes: agent and session
+- Actions: `allow`, `warn`, `block`
+- Loading: one validated, content-digested policy set at startup; restart the
+  proxy after changing policy files
+- Failure posture: explicit `fail_open` or `fail_closed`
+
+Policies are strict on purpose. Unknown fields, malformed conditions, duplicate
+YAML keys, an empty directory, or any invalid file make the set fail to load.
+That turns a typo into a visible startup problem instead of a silently weaker
+rule.
+
+## Supported Protocols and Adapters
+
+| Protocol / adapter | Capture method | Boundary |
+|--------------------|----------------|----------|
+| Anthropic Messages API | Reverse proxy | Model API |
+| OpenAI Chat Completions and Responses APIs | Reverse proxy | Model API |
+| Gemini `generateContent` and `streamGenerateContent` | Reverse proxy | Model API |
+| Hermes Agent | Native plugin | Host-reported lifecycle; optional pre-tool authorization |
+
+An agent is proxy-compatible only if it lets you replace its model API base URL
+and emits a supported protocol. That is not equivalent to a tested native
+integration.
+
+Current action parsing covers OpenAI function/custom/computer/shell/apply-patch
+and hosted-tool output items, Anthropic client and server tool blocks, and
+Gemini function, built-in tool, and code-execution parts. Unknown tool
+declarations or response item types never become an implicit safe result:
+`fail_closed` denies them, while `fail_open` records degraded inspection.
+Provider features introduced after this release, including OpenAI programmatic
+tool-calling output, require an adapter update and adversarial fixtures before
+they are supported.
+
+## Commands
+
+```text
+panoptes proxy          Start the loopback-only model-API reverse proxy
+panoptes --version      Show the installed Panoptes version
+panoptes status         Show event statistics
+panoptes query          Query events by agent, type, tool, or time
+panoptes session <id>   Show up to 10,000 newest session events
+panoptes evidence <id>  Reconstruct a related decision path
+panoptes verify         Verify the local chain or a separately stored checkpoint
+panoptes checkpoint     Print the current chain checkpoint
+panoptes policy list    List the active policy snapshot
+panoptes policy add     Add a policy file
+panoptes policy check   Scan a bounded newest-event selection; errors exit nonzero
+panoptes policy test    Test one policy against one event
+```
+
+## Project Status
+
+| Component | Status |
+|-----------|--------|
+| Model-API reverse proxy | Alpha |
+| Hermes lifecycle plugin and authorizer API | Alpha |
+| SQLite storage and local hash chain | Available; external checkpoints remain operator-managed |
+| Query, policy, and integrity CLI | Available |
+| YAML policy engine | Alpha |
+| Mandatory local execution broker | Out of scope today |
+
+The project targets Python 3.10 through 3.13 and runs its tests, distribution
+validation, and wheel smoke test in GitHub Actions. Passing tests do not expand
+the adapter guarantees described in [SECURITY.md](SECURITY.md).
+
+Runtime dependencies are intentionally small: `httpx` and `PyYAML`.
+
+## Development
+
+Create an environment, install the development extra, and run the suite:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e ".[dev,release]"
+python -m pytest -q
+python -m build
+python -m twine check --strict dist/*
+```
+
+The tests are local and network-independent. A change is ready to review when
+the full suite passes and `git diff --check` is clean. Release ownership and
+the tagged publishing flow are documented in [RELEASING.md](RELEASING.md).
+
+## Contributing
+
+Bug reports, protocol fixtures, and focused adapters are welcome. The most
+useful contributions strengthen an existing boundary: native pre-execution
+adapters, external append-only audit sinks, signed policy distribution, and
+adversarial provider fixtures. For security issues, please use the private
+reporting path in [SECURITY.md](SECURITY.md).
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).