Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add support for rule metadata to be output in scan mode #170

Merged
merged 9 commits into from
Aug 2, 2024
Merged

feat: Add support for rule metadata to be output in scan mode #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a8cee79
Add -m to scan.
wxsBSD Aug 1, 2024
1ca78b3
Merge branch 'main' into missing_flags
wxsBSD Aug 1, 2024
9629b5d
Implement -m for json output.
wxsBSD Aug 1, 2024
6b608cf
Append metadata to avoid extra allocations.
wxsBSD Aug 2, 2024
df11ab2
Implement xor output in scan command.
wxsBSD Aug 2, 2024
160f98d
chore: some little improvements.
plusvic Aug 2, 2024
25a9ac6
style: fix clippy warnings
plusvic Aug 2, 2024
6838515
style: apply `rustfmt`
plusvic Aug 2, 2024
edd000b
Merge branch 'main' into missing_flags
plusvic Aug 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions cli/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ anyhow = { workspace = true }
clap = { workspace = true, features = ["cargo", "derive"] }
clap_complete = { workspace = true }
globwalk = { workspace = true }
itertools = { workspace = true }
enable-ansi-support = { workspace = true }
env_logger = { workspace = true, optional = true, features = ["auto-color"] }
log = { workspace = true, optional = true }
Expand Down
112 changes: 92 additions & 20 deletions cli/src/commands/scan.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ use std::time::{Duration, Instant};
use anyhow::{bail, Context, Error};
use clap::{arg, value_parser, ArgAction, ArgMatches, Command, ValueEnum};
use crossbeam::channel::Sender;
use itertools::Itertools;
use superconsole::style::Stylize;
use superconsole::{Component, Line, Lines, Span};
use yansi::Color::{Cyan, Red, Yellow};
use yansi::Paint;
use yara_x::{Rule, Rules, ScanError, Scanner};
use yara_x::{MetaValue, Rule, Rules, ScanError, Scanner};

use crate::commands::{
compile_rules, external_var_parser, truncate_with_ellipsis,
Expand Down Expand Up @@ -47,6 +48,13 @@ pub fn scan() -> Command {
.help("Path to the file or directory that will be scanned")
.value_parser(value_parser!(PathBuf))
)
.arg(
arg!(-o --"output-format" <FORMAT>)
.help("Output format for results")
.long_help(help::OUTPUT_FORMAT_LONG_HELP)
.required(false)
.value_parser(value_parser!(OutputFormats))
)
.arg(
arg!(-e --"print-namespace")
.help("Print rule namespace")
Expand All @@ -60,6 +68,10 @@ pub fn scan() -> Command {
.help("Print matching patterns, limited to the first N bytes")
.value_parser(value_parser!(usize))
)
.arg(
arg!(-m --"print-meta")
.help("Print rule metadata")
)
.arg(
arg!(--"disable-console-logs")
.help("Disable printing console log messages")
Expand Down Expand Up @@ -123,13 +135,6 @@ pub fn scan() -> Command {
.value_parser(external_var_parser)
.action(ArgAction::Append)
)
.arg(
arg!(-o --"output-format" <FORMAT>)
.help("Output format for results")
.long_help(help::OUTPUT_FORMAT_LONG_HELP)
.required(false)
.value_parser(value_parser!(OutputFormats))
)
}

pub fn exec_scan(args: &ArgMatches) -> anyhow::Result<()> {
Expand Down Expand Up @@ -350,6 +355,7 @@ fn print_rules_as_json(
output: &Sender<Message>,
) {
let print_namespace = args.get_flag("print-namespace");
let print_meta = args.get_flag("print-meta");
let print_strings = args.get_flag("print-strings");
let print_strings_limit = args.get_one::<usize>("print-strings-limit");

Expand All @@ -374,10 +380,14 @@ fn print_rules_as_json(
})
};

if print_meta {
json_rule["meta"] = matching_rule.metadata().into_json();
}

if print_strings || print_strings_limit.is_some() {
let limit = print_strings_limit.unwrap_or(&STRINGS_LIMIT);
let mut match_vec: Vec<serde_json::Value> = Vec::new();
for p in matching_rule.patterns() {
let mut match_vec: Vec<serde_json::Value> = Vec::new();
for m in p.matches() {
let match_range = m.range();
let match_data = m.data();
Expand All @@ -399,12 +409,24 @@ fn print_rules_as_json(
.as_str(),
);
}
let match_json = serde_json::json!({

let mut match_json = serde_json::json!({
"identifier": p.identifier(),
"start": match_range.start,
"length": match_range.len(),
"data": s.as_str()
});

if let Some(k) = m.xor_key() {
let mut p = String::with_capacity(s.len());
for b in &match_data[..min(match_data.len(), *limit)] {
for c in (b ^ k).escape_ascii() {
p.push_str(format!("{}", c as char).as_str());
}
}
match_json["xor_key"] = serde_json::json!(k);
match_json["plaintext"] = serde_json::json!(p);
}
match_vec.push(match_json);
}
json_rule["strings"] = serde_json::json!(match_vec);
Expand All @@ -425,6 +447,7 @@ fn print_rules_as_text(
output: &Sender<Message>,
) {
let print_namespace = args.get_flag("print-namespace");
let print_meta = args.get_flag("print-meta");
let print_strings = args.get_flag("print-strings");
let print_strings_limit = args.get_one::<usize>("print-strings-limit");

Expand All @@ -433,20 +456,50 @@ fn print_rules_as_text(
// `the `by_ref` method cannot be invoked on a trait object`
#[allow(clippy::while_let_on_iterator)]
while let Some(matching_rule) = rules.next() {
let line = if print_namespace {
let mut line = if print_namespace {
format!(
"{}:{} {}",
"{}:{}",
matching_rule.namespace().paint(Cyan).bold(),
matching_rule.identifier().paint(Cyan).bold(),
file_path.display(),
matching_rule.identifier().paint(Cyan).bold()
)
} else {
format!(
"{} {}",
matching_rule.identifier().paint(Cyan).bold(),
file_path.display()
)
format!("{}", matching_rule.identifier().paint(Cyan).bold())
};

let metadata = matching_rule.metadata();

if print_meta && !metadata.is_empty() {
line.push_str(" [");
for (pos, (m, v)) in metadata.with_position() {
match v {
MetaValue::Bool(v) => {
line.push_str(&format!("{}={}", m, v))
}
MetaValue::Integer(v) => {
line.push_str(&format!("{}={}", m, v))
}
MetaValue::Float(v) => {
line.push_str(&format!("{}={}", m, v))
}
MetaValue::String(v) => {
line.push_str(&format!("{}=\"{}\"", m, v))
}
MetaValue::Bytes(v) => line.push_str(&format!(
"{}=\"{}\"",
m,
v.escape_ascii()
)),
};
if !matches!(pos, itertools::Position::Last) {
line.push(',');
}
}
line.push(']');
}

line.push(' ');
line.push_str(&file_path.display().to_string());

output.send(Message::Info(line)).unwrap();

if print_strings || print_strings_limit.is_some() {
Expand All @@ -457,12 +510,31 @@ fn print_rules_as_text(
let match_data = m.data();

let mut msg = format!(
"{:#x}:{}:{}: ",
"{:#x}:{}:{}",
match_range.start,
match_range.len(),
p.identifier(),
);

match m.xor_key() {
Some(k) => {
msg.push_str(format!(" xor({:#x},", k).as_str());
for b in
&match_data[..min(match_data.len(), *limit)]
{
for c in (b ^ k).escape_ascii() {
msg.push_str(
format!("{}", c as char).as_str(),
);
}
}
msg.push_str("): ");
}
_ => {
msg.push_str(": ");
}
}

for b in &match_data[..min(match_data.len(), *limit)] {
for c in b.escape_ascii() {
msg.push_str(format!("{}", c as char).as_str());
Expand Down
Loading