Return rust String instead of BnString for cases where lossy conversion can be tolerated

Still need to go and audit all usage, but realistically the most important places to give the user control are with symbols, where the data can come from non utf8 sources

This is still incomplete, I just looked for usage of -> BnString so any other variant was omitted.

Author: emesare

plugins/dwarf/dwarf_export/src/lib.rs

@@ -18,7 +18,6 @@ use binaryninja::{
     interaction,
     interaction::{FormResponses, FormResponses::Index},
     rc::Ref,
-    string::BnString,
     symbol::SymbolType,
     types::{MemberAccess, StructureType, Type, TypeClass},
 };
@@ -422,7 +421,7 @@ fn export_functions(
         // Set subprogram DIE attributes
         dwarf.unit.get_mut(function_die_uid).set(
             gimli::DW_AT_name,
-            AttributeValue::String(function.symbol().short_name().as_bytes().to_vec()),
+            AttributeValue::String(function.symbol().short_name().to_bytes().to_vec()),
         );
 
         // TODO : (DW_AT_main_subprogram VS DW_TAG_entry_point)
@@ -557,7 +556,7 @@ fn export_data_vars(
         if let Some(symbol) = data_var_sym {
             dwarf.unit.get_mut(var_die_uid).set(
                 gimli::DW_AT_name,
-                AttributeValue::String(symbol.full_name().as_bytes().to_vec()),
+                AttributeValue::String(symbol.full_name().to_bytes().to_vec()),
             );
 
             if symbol.external() {
@@ -756,7 +755,7 @@ fn export_dwarf(bv: &BinaryView) {
     let arch_name = if let Some(arch) = bv.default_arch() {
         arch.name()
     } else {
-        BnString::new("Unknown")
+        String::from("Unknown")
     };
     let responses = present_form(arch_name.as_str());
 

plugins/dwarf/shared/src/lib.rs

@@ -106,7 +106,7 @@ pub fn create_section_reader<'a, Endian: 'a + Endianity>(
         if let Some(symbol) = view
             .symbols()
             .iter()
-            .find(|symbol| symbol.full_name().as_str() == "__elf_section_headers")
+            .find(|symbol| symbol.full_name().to_string_lossy() == "__elf_section_headers")
         {
             if let Some(data_var) = view
                 .data_variables()

plugins/warp/src/bin/sigem.rs

@@ -131,7 +131,7 @@ fn main() {
 fn data_from_view(view: &BinaryView) -> Data {
     let mut data = Data::default();
     let is_function_named = |f: &BNGuard<BNFunction>| {
-        !f.symbol().short_name().as_str().contains("sub_") || f.has_user_annotations()
+        !f.symbol().short_name().to_string_lossy().contains("sub_") || f.has_user_annotations()
     };
 
     data.functions = view

plugins/warp/src/cache.rs

@@ -439,7 +439,7 @@ pub struct TypeRefID(u64);
 impl From<&BNNamedTypeReference> for TypeRefID {
     fn from(value: &BNNamedTypeReference) -> Self {
         let mut hasher = DefaultHasher::new();
-        hasher.write(value.id().as_bytes());
+        hasher.write(value.id().to_bytes());
         Self(hasher.finish())
     }
 }

plugins/warp/src/matcher.rs

@@ -506,7 +506,7 @@ pub struct PlatformID(u64);
 impl From<&Platform> for PlatformID {
     fn from(value: &Platform) -> Self {
         let mut hasher = DefaultHasher::new();
-        hasher.write(value.name().to_bytes());
+        hasher.write(value.name().as_bytes());
         Self(hasher.finish())
     }
 }

plugins/warp/src/plugin/create.rs

@@ -18,7 +18,7 @@ pub struct CreateSignatureFile;
 impl Command for CreateSignatureFile {
     fn action(&self, view: &BinaryView) {
         let is_function_named = |f: &Guard<Function>| {
-            !f.symbol().short_name().as_str().contains("sub_") || f.has_user_annotations()
+            !f.symbol().short_name().to_string_lossy().contains("sub_") || f.has_user_annotations()
         };
         let mut signature_dir = user_signature_dir();
         if let Some(default_plat) = view.default_platform() {

rust/src/architecture.rs

@@ -1412,8 +1412,8 @@ impl CoreArchitecture {
         }
     }
 
-    pub fn name(&self) -> BnString {
-        unsafe { BnString::from_raw(BNGetArchitectureName(self.handle)) }
+    pub fn name(&self) -> String {
+        unsafe { BnString::to_string(BNGetArchitectureName(self.handle)) }
     }
 }
 

rust/src/background_task.rs

@@ -71,8 +71,8 @@ impl BackgroundTask {
         unsafe { BNFinishBackgroundTask(self.handle) }
     }
 
-    pub fn progress_text(&self) -> BnString {
-        unsafe { BnString::from_raw(BNGetBackgroundTaskProgressText(self.handle)) }
+    pub fn progress_text(&self) -> String {
+        unsafe { BnString::to_string(BNGetBackgroundTaskProgressText(self.handle)) }
     }
 
     pub fn set_progress_text<S: BnStrCompatible>(&self, text: S) {

rust/src/base_detection.rs

@@ -174,9 +174,9 @@ impl BaseAddressDetectionSettings {
         let arch_name = value
             .arch
             .map(|a| a.name().as_ptr())
-            .unwrap_or(BASE_ADDRESS_AUTO_DETECTION_ARCH.as_ptr() as *const c_char);
+            .unwrap_or(BASE_ADDRESS_AUTO_DETECTION_ARCH.as_ptr() as *const u8);
         BNBaseAddressDetectionSettings {
-            Architecture: arch_name,
+            Architecture: arch_name as *const c_char,
             Analysis: value.analysis.as_raw().as_ptr(),
             MinStrlen: value.min_string_len,
             Alignment: value.alignment.get(),

rust/src/binary_view.rs

@@ -27,7 +27,7 @@ use crate::architecture::{Architecture, CoreArchitecture};
 use crate::base_detection::BaseAddressDetection;
 use crate::basic_block::BasicBlock;
 use crate::binary_view::memory_map::MemoryMap;
-use crate::component::{Component, IntoComponentGuid};
+use crate::component::Component;
 use crate::confidence::Conf;
 use crate::data_buffer::DataBuffer;
 use crate::debuginfo::DebugInfo;
@@ -187,9 +187,9 @@ pub trait BinaryViewExt: BinaryViewBase {
         }
     }
 
-    fn type_name(&self) -> BnString {
+    fn type_name(&self) -> String {
         let ptr: *mut c_char = unsafe { BNGetViewType(self.as_ref().handle) };
-        unsafe { BnString::from_raw(ptr) }
+        unsafe { BnString::to_string(ptr) }
     }
 
     fn parent_view(&self) -> Option<Ref<BinaryView>> {
@@ -204,9 +204,9 @@ pub trait BinaryViewExt: BinaryViewBase {
         self.file().view_of_type("Raw")
     }
 
-    fn view_type(&self) -> BnString {
+    fn view_type(&self) -> String {
         let ptr: *mut c_char = unsafe { BNGetViewType(self.as_ref().handle) };
-        unsafe { BnString::from_raw(ptr) }
+        unsafe { BnString::to_string(ptr) }
     }
 
     /// Reads up to `len` bytes from address `offset`
@@ -1493,9 +1493,14 @@ pub trait BinaryViewExt: BinaryViewBase {
         unsafe { BNRemoveComponent(self.as_ref().handle, component.handle.as_ptr()) }
     }
 
-    fn remove_component_by_guid<P: IntoComponentGuid>(&self, guid: P) -> bool {
-        let path = guid.component_guid();
-        unsafe { BNRemoveComponentByGuid(self.as_ref().handle, path.as_ptr()) }
+    fn remove_component_by_guid<P: BnStrCompatible>(&self, guid: P) -> bool {
+        let path = guid.into_bytes_with_nul();
+        unsafe {
+            BNRemoveComponentByGuid(
+                self.as_ref().handle,
+                path.as_ref().as_ptr() as *const c_char,
+            )
+        }
     }
 
     fn data_variable_parent_components(&self, data_variable: &DataVariable) -> Array<Component> {