Make common casr tool draft

Author: hkctkuy

casr/Cargo.toml

@@ -21,7 +21,7 @@ simplelog = "0.12"
 cursive = { version = "0.21", default-features = false, features = ["termion-backend"] }
 cursive_tree_view = "0.9"
 gdb-command = "0.7"
-nix = { version = "0.29", features = ["fs"] }
+nix = { version = "0.29", features = ["fs", "process"] }
 rayon = "1.10"
 num_cpus = "1.16"
 is_executable = "1.0"

casr/src/bin/casr-afl.rs

@@ -1,5 +1,12 @@
-use casr::triage::{CrashInfo, fuzzing_crash_triage_pipeline};
-use casr::util;
+use casr::{
+    mode::{DynMode, csharp::CSharpMode},
+    triage::{CrashInfo, fuzzing_crash_triage_pipeline},
+    util,
+};
+
+use std::collections::HashMap;
+use std::fs;
+use std::path::{Path, PathBuf};
 
 use anyhow::{Result, bail};
 use clap::{
@@ -8,10 +15,6 @@ use clap::{
 };
 use log::error;
 
-use std::collections::HashMap;
-use std::fs;
-use std::path::{Path, PathBuf};
-
 fn main() -> Result<()> {
     let matches = clap::Command::new("casr-afl")
         .version(clap::crate_version!())
@@ -26,11 +29,12 @@ fn main() -> Result<()> {
                 .value_parser(["info", "debug"])
                 .help("Logging level")
         )
-        .arg(Arg::new("jobs")
-            .long("jobs")
-            .short('j')
-            .action(ArgAction::Set)
-            .help("Number of parallel jobs for generating CASR reports [default: half of cpu cores]")
+        .arg(
+            Arg::new("jobs")
+                .long("jobs")
+                .short('j')
+                .action(ArgAction::Set)
+                .help("Number of parallel jobs for generating CASR reports [default: half of cpu cores]")
             .value_parser(clap::value_parser!(u32).range(1..)))
         .arg(
             Arg::new("timeout")
@@ -109,7 +113,7 @@ fn main() -> Result<()> {
                 .value_name("HINT")
                 .action(ArgAction::Set)
                 .default_value("auto")
-                .value_parser(["auto", "gdb", "san", "csharp"])
+                .value_parser(["auto", "gdb", "san", "asan", "msan", "csharp"])
                 .help("Hint to force run casr-HINT tool to analyze crashes")
         )
         .arg(
@@ -134,7 +138,10 @@ fn main() -> Result<()> {
         Vec::new()
     };
 
-    let hint = matches.get_one::<String>("hint").unwrap();
+    let hint = matches
+        .get_one::<String>("hint")
+        .as_ref()
+        .map(|x| x.as_str());
     let input = matches.get_one::<PathBuf>("input").unwrap();
     let afl_dir = input.join("crashes").is_dir();
     let ignore_cmdline = matches.get_flag("ignore-cmdline") || afl_dir;
@@ -173,44 +180,20 @@ fn main() -> Result<()> {
                 continue;
             }
         };
-        crash_info.casr_tool = if hint == "csharp"
-            || hint == "auto"
-                && !crash_info.target_args.is_empty()
-                && (crash_info.target_args[0].ends_with("dotnet")
-                    || crash_info.target_args[0].ends_with("mono"))
-        {
+        crash_info.mode = DynMode::try_from((hint, &crash_info.target_args))?;
+        if crash_info.mode.is_mode::<CSharpMode>() {
             is_casr_gdb = false;
-            util::get_path("casr-csharp")?
-        } else {
-            util::get_path("casr-gdb")?
-        };
+        }
         crash_info.at_index = crash_info
             .target_args
             .iter()
             .skip(1)
             .position(|s| s.contains("@@"))
             .map(|x| x + 1);
 
-        // When we triage crashes for binaries, use casr-san.
-        if hint == "san" || hint == "auto" && is_casr_gdb {
-            if let Some(target) = crash_info.target_args.first() {
-                match util::symbols_list(Path::new(target)) {
-                    Ok(list) => {
-                        if list.contains("__asan") {
-                            crash_info
-                                .casr_tool
-                                .clone_from(&(util::get_path("casr-san")?))
-                        }
-                    }
-                    Err(e) => {
-                        error!("{e}");
-                        continue;
-                    }
-                }
-            } else {
-                error!("Cmdline is empty. Path: {:?}", path.join("cmdline"));
-                continue;
-            }
+        if is_casr_gdb && crash_info.target_args.is_empty() {
+            error!("Cmdline is empty. Path: {:?}", path.join("cmdline"));
+            continue;
         }
 
         // Push crash paths.

casr/src/bin/casr-cli.rs

@@ -1013,10 +1013,10 @@ fn print_summary(dir: &Path, unique_crash_line: bool, strip_path: Option<&String
         println!("==> <{}>", filename.magenta());
         for info in cluster_hash.values() {
             let mut path = info.0.last().unwrap().clone();
-            if let Some(prefix) = strip_path {
-                if let Ok(stripped) = Path::new(&path).strip_prefix(prefix) {
-                    path = stripped.display().to_string();
-                }
+            if let Some(prefix) = strip_path
+                && let Ok(stripped) = Path::new(&path).strip_prefix(prefix)
+            {
+                path = stripped.display().to_string();
             }
             if ubsan {
                 // /path/to/report.casrep: Description: crashline (path:line:column)
@@ -1082,10 +1082,10 @@ fn process_report(
         return None;
     };
     let mut report = report.to_string();
-    if let Some(prefix) = strip_path {
-        if let Ok(stripped) = Path::new(&report).strip_prefix(prefix) {
-            report = stripped.display().to_string();
-        }
+    if let Some(prefix) = strip_path
+        && let Ok(stripped) = Path::new(&report).strip_prefix(prefix)
+    {
+        report = stripped.display().to_string();
     }
     let Ok(jreport): Result<Value, _> = serde_json::from_reader(BufReader::new(file)) else {
         return None;

casr/src/bin/casr-core.rs

@@ -219,7 +219,7 @@ fn main() -> Result<()> {
     report.pid = pid;
     // Add network connections.
     if let Err(error) = report.add_network_connections() {
-        error!("{}", error);
+        error!("{error}");
     }
 
     file_name_to_save.push_str(&format!("_{}", report.date));

casr/src/bin/casr-csharp.rs

@@ -1,179 +1,10 @@
-use casr::util;
-use libcasr::{
-    csharp::*, exception::Exception, init_ignored_frames, report::CrashReport, stacktrace::*,
-};
+use anyhow::Result;
 
-use anyhow::{Result, bail};
-use clap::{Arg, ArgAction, ArgGroup};
-use regex::Regex;
-use std::path::PathBuf;
-use std::process::Command;
+use ::casr::{
+    casr,
+    mode::{DynMode, csharp::CSharpMode},
+};
 
 fn main() -> Result<()> {
-    let matches = clap::Command::new("casr-csharp")
-        .version(clap::crate_version!())
-        .about("Create CASR reports (.casrep) from C# reports")
-        .term_width(90)
-        .arg(
-            Arg::new("output")
-                .short('o')
-                .long("output")
-                .action(ArgAction::Set)
-                .value_parser(clap::value_parser!(PathBuf))
-                .value_name("REPORT")
-                .help(
-                    "Path to save report. Path can be a directory, then report name is generated",
-                ),
-        )
-        .arg(
-            Arg::new("stdout")
-                .action(ArgAction::SetTrue)
-                .long("stdout")
-                .help("Print CASR report to stdout"),
-        )
-        .group(
-            ArgGroup::new("out")
-                .args(["stdout", "output"])
-                .required(true),
-        )
-        .arg(
-            Arg::new("stdin")
-                .long("stdin")
-                .action(ArgAction::Set)
-                .value_parser(clap::value_parser!(PathBuf))
-                .value_name("FILE")
-                .help("Stdin file for program"),
-        )
-        .arg(
-            Arg::new("timeout")
-                .short('t')
-                .long("timeout")
-                .action(ArgAction::Set)
-                .default_value("0")
-                .value_name("SECONDS")
-                .help("Timeout (in seconds) for target execution, 0 value means that timeout is disabled")
-                .value_parser(clap::value_parser!(u64))
-        )
-        .arg(
-            Arg::new("ignore")
-                .long("ignore")
-                .action(ArgAction::Set)
-                .value_parser(clap::value_parser!(PathBuf))
-                .value_name("FILE")
-                .help("File with regular expressions for functions and file paths that should be ignored"),
-        )
-        .arg(
-            Arg::new("strip-path")
-                .long("strip-path")
-                .env("CASR_STRIP_PATH")
-                .action(ArgAction::Set)
-                .value_name("PREFIX")
-                .help("Path prefix to strip from stacktrace and crash line"),
-        )
-        .arg(
-            Arg::new("ld-preload")
-                .long("ld-preload")
-                .env("CASR_PRELOAD")
-                .action(ArgAction::Set)
-                .num_args(1..)
-                .value_name("LIBS")
-                .value_parser(clap::value_parser!(String))
-                .help("Set LD_PRELOAD for the target program without disrupting the CASR process itself (both ` ` and `:` are valid delimiter)")
-        )
-        .arg(
-            Arg::new("ARGS")
-                .action(ArgAction::Set)
-                .num_args(1..)
-                .last(true)
-                .required(true)
-                .help("Add \"-- <path> <arguments>\" to run"),
-        )
-        .get_matches();
-
-    init_ignored_frames!("csharp", "cpp");
-    if let Some(path) = matches.get_one::<PathBuf>("ignore") {
-        util::add_custom_ignored_frames(path)?;
-    }
-    // Get program args.
-    let argv: Vec<&str> = if let Some(argvs) = matches.get_many::<String>("ARGS") {
-        argvs.map(|s| s.as_str()).collect()
-    } else {
-        bail!("Wrong arguments for starting program");
-    };
-
-    // Check that args are valid.
-    let Some(pos) = argv
-        .iter()
-        .position(|x| x.ends_with(".dll") || x.ends_with(".exe") || x.ends_with(".csproj"))
-    else {
-        bail!("dotnet/mono target is not specified by .dll, .exe or .csproj executable.");
-    };
-
-    // Get stdin for target program.
-    let stdin_file = util::stdin_from_matches(&matches)?;
-
-    // Get timeout.
-    let timeout = *matches.get_one::<u64>("timeout").unwrap();
-
-    // Run program.
-    let mut csharp_cmd = Command::new(argv[0]);
-    // Set ld preload
-    if let Some(ld_preload) = util::get_ld_preload(&matches) {
-        csharp_cmd.env("LD_PRELOAD", ld_preload);
-    }
-    if let Some(ref file) = stdin_file {
-        csharp_cmd.stdin(std::fs::File::open(file)?);
-    }
-    if argv.len() > 1 {
-        csharp_cmd.args(&argv[1..]);
-    }
-    let csharp_result = util::get_output(&mut csharp_cmd, timeout, true)?;
-
-    let csharp_stderr = String::from_utf8_lossy(&csharp_result.stderr);
-
-    // Create report.
-    let mut report = CrashReport::new();
-    // Set executable path (for C# .dll, .csproj (dotnet) or .exe (mono) file).
-    report.executable_path = argv.get(pos).unwrap().to_string();
-    report.proc_cmdline = argv.join(" ");
-    let _ = report.add_os_info();
-    let _ = report.add_proc_environ();
-
-    // Get C# report.
-    let csharp_stderr_list: Vec<String> =
-        csharp_stderr.split('\n').map(|l| l.to_string()).collect();
-    let re = Regex::new(r"^Unhandled [Ee]xception(?::\n|\. ).*").unwrap();
-    if let Some(start) = csharp_stderr_list.iter().position(|x| re.is_match(x)) {
-        let end = csharp_stderr_list[start..]
-            .iter()
-            .rposition(|x| !x.is_empty())
-            .unwrap()
-            + 1;
-        report.csharp_report = csharp_stderr_list[start..end].to_vec();
-        let report_str = report.csharp_report.join("\n");
-        report.stacktrace = CSharpStacktrace::extract_stacktrace(&report_str)?;
-        if let Some(exception) = CSharpException::parse_exception(&report_str) {
-            report.execution_class = exception;
-        }
-    } else {
-        // Call casr-san
-        return util::call_casr_san(&matches, &argv, "casr-csharp");
-    }
-
-    let stacktrace = CSharpStacktrace::parse_stacktrace(&report.stacktrace)?;
-    if let Ok(crash_line) = stacktrace.crash_line() {
-        report.crashline = crash_line.to_string();
-        if let CrashLine::Source(debug) = crash_line {
-            if let Some(sources) = CrashReport::sources(&debug) {
-                report.source = sources;
-            }
-        }
-    }
-
-    if let Some(path) = matches.get_one::<String>("strip-path") {
-        util::strip_paths(&mut report, &stacktrace, path);
-    }
-
-    //Output report.
-    util::output_report(&report, &matches, &argv)
+    casr::stub(DynMode::new::<CSharpMode>())
 }