Don't leak object crate's ElfFile32 type in public APIs (esp-rs#825)

* Don't leak `object` crate's `ElfFile32` type in public APIs

* Update `CHANGELOG.md`

Author: jessebraham

CHANGELOG.md

@@ -34,6 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Update flash size when creating the app partition (#797)
 - `--non-interactive` may now react to key events (user input, Ctrl-C, Ctrl-R) if possible (#819)
 - Removed `get_` prefix from any functions which previously had it (#824)
+- Take elf data as bytes rather than `ElfFile` struct when creating an image format (#825)
 
 ### Fixed
 

espflash/src/cli/mod.rs

@@ -25,7 +25,6 @@ use esp_idf_part::{DataType, Partition, PartitionTable};
 use indicatif::{style::ProgressStyle, HumanCount, ProgressBar};
 use log::{debug, info, warn};
 use miette::{IntoDiagnostic, Result, WrapErr};
-use object::read::elf::ElfFile32 as ElfFile;
 use serialport::{FlowControl, SerialPortInfo, SerialPortType, UsbPortInfo};
 
 use self::{
@@ -606,15 +605,13 @@ pub fn save_elf_as_image(
     skip_padding: bool,
     xtal_freq: XtalFrequency,
 ) -> Result<()> {
-    let elf = ElfFile::parse(elf_data).into_diagnostic()?;
+    // To get a chip revision, the connection is needed
+    // For simplicity, the revision None is used
+    let image = chip
+        .into_target()
+        .flash_image(elf_data, flash_data.clone(), None, xtal_freq)?;
 
     if merge {
-        // To get a chip revision, the connection is needed
-        // For simplicity, the revision None is used
-        let image = chip
-            .into_target()
-            .flash_image(elf, flash_data.clone(), None, xtal_freq)?;
-
         display_image_size(image.app_size(), image.part_size());
 
         let mut file = fs::OpenOptions::new()
@@ -645,10 +642,6 @@ pub fn save_elf_as_image(
             file.write_all(&padding_bytes).into_diagnostic()?;
         }
     } else {
-        let image = chip
-            .into_target()
-            .flash_image(elf, flash_data, None, xtal_freq)?;
-
         display_image_size(image.app_size(), image.part_size());
 
         let parts = image.ota_segments().collect::<Vec<_>>();

espflash/src/flasher/mod.rs

@@ -1041,8 +1041,6 @@ impl Flasher {
         mut progress: Option<&mut dyn ProgressCallbacks>,
         xtal_freq: XtalFrequency,
     ) -> Result<(), Error> {
-        let elf = ElfFile::parse(elf_data)?;
-
         let mut target =
             self.chip
                 .flash_target(self.spi_params, self.use_stub, self.verify, self.skip);
@@ -1057,7 +1055,7 @@ impl Flasher {
         let image =
             self.chip
                 .into_target()
-                .flash_image(elf, flash_data, chip_revision, xtal_freq)?;
+                .flash_image(elf_data, flash_data, chip_revision, xtal_freq)?;
 
         // When the `cli` feature is enabled, display the image size information.
         #[cfg(feature = "cli")]

espflash/src/image_format/esp_idf.rs

@@ -119,14 +119,17 @@ pub struct IdfBootloaderFormat<'a> {
 
 impl<'a> IdfBootloaderFormat<'a> {
     pub fn new(
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         chip: Chip,
         flash_data: FlashData,
         params: Esp32Params,
     ) -> Result<Self, Error> {
+        let elf = ElfFile::parse(elf_data)?;
+
         let partition_table = flash_data.partition_table.unwrap_or_else(|| {
             default_partition_table(&params, flash_data.flash_settings.size.map(|v| v.size()))
         });
+
         let mut bootloader = if let Some(bytes) = flash_data.bootloader {
             Cow::Owned(bytes)
         } else {

espflash/src/targets/esp32.rs

@@ -1,7 +1,5 @@
 use std::ops::Range;
 
-use object::read::elf::ElfFile32 as ElfFile;
-
 #[cfg(feature = "serialport")]
 use crate::{connection::Connection, targets::bytes_to_mac_addr};
 use crate::{
@@ -157,12 +155,12 @@ impl Target for Esp32 {
 
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         _chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,
     ) -> Result<IdfBootloaderFormat<'a>, Error> {
-        let booloader: &'static [u8] = match xtal_freq {
+        let bootloader: &'static [u8] = match xtal_freq {
             XtalFrequency::_40Mhz => {
                 include_bytes!("../../resources/bootloaders/esp32-bootloader.bin")
             }
@@ -183,10 +181,10 @@ impl Target for Esp32 {
             0x3f_0000,
             CHIP_ID,
             FlashFrequency::_40Mhz,
-            booloader,
+            bootloader,
         );
 
-        IdfBootloaderFormat::new(elf, Chip::Esp32, flash_data, params)
+        IdfBootloaderFormat::new(elf_data, Chip::Esp32, flash_data, params)
     }
 
     #[cfg(feature = "serialport")]

espflash/src/targets/esp32c2.rs

@@ -1,7 +1,6 @@
 use std::{collections::HashMap, ops::Range};
 
 use log::debug;
-use object::read::elf::ElfFile32 as ElfFile;
 
 #[cfg(feature = "serialport")]
 use crate::{connection::Connection, targets::bytes_to_mac_addr};
@@ -92,12 +91,12 @@ impl Target for Esp32c2 {
 
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         _chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,
     ) -> Result<IdfBootloaderFormat<'a>, Error> {
-        let booloader: &'static [u8] = match xtal_freq {
+        let bootloader: &'static [u8] = match xtal_freq {
             XtalFrequency::_40Mhz => {
                 debug!("Using 40MHz bootloader");
                 include_bytes!("../../resources/bootloaders/esp32c2-bootloader.bin")
@@ -120,10 +119,10 @@ impl Target for Esp32c2 {
             0x1f_0000,
             CHIP_ID,
             FlashFrequency::_30Mhz,
-            booloader,
+            bootloader,
         );
 
-        IdfBootloaderFormat::new(elf, Chip::Esp32c2, flash_data, params)
+        IdfBootloaderFormat::new(elf_data, Chip::Esp32c2, flash_data, params)
     }
 
     #[cfg(feature = "serialport")]

espflash/src/targets/esp32c3.rs

@@ -1,7 +1,5 @@
 use std::ops::Range;
 
-use object::read::elf::ElfFile32 as ElfFile;
-
 #[cfg(feature = "serialport")]
 use crate::connection::Connection;
 use crate::{
@@ -81,7 +79,7 @@ impl Target for Esp32c3 {
 
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         _chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,
@@ -93,7 +91,7 @@ impl Target for Esp32c3 {
             });
         }
 
-        IdfBootloaderFormat::new(elf, Chip::Esp32c3, flash_data, PARAMS)
+        IdfBootloaderFormat::new(elf_data, Chip::Esp32c3, flash_data, PARAMS)
     }
 
     fn spi_registers(&self) -> SpiRegisters {

espflash/src/targets/esp32c6.rs

@@ -1,7 +1,5 @@
 use std::ops::Range;
 
-use object::read::elf::ElfFile32 as ElfFile;
-
 #[cfg(feature = "serialport")]
 use crate::connection::Connection;
 use crate::{
@@ -76,7 +74,7 @@ impl Target for Esp32c6 {
 
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         _chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,
@@ -88,7 +86,7 @@ impl Target for Esp32c6 {
             });
         }
 
-        IdfBootloaderFormat::new(elf, Chip::Esp32c6, flash_data, PARAMS)
+        IdfBootloaderFormat::new(elf_data, Chip::Esp32c6, flash_data, PARAMS)
     }
 
     fn spi_registers(&self) -> SpiRegisters {

espflash/src/targets/esp32h2.rs

@@ -1,7 +1,5 @@
 use std::{collections::HashMap, ops::Range};
 
-use object::read::elf::ElfFile32 as ElfFile;
-
 #[cfg(feature = "serialport")]
 use crate::connection::Connection;
 use crate::{
@@ -83,7 +81,7 @@ impl Target for Esp32h2 {
 
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         _chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,
@@ -95,7 +93,7 @@ impl Target for Esp32h2 {
             });
         }
 
-        IdfBootloaderFormat::new(elf, Chip::Esp32h2, flash_data, PARAMS)
+        IdfBootloaderFormat::new(elf_data, Chip::Esp32h2, flash_data, PARAMS)
     }
 
     fn spi_registers(&self) -> SpiRegisters {

espflash/src/targets/esp32p4.rs

@@ -1,7 +1,5 @@
 use std::ops::Range;
 
-use object::read::elf::ElfFile32 as ElfFile;
-
 #[cfg(feature = "serialport")]
 use crate::connection::Connection;
 use crate::{
@@ -73,7 +71,7 @@ impl Target for Esp32p4 {
 
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         _chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,
@@ -85,7 +83,7 @@ impl Target for Esp32p4 {
             });
         }
 
-        IdfBootloaderFormat::new(elf, Chip::Esp32p4, flash_data, PARAMS)
+        IdfBootloaderFormat::new(elf_data, Chip::Esp32p4, flash_data, PARAMS)
     }
 
     fn spi_registers(&self) -> SpiRegisters {

espflash/src/targets/esp32s2.rs

@@ -1,7 +1,5 @@
 use std::ops::Range;
 
-use object::read::elf::ElfFile32 as ElfFile;
-
 #[cfg(feature = "serialport")]
 use super::flash_target::MAX_RAM_BLOCK_SIZE;
 #[cfg(feature = "serialport")]
@@ -145,7 +143,7 @@ impl Target for Esp32s2 {
 
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         _chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,
@@ -157,7 +155,7 @@ impl Target for Esp32s2 {
             });
         }
 
-        IdfBootloaderFormat::new(elf, Chip::Esp32s2, flash_data, PARAMS)
+        IdfBootloaderFormat::new(elf_data, Chip::Esp32s2, flash_data, PARAMS)
     }
 
     #[cfg(feature = "serialport")]

espflash/src/targets/esp32s3.rs

@@ -1,7 +1,5 @@
 use std::ops::Range;
 
-use object::read::elf::ElfFile32 as ElfFile;
-
 #[cfg(feature = "serialport")]
 use crate::connection::Connection;
 use crate::{
@@ -100,7 +98,7 @@ impl Target for Esp32s3 {
 
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         _chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,
@@ -112,7 +110,7 @@ impl Target for Esp32s3 {
             });
         }
 
-        IdfBootloaderFormat::new(elf, Chip::Esp32s3, flash_data, PARAMS)
+        IdfBootloaderFormat::new(elf_data, Chip::Esp32s3, flash_data, PARAMS)
     }
 
     fn spi_registers(&self) -> SpiRegisters {

espflash/src/targets/mod.rs

@@ -6,7 +6,6 @@
 
 use std::collections::HashMap;
 
-use object::read::elf::ElfFile32 as ElfFile;
 use serde::{Deserialize, Serialize};
 use strum::{Display, EnumIter, EnumString, VariantNames};
 
@@ -355,7 +354,7 @@ pub trait Target: ReadEFuse {
     /// Build an image from the provided data for flashing
     fn flash_image<'a>(
         &self,
-        elf: ElfFile<'a>,
+        elf_data: &'a [u8],
         flash_data: FlashData,
         chip_revision: Option<(u32, u32)>,
         xtal_freq: XtalFrequency,