capa 0.5.2

File capability extractor.
Documentation 
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

use crate::{Result, consts::FileFormat};

pub mod dnfile;
pub mod smda;

// 0.4.2: trait-object types are passed across rayon threads in
// `find_capabilities`'s parallel function loop. The `Send + Sync`
// supertrait bounds tell Rust the boxed values can cross thread
// boundaries safely. Both the smda and dnfile extractor structs
// already satisfy these in practice (smda 0.5's `DisassemblyReport`
// is `Send + Sync`; dnfile 0.4's `DnPe` is too; both extractors'
// internal caches use `parking_lot::RwLock`).

pub trait Instruction: Send + Sync {
    fn is_mov_imm_to_stack(&self) -> Result<bool>;
    fn get_printable_len(&self) -> Result<u64>;
    fn as_any(&self) -> &dyn std::any::Any;
}

pub trait Function: Send + Sync {
    fn inrefs(&self) -> &Vec<u64>;
    fn blockrefs(&self) -> &std::collections::HashMap<u64, Vec<u64>>;
    fn offset(&self) -> u64;
    fn get_blocks(&self) -> Result<std::collections::BTreeMap<u64, Vec<Box<dyn Instruction>>>>;
    fn as_any(&self) -> &dyn std::any::Any;
}

pub trait Extractor: Send + Sync {
    // 0.4.0: `get_base_address` and `format` are only consumed by the
    // properties-feature-gated `FileCapabilities::new`. With
    // `--no-default-features` they'd warn as unused trait methods —
    // they're still part of the trait contract so downstream impls
    // need them, but cargo's reachability analysis can't see that.
    #[allow(dead_code)]
    fn get_base_address(&self) -> Result<u64>;
    #[allow(dead_code)]
    fn format(&self) -> FileFormat;
    fn bitness(&self) -> u32;
    /// 0.5.0: surface the actual architecture instead of guessing it
    /// from `bitness()` upstream. Required because smda 0.6's
    /// `FileArchitecture::Aarch64` is also 64-bit — the previous
    /// "64 → AMD64" inference in `FileCapabilities::get_arch`
    /// mislabelled every ARM64 binary as AMD64.
    #[allow(dead_code)]
    fn arch(&self) -> Result<crate::FileArchitecture>;
    fn extract_global_features(&self) -> Result<Vec<(crate::rules::features::Feature, u64)>>;
    fn extract_file_features(&self) -> Result<Vec<(crate::rules::features::Feature, u64)>>;
    fn get_functions(&self) -> Result<std::collections::BTreeMap<u64, Box<dyn Function>>>;
    fn extract_function_features(
        &self,
        f: &Box<dyn Function>,
    ) -> Result<Vec<(crate::rules::features::Feature, u64)>>;
    fn get_basic_blocks(
        &self,
        f: &Box<dyn Function>,
    ) -> Result<std::collections::BTreeMap<u64, Vec<Box<dyn Instruction>>>>;
    fn get_instructions<'a>(
        &self,
        f: &Box<dyn Function>,
        bb: &'a (&u64, &Vec<Box<dyn Instruction>>),
    ) -> Result<&'a Vec<Box<dyn Instruction>>>;
    fn extract_basic_block_features(
        &self,
        f: &Box<dyn Function>,
        bb: &(&u64, &Vec<Box<dyn Instruction>>),
    ) -> Result<Vec<(crate::rules::features::Feature, u64)>>;
    fn extract_insn_features(
        &self,
        f: &Box<dyn Function>,
        insn: &Box<dyn Instruction>,
    ) -> Result<Vec<(crate::rules::features::Feature, u64)>>;
    fn is_dot_net(&self) -> bool;

    /// 0.4.3: raw function-leading bytes, used by the FLIRT matcher
    /// to identify statically-linked library functions. Returns up to
    /// `max_len` bytes starting at `addr`; `None` when the extractor
    /// doesn't expose raw bytes (dnfile / managed .NET code — FLIRT
    /// signatures only target native machine code anyway). Default
    /// impl returns `None`; smda extractor overrides via
    /// `binary_info.bytes_at_best_effort`.
    fn function_bytes(&self, _addr: u64, _max_len: u32) -> Option<&[u8]> {
        None
    }
}