Add API to get all project metadata

Author: negasora

binaryninjaapi.h

@@ -3687,6 +3687,7 @@ namespace BinaryNinja {
 
 		Ref<Metadata> QueryMetadata(const std::string& key);
 		bool StoreMetadata(const std::string& key, Ref<Metadata> value);
+		Ref<Metadata> GetMetadata();
 		bool RemoveMetadata(const std::string& key);
 
 		Ref<ProjectFolder> CreateFolderFromPath(const std::string& path, Ref<ProjectFolder> parent, const std::string& description,
@@ -5774,7 +5775,7 @@ namespace BinaryNinja {
 		void PerformDefineRelocation(Architecture* arch, BNRelocationInfo& info, Ref<Symbol> sym, uint64_t reloc);
 
 		/*! OnAfterSnapshotDataApplied is called when loading a view from a database, after snapshot data has been applied to it.
-		
+
 		    \note This method **may** be overridden by custom BinaryViews.
 
 			\warning This method **must not** be called directly.

binaryninjacore.h

@@ -4308,6 +4308,7 @@ extern "C"
 
 	BINARYNINJACOREAPI BNMetadata* BNProjectQueryMetadata(BNProject* project, const char* key);
 	BINARYNINJACOREAPI bool BNProjectStoreMetadata(BNProject* project, const char* key, BNMetadata* value);
+	BINARYNINJACOREAPI BNMetadata* BNProjectGetMetadata(BNProject* project);
 	BINARYNINJACOREAPI bool BNProjectRemoveMetadata(BNProject* project, const char* key);
 
 	BINARYNINJACOREAPI BNProjectFile* BNProjectCreateFileFromPath(BNProject* project, const char* path, BNProjectFolder* folder, const char* name, const char* description, void* ctxt,

project.cpp

@@ -340,6 +340,15 @@ bool Project::StoreMetadata(const std::string& key, Ref<Metadata> value)
 }
 
 
+Ref<Metadata> Project::GetMetadata()
+{
+	BNMetadata* value = BNProjectGetMetadata(m_object);
+	if (value == nullptr)
+		return nullptr;
+	return new Metadata(value);
+}
+
+
 bool Project::RemoveMetadata(const std::string& key)
 {
 	return BNProjectRemoveMetadata(m_object, key.c_str());

python/project.py

@@ -22,7 +22,7 @@
 
 from contextlib import contextmanager
 from os import PathLike
-from typing import Any, Callable, List, Optional, Union
+from typing import Any, Callable, Dict, List, Optional, Union
 
 import binaryninja
 from . import _binaryninjacore as core
@@ -585,6 +585,19 @@ def store_metadata(self, key: str, value: MetadataValueType) -> bool:
 			_val = Metadata(_val)
 		return core.BNProjectStoreMetadata(self._handle, key, _val.handle)
 
+	@property
+	def metadata(self) -> Dict[str, 'MetadataValueType']:
+		"""
+		Retrieves the metadata associated with the project.
+
+		:return: metadata associated with the Project
+		"""
+		md_handle = core.BNProjectGetMetadata(self._handle)
+		assert md_handle is not None, "core.BNProjectGetMetadata returned None"
+		value = Metadata(handle=md_handle).value
+		assert isinstance(value, dict), "core.BNProjectGetMetadata did not return a dict"
+		return value
+
 	def remove_metadata(self, key: str) -> bool:
 		"""
 		Removes the metadata associated with this key from the project

rust/src/project.rs

@@ -132,6 +132,13 @@ impl Project {
         unsafe { BNProjectStoreMetadata(self.handle.as_ptr(), key_raw.as_ptr(), value.handle) }
     }
 
+    /// Retrieves the metadata associated with the project.
+    pub fn metadata(&self) -> Ref<Metadata> {
+        let md_handle = unsafe { BNProjectGetMetadata(self.handle.as_ptr()) };
+        assert!(!md_handle.is_null());
+        unsafe { Metadata::ref_from_raw(md_handle) }
+    }
+
     /// Removes the metadata associated with this `key` from the project
     pub fn remove_metadata(&self, key: &str) -> bool {
         let key_raw = key.to_cstr();