hexharness 1.0.0__tar.gz

hexharness-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hexharness-1.0.0/NOTICE

@@ -0,0 +1,12 @@
+HexHarness
+Copyright 2026 Matias Tillerias
+
+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
+
+HexHarness is a dual-use security tool intended for authorized penetration
+testing and defensive security research only. You are responsible for using it
+only against systems you are explicitly authorized to test.

hexharness-1.0.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: hexharness
+Version: 1.0.0
+Summary: Agentic pentesting harness with a hard domain control plane (scope, ROE, evidence, budget).
+Author-email: Matias Tillerias <matias.tillerias@securehex.cl>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Secure-Hex/hexharness
+Project-URL: Repository, https://github.com/Secure-Hex/hexharness
+Project-URL: Issues, https://github.com/Secure-Hex/hexharness/issues
+Keywords: pentesting,security,agent,llm,offensive-security,control-plane,mitre-attack
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Security
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pydantic>=2.6
+Requires-Dist: anthropic>=0.40
+Requires-Dist: pyyaml>=6
+Requires-Dist: ddgs>=6.0
+Requires-Dist: dnspython>=2.6
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Provides-Extra: openai
+Requires-Dist: openai>=1.40; extra == "openai"
+Provides-Extra: google
+Requires-Dist: google-genai>=0.3; extra == "google"
+Provides-Extra: otel
+Requires-Dist: opentelemetry-sdk>=1.20; extra == "otel"
+Provides-Extra: daemon
+Requires-Dist: websockets>=12; extra == "daemon"
+Provides-Extra: reporting
+Requires-Dist: jinja2>=3; extra == "reporting"
+Requires-Dist: weasyprint>=60; extra == "reporting"
+Requires-Dist: docxtpl>=0.16; extra == "reporting"
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.0; extra == "mcp"
+Provides-Extra: tui
+Requires-Dist: textual>=0.60; extra == "tui"
+Provides-Extra: browser
+Requires-Dist: playwright>=1.40; extra == "browser"
+Provides-Extra: secrets
+Requires-Dist: cryptography>=42; extra == "secrets"
+Provides-Extra: voice
+Requires-Dist: sounddevice>=0.4; extra == "voice"
+Requires-Dist: faster-whisper>=1.0; extra == "voice"
+Requires-Dist: numpy>=1.26; extra == "voice"
+Provides-Extra: search
+Requires-Dist: ddgs>=6.0; extra == "search"
+Provides-Extra: all
+Requires-Dist: openai>=1.40; extra == "all"
+Requires-Dist: google-genai>=0.3; extra == "all"
+Requires-Dist: opentelemetry-sdk>=1.20; extra == "all"
+Requires-Dist: websockets>=12; extra == "all"
+Requires-Dist: jinja2>=3; extra == "all"
+Requires-Dist: weasyprint>=60; extra == "all"
+Requires-Dist: docxtpl>=0.16; extra == "all"
+Requires-Dist: mcp>=1.0; extra == "all"
+Requires-Dist: textual>=0.60; extra == "all"
+Requires-Dist: sounddevice>=0.4; extra == "all"
+Requires-Dist: faster-whisper>=1.0; extra == "all"
+Requires-Dist: numpy>=1.26; extra == "all"
+Requires-Dist: ddgs>=6.0; extra == "all"
+Requires-Dist: cryptography>=42; extra == "all"
+Dynamic: license-file
+
+# HexHarness
+
+Agentic pentesting harness. The differentiator is not the agent loop (that is standard)
+but a **domain control plane** — scope, ROE, evidence, approvals, budget — that is
+unbreakable by design. Dual-use by nature; what keeps it on the right side is that the
+Scope Guard + ROE are hard gates and everything lands in the hash-chained audit log.
+
+## Install
+
+```bash
+python -m venv venv && ./venv/bin/pip install -e '.[dev]'
+./venv/bin/pytest -q          # 252 passed, 3 skipped (optional-dep paths)
+```
+
+Core + tests run with no optional dependency installed; every integration is lazy-imported.
+
+## Quickstart (TUI)
+
+```bash
+./venv/bin/pip install -e '.[tui]'
+./venv/bin/python -m hexharness tui                 # start blank — describe a target to configure it
+./venv/bin/python -m hexharness tui --engagement engagements/example.engagement.yaml
+```
+
+Launched without `--engagement` the TUI starts **unconfigured**: no scope, no resumed
+history. Describe the target and the model drafts an engagement; you approve the scope/ROE
+in a dialog before anything runs. Each turn auto-saves; reopening resumes the session.
+
+Key bindings: `Ctrl+P` provider · `Ctrl+E` edit engagement (scope/ROE/budget/sandbox/hardware)
+· `Ctrl+O` mode · `Ctrl+T` capabilities · `Ctrl+F` findings · `Ctrl+G` generate report
+· `Ctrl+R` dictate · `Ctrl+K` kill switch · `Ctrl+X` cancel turn · drag to select, `Ctrl+C` copies.
+
+## CLI
+
+```bash
+# run one task against an existing engagement
+ANTHROPIC_API_KEY=sk-... ./venv/bin/python -m hexharness run \
+    "Look up CWE-79 and explain it" --engagement engagements/example.engagement.yaml \
+    --autonomy interactive --phase recon
+
+# draft a new engagement from a natural-language brief, confirm, then run it
+ANTHROPIC_API_KEY=sk-... ./venv/bin/python -m hexharness init \
+    "External test of acme.example and 203.0.113.0/24, exclude vpn.acme.example, \
+     enumeration only, business hours" --task "Resolve www.acme.example"
+
+./venv/bin/python -m hexharness build-image     # build the Kali sandbox image (Kali + tools)
+./venv/bin/python -m hexharness verify  --engagement <file>   # verify the audit log hash chain
+./venv/bin/python -m hexharness report  --engagement <file> --out report.html
+```
+
+The requested `--autonomy/--phase` are clamped to the engagement's ROE ceiling. The agent
+can never grant itself scope or ROE: `init` drafting writes an inert file, and activation
+is a human step (invariants #3/#4).
+
+## The non-negotiable invariants (each has a test)
+
+1. The agent loop never calls `tool.run()` directly — always `ControlPlane.authorize()` first.
+2. `authorize()` order: `scope_guard → mode.decide(risk) → roe.cap → budget → HITL → secrets`, fail-closed.
+3. Scope Guard is a hard gate no mode bypasses — not even `bypass`. Out of scope = deny.
+4. ROE sets the engagement's max mode (immutable); active mode = `min(requested, ceiling)`.
+5. Findings enter as CANDIDATE; only CONFIRMED reach the report; REJECTED kept with reason.
+6. Kill switch is out-of-band (signal / trigger file), works client-disconnected, checkpoints first.
+7. Secrets are acquired out-of-band; their values never reach the model or the logs — only names.
+
+Audit log, tracing and checkpointing are **projections** of one append-only, hash-chained
+event stream (`hexharness/events/`). `hexharness verify` walks the chain and flags tampering.
+
+## Capabilities (tools)
+
+The agent drives tools through the control plane; `knowledge_search` and the skills library
+document each one. Current toolset:
+
+- **Recon** — `dns_enum`, `dns_lookup`, `whois_lookup`, `port_scan`, `parallel_scan`
+  (concurrent multi-host, scope-enforced), `banner_grab`, `ssh_info`, `ftp_check`,
+  `http_probe`, `smb_enum`, `browser` (Playwright: interact + screenshots).
+- **OSINT** — `web_search` (DuckDuckGo free / Tavily / Exa), `shodan_host`, `wayback_urls`,
+  `github_dork`, `cloud_storage_enum` (S3/Azure/GCS).
+- **Exploitation / C2** — `exec_command` (sandboxed, session-persistent), `exploit_run`
+  (scope-checked), `msfvenom_payload`, and the reverse-shell handler
+  (`listener_start` / `shell_sessions` / `shell_exec` / `listener_stop`).
+- **Analysis** — `binary_info`, `checksec`, `disassemble`, `postman_list`, `postman_run`.
+- **Evidence / reporting** — `record_finding`, `list_findings`, `generate_report`.
+- **Orchestration / meta** — `run_workflow` (declarative pipeline: templating, `for_each`,
+  conditions — every step still passes the control plane), `skill_lookup`, `skill_install`
+  (project or global scope), `knowledge_search`, `cwe_lookup`, `mitre_attack_lookup`,
+  `mcp_connect`, `engagement_draft`, `file_read`, `file_write`.
+
+Offensive tools are `DESTRUCTIVE`/`INTRUSIVE` + `requires_approval` and, where a target is
+involved, scope-sensitive. A caught reverse shell whose peer IP is out of scope is dropped
+on connect.
+
+## Sandbox
+
+`exec_command` runs in a **long-lived Docker container per session** (installs/state persist
+across calls; only the host-mounted `/workspace` survives after the session ends). The bundled
+image `hexharness/kali:latest` builds from `sandbox/docker/Dockerfile` (ships in the wheel,
+auto-builds on first use): Kali + nmap/smbclient/curl/metasploit-framework/aircrack-ng/etc.
+
+`engagement.hardware_access` (opt-in, default off) passes host USB/UART + wireless NICs into
+the session container (`--privileged`, host net) for hardware and WiFi work — it drops the
+sandbox isolation, so it is explicit. Scanners keep ephemeral, hardened containers.
+
+## Knowledge base
+
+- `mitre_attack_lookup` — the full MITRE ATT&CK Enterprise catalog (~697 techniques).
+- `cwe_lookup` — the full MITRE CWE catalog (~969 weaknesses).
+- `knowledge_search` — TF-IDF RAG over a local markdown corpus (technique playbooks + a
+  per-capability tool reference + the workflow guide).
+- Skills library (`skill_lookup`) — runnable playbooks (sqli-triage, subdomain-enumeration,
+  workflow-chaining, reverse-shell-handler, exploitation); install more at project or global scope.
+
+## Secrets
+
+Out-of-band vault: a tool that needs a key (`shodan_host`, `github_dork`, paid web search,
+MCP servers) triggers an operator prompt; the value is stored and reused, **never** shown to
+the model or logged. With the `[secrets]` extra it persists **encrypted at rest** (Fernet,
+per engagement); without it, in-memory only.
+
+## Layout
+
+```
+hexharness/
+  providers/   normalized LLM types + Anthropic/OpenAI/Google/Ollama adapters + router (+ fake)
+  agent/       ExecContext, single-agent loop (the chokepoint), workflow engine, orchestrator
+  control/     THE control plane: plane, scope_guard, policy(modes), roe, budget, hitl, kill_switch, vault
+  events/      append-only log + SHA-256 hash chain + bus
+  tools/       Tool base + registry + native tools + MCP client
+  sandbox/     Docker executor (hardened; argv list, no shell) + packaged Kali image
+  evidence/    findings (candidate/confirmed/rejected) + store
+  knowledge/   MITRE ATT&CK + CWE data + TF-IDF RAG corpus
+  skills/      skill engine + bundled playbook library
+  reporting/   ReportModel (from confirmed findings) + Jinja/DOCX render
+  tui/         Textual terminal UI
+  observability/ OTel span projection    recovery/ snapshot + replay
+  protocol/ transport/ daemon/ client/   JSON-RPC client/daemon split (sessions attach/resume)
+  engagement.py  engagement.yaml -> control-plane objects     engine.py  composition root
+```
+
+## Optional dependencies
+
+```bash
+./venv/bin/pip install -e '.[all]'   # everything
+# or pick: tui / openai / google / otel / daemon / reporting / mcp / browser / secrets / voice
+```
+
+`browser` also needs `./venv/bin/playwright install chromium`.
+
+## Known ceilings (marked `ponytail:` in code)
+
+- Orchestrator workers run sequentially (swap to `asyncio.gather` + per-worker providers).
+- Knowledge RAG is a linear TF-IDF scan (fine for a local corpus; add a vector index if it grows).
+- `run_workflow` passes values as text (no structured outputs); `for_each` splits on lines/commas.
+- Reverse-shell output is read by idle-timeout (no PTY/prompt detection); keep commands non-interactive.
+- MCP tools default to INTRUSIVE + requires_approval unless a `classify` override says otherwise.
+- `.md`→PDF and DOCX→PDF need extra converters; HTML→PDF via WeasyPrint is the primary path.

hexharness-1.0.0/README.md

@@ -0,0 +1,155 @@
+# HexHarness
+
+Agentic pentesting harness. The differentiator is not the agent loop (that is standard)
+but a **domain control plane** — scope, ROE, evidence, approvals, budget — that is
+unbreakable by design. Dual-use by nature; what keeps it on the right side is that the
+Scope Guard + ROE are hard gates and everything lands in the hash-chained audit log.
+
+## Install
+
+```bash
+python -m venv venv && ./venv/bin/pip install -e '.[dev]'
+./venv/bin/pytest -q          # 252 passed, 3 skipped (optional-dep paths)
+```
+
+Core + tests run with no optional dependency installed; every integration is lazy-imported.
+
+## Quickstart (TUI)
+
+```bash
+./venv/bin/pip install -e '.[tui]'
+./venv/bin/python -m hexharness tui                 # start blank — describe a target to configure it
+./venv/bin/python -m hexharness tui --engagement engagements/example.engagement.yaml
+```
+
+Launched without `--engagement` the TUI starts **unconfigured**: no scope, no resumed
+history. Describe the target and the model drafts an engagement; you approve the scope/ROE
+in a dialog before anything runs. Each turn auto-saves; reopening resumes the session.
+
+Key bindings: `Ctrl+P` provider · `Ctrl+E` edit engagement (scope/ROE/budget/sandbox/hardware)
+· `Ctrl+O` mode · `Ctrl+T` capabilities · `Ctrl+F` findings · `Ctrl+G` generate report
+· `Ctrl+R` dictate · `Ctrl+K` kill switch · `Ctrl+X` cancel turn · drag to select, `Ctrl+C` copies.
+
+## CLI
+
+```bash
+# run one task against an existing engagement
+ANTHROPIC_API_KEY=sk-... ./venv/bin/python -m hexharness run \
+    "Look up CWE-79 and explain it" --engagement engagements/example.engagement.yaml \
+    --autonomy interactive --phase recon
+
+# draft a new engagement from a natural-language brief, confirm, then run it
+ANTHROPIC_API_KEY=sk-... ./venv/bin/python -m hexharness init \
+    "External test of acme.example and 203.0.113.0/24, exclude vpn.acme.example, \
+     enumeration only, business hours" --task "Resolve www.acme.example"
+
+./venv/bin/python -m hexharness build-image     # build the Kali sandbox image (Kali + tools)
+./venv/bin/python -m hexharness verify  --engagement <file>   # verify the audit log hash chain
+./venv/bin/python -m hexharness report  --engagement <file> --out report.html
+```
+
+The requested `--autonomy/--phase` are clamped to the engagement's ROE ceiling. The agent
+can never grant itself scope or ROE: `init` drafting writes an inert file, and activation
+is a human step (invariants #3/#4).
+
+## The non-negotiable invariants (each has a test)
+
+1. The agent loop never calls `tool.run()` directly — always `ControlPlane.authorize()` first.
+2. `authorize()` order: `scope_guard → mode.decide(risk) → roe.cap → budget → HITL → secrets`, fail-closed.
+3. Scope Guard is a hard gate no mode bypasses — not even `bypass`. Out of scope = deny.
+4. ROE sets the engagement's max mode (immutable); active mode = `min(requested, ceiling)`.
+5. Findings enter as CANDIDATE; only CONFIRMED reach the report; REJECTED kept with reason.
+6. Kill switch is out-of-band (signal / trigger file), works client-disconnected, checkpoints first.
+7. Secrets are acquired out-of-band; their values never reach the model or the logs — only names.
+
+Audit log, tracing and checkpointing are **projections** of one append-only, hash-chained
+event stream (`hexharness/events/`). `hexharness verify` walks the chain and flags tampering.
+
+## Capabilities (tools)
+
+The agent drives tools through the control plane; `knowledge_search` and the skills library
+document each one. Current toolset:
+
+- **Recon** — `dns_enum`, `dns_lookup`, `whois_lookup`, `port_scan`, `parallel_scan`
+  (concurrent multi-host, scope-enforced), `banner_grab`, `ssh_info`, `ftp_check`,
+  `http_probe`, `smb_enum`, `browser` (Playwright: interact + screenshots).
+- **OSINT** — `web_search` (DuckDuckGo free / Tavily / Exa), `shodan_host`, `wayback_urls`,
+  `github_dork`, `cloud_storage_enum` (S3/Azure/GCS).
+- **Exploitation / C2** — `exec_command` (sandboxed, session-persistent), `exploit_run`
+  (scope-checked), `msfvenom_payload`, and the reverse-shell handler
+  (`listener_start` / `shell_sessions` / `shell_exec` / `listener_stop`).
+- **Analysis** — `binary_info`, `checksec`, `disassemble`, `postman_list`, `postman_run`.
+- **Evidence / reporting** — `record_finding`, `list_findings`, `generate_report`.
+- **Orchestration / meta** — `run_workflow` (declarative pipeline: templating, `for_each`,
+  conditions — every step still passes the control plane), `skill_lookup`, `skill_install`
+  (project or global scope), `knowledge_search`, `cwe_lookup`, `mitre_attack_lookup`,
+  `mcp_connect`, `engagement_draft`, `file_read`, `file_write`.
+
+Offensive tools are `DESTRUCTIVE`/`INTRUSIVE` + `requires_approval` and, where a target is
+involved, scope-sensitive. A caught reverse shell whose peer IP is out of scope is dropped
+on connect.
+
+## Sandbox
+
+`exec_command` runs in a **long-lived Docker container per session** (installs/state persist
+across calls; only the host-mounted `/workspace` survives after the session ends). The bundled
+image `hexharness/kali:latest` builds from `sandbox/docker/Dockerfile` (ships in the wheel,
+auto-builds on first use): Kali + nmap/smbclient/curl/metasploit-framework/aircrack-ng/etc.
+
+`engagement.hardware_access` (opt-in, default off) passes host USB/UART + wireless NICs into
+the session container (`--privileged`, host net) for hardware and WiFi work — it drops the
+sandbox isolation, so it is explicit. Scanners keep ephemeral, hardened containers.
+
+## Knowledge base
+
+- `mitre_attack_lookup` — the full MITRE ATT&CK Enterprise catalog (~697 techniques).
+- `cwe_lookup` — the full MITRE CWE catalog (~969 weaknesses).
+- `knowledge_search` — TF-IDF RAG over a local markdown corpus (technique playbooks + a
+  per-capability tool reference + the workflow guide).
+- Skills library (`skill_lookup`) — runnable playbooks (sqli-triage, subdomain-enumeration,
+  workflow-chaining, reverse-shell-handler, exploitation); install more at project or global scope.
+
+## Secrets
+
+Out-of-band vault: a tool that needs a key (`shodan_host`, `github_dork`, paid web search,
+MCP servers) triggers an operator prompt; the value is stored and reused, **never** shown to
+the model or logged. With the `[secrets]` extra it persists **encrypted at rest** (Fernet,
+per engagement); without it, in-memory only.
+
+## Layout
+
+```
+hexharness/
+  providers/   normalized LLM types + Anthropic/OpenAI/Google/Ollama adapters + router (+ fake)
+  agent/       ExecContext, single-agent loop (the chokepoint), workflow engine, orchestrator
+  control/     THE control plane: plane, scope_guard, policy(modes), roe, budget, hitl, kill_switch, vault
+  events/      append-only log + SHA-256 hash chain + bus
+  tools/       Tool base + registry + native tools + MCP client
+  sandbox/     Docker executor (hardened; argv list, no shell) + packaged Kali image
+  evidence/    findings (candidate/confirmed/rejected) + store
+  knowledge/   MITRE ATT&CK + CWE data + TF-IDF RAG corpus
+  skills/      skill engine + bundled playbook library
+  reporting/   ReportModel (from confirmed findings) + Jinja/DOCX render
+  tui/         Textual terminal UI
+  observability/ OTel span projection    recovery/ snapshot + replay
+  protocol/ transport/ daemon/ client/   JSON-RPC client/daemon split (sessions attach/resume)
+  engagement.py  engagement.yaml -> control-plane objects     engine.py  composition root
+```
+
+## Optional dependencies
+
+```bash
+./venv/bin/pip install -e '.[all]'   # everything
+# or pick: tui / openai / google / otel / daemon / reporting / mcp / browser / secrets / voice
+```
+
+`browser` also needs `./venv/bin/playwright install chromium`.
+
+## Known ceilings (marked `ponytail:` in code)
+
+- Orchestrator workers run sequentially (swap to `asyncio.gather` + per-worker providers).
+- Knowledge RAG is a linear TF-IDF scan (fine for a local corpus; add a vector index if it grows).
+- `run_workflow` passes values as text (no structured outputs); `for_each` splits on lines/commas.
+- Reverse-shell output is read by idle-timeout (no PTY/prompt detection); keep commands non-interactive.
+- MCP tools default to INTRUSIVE + requires_approval unless a `classify` override says otherwise.
+- `.md`→PDF and DOCX→PDF need extra converters; HTML→PDF via WeasyPrint is the primary path.

hexharness-1.0.0/hexharness/__init__.py

@@ -0,0 +1,7 @@
+"""HexHarness — agentic pentesting harness.
+
+The value is not the agent loop (that is standard) but the domain CONTROL PLANE:
+scope, ROE, evidence, approvals, budget. See hexharness.control.
+"""
+
+__version__ = "0.1.0"