mcpthreat-scan 0.1.0__tar.gz

mcpthreat_scan-0.1.0/LICENSE

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

mcpthreat_scan-0.1.0/PKG-INFO

@@ -0,0 +1,363 @@
+Metadata-Version: 2.4
+Name: mcpthreat-scan
+Version: 0.1.0
+Summary: Static zero-execution security scanner for MCP server source code
+Author: Taha Al-Faqih
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/0xtahaa/MCPThreat-Scan
+Project-URL: Source, https://github.com/0xtahaa/MCPThreat-Scan
+Project-URL: Issues, https://github.com/0xtahaa/MCPThreat-Scan/issues
+Keywords: mcp,security,scanner,static-analysis,semgrep
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Environment :: Console
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: semgrep>=1.86.0
+Requires-Dist: pip-audit>=2.10.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: textual>=8.2.0
+Requires-Dist: pyfiglet>=1.0.4
+Requires-Dist: tree-sitter>=0.25.0
+Requires-Dist: tree-sitter-typescript>=0.23.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.0; extra == "dev"
+Dynamic: license-file
+
+# MCPThreat-Scan
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](pyproject.toml)
+
+**Check MCP servers for security flaws before you trust them — without ever running them.**
+
+MCPThreat-Scan reads the source code of an MCP server (Python, TypeScript or JavaScript)
+and reports risks such as hardcoded secrets, command injection and poisoned tool
+descriptions. It is made for anyone who connects AI agents to third-party MCP servers
+(individuals, developers and teams) and wants to know what a server can do before giving it
+access to their data and tools. Because the scanned code is never executed, it is safe to
+scan servers you do not trust yet. If you build MCP servers yourself, use it to check your
+own code before a release.
+
+## Example
+
+```text
+$ mcpthreat-scan scan benchmark/vulnerable/command_injection.py
+
+benchmark\vulnerable\command_injection.py:
+  Line 9 [Command Injection] ERROR: Command Injection: A function parameter flows unchecked
+  into a shell command or eval/exec. ...
+
+Summary: 8 of 9 OWASP MCP categories without findings.
+Categories with findings: Command Injection
+```
+
+Every finding shows the file, line, category, severity and a hint on how to fix it.
+
+## Features
+
+- **Zero-execution:** the code is only read and parsed, never run, so it is safe to scan
+  servers you do not trust yet
+- **9 OWASP MCP risk categories:** from hardcoded secrets and command injection to tool
+  poisoning and typosquatting
+- **Rug-pull detection:** compare two versions of a server and see changed tools, parameters
+  and descriptions (`diff`)
+- **Optional AI review** of tool-poisoning candidates (opt-in with `--ai-review`)
+- **CI-ready:** text, JSON and SARIF output, and `--fail-on` to fail a build by severity
+- **Interactive terminal UI** (`tui`)
+- **Open benchmark** with known test cases, so you can check how the rules perform
+
+## Quick start
+
+Requires Python 3.12+ and Git.
+
+```bash
+git clone https://github.com/0xtahaa/MCPThreat-Scan.git
+cd MCPThreat-Scan
+python -m venv .venv
+source .venv/bin/activate        # Windows: .venv\Scripts\activate
+pip install -e .
+```
+
+The commands below assume the virtual environment is active.
+
+**Interactive interface (recommended to start):**
+
+```bash
+mcpthreat-scan tui
+```
+
+It guides you through choosing a target, running the scan and reading the findings.
+
+**Command line:** scan a single file or a whole folder:
+
+```bash
+mcpthreat-scan scan path/to/mcp_server.py
+```
+
+Optional: for the AI review (`--ai-review`), store an `OPENAI_API_KEY` in a local `.env`
+file. It is never committed (see `.gitignore`).
+
+### Set up with an AI assistant
+
+Copy this prompt into Claude Code, Codex or a similar agent. It only installs the tool.
+
+```text
+Set up MCPThreat-Scan for me. Only do the setup, do not scan anything.
+
+1. Check that Python 3.12+ and Git are installed. If not, tell me how to install them.
+2. Clone https://github.com/0xtahaa/MCPThreat-Scan.git, create a virtual environment
+   and run `pip install -e .`.
+3. Check the installation with: mcpthreat-scan --help
+4. Tell me how to start the interactive interface myself:
+   mcpthreat-scan tui
+
+Show me each command before you run it.
+```
+
+> **Run the scans yourself.** We recommend not letting an AI agent scan or read untrusted
+> servers for you: scanned code can contain instructions aimed at AI agents, which is exactly
+> what the *Tool Poisoning* check looks for. Use the interactive interface or the command line.
+
+## Usage
+
+### Scan
+
+Scan a single file or a whole folder:
+
+```bash
+mcpthreat-scan scan path/to/mcp_server.py
+mcpthreat-scan scan path/to/project/
+```
+
+The default output is readable text. Tool-poisoning findings are first reported as
+*candidates*. With `--ai-review`, an OpenAI model reviews each candidate and confirms or
+dismisses it:
+
+```bash
+mcpthreat-scan scan path/to/mcp_server.py --ai-review
+```
+
+This needs an `OPENAI_API_KEY`. Without one, the scan does not abort and the candidate simply
+stays unconfirmed.
+
+### Compare two versions (rug-pull detection)
+
+A server that was harmless in version 1 can turn malicious in version 2. Compare two versions
+of the same file to see what changed in tool names, parameters, descriptions and hidden
+behavior:
+
+```bash
+mcpthreat-scan diff server_v1.py server_v2.py
+```
+
+### Output formats and CI
+
+| Option | Effect |
+|---|---|
+| `--format text` | Readable text (default) |
+| `--format json` | Machine-readable JSON |
+| `--format sarif` | SARIF 2.1.0, the standard for GitHub Code Scanning and other CI tools |
+| `--fail-on ERROR\|WARNING\|INFO` | Exit code 1 as soon as a finding is at least that severe. Without this flag the exit code is always 0. |
+
+> **Note:** JSON and SARIF include the flagged source line or description (`evidence`),
+> which comes straight from the scanned code. Do not pass these reports to an AI agent.
+
+Example for GitHub Actions: fail the build on errors and upload the results to GitHub
+Code Scanning.
+
+```yaml
+name: MCP security scan
+on: [push, pull_request]
+
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install git+https://github.com/0xtahaa/MCPThreat-Scan.git
+      - run: mcpthreat-scan scan . --format sarif --fail-on ERROR > results.sarif
+      - if: always()
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: results.sarif
+```
+
+### Interactive interface (TUI)
+
+```bash
+mcpthreat-scan tui
+```
+
+![Main menu](docs/tui/01_menu_empty.svg)
+
+From the main menu you can:
+
+- **Start New Scan:** pick a file or folder, confirm, follow the scan and read the summary
+- **View Findings:** filter by severity and open a detail view with description and
+  recommendation for each finding
+- **Compare Versions:** compare two files or two folders and see changed tool definitions
+  plus new and resolved findings
+- **Trusted Servers & Exclusions:** manage trusted servers and ignore rules
+- **Export:** save the report as JSON or SARIF with `E`
+
+![Finding details](docs/tui/07_findings_detail.svg)
+
+Shortcuts are shown on every screen. On the main menu: `S` scan, `D` compare, `?` help,
+`Q` quit. A running scan cannot be cancelled safely, because Semgrep runs as one external
+process.
+
+## Configuration
+
+### Ignoring findings
+
+If you have reviewed a finding and accept it, ignore it. In the TUI, open the finding and press
+`i`. The rule is saved in a file called `.mcpscannerignore` in the folder you run the scan from.
+
+On the command line or in CI you can edit that file yourself, one rule per line as
+`file:Category`:
+
+```text
+# reviewed and accepted
+src/server.py:Missing Audit Logging
+```
+
+Ignored findings are counted in the summary, so nothing disappears silently.
+
+### Network access and your data
+
+The scan reads your code locally. Two features talk to external services:
+
+| Feature | What is sent |
+|---|---|
+| Supply-chain check | Dependency names and versions are looked up in the OSV vulnerability database through `pip-audit` |
+| `--ai-review` | The text of each tool-poisoning candidate (the flagged tool description or handler output, not whole files) goes to the OpenAI API, default model `gpt-4o-mini` |
+
+For the AI review, the candidate text is wrapped in markers and the model is instructed to treat
+it as data only. Your `OPENAI_API_KEY` is read from the environment or a local `.env` file.
+Checking `package-lock.json` for npm projects needs the separate
+[osv-scanner](https://google.github.io/osv-scanner/) program on your `PATH`.
+
+## What it checks
+
+MCPThreat-Scan checks for the most common known vulnerabilities in MCP servers, based on OWASP.
+
+| Category | What is checked |
+|---|---|
+| Hardcoded Secret | API keys or tokens written directly in the source code |
+| Command Injection | Tool input that reaches `eval`, `exec`, `os.system` or `subprocess` without checks |
+| Header Leak | Request headers ending up in error messages |
+| Unscoped Environment Access | Environment variables read on every tool call instead of once at startup |
+| Tool Poisoning | Hidden instructions for AI agents in tool descriptions or tool output. Rug pulls are found with `diff`. |
+| Supply Chain | Dependencies with known vulnerabilities (`requirements.txt`, and `package-lock.json` with osv-scanner) |
+| Missing Audit Logging | Security-relevant actions without any logging |
+| Capability Mismatch | A tool that makes network or email calls without saying so in its name or description. This is a keyword heuristic and does not detect deliberately deceptive descriptions. |
+| Typosquatting / Shadow Server | A server name that closely resembles a known server. A candidate, not proof. |
+
+Command Injection, Hardcoded Secret, Header Leak, Tool Poisoning and Unscoped Environment Access
+cover Python and TypeScript/JavaScript. Capability Mismatch and Missing Audit Logging currently
+cover Python only.
+
+Not covered: precise scope measurement (needs runtime tracing), a general prompt-injection content
+filter, server operations monitoring and shadow-server discovery.
+
+## Benchmark
+
+The rules are tested against example servers with known vulnerabilities and known-clean
+examples in [`benchmark/`](benchmark/). Run it yourself from the repository root:
+
+```bash
+python -m benchmark.evaluate
+```
+
+Result without `--ai-review` (rules and supply-chain check only):
+
+| Category | TP | FP | FN | Precision | Recall |
+|---|---|---|---|---|---|
+| Capability Mismatch | 2 | 0 | 0 | 100 % | 100 % |
+| Command Injection | 2 | 0 | 0 | 100 % | 100 % |
+| Hardcoded Secret | 2 | 0 | 0 | 100 % | 100 % |
+| Header Leak | 2 | 0 | 0 | 100 % | 100 % |
+| Missing Audit Logging | 6 | 0 | 0 | 100 % | 100 % |
+| Supply Chain | 2 | 0 | 0 | 100 % | 100 % |
+| Tool Poisoning | 6 | 1 | 2 | 86 % | 75 % |
+| Typosquatting / Shadow Server | 2 | 0 | 0 | 100 % | 100 % |
+| Unscoped Environment Access | 5 | 0 | 0 | 100 % | 100 % |
+| **Total** | **29** | **1** | **2** | **97 %** | **94 %** |
+
+**How to read this:** The examples were written together with the rules, so the benchmark
+shows that the rules do what they are meant to do. It is not an independent measurement of
+accuracy on real-world servers. A sample of 40 findings from public MCP servers is prepared for
+manual rating ([`benchmark/precision_sample.csv`](benchmark/precision_sample.csv)). The
+real-world precision will be published once it is rated.
+
+Tool Poisoning is weaker on purpose: the rules only deliver candidates, and `--ai-review` is
+what confirms them. The AI review is not measured here. The two misses are rug-pull cases from
+`benchmark/rugpull/`, see [Limitations](#limitations).
+
+## Limitations
+
+- **Findings are candidates, not proof.** Some checks (Tool Poisoning, Capability Mismatch,
+  Typosquatting) are heuristics. They can raise false alarms, and a carefully disguised attack
+  can slip through. `--ai-review` helps to confirm Tool Poisoning candidates, but it is not
+  measured in the benchmark.
+- **Only static analysis.** The scanner never runs the code, so it cannot see what a server does
+  at runtime.
+- **Languages:** Python and TypeScript/JavaScript. Capability Mismatch and Missing Audit Logging
+  cover Python only.
+- **Rug-pull detection compares two versions that you provide.** It does not watch a server over
+  time. In the benchmark it misses two cases (`benchmark/rugpull/`), and these cases are not part
+  of the automatic benchmark run.
+- **No real-world accuracy figures yet.** See [Benchmark](#benchmark).
+
+## Contributing
+
+Issues and pull requests are welcome. Before opening a pull request, run the tests and the
+benchmark:
+
+```bash
+pip install -e ".[dev]"
+pytest
+python -m benchmark.evaluate
+```
+
+## Development
+
+### Project structure
+
+```
+src/mcpthreat_scan/
+  cli/         Command-line interface (argparse: scan, diff, tui) — parsing only, delegates to core
+  tui/         Interactive terminal interface (Textual)
+  core/        Orchestration (run_scan, run_diff), categories/severities, shared exceptions
+  analyzers/   Semgrep (layer 1), AI review (layer 2, OpenAI), supply chain (pip-audit/OSV),
+               typosquat, capability post-filter — one task per analyzer, no analyzer chains
+  diff/        AST extraction of tool functions (never executed) and rug-pull comparison
+  policy/      .mcpscannerignore and reputation/whitelist
+  reporting/   Renderers for text, JSON and SARIF
+  resources/   Semgrep rules (rules/, one file per OWASP MCP category), known_mcp_servers.json
+benchmark/   Test cases with known results (vulnerable/, clean/, rugpull/) + expected_results.json
+             + evaluate.py (precision/recall; uses the core API, not part of the installable package)
+tests/       Unit tests (pytest)
+```
+
+### Known issues
+
+- **`policy/reputation.py` is not used by the scan.** The whitelist/fingerprint mechanism (meant to
+  skip costly re-review for established, unchanged servers) is not wired into the scan pipeline;
+  only the TUI management (`list_reviewed`, `revoke_review`) and the tests call it.
+- Two tests (`test_ai_review.py`, real OpenAI call) are skipped without `OPENAI_API_KEY`. Tests
+  with an OSV query via `pip-audit` (`test_dependency_check.py`) need network access and may fail
+  without it, which is an external dependency and not a code error.
+
+## License
+
+Apache License 2.0, see [LICENSE](LICENSE).