uhbs 4.2.0__tar.gz

uhbs-4.2.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 2026 UHBS Project Contributors
+
+   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.

uhbs-4.2.0/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: uhbs
+Version: 4.2.0
+Summary: Universal Honeypot Benchmarking Standard (UHBS) — validators and UHBS-Lab reference core
+Author: Moran Zavdi
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/mziqudhd92/uhbs-standard
+Project-URL: Documentation, https://mziqudhd92.github.io/uhbs-standard/
+Project-URL: Repository, https://github.com/mziqudhd92/uhbs-standard
+Keywords: honeypot,benchmarking,cybersecurity,deception,uhbs,mcp,model-context-protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Security
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema>=4.22
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: click>=8.1
+Provides-Extra: lab
+Requires-Dist: paramiko>=3.0; extra == "lab"
+Provides-Extra: mcp
+Requires-Dist: mcp<2,>=1.28; extra == "mcp"
+Provides-Extra: scapy
+Requires-Dist: scapy<3,>=2.7; extra == "scapy"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: paramiko>=3.0; extra == "dev"
+Requires-Dist: mcp<2,>=1.28; extra == "dev"
+Dynamic: license-file
+
+# Universal Honeypot Benchmarking Standard (UHBS)
+
+[![CI](https://github.com/mziqudhd92/uhbs-standard/actions/workflows/ci-validate.yml/badge.svg)](https://github.com/mziqudhd92/uhbs-standard/actions/workflows/ci-validate.yml)
+[![Docs](https://github.com/mziqudhd92/uhbs-standard/actions/workflows/deploy-docs.yml/badge.svg)](https://mziqudhd92.github.io/uhbs-standard/)
+[![CodeQL](https://github.com/mziqudhd92/uhbs-standard/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/mziqudhd92/uhbs-standard/actions/workflows/codeql-analysis.yml)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.21631156.svg)](https://doi.org/10.5281/zenodo.21631156)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Spec](https://img.shields.io/badge/Specification-v4.2.0-indigo.svg)](docs/specification/core-principles.md)
+[![UHQS](https://img.shields.io/badge/UHQS-0%E2%80%93100-success.svg)](docs/specification/scoring-formula.md)
+
+> An objective, repeatable, quantitative methodology for deception technology evaluation — a **personal open-source beta framework** for comparing and grading honeypots and decoy systems by class and protocol.
+
+**UHBS v4.2.0** is a protocol-agnostic, **vendor-neutral** evaluation framework for measuring deception realism, safety containment, operational scale, and telemetry quality. It is **not** an industry consortium standard or multi-party governed body — see [ROADMAP.md](ROADMAP.md) for what maturity would require.
+
+## Project status
+
+**Status:** Beta / Experimental · personal project ([specification status](docs/specification/status.md)).
+
+- **Author / maintainer:** [@mziqudhd92](https://github.com/mziqudhd92) — see [MAINTAINERS.md](MAINTAINERS.md)
+- **Governance claims:** no Steering Committee, no independent adopter list yet — those are [roadmap goals](ROADMAP.md#phase-6--community-maturity-aspirational--not-done)
+- **Suggested use:** organizations **MAY** use the Production Baseline Profile (**UHQS > 80** + passing Safety Gate) as an *internal* evaluation gate; that is a recommendation in the beta, not a mandate from any standards body
+
+## Why UHBS?
+
+| Pillar | What it delivers |
+| --- | --- |
+| **Protocol-Agnostic** | Architecture-neutral testing across IT, OT/ICS, AI, and Cloud |
+| **Vendor-Neutral** | Class- and protocol-based evaluation — no product or brand endorsements |
+| **Quantitative Scoring** | Normalized **UHQS 0–100** composite with a non-linear Safety Gate |
+| **Six Evaluation Modules** | Modules A–F covering fidelity, behavior, telemetry, safety, scale, and audit |
+| **Production Baseline** | **UHQS > 80** suggested as an internal gate (RECOMMENDED in the beta) |
+
+> **Vendor-neutral** beta framework: compare any deception by class and protocol.
+> UHBS-Lab harness: `pip install -e '.[lab]'` → `uhbs-lab` / `uhbs lab`.
+> Named product proof lives only under [conformance fixtures](docs/conformance/index.md).
+> Maturity goals (committee, adopters, neutral org): [ROADMAP.md](ROADMAP.md).
+
+## Quickstart
+
+Validate a honeypot against a Target Profile Specification (`profile.yaml`) in three steps:
+
+```bash
+# 1. Install the CLI (add [lab] for the Modules A–F harness)
+pip install -e ".[lab]"
+
+# 2. Create or adapt a target profile
+cp templates/profile.yaml ./my-honeypot.profile.yaml
+
+# 3. Validate the profile against the official schema
+uhbs validate-profile my-honeypot.profile.yaml
+```
+
+Run a full scorecard validation once your audit harness produces results:
+
+```bash
+uhbs validate-scorecard path/to/scorecard.json
+uhbs score --profile my-honeypot.profile.yaml --scores scores.json
+```
+
+### MCP (AI hosts — Cursor, Claude, VS Code, …)
+
+Install the optional MCP extra so agents can call validators / UHQS scoring over
+the [Model Context Protocol](https://modelcontextprotocol.io/) (local stdio):
+
+```bash
+pip install -e ".[mcp]"
+# Configure your host — see docs/tooling/mcp.md
+# Cursor / Claude example uses: python -m uhbs_mcp  (set UHBS_ROOT to this checkout)
+```
+
+Registry metadata: [`server.json`](server.json). Live Docker lab probes stay on the CLI (`uhbs lab`), not MCP.
+
+### MCP honeypot grading (`uhbs[lab]`)
+
+Grade network-facing MCP decoys (JSON-RPC over HTTP/SSE) with the in-tree `mcp` protocol plugin — distinct from the AI-host MCP server above:
+
+```bash
+pip install -e ".[lab]"
+uhbs-lab --list-protocols   # includes mcp
+uhbs-lab \
+  --inventory docs/conformance/labs/beelzebub/inventory.yaml \
+  --target beelzebub-mcp \
+  --tps docs/conformance/labs/beelzebub/web_api_mcp_quick.yaml \
+  --protocol mcp \
+  --out ./reports/mcp
+```
+
+Details: [docs/architecture/mcp-honeypot-grading.md](docs/architecture/mcp-honeypot-grading.md).
+
+### Docker (grade without a local Python install)
+
+Build the grading image (CLI + UHBS-Lab harness):
+
+```bash
+docker build -t uhbs:4.2.0 .
+# or: docker compose build
+```
+
+Mount your working directory at `/work` and pass the same `uhbs` commands:
+
+```bash
+# Validate a scorecard on disk
+docker run --rm -v "$PWD:/work" -w /work uhbs:4.2.0 \
+  validate-scorecard ./docs/conformance/fixtures/cowrie-low-interaction.scorecard.json
+
+# Compute UHQS from module scores
+docker run --rm -v "$PWD:/work" -w /work uhbs:4.2.0 \
+  score --class Low-Interaction --scores ./scores.json
+
+# List protocol plugins / run a lab probe against a reachable honeypot
+docker run --rm -v "$PWD:/work" -w /work uhbs:4.2.0 lab --list-protocols
+docker run --rm -v "$PWD:/work" -w /work \
+  -e UHBS_QUICK=1 -e UHBS_AIRGAP_ATTESTED=1 \
+  uhbs:4.2.0 lab \
+    --tps low_interaction \
+    --protocol ssh \
+    --target host.docker.internal --port 2222 \
+    --source-root /work \
+    --phases profile,static,dynamic,score \
+    --quick \
+    --out /work/.local/bench-reports/my-target
+```
+
+Compose shorthand: `docker compose run --rm uhbs validate-profile ./my-honeypot.profile.yaml`.
+
+Documentation site: **[https://mziqudhd92.github.io/uhbs-standard/](https://mziqudhd92.github.io/uhbs-standard/)** (landing hub) · **[docs / MkDocs](https://mziqudhd92.github.io/uhbs-standard/mkdocs/)**  
+Maturity roadmap: **[ROADMAP.md](ROADMAP.md)** · Reference harness: **[docs/reference-implementation.md](docs/reference-implementation.md)** · CLI guide: **[docs/tooling/cli.md](docs/tooling/cli.md)**
+
+### Discovery for search & AI agents (SEO / AEO / GEO)
+
+| File | Purpose |
+| --- | --- |
+| [llms.txt](llms.txt) (repo) · [site llms.txt](https://mziqudhd92.github.io/uhbs-standard/llms.txt) | Curated index for coding / answer agents |
+| [AGENTS.md](AGENTS.md) | Rules for assistants editing this repo |
+| [CITATION.cff](CITATION.cff) | Formal citation metadata |
+| Site [robots.txt](https://mziqudhd92.github.io/uhbs-standard/robots.txt) · [sitemap.xml](https://mziqudhd92.github.io/uhbs-standard/mkdocs/sitemap.xml) | Crawler hints |
+
+## Scoring Summary (UHQS 4.2.0)
+
+The **Universal Honeypot Quality Score (UHQS)** is a normalized composite from **0 to 100**:
+
+\[
+\mathrm{UHQS} = \delta_C \cdot (w_A S_A + w_B S_B + w_C S_C + w_E S_E + w_F S_F)
+\]
+
+- \(S_A \ldots S_F\) — normalized module scores (0–100)
+- \(w_A \ldots w_F\) — profile-adaptive weights (sum to 1.00)
+- \(\delta_C\) — **Safety Gate** from Module D (Containment):  
+  \(\delta_C = 1.0\) if \(C \ge 95\); otherwise \(\delta_C = (C/100)^2\)
+
+Production deployment requires **UHQS > 80** and a passing Safety Gate. A decoy with excellent deception scores can still fail evaluation if Module D falls below the gate. See [Scoring Formula](docs/specification/scoring-formula.md).
+
+## Audit Workflow (5 Phases)
+
+```text
+┌─────────────┐   ┌─────────────┐   ┌─────────────┐   ┌─────────────┐   ┌─────────────┐
+│  Phase 1    │──▶│  Phase 2    │──▶│  Phase 3    │──▶│  Phase 4    │──▶│  Phase 5    │
+│  Profile &  │   │  Static     │   │  Sandbox    │   │  Dynamic    │   │  Score &    │
+│  Config     │   │  Audit (F)  │   │  Provision  │   │  Modules A–E│   │  Report     │
+└─────────────┘   └─────────────┘   └─────────────┘   └─────────────┘   └─────────────┘
+```
+
+1. **Configuration & Profile Setup** — Define `profile.yaml`, protocol expectations, baselines  
+2. **Static Audit Execution** — Analyze repository, container build manifests, and system prompts  
+3. **Sandbox Environment Provisioning** — Isolated runtime with egress monitors  
+4. **Dynamic Adversarial Execution** — Modules A–E via automated harnesses  
+5. **Score Computation & Reporting** — Apply \(\delta_C\) and emit the standard scorecard  
+
+## Repository Layout
+
+```text
+uhbs-standard/
+├── docs/                 # Website + Docs-as-Code (MkDocs → GitHub Pages)
+│   └── conformance/
+│       ├── fixtures/     # Sanitized scorecard JSON
+│       └── reports/      # Quick + full lab artifacts + tutorials (named proof)
+├── schemas/              # JSON Schemas for profiles & scorecards
+├── templates/            # Starter profile.yaml for framework users
+├── src/uhbs_cli/         # Validation CLI
+├── src/uhbs_core/        # UHBS-Lab reference harness
+├── Dockerfile            # Grading image (uhbs CLI + lab)
+├── Dockerfile.full       # Grading image + Module F SAST tools
+├── docker-compose.yml    # Mount-cwd helper for the grading image
+├── GOVERNANCE.md         # Project notes (personal maintainer; not a committee)
+├── SECURITY.md           # Vulnerability disclosure policy
+└── CITATION.cff          # Citation metadata
+```
+
+## Modules at a Glance
+
+| Module | Focus |
+| --- | --- |
+| **A** | Protocol & Syntax Fidelity |
+| **B** | Behavioral & Stateful Realism |
+| **C** | Telemetry Quality & Pipeline Resilience |
+| **D** | Safety, Containment & Boundary Controls (**Safety Gate**) |
+| **E** | Scalability, Latency & Stress Performance |
+| **F** | White-Box Static Code Audit |
+
+## Embed Your Grade
+
+After publishing an official scorecard, maintainers can embed:
+
+```markdown
+![UHBS v4.2.0](https://img.shields.io/badge/UHBS%20v4.2.0-Grade%20A-brightgreen)
+```
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) and [GOVERNANCE.md](GOVERNANCE.md). Specification changes go through an **RFC** process. By contributing, you agree to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/) (sign-off required on commits).
+
+## Citation
+
+```bibtex
+@software{uhbs2026,
+  author = {Zavdi, Moran},
+  title = {Universal Honeypot Benchmarking Standard (UHBS)},
+  year = {2026},
+  version = {4.2.0},
+  publisher = {Zenodo},
+  doi = {10.5281/zenodo.21631156},
+  url = {https://doi.org/10.5281/zenodo.21631156}
+}
+```
+
+Or use the machine-readable [`CITATION.cff`](CITATION.cff). Concept DOI (always resolves to the latest deposit): [10.5281/zenodo.21631155](https://doi.org/10.5281/zenodo.21631155).
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).
+
+---
+
+An objective, repeatable, quantitative methodology for deception technology evaluation — providing cybersecurity professionals with a non-biased baseline for comparing and grading honeypots and decoy systems.