-
-
Notifications
You must be signed in to change notification settings - Fork 76.2k
Expand file tree
/
Copy pathredact.ts
More file actions
197 lines (178 loc) · 6.78 KB
/
redact.ts
File metadata and controls
197 lines (178 loc) · 6.78 KB
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
import { compileConfigRegex } from "../security/config-regex.js";
import { readLoggingConfig } from "./config.js";
import { replacePatternBounded } from "./redact-bounded.js";
export type RedactSensitiveMode = "off" | "tools";
type RedactPattern = string | RegExp;
const DEFAULT_REDACT_MODE: RedactSensitiveMode = "tools";
const DEFAULT_REDACT_MIN_LENGTH = 18;
const DEFAULT_REDACT_KEEP_START = 6;
const DEFAULT_REDACT_KEEP_END = 4;
const DEFAULT_REDACT_PATTERNS: string[] = [
// ENV-style assignments. Keep this case-sensitive so diagnostics like
// `Unrecognized key: "llm"` do not lose the actual config key.
String.raw`/\b[A-Z0-9_]*(?:KEY|TOKEN|SECRET|PASSWORD|PASSWD)\b\s*[=:]\s*(["']?)([^\s"'\\]+)\1/g`,
// URL query parameters. Keep this separate from ENV-style assignments so
// lower-case URL secrets stay redacted without hiding config-key diagnostics.
String.raw`/[?&](?:access[-_]?token|auth[-_]?token|hook[-_]?token|refresh[-_]?token|api[-_]?key|client[-_]?secret|token|key|secret|password|pass|passwd|auth|signature)=([^&\s"'<>]+)/gi`,
// JSON fields.
String.raw`"(?:apiKey|token|secret|password|passwd|accessToken|refreshToken)"\s*:\s*"([^"]+)"`,
// CLI flags.
String.raw`--(?:api[-_]?key|hook[-_]?token|token|secret|password|passwd)\s+(["']?)([^\s"']+)\1`,
// Authorization headers.
String.raw`Authorization\s*[:=]\s*Bearer\s+([A-Za-z0-9._\-+=]+)`,
String.raw`\bBearer\s+([A-Za-z0-9._\-+=]{18,})\b`,
// Standalone token assignments in CLI or HTTP diagnostics. URL query params
// are handled above so non-secret params survive and long values stay hinted.
String.raw`(^|[\s,;])(?:access_token|refresh_token|api[-_]?key|token|secret|password|passwd)=([^\s&#]+)`,
// PEM blocks.
String.raw`-----BEGIN [A-Z ]*PRIVATE KEY-----[\s\S]+?-----END [A-Z ]*PRIVATE KEY-----`,
// Common token prefixes.
String.raw`\b(sk-[A-Za-z0-9_-]{8,})\b`,
String.raw`\b(ghp_[A-Za-z0-9]{20,})\b`,
String.raw`\b(github_pat_[A-Za-z0-9_]{20,})\b`,
String.raw`\b(xox[baprs]-[A-Za-z0-9-]{10,})\b`,
String.raw`\b(xapp-[A-Za-z0-9-]{10,})\b`,
String.raw`\b(gsk_[A-Za-z0-9_-]{10,})\b`,
String.raw`\b(AIza[0-9A-Za-z\-_]{20,})\b`,
String.raw`\b(pplx-[A-Za-z0-9_-]{10,})\b`,
String.raw`\b(npm_[A-Za-z0-9]{10,})\b`,
// Telegram Bot API URLs embed the token as `/bot<token>/...` (no word-boundary before digits).
String.raw`\bbot(\d{6,}:[A-Za-z0-9_-]{20,})\b`,
String.raw`\b(\d{6,}:[A-Za-z0-9_-]{20,})\b`,
];
type RedactOptions = {
mode?: RedactSensitiveMode;
patterns?: RedactPattern[];
};
export type ResolvedRedactOptions = {
mode: RedactSensitiveMode;
patterns: RegExp[];
};
function normalizeMode(value?: string): RedactSensitiveMode {
return value === "off" ? "off" : DEFAULT_REDACT_MODE;
}
function parsePattern(raw: RedactPattern): RegExp | null {
if (raw instanceof RegExp) {
if (raw.flags.includes("g")) {
return raw;
}
return new RegExp(raw.source, `${raw.flags}g`);
}
if (!raw.trim()) {
return null;
}
const match = raw.match(/^\/(.+)\/([gimsuy]*)$/);
if (match) {
const flags = match[2].includes("g") ? match[2] : `${match[2]}g`;
return compileConfigRegex(match[1], flags)?.regex ?? null;
}
return compileConfigRegex(raw, "gi")?.regex ?? null;
}
function resolvePatterns(value?: RedactPattern[]): RegExp[] {
const source = value?.length ? value : DEFAULT_REDACT_PATTERNS;
return source.map(parsePattern).filter((re): re is RegExp => Boolean(re));
}
function maskToken(token: string): string {
if (token.length < DEFAULT_REDACT_MIN_LENGTH) {
return "***";
}
const start = token.slice(0, DEFAULT_REDACT_KEEP_START);
const end = token.slice(-DEFAULT_REDACT_KEEP_END);
return `${start}…${end}`;
}
function redactPemBlock(block: string): string {
const lines = block.split(/\r?\n/).filter(Boolean);
if (lines.length < 2) {
return "***";
}
return `${lines[0]}\n…redacted…\n${lines[lines.length - 1]}`;
}
function redactMatch(match: string, groups: string[]): string {
if (match.includes("PRIVATE KEY-----")) {
return redactPemBlock(match);
}
const token = groups.findLast((value) => typeof value === "string" && value.length > 0) ?? match;
const masked = maskToken(token);
if (token === match) {
return masked;
}
return match.replace(token, masked);
}
function redactText(text: string, patterns: RegExp[]): string {
let next = text;
for (const pattern of patterns) {
next = replacePatternBounded(next, pattern, (...args: string[]) =>
redactMatch(args[0], args.slice(1, -2)),
);
}
return next;
}
function resolveConfigRedaction(): RedactOptions {
const cfg = readLoggingConfig();
return {
mode: normalizeMode(cfg?.redactSensitive),
patterns: cfg?.redactPatterns,
};
}
export function resolveRedactOptions(options?: RedactOptions): ResolvedRedactOptions {
const resolved = options ?? resolveConfigRedaction();
const mode = normalizeMode(resolved.mode);
if (mode === "off") {
return {
mode,
patterns: [],
};
}
return {
mode,
patterns: resolvePatterns(resolved.patterns),
};
}
export function redactSensitiveText(text: string, options?: RedactOptions): string {
if (!text) {
return text;
}
const resolved = resolveRedactOptions(options);
if (resolved.mode === "off") {
return text;
}
if (!resolved.patterns.length) {
return text;
}
return redactText(text, resolved.patterns);
}
export function redactToolDetail(detail: string): string {
const resolved = resolveConfigRedaction();
if (normalizeMode(resolved.mode) !== "tools") {
return detail;
}
return redactSensitiveText(detail, resolved);
}
// Forces tools-mode regardless of `logging.redactSensitive` (which governs log
// output, not UI surfaces), and merges user `logging.redactPatterns` with the
// built-in defaults so both apply.
export function redactToolPayloadText(text: string): string {
if (!text) {
return text;
}
const cfg = readLoggingConfig();
const userPatterns = cfg?.redactPatterns;
const patterns =
userPatterns && userPatterns.length > 0
? [...userPatterns, ...DEFAULT_REDACT_PATTERNS]
: undefined;
return redactSensitiveText(text, { mode: "tools", patterns });
}
export function getDefaultRedactPatterns(): string[] {
return [...DEFAULT_REDACT_PATTERNS];
}
// Applies already-resolved redaction to a batch of lines without re-resolving options.
// Lines are joined before redacting so multiline patterns (e.g. PEM blocks) can match across
// line boundaries, then split back. Use this instead of mapping redactSensitiveText when
// options are resolved once per request.
export function redactSensitiveLines(lines: string[], resolved: ResolvedRedactOptions): string[] {
if (resolved.mode === "off" || !resolved.patterns.length || lines.length === 0) {
return lines;
}
return redactText(lines.join("\n"), resolved.patterns).split("\n");
}