npx-ray 1.0.0

package/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.

package/README.md

@@ -0,0 +1,365 @@
+# npx-ray
+
+**X-ray vision for npm packages.**
+
+A security scanner that audits source code, detects obfuscation, and flags supply chain risks -- all before you install. Downloads the tarball, runs 8 scanners in parallel, checks GitHub health, diffs source against the published package, and gives you a 0-100 risk score. No account required. Runs entirely locally.
+
+[![license](https://img.shields.io/github/license/txdadlab/npx-ray)](https://github.com/txdadlab/npx-ray/blob/main/LICENSE)
+[![node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
+
+---
+
+## Quick Start
+
+```bash
+npx npx-ray chalk              # Scan any package
+npx npx-ray chalk@5.0.0        # Scan specific version
+npx npx-ray --json chalk       # JSON output for CI/CD
+npx npx-ray --mcp              # Scan your MCP servers
+npx npx-ray --verbose express  # Detailed findings
+```
+
+Or install globally:
+
+```bash
+npm install -g npx-ray
+npx-ray lodash
+```
+
+---
+
+## Transparency: We Scanned Ourselves
+
+We ran npx-ray against its own source code. The result: **45/100 (F) -- DANGER**. Here's why, and why that's expected.
+
+npx-ray's scanners detect dangerous patterns like `eval()`, `child_process`, `exec()`, and `-----BEGIN PRIVATE KEY-----` by searching for those strings in source code. But npx-ray's own detection rules *contain those exact strings* as regex patterns. The scanner flags its own signatures:
+
+| Scanner | Self-Flag | Why |
+|---|---|---|
+| Static Analysis | 10 critical, 20 warnings | `static.js` contains detection patterns for `eval()`, `exec()`, `spawn()`, etc. -- the scanner finds its own rules |
+| Secrets | 1 critical | `secrets.js` contains the regex `-----BEGIN.*PRIVATE KEY-----` as a detection pattern -- flagged as a private key |
+| Obfuscation | 2 warnings | `ioc.js` and `obfuscation.js` contain hex escape sequences used for pattern matching |
+| IOC | 1 IP | `ioc.js` contains the example IP `1.2.3.4` in its test ignore list |
+
+**This is the "who watches the watchmen" problem** -- any security tool that scans for dangerous patterns will inevitably contain those patterns in its own detection rules. This does not affect scanning of other packages. We publish this result for full transparency.
+
+Full source code: [github.com/txdadlab/npx-ray](https://github.com/txdadlab/npx-ray)
+
+---
+
+## Example Output
+
+```
+npx-ray v1.0.0 — X-ray vision for npm packages
+───────────────────────────────────────────────────────
+
+Package: chalk@5.4.1
+Publisher: sindresorhus
+Published: 2024-11-21
+License: MIT
+Files: 7
+Size: 11.2 KB
+
+───────────────────────────────────────────────────────
+  Risk Score: 90/100 (A)
+───────────────────────────────────────────────────────
+
+Scan Results
+
+  ✅ Static: No dangerous patterns detected
+  ✅ Obfuscation: No obfuscation detected
+  ✅ Hooks: No lifecycle hooks found
+  ✅ Secrets: No embedded secrets detected
+  ✅ Binaries: No binary files found
+  ✅ Dependencies: 0 direct, 0 optional dependencies
+  ✅ Typosquatting: "chalk" is a known popular package
+
+GitHub
+  ✅ Repository: chalk/chalk
+    Stars: 22000 | Forks: 850 | Open Issues: 12
+    Created: 2013-07-18 | Last Push: 2024-11-21
+
+Source Diff
+  ✅ Source matches published package
+
+───────────────────────────────────────────────────────
+  Verdict: CLEAN — No issues detected
+───────────────────────────────────────────────────────
+
+Scan completed in 3.2s
+```
+
+---
+
+## What It Checks
+
+| Scanner | What it detects | Severity |
+|---|---|---|
+| **Static Analysis** | `eval()`, `child_process`, `exec()`, `spawn()`, `fetch()`, dynamic `require()`, filesystem writes, `process.env` access | Critical / Warning / Info |
+| **Obfuscation** | Shannon entropy anomalies, hex-encoded strings, base64 blobs (>500 chars), string array rotation (>50 elements), suspiciously long lines | Critical / Warning / Info |
+| **Lifecycle Hooks** | `preinstall`, `postinstall`, and other install-time scripts; shell commands in hooks (`curl`, `wget`, `bash`, `node -e`) | Critical / Warning |
+| **Secrets** | AWS keys, GitHub/npm tokens, private keys, credentials in URLs, generic API keys and tokens | Critical / Warning |
+| **Binaries** | `.node`, `.so`, `.dll`, `.dylib`, `.exe`, `.bin`, `.wasm` files that cannot be source-reviewed | Warning |
+| **Dependencies** | Dependency bloat (>20 warning, >50 critical), wildcard/unpinned versions (`*`, `latest`), git URL dependencies | Critical / Warning |
+| **Typosquatting** | Package names within 1-2 edits of popular packages (Levenshtein distance) | Critical / Warning |
+| **GitHub Health** | Stars, forks, archive status, repo age, publisher-vs-owner mismatch | Scoring adjustment |
+| **Source Diff** | Files in npm but not in GitHub repo, content hash mismatches between published and source | Scoring adjustment |
+| **IOC Extraction** | URLs and IP addresses extracted and defanged for safe review; decodes hex escapes, unicode escapes, `String.fromCharCode()`, and base64 | Warning (decoded) / Info (plaintext) |
+| **MCP Servers** | Unpinned MCP server versions in editor configs, tool description injection risks | Via `--mcp` flag |
+
+---
+
+## Limitations
+
+npx-ray is a **static analysis** tool. It does not execute any code from scanned packages. This means there are classes of threats it cannot fully detect:
+
+- **Cross-file obfuscation** -- A payload split across multiple files (e.g., encrypted blob in `data.js` with the decryption key in `utils.js`) cannot be reassembled by static analysis. The obfuscation scanner will flag the suspicious patterns, but the IOC scanner cannot extract the hidden URL.
+- **Key-based encoding** -- XOR ciphers, custom lookup tables, or any encoding that requires a runtime key to decode. npx-ray can decode self-contained encodings (hex, unicode, base64, charCode) but not schemes that depend on external keys or functions.
+- **Runtime string construction** -- Patterns like `arr[3] + arr[7] + arr[1]` where array elements are defined elsewhere, or template literals assembled from variables across scopes.
+- **Multi-stage deobfuscation** -- Pipelines like base64 decode -> XOR -> URL, where the output of one decoding step feeds into another that requires context.
+- **Novel or custom obfuscation** -- Obfuscation techniques not covered by the built-in pattern library. The entropy scanner provides a general safety net (obfuscated code tends to have high Shannon entropy), but purpose-built obfuscators can evade specific signature checks.
+- **Native binary analysis** -- `.node`, `.so`, `.dll`, and `.wasm` files are flagged as unreviable but their contents are not analyzed.
+
+**What this means in practice:** npx-ray catches the majority of real-world supply chain attacks, which overwhelmingly rely on plaintext or simple single-layer obfuscation. Sophisticated multi-file encrypted payloads exist but are rare in npm malware. When npx-ray encounters obfuscation it can't decode, the obfuscation scanner still flags the suspicious patterns -- you just won't see the decoded IOC.
+
+For defense-in-depth, combine npx-ray with runtime monitoring, sandboxed installs, and lockfile auditing.
+
+---
+
+## Risk Scoring
+
+Every package receives a score from 0 (dangerous) to 100 (clean), computed by summing weighted category scores. Each category starts at its maximum points and deducts based on the severity of findings.
+
+### Category Weights
+
+| Category | Max Points | Critical Deduction | Warning Deduction | Info Deduction |
+|---|---|---|---|---|
+| Static Analysis | 25 | -15 | -5 | 0 |
+| Obfuscation | 15 | -10 | -10 | -3 |
+| Lifecycle Hooks | 10 | -10 | -5 | 0 |
+| Dependencies | 10 | -10 | -5 | 0 |
+| GitHub Health | 15 | -- | -- | -- |
+| Source Diff | 10 | -- | -- | -- |
+| Secrets | 5 | -5 | -5 | 0 |
+| Binaries | 5 | -3 | -3 | -1 |
+| Typosquatting | 5 | -5 | -5 | 0 |
+| **Total** | **100** | | | |
+
+GitHub Health deductions: archived repo (-10), zero stars (-5), repo less than 1 month old (-5), publisher does not match GitHub owner (-10).
+
+Source Diff deductions: -5 per unexpected file in the npm package that is not in the GitHub repo.
+
+### Letter Grades
+
+| Grade | Score | Verdict | Exit Code |
+|---|---|---|---|
+| **A** | 90 -- 100 | CLEAN -- No issues detected | 0 |
+| **B** | 80 -- 89 | CLEAN -- No issues detected | 0 |
+| **C** | 70 -- 79 | CAUTION -- Review findings before installing | 1 |
+| **D** | 60 -- 69 | DANGER -- Manual review strongly recommended | 2 |
+| **F** | 0 -- 59 | DANGER -- Manual review strongly recommended | 2 |
+
+---
+
+## CLI Reference
+
+```
+Usage: npx-ray [options] [package]
+
+X-ray vision for npm packages — security scanner that audits source code,
+detects obfuscation, and flags supply chain risks before you install
+
+Arguments:
+  package              Package to scan (name, name@version, or local tarball)
+
+Options:
+  --json               Output results as JSON (for CI/CD pipelines)
+  --verbose            Show detailed findings for each scanner
+  --mcp                Scan MCP servers from editor configurations
+  --no-github          Skip GitHub repository checks
+  --no-diff            Skip source-vs-published diff
+  -V, --version        Output the version number
+  -h, --help           Display help
+```
+
+### Examples
+
+```bash
+# Scan a package by name (resolves latest version)
+npx npx-ray express
+
+# Scan a specific version
+npx npx-ray lodash@4.17.21
+
+# JSON output for scripting or CI
+npx npx-ray react --json
+
+# Full detail with every individual finding
+npx npx-ray axios --verbose
+
+# Fast scan (skip GitHub API and source diff)
+npx npx-ray leftpad --no-github --no-diff
+
+# Scan all MCP servers configured on your machine
+npx npx-ray --mcp
+```
+
+---
+
+## MCP Server Scanning
+
+The `--mcp` flag scans your local editor configurations for MCP (Model Context Protocol) servers that use npm packages. It automatically discovers servers from:
+
+- **Claude Desktop** (macOS, Windows, Linux)
+- **Cursor** (`~/.cursor/mcp.json`)
+- **VS Code** (`~/.vscode/mcp.json`)
+- **Claude Code** (`~/.claude.json`)
+- **Windsurf** (`~/.windsurf/mcp.json`, `~/.codeium/windsurf/mcp_config.json`)
+
+For each npm-based MCP server found, npx-ray:
+
+1. Checks whether the package version is **pinned** (e.g., `@anthropic-ai/mcp-server@1.2.3` vs unpinned `@anthropic-ai/mcp-server`)
+2. Runs the **full security scan** on the npm package
+3. Reports a summary across all servers
+
+Unpinned MCP servers are a supply chain risk -- an attacker who compromises a package can push a new version that gets auto-installed the next time your editor launches.
+
+```bash
+npx npx-ray --mcp
+```
+
+---
+
+## CI/CD Integration
+
+Use npx-ray in your CI pipeline to gate new dependencies before they enter your project.
+
+### GitHub Actions
+
+```yaml
+name: Dependency Security Scan
+on:
+  pull_request:
+    paths:
+      - 'package.json'
+      - 'package-lock.json'
+
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        package: [express, lodash, axios]  # or parse from diff
+    steps:
+      - name: Security scan
+        run: npx npx-ray ${{ matrix.package }} --json
+```
+
+### Exit Codes
+
+| Code | Meaning | Action |
+|---|---|---|
+| 0 | Grade A or B -- clean | Proceed |
+| 1 | Grade C -- warnings found | Review findings |
+| 2 | Grade D or F -- critical issues | Block and investigate |
+
+### JSON Output Schema
+
+The `--json` flag outputs a structured report that can be parsed by downstream tools:
+
+```json
+{
+  "package": {
+    "name": "example",
+    "version": "1.0.0",
+    "license": "MIT",
+    "publisher": "author",
+    "dependencies": {}
+  },
+  "scanners": [
+    {
+      "name": "static",
+      "passed": true,
+      "findings": [],
+      "summary": "No dangerous patterns detected"
+    }
+  ],
+  "score": 95,
+  "grade": "A",
+  "verdict": "CLEAN — No issues detected",
+  "duration": 2100
+}
+```
+
+---
+
+## How It Works
+
+1. **Fetch metadata** from the npm registry (version, tarball URL, publisher, dependencies)
+2. **Download and extract** the tarball to a temporary directory -- nothing is installed, no scripts run
+3. **Run 8 scanners in parallel** against the extracted source code:
+   - Static analysis (dangerous API patterns)
+   - Obfuscation detection (entropy, hex, base64, string arrays)
+   - Lifecycle hooks (install scripts)
+   - Secrets (API keys, tokens, private keys)
+   - Binaries (non-reviewable native addons)
+   - Dependency analysis (bloat, wildcards, git URLs)
+   - Typosquatting (Levenshtein distance against top npm packages)
+   - IOC extraction (URLs and IPs, with deobfuscation layer)
+4. **Check GitHub health** via the unauthenticated API (stars, age, archive status, publisher match)
+5. **Diff source vs. published** by downloading the GitHub repo tarball and comparing file lists and content hashes
+6. **Calculate score** using weighted category deductions
+7. **Output report** (colored terminal output or JSON)
+8. **Clean up** the temporary directory
+
+No data is sent to any external service. GitHub API requests are unauthenticated and optional (skip with `--no-github`).
+
+---
+
+## Comparison
+
+| Feature | npx-ray | npm audit | socket.dev | mcp-scan |
+|---|---|---|---|---|
+| Source code analysis | Yes | No | No | No |
+| Obfuscation detection | Yes | No | Yes | No |
+| Shannon entropy analysis | Yes | No | No | No |
+| Typosquatting detection | Yes | No | Yes | No |
+| Source-vs-npm diff | Yes | No | No | No |
+| Lifecycle hook scanning | Yes | No | Yes | No |
+| Secret detection | Yes | No | No | No |
+| Binary file detection | Yes | No | No | No |
+| Dependency analysis | Yes | Yes | Yes | No |
+| GitHub health check | Yes | No | Yes | No |
+| MCP server scanning | Yes | No | No | Yes |
+| Works pre-install | Yes | No (post-install) | Yes | Yes |
+| Runs locally | Yes | Yes | No (SaaS) | Yes |
+| No account required | Yes | Yes | No | Yes |
+| JSON output for CI | Yes | Yes | Yes | Yes |
+
+---
+
+## Contributing
+
+Contributions are welcome. Please open an issue first to discuss what you would like to change.
+
+```bash
+git clone https://github.com/txdadlab/npx-ray.git
+cd npx-ray
+npm install
+npm run build
+node dist/cli.js chalk    # Test your changes
+npm test                  # Run the test suite
+```
+
+### Adding a New Scanner
+
+1. Create `src/scanners/your-scanner.ts` implementing the `ScannerResult` interface
+2. Import and add it to the `Promise.all` array in `src/cli.ts`
+3. Add a weight entry in `src/scorer.ts` under `CATEGORY_WEIGHTS`
+4. Add tests in `tests/`
+
+---
+
+## License
+
+[Apache-2.0](LICENSE)