File size: 5,243 Bytes
44084af | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | #!/usr/bin/env python3
"""Scrub credentials and local paths from text that is about to be published.
from redact import redact # used by export_runs.py before writing runs.json
python scripts/redact.py --check DIR # exit 1 if anything under DIR still looks like a secret
Catches known key formats (OpenAI, Anthropic, Together, OpenRouter, HF, GitHub, AWS, Google, Slack),
JWT/OAuth tokens, `KEY=value` style assignments for secret-looking names, the exact values of any
secret-looking environment variables set in this shell, /Users/<name> or /home/<name> paths, macOS temp
directories (under /var/folders, and the /private view of the temp dirs) and e-mail addresses. Addresses at
reserved names (RFC 2606/6761: `*.example`, `example.com|net|org`, `*.test`, `*.invalid`, `*.localhost`) are
synthetic, as in the tasks' Alertmanager configs, and stay. The check skips shell defaults and expansions
(`${API_KEY:-...}`), code such as `_TOKEN = re.compile(...)` and the masks themselves.
"""
from __future__ import annotations
import argparse
import os
import re
import sys
MASK = "[REDACTED]"
PATTERNS = [
r"sk-ant-[A-Za-z0-9_\-]{20,}", # Anthropic keys and OAuth tokens
r"sk-or-[A-Za-z0-9_\-]{20,}", # OpenRouter
r"sk-(?:proj-|svcacct-|admin-)?[A-Za-z0-9_\-]{20,}", # OpenAI
r"tgp_v1_[A-Za-z0-9_\-]{20,}", # Together
r"hf_[A-Za-z0-9]{30,}", # Hugging Face
r"gh[pousr]_[A-Za-z0-9]{30,}", # GitHub tokens
r"github_pat_[A-Za-z0-9_]{40,}",
r"AKIA[0-9A-Z]{16}", # AWS access key id
r"AIza[0-9A-Za-z_\-]{35}", # Google API key
r"xox[abprs]-[A-Za-z0-9\-]{10,}", # Slack
r"eyJ[A-Za-z0-9_\-]{10,}\.eyJ[A-Za-z0-9_\-]{10,}\.[A-Za-z0-9_\-]{10,}", # JWT (ChatGPT/Codex auth)
r"(?i)bearer\s+[A-Za-z0-9._\-]{20,}",
]
SECRET_NAME = r"[A-Z0-9_]*(?:API_KEY|TOKEN|SECRET|PASSWORD|ACCESS_KEY|AUTH)[A-Z0-9_]*"
ASSIGN = re.compile(r"(\b" + SECRET_NAME + r"\b\s*[=:]\s*[\"']?)([^\s\"',}]{8,})")
JSON_FIELD = re.compile(r'((?:\\?")(?:access_token|refresh_token|id_token|api_key|OPENAI_API_KEY|token)(?:\\?")\s*:\s*(?:\\?"))([^"\\]{8,})')
HOME = re.compile(r"/(?:Users|home)/[A-Za-z0-9._\-]+")
TMPX = re.compile(r"/private(?=/tmp\b)/tmp|/(?:private/)?var/folders/[^/\s\"'\\]+/[^/\s\"'\\]+(?:/[TC](?![A-Za-z0-9._\-]))?")
EMAIL = re.compile(r"(?<![A-Za-z0-9._%+\-])[A-Za-z0-9._%+\-]+@((?:[A-Za-z0-9\-]+\.)+[A-Za-z]{2,})(?![A-Za-z0-9\-])")
RESERVED = re.compile(r"(?:^|\.)(?:example|test|invalid|localhost)$|^example\.(?:com|net|org)$", re.I)
EMAIL_MASK = "user@example.com"
COMPILED = [re.compile(p) for p in PATTERNS]
def _email(m) -> str:
return m.group(0) if RESERVED.search(m.group(1)) else EMAIL_MASK
def _env_secrets() -> list[str]:
name = re.compile("^" + SECRET_NAME + "$")
return sorted({v for k, v in os.environ.items() if name.match(k) and len(v) >= 8}, key=len, reverse=True)
def redact(text: str) -> str:
for v in _env_secrets():
text = text.replace(v, MASK)
for rx in COMPILED:
text = rx.sub(MASK, text)
text = ASSIGN.sub(lambda m: m.group(1) + MASK, text)
text = JSON_FIELD.sub(lambda m: m.group(1) + MASK, text)
text = TMPX.sub("/tmp", text)
text = EMAIL.sub(_email, text)
return HOME.sub("/home/user", text)
def _not_a_value(text: str, m) -> bool:
"""An assignment-shaped match that holds no literal: a shell default or error message (`${NAME:-word}`,
`${NAME:?msg}`), a shell expansion (`$VAR`, `${VAR}`) or code (`_TOKEN = re.compile(...)`; no key format
starts with `$` or contains a parenthesis)."""
shell = text[max(0, m.start() - 2):m.start()] == "${" and m.group(1).rstrip().endswith(":") \
and m.group(2)[:1] in "-?=+"
return shell or m.group(2).startswith("$") or "(" in m.group(2)
def findings(text: str) -> list[str]:
hits = [m.group(0) for rx in COMPILED for m in rx.finditer(text)]
hits += [m.group(0) for m in ASSIGN.finditer(text) if m.group(2) != MASK and not _not_a_value(text, m)]
hits += [m.group(0) for m in JSON_FIELD.finditer(text) if m.group(2) != MASK]
hits += [v for v in _env_secrets() if v in text]
hits += [m.group(0) for m in HOME.finditer(text) if m.group(0) != "/home/user"] # the mask itself
hits += [m.group(0) for m in TMPX.finditer(text)]
hits += [m.group(0) for m in EMAIL.finditer(text) if not RESERVED.search(m.group(1))]
return hits
def check(root: str) -> int:
bad = 0
for dirpath, _, files in os.walk(root):
if "/.git" in dirpath:
continue
for f in files:
p = os.path.join(dirpath, f)
try:
text = open(p, encoding="utf-8").read()
except (UnicodeDecodeError, OSError):
continue
for h in findings(text):
bad += 1
print(f"{p}: looks like a secret or local path: {h[:12]}...", file=sys.stderr)
return 1 if bad else 0
if __name__ == "__main__":
ap = argparse.ArgumentParser()
ap.add_argument("--check", required=True, help="directory to scan before publishing")
sys.exit(check(ap.parse_args().check))
|