crypto-scanner

# 从 PyPI 安装
pip install crypto-scanner

# 扫描你的项目
crypto-scanner scan .

# 生成管理层 HTML 报告
crypto-scanner scan . --html --output quantum-risk-report.html

pip install crypto-scanner

git clone https://github.com/mbennett-labs/crypto-scanner.git
cd crypto-scanner
pip install -e .

# 扫描目录（JSON 输出至 stdout）
crypto-scanner scan <directory>

# 显示支持的文件类型和风险分类
crypto-scanner info

# 显示版本
crypto-scanner --version

# 扫描并显示详细信息
crypto-scanner scan ./src --verbose

# 将 JSON 报告保存到文件
crypto-scanner scan . --output crypto-audit.json

# 为利益相关者生成品牌化的 HTML 报告
crypto-scanner scan . --html --output quantum-assessment.html

# 排除特定目录
crypto-scanner scan . --exclude vendor --exclude legacy

# 排除文件模式
crypto-scanner scan . --exclude "*.test.js" --exclude "*.spec.ts"

# 组合选项
crypto-scanner scan ./backend -v --exclude node_modules -o report.json

.git, .svn, .hg          # 版本控制
node_modules, vendor     # 包依赖
__pycache__, .pytest_cache, .mypy_cache
.venv, venv, env         # 虚拟环境
dist, build, out         # 构建输出
.idea, .vscode           # IDE 目录
site-packages, third_party

{
  "scan_directory": "/path/to/project",
  "scan_timestamp": "2026-02-06T10:30:00",
  "scanner_version": "0.1.0",
  "summary": {
    "total_files_scanned": 150,
    "total_findings": 23,
    "critical_count": 5,
    "high_count": 8,
    "medium_count": 7,
    "low_count": 3
  },
  "excluded_patterns": [".git", "node_modules", "..."],
  "findings": [
    {
      "file_path": "/path/to/auth.py",
      "line_number": 42,
      "algorithm": "RSA",
      "key_size": 2048,
      "risk_level": "critical",
      "description": "RSA key generation detected",
      "recommendation": "Plan migration to post-quantum algorithms (ML-KEM, ML-DSA)",
      "context": "key = rsa.generate_private_key(public_exponent=65537, key_size=2048)"
    }
  ]
}

crypto-scanner scan . --html --output report.html

name: Crypto Vulnerability Scan

on: [push, pull_request]

jobs:
  crypto-scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Install Crypto Scanner
        run: pip install crypto-scanner

      - name: Run Crypto Scan
        run: crypto-scanner scan ./src --output crypto-report.json

      - name: Check for Critical Findings
        run: |
          CRITICAL=$(jq '.summary.critical_count' crypto-report.json)
          if [ "$CRITICAL" -gt 0 ]; then
            echo "::error::Found $CRITICAL critical quantum-vulnerable algorithms!"
            jq '.findings[] | select(.risk_level == "critical")' crypto-report.json
            exit 1
          fi

      - name: Upload Report
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: crypto-vulnerability-report
          path: crypto-report.json

crypto-scan:
  stage: security
  image: python:3.12
  script:
    - pip install crypto-scanner
    - crypto-scanner scan . --output crypto-report.json
    - |
      CRITICAL=$(jq '.summary.critical_count' crypto-report.json)
      if [ "$CRITICAL" -gt 0 ]; then
        echo "Critical quantum-vulnerable cryptography detected!"
        exit 1
      fi
  artifacts:
    reports:
      dotenv: crypto-report.json
    paths:
      - crypto-report.json
    when: always

repos:
  - repo: local
    hooks:
      - id: crypto-scanner
        name: Crypto Scanner
        entry: bash -c 'crypto-scanner scan . --output /tmp/crypto-scan.json && CRITICAL=$(jq ".summary.critical_count" /tmp/crypto-scan.json) && [ "$CRITICAL" -eq 0 ]'
        language: system
        pass_filenames: false
        always_run: true

#!/bin/bash
# crypto-check.sh - 如果发现严重漏洞则失败

set -e

crypto-scanner scan . --output /tmp/crypto-report.json

CRITICAL=$(jq '.summary.critical_count' /tmp/crypto-report.json)
HIGH=$(jq '.summary.high_count' /tmp/crypto-report.json)

echo "扫描完成：$CRITICAL 个严重，$HIGH 个高风险发现"

if [ "$CRITICAL" -gt 0 ]; then
    echo "失败：检测到严重的易受量子攻击的加密算法！"
    exit 1
fi

crypto-scanner/
├── src/crypto_scanner/
│   ├── cli.py              # Typer CLI 接口
│   ├── scanner.py          # 核心编排逻辑
│   ├── models.py           # Pydantic 数据模型
│   ├── patterns.py         # 50 多个正则检测模式
│   ├── analyzers/          # 文件类型分析器
│   │   ├── base.py         # 抽象基类
│   │   ├── source.py       # 源代码分析器（14 种语言）
│   │   ├── config.py       # 配置文件分析器
│   │   └── certificate.py  # X.509 证书分析器
│   └── reporters/          # 输出生成器
│       ├── json_reporter.py
│       └── html_reporter.py
└── tests/                  # 综合测试套件

git clone https://github.com/mbennett-labs/crypto-scanner.git
cd crypto-scanner
pip install -e ".[dev]"

# 运行所有测试
pytest tests/ -v

# 运行测试并生成覆盖率报告
pytest tests/ -v --cov=crypto_scanner --cov-report=html