agentboxx 0.2.1__tar.gz

agentboxx-0.2.1/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.

agentboxx-0.2.1/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: agentboxx
+Version: 0.2.1
+Summary: A tamper-evident flight recorder for AI agents
+Author-email: Prathmesh Kokate <prathmeshkokate775@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Prathmesh010190/Agentboxx
+Project-URL: Repository, https://github.com/Prathmesh010190/Agentboxx
+Project-URL: Issues, https://github.com/Prathmesh010190/Agentboxx/issues
+Project-URL: Documentation, https://github.com/Prathmesh010190/Agentboxx/tree/main/docs
+Keywords: ai,agents,security,audit,flight-recorder,tamper-evident,sandbox
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: jsonschema; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+# agentbox
+
+**A tamper-evident flight recorder for AI agents.**
+
+Run agent commands in an isolated sandbox, record what actually happened, sign every record, and catch agents that get stuck.
+
+[![CI](https://github.com/Prathmesh010190/Agentboxx/actions/workflows/ci.yml/badge.svg)](https://github.com/Prathmesh010190/Agentboxx/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+![Python](https://img.shields.io/badge/python-3.10%2B-3776AB.svg)
+![Status](https://img.shields.io/badge/status-MVP-green.svg)
+
+</div>
+
+> [!NOTE]
+> **v0.2 MVP.** Working prototype validated end-to-end with sandboxed execution, cryptographic signing, loop detection, and live model execution. Interfaces may evolve before v1.0. Known gaps are listed under [Limitations](#limitations).
+
+---
+
+## Why agentbox
+
+Most agent tooling records what the agent *says* it did, from inside the agent's own process. agentbox observes from the outside.
+
+| | What it gives you |
+|---|---|
+| **Host-side capture** | Output, exit codes and timing are recorded by the host, not reported by the agent. |
+| **Tamper-evident logs** | Every record is hash-chained and HMAC-signed with a key that never enters the sandbox. Edits, deletions and reordering are detected by `agentbox verify`. |
+| **State-aware loop detection** | A repeated command only counts when the workspace did not change, which separates retrying from making progress. |
+| **Hint feedback** | When the detector fires, a hint is added to the agent's next observation so it can change approach. |
+| **Hardened sandbox** | Docker backend with no network, read-only root filesystem, dropped capabilities, non-root user and resource limits. |
+
+## Architecture
+
+<p align="center">
+  <img src="docs/architecture.svg" alt="agentbox architecture: model, Docker sandbox, recorder, signed log, and loop detector feeding hints back to the model" width="900">
+</p>
+
+| Module | Role |
+|---|---|
+| `signer.py` | Hash-chained, HMAC-signed event log and `verify_file` |
+| `executor.py` | Local command runner, error fingerprints, workspace hashing |
+| `docker_backend.py` | Runs commands in a locked-down container |
+| `loop_detector.py` | Exact repeat, repeated error, no-progress and cycle detection |
+| `recorder.py` | Main API: `Recorder.run(command)` |
+| `agent.py` | Minimal ReAct-style loop that feeds detector hints back to the model |
+
+## Quick start
+
+Requires Python 3.10+. Docker is optional and used by the sandbox demos.
+
+~~~bash
+pip install agentboxx
+~~~
+
+Or install from source:
+
+~~~bash
+git clone https://github.com/Prathmesh010190/Agentboxx.git
+cd Agentboxx
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+~~~
+
+Try it with one command (no Docker, no API key, nothing left behind):
+
+~~~bash
+agentbox demo
+~~~
+
+Run the demos from the repo:
+
+~~~bash
+python examples/demo_agent.py            # stuck-agent demo (local backend)
+python examples/demo_docker.py           # shows what the Docker sandbox blocks
+python examples/demo_agent_loop.py       # full pipeline: detect, hint, recover
+
+agentbox report runs/agent-demo.ndjson   # readable summary
+agentbox verify runs/agent-demo.ndjson   # integrity check
+agentbox list                            # every log in ./runs: session, start time, steps, verifies?
+agentbox --version
+~~~
+
+`report` uses color for errors and warnings when writing to a terminal. Set `NO_COLOR=1` to turn it off. It supports `--format text|json|html` (default: `text`) and `--output <file>` (or `-o`) to export reports; HTML reports are completely self-contained with no external assets.
+
+### Example: a stuck agent recovers
+
+The scripted agent repeats a failing command. After the third identical failure on an unchanged workspace, the detector raises warnings and the next observation carries a hint:
+
+~~~text
+[2] Run it.
+    $ python3 main.py  -> exit 1
+[3] Run it.
+    $ python3 main.py  -> exit 1
+[4] Run it.
+    $ python3 main.py  -> exit 1
+    !! warn: loop.exact
+    !! warn: loop.error_repeat
+    !! warn: loop.no_progress
+[5] The hint is right: x = 0 causes the crash. Fix the value.
+    $ sed -i 's/x = 0/x = 2/' main.py  -> exit 0
+[6] Run it again.
+    $ python3 main.py  -> exit 0
+
+Result: {'reason': 'final_answer', 'final': 'Fixed the divide-by-zero; script prints 5.0.'}
+~~~
+
+### Example: tamper detection
+
+Change any value in a log file and verification fails:
+
+~~~text
+$ agentbox verify runs/demo.ndjson
+LOG HAS BEEN TAMPERED WITH OR IS CORRUPT:
+  - line 3: content was modified
+~~~
+
+## Use it in your own agent
+
+~~~python
+from agentbox import Recorder
+from agentbox.docker_backend import DockerSandbox
+
+sandbox = DockerSandbox("./workspace")   # no network by default
+sandbox.start()
+rec = Recorder("my-session", workspace="./workspace", sandbox=sandbox)
+
+result = rec.run("pytest -x", thought="Run the tests")
+print(result["signals"])                 # loop warnings, if any
+
+rec.close("done")                        # also stops the container
+~~~
+
+`agentbox.agent.run_agent` wraps this in a ReAct-style loop. `ScriptedModel` needs no API key. `GeminiModel` connects to Google Gemini via standard-library REST (needs `GEMINI_API_KEY`, validated end-to-end). `AnthropicModel` is an optional adapter (`pip install anthropic`, set `ANTHROPIC_API_KEY`).
+
+## What `agentbox verify` reports
+
+| Result | Exit code | Meaning |
+|---|---|---|
+| `OK` | 0 | Chain, signatures and the closing manifest all match |
+| `TAMPERED` | 1 | A record was edited, removed or reordered, or the log no longer matches its signed manifest |
+| `INCOMPLETE` | 2 | The log is intact so far but was never closed: a crash, a running session, or a removed tail |
+| *(error)* | 3 | The file is missing, empty, a directory or unreadable. This is not a verdict on the log, and `report` uses the same code |
+
+The manifest (`<session>.manifest.json`) is written when a session closes and records the final record count and hash, signed with the same key. The verifier requires the manifest: a closed session whose manifest is missing is reported as `INCOMPLETE`, and a truncated log whose manifest is still present is reported as `TAMPERED`. Anyone who can read the signing key can forge both files, so copy manifests somewhere the agent host cannot write to if that matters. Public-key signing, as used for Nanda Town's evidence attestations, would let third parties verify logs without holding a secret, and is a possible future change.
+
+## Detection signals
+
+| Signal | Meaning |
+|---|---|
+| `loop.exact` | The same command was repeated on an unchanged workspace |
+| `loop.error_repeat` | The same normalized error keeps recurring |
+| `loop.no_progress` | Several steps failed while no files changed |
+| `loop.cycle` | The agent alternates between the same few commands |
+
+Warnings become hints for the model. Critical severity (for example five identical repeats) stops the run.
+
+## Sandbox resource and crash events
+
+With the Docker backend, the host records two extra signed events after each step: `sandbox.resource` (memory, CPU, process count) and `sandbox.crash` (an out-of-memory kill, or a container that stopped). Everything is read on the host through Docker, so the agent cannot influence it.
+
+- Resource sampling adds about a second per step. Turn it off with `DockerSandbox(resource_stats=False)`.
+- A sample is a snapshot after the step, not a peak.
+- The local backend has no equivalent, and `agentbox report` does not show these events yet.
+
+## Error signatures
+
+Repeated-error detection compares normalized error signatures, so the same failure matches even when line numbers, file paths or runtime versions differ.
+
+| Language | Recognized output | Signature class |
+|---|---|---|
+| Python | Tracebacks | Exception name, e.g. `ZeroDivisionError` |
+| Node.js | Uncaught errors with stack frames | e.g. `TypeError`, `Error[ERR_MODULE_NOT_FOUND]` |
+| Go | Panics, fatal errors, compile errors | `GoPanic`, `GoFatalError`, `GoCompileError` |
+
+Anything else falls back to hashing the last lines of stderr. To add a language, see `src/agentbox/error_signatures.py`.
+
+## Secret redaction
+
+Commands, output and the model's reasoning are redacted **before** they are signed, because a signed record cannot be edited afterward. Recognized: private key blocks, AWS, GitHub, Slack and Google keys, `sk-` style API keys, JWTs, `Authorization` headers, passwords in URLs, and `NAME=value` where the name contains `password`, `secret`, `token` or `api_key`. Each step records only a count per pattern, never the value.
+
+Limits to know about:
+- Patterns are heuristics. They miss some secrets (for example a secret with no recognizable name or format) and sometimes hide harmless values such as a long `*_token=` setting.
+- The command itself still runs with the real value. Only the **record** is redacted.
+- With the agent loop, the model also receives the redacted output, so it cannot read a secret that a command printed.
+- Files in the workspace are not logged, but anything a command prints from them is covered by these patterns only.
+- Add your own patterns with `agentbox.redact.add_pattern(name, regex)`.
+
+## Log format
+
+The log format is documented in [docs/log-format.md](docs/log-format.md) and described by JSON Schemas ([record](docs/schema.json), [manifest](docs/manifest.schema.json)). [examples/verify_standalone.py](examples/verify_standalone.py) verifies a log using only the Python standard library, as an independent check that the spec is complete.
+
+## Threat model
+
+- **Docker backend:** commands run as a non-root user in a container with no network, a read-only root filesystem, all Linux capabilities dropped, `no-new-privileges`, and CPU, memory and process limits. The signing key and logs stay on the host and are never mounted into the container.
+- **Local backend:** no isolation. The agent runs as your user and could read the signing key. Use it only for trusted experiments.
+- Docker isolation is strong but not a perfect boundary. Run untrusted agents in a disposable VM.
+- The log shows that records were not altered after writing. It does not prove the agent's intent, and it cannot see anything that bypasses the executor.
+
+## Limitations
+
+- Windows is experimental. The Docker backend no longer needs Unix user IDs and runs as user `1000:1000` in the container (override with `DockerSandbox(user=...)`), but it has not been run on real Windows hardware yet. It needs Docker Desktop with Linux containers. The local backend still needs `bash` (Git Bash), and on Windows a timeout kills only the direct child process.
+- Detector thresholds are initial values, not calibrated on real agent traces.
+- No network capture yet (the sandbox simply has no network).
+- No semantic drift detection yet; detection is command and state based.
+- Error signatures cover Python, Node.js and Go only. Other languages use a generic fallback.
+
+## Roadmap
+
+- [x] Signed, hash-chained event log with verification
+- [x] Docker sandbox backend
+- [x] Loop detection with hint feedback
+- [x] ReAct-style agent loop
+- [x] Stable error signatures for Python, Node.js and Go
+- [x] Truncation detection with a signed closing manifest
+- [x] Secret redaction before signing
+- [ ] Output size cap and process-tree kill on timeout
+- [x] Sandbox resource and crash events (Docker backend)
+- [ ] Public-key signing so third parties can verify logs
+- [x] Validate against a live model ([#5](https://github.com/Prathmesh010190/Agentboxx/issues/5))
+- [ ] Network egress capture (design in [docs/network-egress.md](docs/network-egress.md))
+- [ ] Semantic drift detector
+- [ ] Session replay UI
+- [ ] Threshold calibration on recorded sessions
+
+## Contributing
+
+Contributions are welcome. Start with [CONTRIBUTING.md](CONTRIBUTING.md) and the issues labeled [`good first issue`](https://github.com/Prathmesh010190/Agentboxx/labels/good%20first%20issue).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).