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.

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

Full search #728

Merged
merged 2 commits into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 10 additions & 6 deletions src/binwalk.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ pub struct Binwalk {

impl Binwalk {
/// Create a new Binwalk instance with all default values.
/// Equivalent to `Binwalk::configure(None, None, None, None, None)`.
/// Equivalent to `Binwalk::configure(None, None, None, None, None, false)`.
///
/// ## Example
///
Expand All @@ -84,7 +84,7 @@ impl Binwalk {
/// ```
#[allow(dead_code)]
pub fn new() -> Binwalk {
Binwalk::configure(None, None, None, None, None).unwrap()
Binwalk::configure(None, None, None, None, None, false).unwrap()
}

/// Create a new Binwalk instance.
Expand All @@ -111,7 +111,8 @@ impl Binwalk {
/// None,
/// None,
/// Some(exclude_filters),
/// None)?;
/// None,
/// false)?;
/// # Ok(binwalker)
/// # } _doctest_main_src_binwalk_rs_102_0(); }
/// ```
Expand All @@ -121,6 +122,7 @@ impl Binwalk {
include: Option<Vec<String>>,
exclude: Option<Vec<String>>,
signatures: Option<Vec<signatures::common::Signature>>,
full_search: bool,
) -> Result<Binwalk, BinwalkError> {
let mut new_instance = Binwalk {
..Default::default()
Expand Down Expand Up @@ -193,7 +195,7 @@ impl Binwalk {

// Each signature may have multiple magic bytes associated with it
for pattern in signature.magic.clone() {
if signature.short {
if signature.short && !full_search {
// These are short patterns, and should only be searched for at the very beginning of a file
new_instance.short_signatures.push(signature.clone());
} else {
Expand Down Expand Up @@ -544,7 +546,8 @@ impl Binwalk {
/// Some(extraction_directory),
/// None,
/// None,
/// None)?;
/// None,
/// false)?;
///
/// let file_data = std::fs::read(&binwalker.base_target_file).expect("Unable to read file");
///
Expand Down Expand Up @@ -645,7 +648,8 @@ impl Binwalk {
/// Some(extraction_directory),
/// None,
/// None,
/// None)?;
/// None,
/// false)?;
///
/// let analysis_results = binwalker.analyze(&binwalker.base_target_file, true);
///
Expand Down
4 changes: 4 additions & 0 deletions src/cliparser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ pub struct CliArgs {
#[arg(short = 'M', long)]
pub matryoshka: bool,

/// Search for all signatures at all offsets
#[arg(short = 'a', long)]
pub search_all: bool,

/// Plot the entropy of the specified file
#[arg(short = 'E', long, conflicts_with = "extract")]
pub entropy: bool,
Expand Down
5 changes: 3 additions & 2 deletions src/extractors/zlib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
use crate::extractors::common::{ExtractionResult, Extractor, ExtractorType};
use crate::extractors::inflate;

/// Size of the checksum that follows the ZLIB deflate data stream
pub const CHECKSUM_SIZE: usize = 4;

/// Defines the internal extractor function for decompressing zlib data
pub fn zlib_extractor() -> Extractor {
Extractor {
Expand All @@ -17,8 +20,6 @@ pub fn zlib_decompress(
) -> ExtractionResult {
// Size of the zlib header
const HEADER_SIZE: usize = 2;
// Size of the checksum that follows the deflate data stream
const CHECKSUM_SIZE: usize = 4;

// Do the decompression, ignoring the ZLIB header
let mut result =
Expand Down
1 change: 1 addition & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ fn main() {
cliargs.include,
cliargs.exclude,
None,
cliargs.search_all,
)
.expect("Binwalk initialization failed");

Expand Down
13 changes: 7 additions & 6 deletions src/signatures/compressd.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
use crate::signatures::common::{SignatureError, SignatureResult, CONFIDENCE_MEDIUM};
use crate::signatures::common::{
SignatureError, SignatureResult, CONFIDENCE_LOW, CONFIDENCE_MEDIUM,
};

/// Human readable description
pub const DESCRIPTION: &str = "compress'd data";
Expand All @@ -14,17 +16,16 @@ pub fn compressd_parser(
offset: usize,
) -> Result<SignatureResult, SignatureError> {
// Successful return value; confidence is medium since this only matches magic bytes at the beginning of a file
let result = SignatureResult {
let mut result = SignatureResult {
offset,
description: DESCRIPTION.to_string(),
confidence: CONFIDENCE_MEDIUM,
confidence: CONFIDENCE_LOW,
..Default::default()
};

// This is enforced in magic.rs so this check is superfluous
if offset == 0 {
return Ok(result);
result.confidence = CONFIDENCE_MEDIUM;
}

Err(SignatureError)
Ok(result)
}
4 changes: 2 additions & 2 deletions src/signatures/fat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ pub fn fat_parser(file_data: &[u8], offset: usize) -> Result<SignatureResult, Si
..Default::default()
};

// This signature is only matched at the beginning of files (see magic.rs), so this check is not strictly necessary
if offset == MAGIC_OFFSET {
// Sanity check the magic offset
if offset >= MAGIC_OFFSET {
// FAT actually starts this may bytes before the magic bytes
result.offset = offset - MAGIC_OFFSET;

Expand Down
25 changes: 14 additions & 11 deletions src/signatures/gpg.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::extractors::zlib::zlib_decompress;
use crate::extractors::zlib::{zlib_decompress, CHECKSUM_SIZE};
use crate::signatures::common::{SignatureError, SignatureResult, CONFIDENCE_HIGH};

/// Human readable description
Expand All @@ -15,23 +15,26 @@ pub fn gpg_signed_parser(
offset: usize,
) -> Result<SignatureResult, SignatureError> {
// Success result; confidence is high since this signature is only reported what it starts at the beginning of a file
let result = SignatureResult {
let mut result = SignatureResult {
offset,
confidence: CONFIDENCE_HIGH,
description: GPG_SIGNED_DESCRIPTION.to_string(),
..Default::default()
};

// This is enforced in magic.rs so this check is supurfulous
if offset == 0 {
/*
* GPG signed files are just zlib compressed files with the zlib magic bytes replaced with the GPG magic bytes.
* Decompress the signed file; no output directory specified, dry run only.
*/
let decompression_dry_run = zlib_decompress(file_data, offset, None);
/*
* GPG signed files are just zlib compressed files with the zlib magic bytes replaced with the GPG magic bytes.
* Decompress the signed file; no output directory specified, dry run only.
*/
let decompression_dry_run = zlib_decompress(file_data, offset, None);

// If the decompression dry run was a success, this signature is almost certianly valid
if decompression_dry_run.success {
// If the decompression dry run was a success, this signature is almost certianly valid
if decompression_dry_run.success {
if let Some(total_size) = decompression_dry_run.size {
// GPG doesn't include the trailing checksum
result.size = total_size - CHECKSUM_SIZE;
result.description =
format!("{}, total size: {} bytes", result.description, result.size);
return Ok(result);
}
}
Expand Down
21 changes: 9 additions & 12 deletions src/signatures/zlib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,16 @@ pub fn zlib_parser(file_data: &[u8], offset: usize) -> Result<SignatureResult, S
..Default::default()
};

// This is enforced in magic.rs, so this check is supurfulous
if offset == 0 {
// Decompress the zlib; no output directory specified, dry run only.
let decompression_dry_run = zlib_decompress(file_data, offset, None);
// Decompress the zlib; no output directory specified, dry run only.
let decompression_dry_run = zlib_decompress(file_data, offset, None);

// If the decompression dry run was a success, this signature is almost certianly valid
if decompression_dry_run.success {
if let Some(zlib_file_size) = decompression_dry_run.size {
result.size = zlib_file_size;
result.description =
format!("{}, total size: {} bytes", result.description, result.size);
return Ok(result);
}
// If the decompression dry run was a success, this signature is almost certianly valid
if decompression_dry_run.success {
if let Some(zlib_file_size) = decompression_dry_run.size {
result.size = zlib_file_size;
result.description =
format!("{}, total size: {} bytes", result.description, result.size);
return Ok(result);
}
}

Expand Down