Struct cwe_checker_lib::utils::binary::BareMetalConfig

pub struct BareMetalConfig {
    pub processor_id: String,
    pub flash_base_address: String,
    pub ram_base_address: String,
    pub ram_size: String,
}

Contains all information parsed out of the bare metal configuration JSON file.

The content is information that is necessary for handling bare metal binaries and that the cwe_checker cannot automatically deduce from the binary itself.

When handling bare metal binaries we assume that the corresponding MCU uses a very simple memory layout consisting of exactly one region of non-volatile (flash) memory and exactly one region of volatile memory (RAM). Furthermore, we assume that the binary itself is just a dump of the non-volatile memory region.

Fields

processor_id: String

The CPU type.

The string has to match the processor_id that Ghidra uses for the specific CPU type, as it is forwarded to Ghidra to identify the CPU.

flash_base_address: String

The base address of the non-volatile memory (usually flash memory) used by the chip. The string is parsed as a hexadecimal number.

We assume that the size of the non-volatile memory equals the size of the input binary. In other words, we assume that the input binary is a complete dump of the contents of the non-volatile memory of the chip.

ram_base_address: String

The base address of the volatile memory (RAM) used by the chip. The string is parsed as a hexadecimal number.

ram_size: String

The size of the volatile memory (RAM) used by the chip. The string is parsed as a hexadecimal number.

If the exact size is unknown, then one can try to use an upper approximation instead.

Implementations

impl BareMetalConfig

pub fn parse_binary_base_address(&self) -> u64

Return the base address of the binary as an integer.

Trait Implementations

impl Clone for BareMetalConfig

fn clone(&self) -> BareMetalConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BareMetalConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BareMetalConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for BareMetalConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BareMetalConfig

fn eq(&self, other: &BareMetalConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BareMetalConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BareMetalConfig

impl StructuralEq for BareMetalConfig

impl StructuralPartialEq for BareMetalConfig