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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
use super::pipeline::{push_decoded_replacements_spliced, DECODE_REPLACEMENT_BATCH_SOURCE_BYTES};
use super::util::{resolve_escaped_codepoint, simple_control_escape, take_hex_digits};
use super::{DecodeAdmissionSketch, Decoder};
use keyhog_core::Chunk;
/// JSON-aware decoder that unescapes string values before scanning.
pub(super) struct JsonDecoder;
impl Decoder for JsonDecoder {
fn name(&self) -> &'static str {
"json"
}
fn admission_sketch(&self, chunk: &Chunk) -> DecodeAdmissionSketch {
let strings = extract_escaped_json_strings(&chunk.data);
if strings.is_empty() {
DecodeAdmissionSketch::NONE
} else {
let bytes = strings
.iter()
.fold(0usize, |total, value| total.saturating_add(value.len()));
DecodeAdmissionSketch::possible(DecodeAdmissionSketch::JSON, strings.len(), bytes)
}
}
fn decode_chunk(&self, chunk: &Chunk) -> Vec<Chunk> {
let mut lines: Vec<JsonLine> = Vec::new();
for json_string in extract_escaped_json_strings(&chunk.data) {
let Ok(unescaped) = json_unescape(json_string) else {
// LAW10: recall-preserving; the original JSON text remains in the root scan.
continue;
};
let value_start =
json_string.as_ptr() as usize - chunk.data.as_bytes().as_ptr() as usize;
let value_end = value_start + json_string.len();
let line_start = memchr::memrchr(b'\n', &chunk.data.as_bytes()[..value_start])
.map_or(0, |newline| newline + 1);
if lines.last().is_none_or(|line| line.start != line_start) {
let line_end = memchr::memchr(b'\n', &chunk.data.as_bytes()[value_end..])
.map_or(chunk.data.len(), |newline| value_end + newline);
lines.push(JsonLine {
start: line_start,
end: line_end,
preserves_embedded_newlines: false,
replacements: Vec::new(),
});
}
let line_index = lines.len() - 1;
let line = &mut lines[line_index];
let (unescaped, preserves_embedded_newlines) =
normalize_json_control_separators(unescaped);
line.preserves_embedded_newlines |= preserves_embedded_newlines;
line.replacements.push((value_start, value_end, unescaped));
}
let mut decoded_chunks = Vec::new();
let mut batch_start = usize::MAX;
let mut batch_end = 0;
let mut batch_replacements = Vec::new();
for mut line in lines {
let exceeds_batch = batch_start != usize::MAX
&& line.end.saturating_sub(batch_start) > DECODE_REPLACEMENT_BATCH_SOURCE_BYTES;
if line.preserves_embedded_newlines || exceeds_batch {
push_decoded_replacements_spliced(
&mut decoded_chunks,
chunk,
batch_start,
batch_end,
&mut batch_replacements,
self.name(),
);
batch_start = usize::MAX;
}
if line.preserves_embedded_newlines {
push_decoded_replacements_spliced(
&mut decoded_chunks,
chunk,
line.start,
line.end,
&mut line.replacements,
self.name(),
);
continue;
}
if batch_start == usize::MAX {
batch_start = line.start;
}
batch_end = line.end;
batch_replacements.append(&mut line.replacements);
}
push_decoded_replacements_spliced(
&mut decoded_chunks,
chunk,
batch_start,
batch_end,
&mut batch_replacements,
self.name(),
);
decoded_chunks
}
}
struct JsonLine {
start: usize,
end: usize,
preserves_embedded_newlines: bool,
replacements: Vec<(usize, usize, String)>,
}
fn normalize_json_control_separators(decoded: String) -> (String, bool) {
let is_multiline_private_key =
decoded.contains("-----BEGIN") && decoded.contains("PRIVATE KEY-----");
if is_multiline_private_key {
return (decoded, true);
}
if decoded
.bytes()
.any(|byte| matches!(byte, b'\n' | b'\r' | b'\t' | 0x08 | 0x0c))
{
(
decoded
.chars()
.map(|ch| {
if matches!(ch, '\n' | '\r' | '\t' | '\u{8}' | '\u{c}') {
' '
} else {
ch
}
})
.collect(),
false,
)
} else {
(decoded, false)
}
}
/// Extract JSON string values that actually contain escapes.
/// Returns borrowed raw content inside quotes (including escape backslashes).
///
/// Most JSON/NDJSON fixture files are packed with plain keys and values. The
/// decoder only needs strings containing `\` escapes, so this scanner avoids
/// allocating a `String` for every ordinary JSON value and borrows only the
/// escaped spans that can produce a distinct decoded chunk.
fn extract_escaped_json_strings(text: &str) -> Vec<&str> {
// Shortest escaped JSON string worth a distinct decoded chunk: below 4 chars
// an unescaped body cannot carry a credential-length value.
const MIN_ESCAPED_JSON_STRING_LEN: usize = 4;
let mut strings = Vec::new();
let bytes = text.as_bytes();
let mut index = 0;
while index < bytes.len() {
// memchr is byte-safe even at UTF-8 boundaries because b'"' is
// ASCII (< 0x80) and therefore never appears inside a multi-
// byte UTF-8 continuation. Same for b'\\' and the line
// terminators below.
if let Some(quote_idx) = memchr::memchr(b'"', &bytes[index..]) {
index += quote_idx;
} else {
break;
}
// Found opening quote. Walk bytes: `"`, `\`, CR and LF are ASCII and
// cannot appear inside a UTF-8 continuation byte, so byte scanning is
// UTF-8 safe while avoiding per-character allocation.
index += 1;
let content_start = index;
let mut saw_value_changing_escape = false;
let mut closed = false;
while index < bytes.len() {
match bytes[index] {
b'\\' => {
// JSON control escapes only insert whitespace/control bytes;
// they cannot reveal a hidden credential character. Ignore
// strings containing only those escapes so notebooks and
// generated JSON do not emit one decoded root per source
// line. Quotes, slashes, backslashes, and Unicode escapes
// can restore detector-significant bytes.
saw_value_changing_escape |= bytes
.get(index + 1)
.is_some_and(|escaped| matches!(escaped, b'"' | b'\\' | b'/' | b'u'));
// Skip the escaped byte so `\"` does not terminate this
// string. If the escape is truncated, the string is
// malformed and the outer loop will advance below.
index = index.saturating_add(2);
}
b'"' => {
let content_end = index;
index += 1;
closed = true;
if saw_value_changing_escape
&& content_end.saturating_sub(content_start) >= MIN_ESCAPED_JSON_STRING_LEN
{
strings.push(&text[content_start..content_end]);
}
break;
}
b'\n' | b'\r' => {
// JSON strings cannot span lines unescaped. Leave index
// on the terminator; the outer loop advances once below.
break;
}
_ => index += 1,
}
}
if closed {
continue;
}
// Either no closing quote OR we broke on a line terminator;
// advance one byte to avoid an infinite loop on the unmatched
// opening quote.
index += 1;
}
strings
}
/// Unescape a JSON string. The input must include backslash escape sequences.
fn json_unescape(input: &str) -> Result<String, ()> {
let mut decoded = String::with_capacity(input.len());
let mut chars = input.chars().peekable();
while let Some(ch) = chars.next() {
if ch != '\\' {
decoded.push(ch);
continue;
}
match chars.next() {
Some('"') => decoded.push('"'),
Some('\\') => decoded.push('\\'),
Some('/') => decoded.push('/'),
Some('u') => {
let code = take_hex_digits(&mut chars, 4)?;
// Shared surrogate-pair resolution (see `util`): reads a
// following `\u` low-surrogate code unit from `chars` itself.
decoded.push(resolve_escaped_codepoint(code, &mut chars)?);
}
Some(escaped) => decoded.push(simple_control_escape(escaped).ok_or(())?),
None => return Err(()),
}
}
Ok(decoded)
}