|
| 1 | +#!/usr/bin/env python3 |
| 2 | +""" |
| 3 | +check_package.py - Check whether a package is safe to install. |
| 4 | +
|
| 5 | +Data sources (all free, no API key): |
| 6 | + 1. OSV.dev -> known vulnerabilities (ground truth: CVEs/GHSAs) |
| 7 | + 2. deps.dev -> package metadata + OpenSSF Scorecard (health score 0-10) |
| 8 | +
|
| 9 | +Usage: |
| 10 | + python3 check_package.py <package-name> [version] [--ecosystem npm] |
| 11 | +
|
| 12 | +Examples: |
| 13 | + python3 check_package.py lodash 4.17.20 |
| 14 | + python3 check_package.py express |
| 15 | + python3 check_package.py requests 2.19.0 --ecosystem PyPI |
| 16 | +
|
| 17 | +Exit codes: |
| 18 | + 0 = SECURE (no known vulnerabilities, acceptable health score) |
| 19 | + 1 = WARNING (known vulnerabilities and/or low health score) |
| 20 | + 2 = ERROR (network failure, package not found, etc.) |
| 21 | +""" |
| 22 | + |
| 23 | +import argparse |
| 24 | +import json |
| 25 | +import sys |
| 26 | +import urllib.parse |
| 27 | +import urllib.request |
| 28 | + |
| 29 | +OSV_API = "https://api.osv.dev/v1/query" |
| 30 | +DEPSDEV_API = "https://api.deps.dev/v3" |
| 31 | +SCORECARD_WARN_THRESHOLD = 4.0 # warn if OpenSSF score is below this |
| 32 | +TIMEOUT = 15 |
| 33 | + |
| 34 | + |
| 35 | +def http_json(url, payload=None): |
| 36 | + req = urllib.request.Request( |
| 37 | + url, |
| 38 | + data=json.dumps(payload).encode() if payload is not None else None, |
| 39 | + headers={"Content-Type": "application/json", |
| 40 | + "User-Agent": "package-security-check"}, |
| 41 | + method="POST" if payload is not None else "GET", |
| 42 | + ) |
| 43 | + with urllib.request.urlopen(req, timeout=TIMEOUT) as resp: |
| 44 | + return json.loads(resp.read().decode()) |
| 45 | + |
| 46 | + |
| 47 | +def get_latest_version(name, ecosystem): |
| 48 | + """Resolve the default/latest version from deps.dev.""" |
| 49 | + url = f"{DEPSDEV_API}/systems/{ecosystem}/packages/{urllib.parse.quote(name, safe='')}" |
| 50 | + data = http_json(url) |
| 51 | + for v in data.get("versions", []): |
| 52 | + if v.get("isDefault"): |
| 53 | + return v["versionKey"]["version"] |
| 54 | + versions = data.get("versions", []) |
| 55 | + return versions[-1]["versionKey"]["version"] if versions else None |
| 56 | + |
| 57 | + |
| 58 | +def query_osv(name, version, ecosystem): |
| 59 | + """Return list of known vulnerabilities for this package version.""" |
| 60 | + payload = {"package": {"name": name, "ecosystem": ecosystem}} |
| 61 | + if version: |
| 62 | + payload["version"] = version |
| 63 | + data = http_json(OSV_API, payload) |
| 64 | + return data.get("vulns", []) |
| 65 | + |
| 66 | + |
| 67 | +def query_scorecard(name, version, ecosystem): |
| 68 | + """Return (score, repo) from deps.dev's OpenSSF Scorecard data, or (None, None).""" |
| 69 | + url = ( |
| 70 | + f"{DEPSDEV_API}/systems/{ecosystem}/packages/" |
| 71 | + f"{urllib.parse.quote(name, safe='')}/versions/{urllib.parse.quote(version, safe='')}" |
| 72 | + ) |
| 73 | + data = http_json(url) |
| 74 | + for project in data.get("relatedProjects", []): |
| 75 | + project_key = project.get("projectKey", {}).get("id") |
| 76 | + if not project_key: |
| 77 | + continue |
| 78 | + try: |
| 79 | + pdata = http_json( |
| 80 | + f"{DEPSDEV_API}/projects/{urllib.parse.quote(project_key, safe='')}") |
| 81 | + except Exception: |
| 82 | + continue |
| 83 | + scorecard = pdata.get("scorecard") |
| 84 | + if scorecard and "overallScore" in scorecard: |
| 85 | + return scorecard["overallScore"], project_key |
| 86 | + return None, None |
| 87 | + |
| 88 | + |
| 89 | +def severity_label(vuln): |
| 90 | + """Best-effort severity extraction from an OSV record.""" |
| 91 | + sev = vuln.get("database_specific", {}).get("severity") |
| 92 | + if sev: |
| 93 | + return sev.upper() |
| 94 | + for s in vuln.get("severity", []): |
| 95 | + if s.get("type", "").startswith("CVSS"): |
| 96 | + return f"CVSS {s.get('score', '?')}" |
| 97 | + return "UNKNOWN" |
| 98 | + |
| 99 | + |
| 100 | +def main(): |
| 101 | + parser = argparse.ArgumentParser() |
| 102 | + parser.add_argument("package") |
| 103 | + parser.add_argument("version", nargs="?", default=None) |
| 104 | + parser.add_argument("--ecosystem", default="npm", |
| 105 | + help="npm (default), PyPI, Go, Maven, NuGet, RubyGems, crates.io") |
| 106 | + parser.add_argument("--json", action="store_true", |
| 107 | + help="machine-readable output") |
| 108 | + args = parser.parse_args() |
| 109 | + |
| 110 | + name, version, eco = args.package, args.version, args.ecosystem |
| 111 | + result = {"package": name, "ecosystem": eco, "version": version, |
| 112 | + "vulnerabilities": [], "scorecard": None, "verdict": None, "notes": []} |
| 113 | + |
| 114 | + # Resolve version if not given (needed for precise OSV + scorecard lookup) |
| 115 | + if not version: |
| 116 | + try: |
| 117 | + version = get_latest_version(name, eco) |
| 118 | + result["version"] = version |
| 119 | + result["notes"].append( |
| 120 | + f"No version specified; checked latest ({version}).") |
| 121 | + except Exception as e: |
| 122 | + result["notes"].append(f"Could not resolve latest version: {e}") |
| 123 | + |
| 124 | + # 1. Known vulnerabilities (OSV) — this is the authoritative check |
| 125 | + try: |
| 126 | + vulns = query_osv(name, version, eco) |
| 127 | + for v in vulns: |
| 128 | + result["vulnerabilities"].append({ |
| 129 | + "id": v.get("id"), |
| 130 | + "summary": (v.get("summary") or v.get("details", ""))[:140], |
| 131 | + "severity": severity_label(v), |
| 132 | + }) |
| 133 | + except Exception as e: |
| 134 | + result["notes"].append(f"OSV query failed: {e}") |
| 135 | + result["verdict"] = "ERROR" |
| 136 | + |
| 137 | + # 2. Health score (OpenSSF Scorecard via deps.dev) — heuristic signal |
| 138 | + if version: |
| 139 | + try: |
| 140 | + score, repo = query_scorecard(name, version, eco) |
| 141 | + if score is not None: |
| 142 | + result["scorecard"] = {"score": score, "repo": repo} |
| 143 | + else: |
| 144 | + result["notes"].append( |
| 145 | + "No OpenSSF Scorecard available (no scored GitHub repo).") |
| 146 | + except Exception as e: |
| 147 | + result["notes"].append(f"Scorecard lookup failed: {e}") |
| 148 | + |
| 149 | + # Verdict |
| 150 | + if result["verdict"] != "ERROR": |
| 151 | + vuln_count = len(result["vulnerabilities"]) |
| 152 | + low_score = (result["scorecard"] is not None |
| 153 | + and result["scorecard"]["score"] < SCORECARD_WARN_THRESHOLD) |
| 154 | + result["verdict"] = "WARNING" if ( |
| 155 | + vuln_count or low_score) else "SECURE" |
| 156 | + |
| 157 | + # Output |
| 158 | + if args.json: |
| 159 | + print(json.dumps(result, indent=2)) |
| 160 | + else: |
| 161 | + v = result["verdict"] |
| 162 | + icon = {"SECURE": "[OK]", "WARNING": "[!!]", "ERROR": "[??]"}[v] |
| 163 | + print(f"{icon} {v}: {name}@{result['version'] or '?'} ({eco})") |
| 164 | + if result["vulnerabilities"]: |
| 165 | + print( |
| 166 | + f"\nKnown vulnerabilities ({len(result['vulnerabilities'])}):") |
| 167 | + for vu in result["vulnerabilities"]: |
| 168 | + print(f" - {vu['id']} [{vu['severity']}] {vu['summary']}") |
| 169 | + if result["scorecard"]: |
| 170 | + sc = result["scorecard"] |
| 171 | + flag = " (below threshold!)" if sc["score"] < SCORECARD_WARN_THRESHOLD else "" |
| 172 | + print( |
| 173 | + f"\nOpenSSF Scorecard: {sc['score']}/10{flag} repo: {sc['repo']}") |
| 174 | + for note in result["notes"]: |
| 175 | + print(f"note: {note}") |
| 176 | + |
| 177 | + sys.exit({"SECURE": 0, "WARNING": 1, "ERROR": 2}[result["verdict"]]) |
| 178 | + |
| 179 | + |
| 180 | +if __name__ == "__main__": |
| 181 | + main() |
0 commit comments