hb-scan 0.1.0__tar.gz

hb_scan-0.1.0/LICENSE

@@ -0,0 +1,189 @@
+                                 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.
+
+      "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 the 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 the 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 any 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
+
+   Copyright 2026 Humanbound
+
+   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.

hb_scan-0.1.0/PKG-INFO

@@ -0,0 +1,339 @@
+Metadata-Version: 2.4
+Name: hb-scan
+Version: 0.1.0
+Summary: AI session security scanner — detect secrets, unsafe code, and data leakage in your AI tool conversations
+Author-email: Humanbound <hello@humanbound.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/humanbound/hb-scan
+Project-URL: Documentation, https://github.com/humanbound/hb-scan#readme
+Project-URL: Repository, https://github.com/humanbound/hb-scan
+Project-URL: Issues, https://github.com/humanbound/hb-scan/issues
+Keywords: ai,security,scanner,secrets,posture,developer-hygiene
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Provides-Extra: html
+Requires-Dist: jinja2>=3.0; extra == "html"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="assets/logo-light.svg"/>
+    <source media="(prefers-color-scheme: light)" srcset="assets/logo-dark.svg"/>
+    <img src="assets/logo-dark.svg" alt="Humanbound" width="280"/>
+  </picture>
+</p>
+
+<h3 align="center">hb-scan</h3>
+
+<p align="center">
+  AI session security scanner -- detect secrets, unsafe code, and data leakage in your AI tool conversations.
+  <br/>
+  <strong>151 rules</strong> &middot; <strong>70+ credential providers</strong> &middot; <strong>8 compliance frameworks</strong>
+</p>
+
+<p align="center">
+  <a href="#quick-start">Quick Start</a> &middot;
+  <a href="#what-it-scans">What It Scans</a> &middot;
+  <a href="#scoring">Scoring</a> &middot;
+  <a href="#compliance">Compliance</a> &middot;
+  <a href="docs/user-guide.md">User Guide</a> &middot;
+  <a href="docs/contributing.md">Contributing</a>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/hb-scan/"><img src="https://img.shields.io/pypi/v/hb-scan?style=flat-square&color=FD9506" alt="PyPI version"/></a>
+  <a href="https://pypi.org/project/hb-scan/"><img src="https://img.shields.io/pypi/dm/hb-scan?style=flat-square&color=FD9506" alt="Downloads"/></a>
+  <a href="https://github.com/humanbound/hb-scan/actions"><img src="https://img.shields.io/github/actions/workflow/status/humanbound/hb-scan/ci.yml?style=flat-square&color=FD9506" alt="Build"/></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-FD9506?style=flat-square" alt="License"/></a>
+  <a href="https://humanbound.ai"><img src="https://img.shields.io/badge/humanbound.ai-platform-FD9506?style=flat-square" alt="Platform"/></a>
+</p>
+
+---
+
+## Quick Start
+
+```bash
+pip install hb-scan
+hb-scan
+```
+
+That's it. hb-scan discovers AI tool sessions on your machine, scans them with 139 regex rules, and produces an AI hygiene report with a compliance-mapped score.
+
+> **Want the full HTML report?** hb-scan generates one automatically in your current directory. Open `hb-scan-report.html` in any browser.
+
+---
+
+## What It Does
+
+```
+$ hb-scan --since 7d
+
+hb-scan v0.1.0
+
+  [1/4] Searching for AI tool footprints...
+  ✓ Found 100 sessions (Claude Code)
+  [2/4] Analysing conversations for secrets...
+  [3/4] Crunching the numbers...
+  [4/4] Building your report...
+  ○ A few opportunities to improve.
+
+┌──────────────────────── hb-scan — AI Hygiene Report ─────────────────────────┐
+│ Mar 12 — Mar 19, 2026                                                        │
+└──────────────────────────────────────────────────────────────────────────────┘
+  Tool: Claude Code
+  Sessions scanned: 100
+
+  ⚠  Credential Exposure — 1 active credential
+  ✓  Sensitive Data — Clean
+  ✓  Code Security — Clean
+  ✓  Commands — Clean
+  ✓  Package Safety — Clean
+  ✓  IP / Trade Secret — Clean
+  ◌  Regulatory Data — requires LLM judge
+  ○  Human Oversight Index — HOI 0.97
+
+┌───────────────────────── HYGIENE SCORE ──────────────────────────────────────┐
+│  80/100 (Grade B)                                                            │
+└──────────────────────────────────────────────────────────────────────────────┘
+  Rules: 139/151 active (12 require LLM judge)
+```
+
+---
+
+## What It Scans
+
+Nine threat classes backed by international standards. Each maps to specific controls in OWASP, NIST, ISO, CIS, MITRE, and the EU AI Act.
+
+| ID | Threat Class | Rules | Detection | Key Standards |
+|---|---|---|---|---|
+| DH-01 | Secret Exposure | 104 | regex | OWASP LLM02, MITRE AML.T0051 |
+| DH-02 | Unsafe Code Acceptance | 6 + 3 LLM | regex + llm | OWASP LLM05, NIST SP 800-218A |
+| DH-03 | Dangerous Command Execution | 8 | regex | OWASP LLM06, SANS IDEsaster |
+| DH-04 | Sensitive Data Sharing | 6 + 1 LLM | regex + llm | ISO 42001 A.7, MITRE AML.T0024 |
+| DH-05 | Supply Chain Risk | 6 | regex | OWASP LLM03, ENISA Slopsquatting |
+| DH-06 | Scope Violation | 5 | regex | OWASP Agentic ASI03, CIS Control 6 |
+| DH-07 | IP / Trade Secret Leakage | 3 + 2 LLM | regex + llm | DTSA, EU Trade Secrets Directive |
+| DH-08 | Regulatory Data Exposure | 0 + 6 LLM | llm only | GDPR, HIPAA, SOX, ABA Opinion 512 |
+| DH-09 | Excessive Reliance | 1 | heuristic | EU AI Act Art. 14, NIST AI RMF |
+
+> **104 credential patterns** sourced from gitleaks and TruffleHog covering AWS, Azure, GCP, OpenAI, Anthropic, GitHub, Slack, Stripe, and 60+ more providers.
+
+See [docs/taxonomy.md](docs/taxonomy.md) for the full reference with standards citations.
+
+---
+
+## Scoring
+
+hb-scan uses **control-based scoring**, not per-finding counting. This mirrors how ISO 42001 and CIS Controls work: each category is a control that either passes or fails.
+
+```
+Score = 100 - sum(category penalties)
+
+Category penalty:
+  0     if clean (no findings)
+  100%  if high-severity findings present
+  50%   if medium-severity findings present
+  25%   if low-severity findings present
+```
+
+| Category | Weight | What it means |
+|---|---|---|
+| Secret Exposure | 20 | Credentials found in AI conversations |
+| Sensitive Data | 15 | Private files shared with AI tools |
+| IP / Trade Secret | 15 | Proprietary content shared with AI |
+| Regulatory Data | 15 | GDPR/HIPAA/SOX data in AI sessions |
+| Code Security | 12 | Vulnerable AI-generated code accepted |
+| Dangerous Commands | 10 | Risky shell commands via AI |
+| Supply Chain | 8 | Unvetted packages installed via AI |
+| Scope Violation | 5 | AI accessing files outside project |
+
+10 leaked API keys = same score as 1 leaked API key. The control is failing either way.
+
+---
+
+## Compliance
+
+The HTML report maps every finding to specific controls in 8 international frameworks:
+
+<table>
+<tr>
+<td width="50%">
+
+**AI-Specific Frameworks**
+- OWASP Top 10 for LLM Applications 2025
+- OWASP Top 10 for Agentic Applications 2026
+- NIST AI RMF & SP 800-218A
+- EU AI Act (Art. 14, 15)
+- MITRE ATLAS
+
+</td>
+<td width="50%">
+
+**General Security Frameworks**
+- ISO/IEC 42001:2023 (AI Management)
+- ISO/IEC 27001:2022 (Information Security)
+- CIS Controls v8.1
+
+</td>
+</tr>
+</table>
+
+Each framework shows an alignment score with pass/fail/partial status per control. Use the report as an audit artifact.
+
+---
+
+## Human Oversight Index
+
+The HOI score (0.0 - 1.0) measures how actively you supervise AI tool actions. Sessions with 50+ tool executions and fewer than 3 substantive user interactions are flagged as auto-pilot.
+
+```
+HOI 1.0   = Full oversight (all sessions supervised)
+HOI 0.9+  = Good
+HOI 0.7+  = Attention needed
+HOI < 0.5 = Significant over-reliance
+```
+
+> 88% of accepted AI-generated code is retained without modification (GitHub/Accenture 2025). EU AI Act Article 14 requires awareness of "automation bias."
+
+---
+
+## Architecture
+
+```
+hb-scan
+  |
+  ├── Discover ────── Find AI tool sessions on disk
+  |                    └── Claude Code (v1), Cursor, Aider... (plugins)
+  |
+  ├── Normalize ───── Convert to common Session / Message / ToolCall schema
+  |
+  ├── Match ────────── Run YAML rules against normalized sessions
+  |                    ├── 139 regex rules (active in Tier 1.1)
+  |                    └── 12 LLM rules (deferred to Tier 1.2)
+  |
+  ├── Enrich ────────  JWT expiry detection, severity adjustments
+  |
+  ├── Aggregate ───── Group findings into insight sections
+  |
+  ├── Score ────────── Control-based posture calculation
+  |
+  └── Report ────────  Terminal summary + branded HTML report
+```
+
+---
+
+## CLI Reference
+
+```bash
+hb-scan                          # Full scan, terminal + HTML report
+hb-scan --since 7d               # Last 7 days only
+hb-scan --since 24h              # Last 24 hours
+hb-scan --tool claude-code       # Specific tool only
+hb-scan --project /path/to/repo  # Specific project only
+hb-scan --rules ./my-rules/      # Add custom YAML rules directory
+hb-scan --format json            # Machine-readable JSON output
+hb-scan --output report.html     # Custom report path
+hb-scan --no-telemetry           # Disable anonymous usage telemetry
+
+hb-scan discover                 # List discovered AI tools
+hb-scan rules                    # List all rules and their status
+```
+
+---
+
+## Supported AI Tools
+
+| Tool | Status | Data Source |
+|---|---|---|
+| Claude Code | **Supported** | `~/.claude/projects/` (JSONL sessions) |
+
+Support for additional AI tools (Cursor, GitHub Copilot, Aider, Continue.dev, ChatGPT Desktop, Windsurf, and others) is in progress. This list will grow as new discoverers are added.
+
+> Adding a new tool = one Python file implementing `BaseDiscoverer`. See [contributing guide](docs/contributing.md#adding-a-new-ai-tool-discoverer).
+
+---
+
+## Tiers
+
+<table>
+<tr>
+<td width="33%">
+
+**Tier 1.1 -- Current**
+
+Regex-based rules. Fully offline. Open source.
+
+```bash
+pip install hb-scan
+hb-scan
+```
+
+</td>
+<td width="33%">
+
+**Tier 1.2 -- Coming**
+
+Bring your own LLM judge. Regulatory data detection. Semantic analysis.
+
+```bash
+hb-scan --llm
+```
+
+</td>
+<td width="34%">
+
+**Tier 2 -- Platform**
+
+Org-wide governance. Device fleet scanning. Posture dashboard.
+
+[humanbound.ai](https://humanbound.ai)
+
+</td>
+</tr>
+</table>
+
+---
+
+## Contributing
+
+We welcome contributions in four areas:
+
+- **Rules** -- detection patterns for new credential types or vulnerability patterns
+- **Discoverers** -- support for new AI tools (Cursor, Aider, Continue.dev)
+- **Compliance** -- control mappings from additional frameworks
+- **Core** -- false positive improvements, scoring refinements, report enhancements
+
+See [docs/contributing.md](docs/contributing.md) for architecture, development setup, and PR guidelines.
+
+---
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE).
+
+---
+
+<p align="center">
+  <a href="https://humanbound.ai">humanbound.ai</a> &middot;
+  <a href="https://github.com/humanbound/hb-scan">GitHub</a>
+</p>
+
+<p align="center">
+  <sub>For organisation-wide AI governance, connect hb-scan to the <a href="https://humanbound.ai">Humanbound platform</a>.</sub>
+</p>