Разработка и Git

Поиск секретов в проекте

Сканирует текстовые файлы регулярными выражениями и показывает возможные ключи и пароли без правок.

Python Windows macOS Linux Продвинутый
Скачать secret_scan.py
Описание

Что делает скрипт

Скрипт обходит проект, пропускает бинарные файлы и служебные каталоги, затем ищет типовые признаки секретов: ключи облаков, приватные ключи, токены и строки вида password = значение. Найденные значения маскируются. Это эвристика, поэтому каждое срабатывание нужно проверить вручную.

Перед запуском
  • Скрипт только читает файлы и не удаляет найденные значения.
Запуск

Быстрый старт

python secret_scan.py --path .

Скачайте файл, откройте терминал в папке со скриптом и выполните команду. В Linux и macOS интерпретатор может называться python3, в Windows - python или py.

Примеры

Другие варианты

  • python secret_scan.py --path .
  • python secret_scan.py --path ./src --json findings.json
  • python secret_scan.py --path . --max 50
Зависимости

Что понадобится

Python 3.10+ Только стандартная библиотека
Windows winget install Python.Python.3.12
macOS brew install python
Linux sudo apt install python3
Исходник

secret_scan.py

#!/usr/bin/env python3
"""Эвристический поиск секретов в исходниках."""
from __future__ import annotations

import argparse
import json
import os
import re
from pathlib import Path

EXCLUDES = {
    ".git",
    ".hg",
    ".svn",
    ".venv",
    "venv",
    "env",
    "node_modules",
    "__pycache__",
    ".mypy_cache",
    ".pytest_cache",
    "dist",
    "build",
    "target",
    "vendor",
}
SKIP_SUFFIXES = {
    ".png",
    ".jpg",
    ".jpeg",
    ".gif",
    ".webp",
    ".ico",
    ".pdf",
    ".zip",
    ".gz",
    ".tar",
    ".7z",
    ".exe",
    ".dll",
    ".so",
    ".dylib",
    ".woff",
    ".woff2",
    ".ttf",
    ".mp4",
    ".mp3",
}
PATTERNS = [
    ("aws-access-key", re.compile(r"\bAKIA[0-9A-Z]{16}\b")),
    ("google-api-key", re.compile(r"\bAIza[0-9A-Za-z_-]{35}\b")),
    ("github-token", re.compile(r"\bgh[pousr]_[A-Za-z0-9]{36,}\b")),
    ("slack-token", re.compile(r"\bxox[baprs]-[A-Za-z0-9-]{10,}\b")),
    ("private-key", re.compile(r"-----BEGIN (?:RSA |OPENSSH |EC |DSA )?PRIVATE KEY-----")),
    (
        "generic-secret",
        re.compile(
            r"(?i)\b(?:api[_-]?key|secret|password|passwd|token)\b\s*[:=]\s*[\"'][^\"'\s]{8,}[\"']"
        ),
    ),
    (
        "bearer-token",
        re.compile(r"(?i)\bauthorization\b\s*[:=]\s*[\"']Bearer\s+[A-Za-z0-9._-]{16,}[\"']"),
    ),
]


def iter_files(root: Path):
    for current, dirs, files in os.walk(root):
        current_path = Path(current)
        dirs[:] = [
            name
            for name in dirs
            if name not in EXCLUDES and not (current_path / name).is_symlink()
        ]
        for name in files:
            path = current_path / name
            if path.is_symlink() or path.suffix.lower() in SKIP_SUFFIXES:
                continue
            try:
                if path.stat().st_size > 2 * 1024 * 1024:
                    continue
                data = path.read_bytes()
            except OSError:
                continue
            if b"\x00" in data[:4096]:
                continue
            yield path


def mask(value: str) -> str:
    if len(value) <= 4:
        return "*" * len(value)
    return value[:4] + "*" * min(12, max(3, len(value) - 4))


def main() -> int:
    parser = argparse.ArgumentParser(description="Найти возможные секреты в файлах")
    parser.add_argument("--path", type=Path, default=Path("."), help="Папка проекта")
    parser.add_argument("--json", type=Path, help="Сохранить отчёт в JSON")
    parser.add_argument("--max", type=int, default=200, help="Максимум находок")
    args = parser.parse_args()

    if args.max < 1:
        print("Параметр --max должен быть положительным.")
        return 2
    root = args.path.expanduser().resolve()
    if not root.is_dir():
        print(f"Папка не найдена: {root}")
        return 2

    findings = []
    for path in iter_files(root):
        try:
            text = path.read_text(encoding="utf-8", errors="replace")
        except OSError:
            continue
        for number, line in enumerate(text.splitlines(), start=1):
            for name, pattern in PATTERNS:
                for match in pattern.finditer(line):
                    findings.append(
                        {
                            "file": str(path.relative_to(root)),
                            "line": number,
                            "rule": name,
                            "match": mask(match.group(0)),
                        }
                    )
                    if len(findings) >= args.max:
                        break
                if len(findings) >= args.max:
                    break
            if len(findings) >= args.max:
                break
        if len(findings) >= args.max:
            break

    if args.json:
        args.json.write_text(
            json.dumps({"root": str(root), "findings": findings}, ensure_ascii=False, indent=2)
            + "\n",
            encoding="utf-8",
        )

    if not findings:
        print("Подозрительных строк не найдено.")
        return 0

    print(f"Найдено подозрительных строк: {len(findings)}")
    for item in findings:
        print(f"  {item['file']}:{item['line']}  [{item['rule']}]  {item['match']}")
    print("Проверьте каждую находку вручную. Это эвристика, а не гарантия.")
    return 1


if __name__ == "__main__":
    raise SystemExit(main())

Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.

CLI 1.0.0

Скачать без браузера

Команда скачает этот файл в текущую папку. CLI работает на Windows, macOS и Linux.

scriptdock get dev-secret-scan
  • Поиск по всему каталогу
  • Python 3.10+
  • Без внешних пакетов
Скачать CLI

GUI-версия готовится. Подробнее

Категория

Разработка и Git

Git, сборка, тесты, зависимости, логи и обслуживание проектов.