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
//! Shared utilities for grep and rg builtins.
//!
//! Extracted from duplicated code in grep.rs and rg.rs to provide a single
//! canonical implementation of common search operations.
use std::collections::{HashMap, VecDeque};
use std::sync::Arc;
use regex::{Regex, RegexBuilder};
use crate::builtins::limits::RUNTIME_REGEX_CACHE_ENTRIES;
use crate::error::{Error, Result};
/// Default compiled-regex size limit (1 MB).
pub(crate) const REGEX_SIZE_LIMIT: usize = 1_000_000;
/// Default DFA size limit (1 MB).
pub(crate) const REGEX_DFA_SIZE_LIMIT: usize = 1_000_000;
/// Backtracking step cap for the fancy-regex (PCRE / `grep -P`) engine.
/// Bounds worst-case backtracking so a pathological pattern can't hang the
/// sandbox (mirrors `sed.rs`'s fallback limit; see TM-INF threat model).
pub(crate) const FANCY_BACKTRACK_LIMIT: usize = 1_000_000;
/// THREAT[TM-DOS-023]: Per-evaluator cache for regex operands compiled during
/// execution, preventing repeated compilation from consuming the CPU budget.
///
/// Both successful and failed compilations are retained. Entry count bounds
/// compiled programs; retained pattern text shares [`REGEX_SIZE_LIMIT`].
#[derive(Default)]
pub(crate) struct RuntimeRegexCache {
entries: HashMap<Arc<str>, Option<Regex>>,
insertion_order: VecDeque<Arc<str>>,
pattern_bytes: usize,
#[cfg(test)]
compile_count: usize,
}
impl RuntimeRegexCache {
pub(crate) fn get_or_compile(&mut self, pattern: &str) -> Option<Regex> {
if let Some(regex) = self.entries.get(pattern) {
return regex.clone();
}
if pattern.len() > REGEX_SIZE_LIMIT {
return None;
}
#[cfg(test)]
{
self.compile_count += 1;
}
let regex = build_regex(pattern).ok();
while self.entries.len() >= RUNTIME_REGEX_CACHE_ENTRIES
|| self.pattern_bytes + pattern.len() > REGEX_SIZE_LIMIT
{
let Some(oldest) = self.insertion_order.pop_front() else {
break;
};
self.pattern_bytes -= oldest.len();
self.entries.remove(oldest.as_ref());
}
let key: Arc<str> = Arc::from(pattern);
self.pattern_bytes += key.len();
self.insertion_order.push_back(Arc::clone(&key));
self.entries.insert(key, regex.clone());
regex
}
#[cfg(test)]
pub(crate) fn compile_count(&self) -> usize {
self.compile_count
}
}
/// Build a regex with enforced size limits.
pub(crate) fn build_regex(pattern: &str) -> std::result::Result<Regex, regex::Error> {
build_regex_opts(pattern, false)
}
/// Build a regex with enforced size limits and optional case-insensitivity.
pub(crate) fn build_regex_opts(
pattern: &str,
case_insensitive: bool,
) -> std::result::Result<Regex, regex::Error> {
RegexBuilder::new(pattern)
.case_insensitive(case_insensitive)
.size_limit(REGEX_SIZE_LIMIT)
.dfa_size_limit(REGEX_DFA_SIZE_LIMIT)
.build()
}
/// A compiled search pattern backed by either the default linear-time `regex`
/// engine or the backtracking `fancy_regex` engine (used for `grep -P`,
/// enabling lookaround and backreferences that `regex` rejects).
///
/// The two engines expose different APIs (`fancy_regex` returns `Result` from
/// `is_match`/`find_iter`); this enum hides that behind a uniform surface so
/// callers needn't branch on the engine. Match failures from the backtracking
/// engine (e.g. hitting `FANCY_BACKTRACK_LIMIT`) are treated as "no match".
pub(crate) enum Matcher {
Standard(Regex),
Fancy(fancy_regex::Regex),
}
impl Matcher {
/// Whether `text` contains at least one match.
pub(crate) fn is_match(&self, text: &str) -> bool {
match self {
Matcher::Standard(re) => re.is_match(text),
Matcher::Fancy(re) => re.is_match(text).unwrap_or(false),
}
}
/// Visit non-overlapping match byte ranges left to right.
///
/// The callback returns `false` to stop scanning immediately. Keep this
/// lazy so grep early exits (`-m`, `-q`, `-l`, `-L`) bound work and memory
/// even for dense `-o` matches on large single-line files.
pub(crate) fn for_each_range(&self, text: &str, mut visit: impl FnMut((usize, usize)) -> bool) {
match self {
Matcher::Standard(re) => {
for m in re.find_iter(text) {
if !visit((m.start(), m.end())) {
break;
}
}
}
// `find_iter` yields `Result<Match, _>`; `Err` arms
// (backtrack-limit / internal errors) keep the same "no match"
// policy as `is_match` by not calling the visitor.
Matcher::Fancy(re) => {
for m in re.find_iter(text).flatten() {
if !visit((m.start(), m.end())) {
break;
}
}
}
}
}
}
/// Build a PCRE-style matcher (`grep -P`) with enforced size and backtracking
/// limits and optional case-insensitivity.
// THREAT[TM-DOS-025]: fancy-regex is a backtracking engine; the backtrack_limit
// caps worst-case work so a crafted pattern can't hang the sandbox.
pub(crate) fn build_fancy_matcher(
pattern: &str,
case_insensitive: bool,
) -> std::result::Result<Matcher, fancy_regex::Error> {
fancy_regex::RegexBuilder::new(pattern)
.case_insensitive(case_insensitive)
.delegate_size_limit(REGEX_SIZE_LIMIT)
.delegate_dfa_size_limit(REGEX_DFA_SIZE_LIMIT)
.backtrack_limit(FANCY_BACKTRACK_LIMIT)
.build()
.map(Matcher::Fancy)
}
/// Parse a numeric flag argument from short-flag character stream.
///
/// Handles both `-m5` (value in same arg) and `-m 5` (value in next arg) forms.
/// Returns the parsed value and the new index into `args`.
///
/// # Arguments
/// * `chars` — remaining characters in the current short flag arg
/// * `j` — current position in `chars` (after the flag letter)
/// * `i` — current position in `args`
/// * `args` — full argument list
/// * `cmd_name` — command name for error messages (e.g. "grep", "rg")
/// * `flag_name` — flag name for error messages (e.g. "-m", "-A")
pub(crate) fn parse_numeric_flag_arg(
chars: &[char],
j: usize,
i: &mut usize,
args: &[String],
cmd_name: &str,
flag_name: &str,
) -> Result<usize> {
let rest: String = chars[j + 1..].iter().collect();
let num_str = if !rest.is_empty() {
rest
} else {
*i += 1;
if *i < args.len() {
args[*i].clone()
} else {
return Err(Error::Execution(format!(
"{}: {} requires an argument",
cmd_name, flag_name
)));
}
};
num_str.parse().map_err(|_| {
Error::Execution(format!(
"{}: invalid {} value: {}",
cmd_name, flag_name, num_str
))
})
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn for_each_range_stops_when_visitor_returns_false() {
let matcher = Matcher::Standard(build_regex(".").unwrap());
let mut visited = 0usize;
matcher.for_each_range(&"x".repeat(100_000), |_| {
visited += 1;
false
});
assert_eq!(visited, 1);
}
#[test]
fn runtime_regex_cache_retains_failures_and_bounds_entries() {
let mut cache = RuntimeRegexCache::default();
assert!(cache.get_or_compile("[").is_none());
assert!(cache.get_or_compile("[").is_none());
for i in 0..=RUNTIME_REGEX_CACHE_ENTRIES {
assert!(cache.get_or_compile(&format!("^value{i}$")).is_some());
}
assert_eq!(cache.compile_count(), RUNTIME_REGEX_CACHE_ENTRIES + 2);
assert_eq!(cache.entries.len(), RUNTIME_REGEX_CACHE_ENTRIES);
assert!(cache.pattern_bytes <= REGEX_SIZE_LIMIT);
assert!(
cache
.get_or_compile(&"x".repeat(REGEX_SIZE_LIMIT + 1))
.is_none()
);
assert_eq!(cache.compile_count(), RUNTIME_REGEX_CACHE_ENTRIES + 2);
}
}