Initial support for opening container formats.

Author: bpotchik

binaryninjaapi.h

@@ -3816,6 +3816,18 @@ namespace BinaryNinja {
 		*/
 		void SetFilename(const std::string& name);
 
+		/*! Get the path to the container file if the current file is inside a container (e.g. ZIP, TAR, etc.)
+
+			\return The path to the container file if the current file is inside a container, otherwise an empty string
+		*/
+		std::string GetVirtualPath() const;
+
+		/*! Set the path to the container file if the current file is inside a container (e.g. ZIP, TAR, etc.)
+
+			\param path The path to the container file if the current file is inside a container
+		*/
+		void SetVirtualPath(const std::string& path);
+
 		/*! Whether the file has unsaved modifications
 
 			\return Whether the file has unsaved modifications
@@ -8947,6 +8959,7 @@ namespace BinaryNinja {
 	{
 	  protected:
 		BNTransformType m_typeForRegister;
+		BNTransformCapabilities m_capabilitiesForRegister;
 		std::string m_nameForRegister, m_longNameForRegister, m_groupForRegister;
 
 		Transform(BNTransform* xform);
@@ -8957,29 +8970,32 @@ namespace BinaryNinja {
 		    void* ctxt, BNDataBuffer* input, BNDataBuffer* output, BNTransformParameter* params, size_t paramCount);
 		static bool EncodeCallback(
 		    void* ctxt, BNDataBuffer* input, BNDataBuffer* output, BNTransformParameter* params, size_t paramCount);
+		static bool CanDecodeCallback(void* ctxt, BNBinaryView* input);
 
 		static std::vector<TransformParameter> EncryptionKeyParameters(size_t fixedKeyLength = 0);
 		static std::vector<TransformParameter> EncryptionKeyAndIVParameters(
 		    size_t fixedKeyLength = 0, size_t fixedIVLength = 0);
 
 	  public:
 		Transform(BNTransformType type, const std::string& name, const std::string& longName, const std::string& group);
+		Transform(BNTransformType type, BNTransformCapabilities capabilities, const std::string& name, const std::string& longName, const std::string& group);
 
 		static void Register(Transform* xform);
 		static Ref<Transform> GetByName(const std::string& name);
 		static std::vector<Ref<Transform>> GetTransformTypes();
 
 		BNTransformType GetType() const;
+		BNTransformCapabilities GetCapabilities() const;
+		bool SupportsDetection() const;
 		std::string GetName() const;
 		std::string GetLongName() const;
 		std::string GetGroup() const;
 
 		virtual std::vector<TransformParameter> GetParameters() const;
 
-		virtual bool Decode(const DataBuffer& input, DataBuffer& output,
-		    const std::map<std::string, DataBuffer>& params = std::map<std::string, DataBuffer>());
-		virtual bool Encode(const DataBuffer& input, DataBuffer& output,
-		    const std::map<std::string, DataBuffer>& params = std::map<std::string, DataBuffer>());
+		virtual bool Decode(const DataBuffer& input, DataBuffer& output, const std::map<std::string, DataBuffer>& params = std::map<std::string, DataBuffer>());
+		virtual bool Encode(const DataBuffer& input, DataBuffer& output, const std::map<std::string, DataBuffer>& params = std::map<std::string, DataBuffer>());
+		virtual bool CanDecode(Ref<BinaryView> input) const;
 	};
 
 	/*!
@@ -8995,8 +9011,64 @@ namespace BinaryNinja {
 		    const std::map<std::string, DataBuffer>& params = std::map<std::string, DataBuffer>()) override;
 		virtual bool Encode(const DataBuffer& input, DataBuffer& output,
 		    const std::map<std::string, DataBuffer>& params = std::map<std::string, DataBuffer>()) override;
+		virtual bool CanDecode(Ref<BinaryView> input) const override;
 	};
 
+	class TransformContext : public CoreRefCountObject<BNTransformContext, BNNewTransformContextReference, BNFreeTransformContext>
+	{
+	  public:
+		TransformContext(BNTransformContext* context);
+		virtual ~TransformContext();
+
+		std::string GetTransformName() const;
+		std::string GetFileName() const;
+		Ref<BinaryView> GetInput() const;
+		Ref<Metadata> GetMetadata() const;
+		Ref<TransformContext> GetParent() const;
+		size_t GetChildCount() const;
+		std::vector<Ref<TransformContext>> GetChildren() const;
+		Ref<TransformContext> GetChild(const std::string& filename) const;
+		Ref<TransformContext> CreateChild(const DataBuffer& data, const std::string& filename);
+		bool IsLeaf() const;
+		bool IsRoot() const;
+		std::vector<std::string> GetAvailableFiles() const;
+		void SetAvailableFiles(const std::vector<std::string>& files);
+		bool HasAvailableFiles() const;
+		std::vector<std::string> GetRequestedFiles() const;
+		void SetRequestedFiles(const std::vector<std::string>& files);
+		bool HasRequestedFiles() const;
+		bool IsDatabase() const;
+	};
+
+	class TransformSession : public CoreRefCountObject<BNTransformSession, BNNewTransformSessionReference, BNFreeTransformSession>
+	{
+	  public:
+		TransformSession(const std::string& filename);
+		TransformSession(const std::string& filename, BNTransformSessionMode mode);
+		TransformSession(Ref<BinaryView> initialView);
+		TransformSession(Ref<BinaryView> initialView, BNTransformSessionMode mode);
+		TransformSession(BNTransformSession* session);
+		virtual ~TransformSession();
+
+		Ref<BinaryView> GetCurrentView() const;
+		Ref<TransformContext> GetRootContext() const;
+		Ref<TransformContext> GetCurrentContext() const;
+		bool Process();
+		bool HasAnyStages() const;
+		bool HasSinglePath() const;
+
+		std::vector<Ref<TransformContext>> GetSelectedContexts() const;
+		void SetSelectedContexts(const std::vector<Ref<TransformContext>>& contexts);
+
+		// UI interaction support
+		bool RequiresUserInput() const;
+		bool HasMultipleFileChoices() const;
+		std::vector<std::string> GetAvailableFileChoices() const;
+		bool SelectFiles(const std::vector<std::string>& selectedFiles);
+		bool ProcessWithUserInput();
+	};
+
+
 	struct InstructionInfo : public BNInstructionInfo
 	{
 		InstructionInfo();

binaryninjacore.h

@@ -37,14 +37,14 @@
 // Current ABI version for linking to the core. This is incremented any time
 // there are changes to the API that affect linking, including new functions,
 // new types, or modifications to existing functions or types.
-#define BN_CURRENT_CORE_ABI_VERSION 132
+#define BN_CURRENT_CORE_ABI_VERSION 133
 
 // Minimum ABI version that is supported for loading of plugins. Plugins that
 // are linked to an ABI version less than this will not be able to load and
 // will require rebuilding. The minimum version is increased when there are
 // incompatible changes that break binary compatibility, such as changes to
 // existing types or functions.
-#define BN_MINIMUM_CORE_ABI_VERSION 131
+#define BN_MINIMUM_CORE_ABI_VERSION 133
 
 #ifdef __GNUC__
 	#ifdef BINARYNINJACORE_LIBRARY
@@ -205,6 +205,8 @@ extern "C"
 	typedef struct BNDatabase BNDatabase;
 	typedef struct BNFileMetadata BNFileMetadata;
 	typedef struct BNTransform BNTransform;
+	typedef struct BNTransformContext BNTransformContext;
+	typedef struct BNTransformSession BNTransformSession;
 	typedef struct BNArchitecture BNArchitecture;
 	typedef struct BNFunction BNFunction;
 	typedef struct BNBasicBlock BNBasicBlock;
@@ -348,6 +350,19 @@ extern "C"
 		HashTransform = 8           // Hash function
 	} BNTransformType;
 
+	typedef enum BNTransformCapabilities
+	{
+		TransformNoCapabilities = 0,
+		TransformSupportsDetection = 1
+	} BNTransformCapabilities;
+
+	typedef enum BNTransformSessionMode
+	{
+		TransformSessionModeDisabled = 0, // Open the root file as-is (no unwrapping)
+		TransformSessionModeFull = 1,     // Discover all paths (build the full context tree)
+		TransformSessionModeOnDemand = 2, // Proceed step-by-step, requesting input at each stage
+	} BNTransformSessionMode;
+
 	typedef enum BNBranchType
 	{
 		UnconditionalBranch = 0,
@@ -1753,10 +1768,9 @@ extern "C"
 		void* context;
 		BNTransformParameterInfo* (*getParameters)(void* ctxt, size_t* count);
 		void (*freeParameters)(BNTransformParameterInfo* params, size_t count);
-		bool (*decode)(
-		    void* ctxt, BNDataBuffer* input, BNDataBuffer* output, BNTransformParameter* params, size_t paramCount);
-		bool (*encode)(
-		    void* ctxt, BNDataBuffer* input, BNDataBuffer* output, BNTransformParameter* params, size_t paramCount);
+		bool (*decode)(void* ctxt, BNDataBuffer* input, BNDataBuffer* output, BNTransformParameter* params, size_t paramCount);
+		bool (*encode)(void* ctxt, BNDataBuffer* input, BNDataBuffer* output, BNTransformParameter* params, size_t paramCount);
+		bool (*canDecode)(void* ctxt, BNBinaryView* input);
 	} BNCustomTransform;
 
 	typedef struct BNInstructionInfo
@@ -3802,6 +3816,7 @@ extern "C"
 	BINARYNINJACOREAPI void BNSetLicense(const char* licenseData);
 
 	BINARYNINJACOREAPI bool BNIsDatabase(const char* filename);
+	BINARYNINJACOREAPI bool BNIsDatabaseFromData(const void* data, size_t len);
 
 	BINARYNINJACOREAPI bool BNAuthenticateEnterpriseServerWithCredentials(
 	    const char* username, const char* password, bool remember);
@@ -4233,6 +4248,9 @@ extern "C"
 	BINARYNINJACOREAPI char* BNGetFilename(BNFileMetadata* file);
 	BINARYNINJACOREAPI void BNSetFilename(BNFileMetadata* file, const char* name);
 
+	BINARYNINJACOREAPI char* BNGetVirtualPath(BNFileMetadata* file);
+	BINARYNINJACOREAPI void BNSetVirtualPath(BNFileMetadata* file, const char* path);
+
 	BINARYNINJACOREAPI BNProjectFile* BNGetProjectFile(BNFileMetadata* file);
 	BINARYNINJACOREAPI void BNSetProjectFile(BNFileMetadata* file, BNProjectFile* pfile);
 
@@ -4610,10 +4628,12 @@ extern "C"
 	BINARYNINJACOREAPI BNTransform* BNGetTransformByName(const char* name);
 	BINARYNINJACOREAPI BNTransform** BNGetTransformTypeList(size_t* count);
 	BINARYNINJACOREAPI void BNFreeTransformTypeList(BNTransform** xforms);
-	BINARYNINJACOREAPI BNTransform* BNRegisterTransformType(
-	    BNTransformType type, const char* name, const char* longName, const char* group, BNCustomTransform* xform);
+	BINARYNINJACOREAPI BNTransform* BNRegisterTransformType(BNTransformType type, const char* name, const char* longName, const char* group, BNCustomTransform* xform);
+	BINARYNINJACOREAPI BNTransform* BNRegisterTransformTypeWithCapabilities(BNTransformType type, uint32_t capabilities, const char* name, const char* longName, const char* group, BNCustomTransform* xform);
 
 	BINARYNINJACOREAPI BNTransformType BNGetTransformType(BNTransform* xform);
+	BINARYNINJACOREAPI uint32_t BNGetTransformCapabilities(BNTransform* xform);
+	BINARYNINJACOREAPI bool BNTransformSupportsDetection(BNTransform* xform);
 	BINARYNINJACOREAPI char* BNGetTransformName(BNTransform* xform);
 	BINARYNINJACOREAPI char* BNGetTransformLongName(BNTransform* xform);
 	BINARYNINJACOREAPI char* BNGetTransformGroup(BNTransform* xform);
@@ -4623,6 +4643,51 @@ extern "C"
 	    BNTransform* xform, BNDataBuffer* input, BNDataBuffer* output, BNTransformParameter* params, size_t paramCount);
 	BINARYNINJACOREAPI bool BNEncode(
 	    BNTransform* xform, BNDataBuffer* input, BNDataBuffer* output, BNTransformParameter* params, size_t paramCount);
+	BINARYNINJACOREAPI bool BNCanDecode(BNTransform* xform, BNBinaryView* input);
+
+	// Transform Context
+	BINARYNINJACOREAPI BNTransformContext* BNNewTransformContextReference(BNTransformContext* context);
+	BINARYNINJACOREAPI void BNFreeTransformContext(BNTransformContext* context);
+	BINARYNINJACOREAPI char* BNTransformContextGetTransformName(BNTransformContext* context);
+	BINARYNINJACOREAPI char* BNTransformContextGetFileName(BNTransformContext* context);
+	BINARYNINJACOREAPI BNBinaryView* BNTransformContextGetInput(BNTransformContext* context);
+	BINARYNINJACOREAPI BNMetadata* BNTransformContextGetMetadata(BNTransformContext* context);
+	BINARYNINJACOREAPI BNTransformContext* BNTransformContextGetParent(BNTransformContext* context);
+	BINARYNINJACOREAPI size_t BNTransformContextGetChildCount(BNTransformContext* context);
+	BINARYNINJACOREAPI BNTransformContext** BNTransformContextGetChildren(BNTransformContext* context, size_t* count);
+	BINARYNINJACOREAPI void BNFreeTransformContextList(BNTransformContext** contexts, size_t count);
+	BINARYNINJACOREAPI BNTransformContext* BNTransformContextGetChild(BNTransformContext* context, const char* filename);
+	BINARYNINJACOREAPI BNTransformContext* BNTransformContextCreateChild(BNTransformContext* context, BNDataBuffer* data, const char* filename);
+	BINARYNINJACOREAPI bool BNTransformContextIsLeaf(BNTransformContext* context);
+	BINARYNINJACOREAPI bool BNTransformContextIsRoot(BNTransformContext* context);
+	BINARYNINJACOREAPI char** BNTransformContextGetAvailableFiles(BNTransformContext* context, size_t* count);
+	BINARYNINJACOREAPI void BNTransformContextSetAvailableFiles(BNTransformContext* context, const char** files, size_t count);
+	BINARYNINJACOREAPI bool BNTransformContextHasAvailableFiles(BNTransformContext* context);
+	BINARYNINJACOREAPI char** BNTransformContextGetRequestedFiles(BNTransformContext* context, size_t* count);
+	BINARYNINJACOREAPI void BNTransformContextSetRequestedFiles(BNTransformContext* context, const char** files, size_t count);
+	BINARYNINJACOREAPI bool BNTransformContextHasRequestedFiles(BNTransformContext* context);
+	BINARYNINJACOREAPI bool BNTransformContextIsDatabase(BNTransformContext* context);
+
+	// Transform Session
+	BINARYNINJACOREAPI BNTransformSession* BNCreateTransformSession(const char* filename);
+	BINARYNINJACOREAPI BNTransformSession* BNCreateTransformSessionWithMode(const char* filename, BNTransformSessionMode mode);
+	BINARYNINJACOREAPI BNTransformSession* BNCreateTransformSessionFromBinaryView(BNBinaryView* initialView);
+	BINARYNINJACOREAPI BNTransformSession* BNCreateTransformSessionFromBinaryViewWithMode(BNBinaryView* initialView, BNTransformSessionMode mode);
+	BINARYNINJACOREAPI BNTransformSession* BNNewTransformSessionReference(BNTransformSession* session);
+	BINARYNINJACOREAPI void BNFreeTransformSession(BNTransformSession* session);
+	BINARYNINJACOREAPI BNBinaryView* BNTransformSessionGetCurrentView(BNTransformSession* session);
+	BINARYNINJACOREAPI BNTransformContext* BNTransformSessionGetRootContext(BNTransformSession* session);
+	BINARYNINJACOREAPI BNTransformContext* BNTransformSessionGetCurrentContext(BNTransformSession* session);
+	BINARYNINJACOREAPI bool BNTransformSessionProcess(BNTransformSession* session);
+	BINARYNINJACOREAPI bool BNTransformSessionHasAnyStages(BNTransformSession* session);
+	BINARYNINJACOREAPI bool BNTransformSessionHasSinglePath(BNTransformSession* session);
+	BINARYNINJACOREAPI BNTransformContext** BNTransformSessionGetSelectedContexts(BNTransformSession* session, size_t* count);
+	BINARYNINJACOREAPI void BNTransformSessionSetSelectedContexts(BNTransformSession* session, BNTransformContext** contexts, size_t count);
+	BINARYNINJACOREAPI bool BNTransformSessionRequiresUserInput(BNTransformSession* session);
+	BINARYNINJACOREAPI bool BNTransformSessionHasMultipleFileChoices(BNTransformSession* session);
+	BINARYNINJACOREAPI char** BNTransformSessionGetAvailableFileChoices(BNTransformSession* session, size_t* count);
+	BINARYNINJACOREAPI bool BNTransformSessionSelectFiles(BNTransformSession* session, const char** files, size_t count);
+	BINARYNINJACOREAPI bool BNTransformSessionProcessWithUserInput(BNTransformSession* session);
 
 	// Architectures
 	BINARYNINJACOREAPI BNArchitecture* BNGetArchitectureByName(const char* name);

filemetadata.cpp

@@ -129,6 +129,21 @@ void FileMetadata::SetFilename(const string& name)
 }
 
 
+string FileMetadata::GetVirtualPath() const
+{
+	char* str = BNGetVirtualPath(m_object);
+	string result = str;
+	BNFreeString(str);
+	return result;
+}
+
+
+void FileMetadata::SetVirtualPath(const string& path)
+{
+	BNSetVirtualPath(m_object, path.c_str());
+}
+
+
 bool FileMetadata::IsModified() const
 {
 	return BNIsFileModified(m_object);

python/filemetadata.py

@@ -208,6 +208,15 @@ def filename(self) -> str:
 	def filename(self, value: str) -> None:
 		core.BNSetFilename(self.handle, str(value))
 
+	@property
+	def virtual_path(self) -> str:
+		"""The virtual path of the file including container and internal path (e.g., 'archive.zip:folder/file.bin') (read/write)"""
+		return core.BNGetVirtualPath(self.handle)
+
+	@virtual_path.setter
+	def virtual_path(self, value: str) -> None:
+		core.BNSetVirtualPath(self.handle, str(value))
+
 	@property
 	def modified(self) -> bool:
 		"""Boolean result of whether the file is modified (Inverse of 'saved' property) (read/write)"""

python/transform.py

@@ -26,6 +26,7 @@
 import binaryninja
 from .log import log_error_for_exception
 from . import databuffer
+from . import binaryview
 from . import _binaryninjacore as core
 from .enums import TransformType
 
@@ -99,6 +100,8 @@ class Transform(metaclass=_TransformMetaClass):
 		b'173d3b2c2c373923720f242d39'
 	"""
 	transform_type = None
+	capabilities = 0
+	supports_detection = False
 	name = None
 	long_name = None
 	group = None
@@ -113,6 +116,7 @@ def __init__(self, handle):
 			self._cb.freeParameters = self._cb.freeParameters.__class__(self._free_parameters)
 			self._cb.decode = self._cb.decode.__class__(self._decode)
 			self._cb.encode = self._cb.encode.__class__(self._encode)
+			self._cb.canDecode = self._cb.canDecode.__class__(self._can_decode)
 			self._pending_param_lists = {}
 			self.type = self.__class__.transform_type
 			if not isinstance(self.type, str):
@@ -125,6 +129,8 @@ def __init__(self, handle):
 		else:
 			self.handle = handle
 			self.type = TransformType(core.BNGetTransformType(self.handle))
+			self.capabilities = core.BNGetTransformCapabilities(self.handle)
+			self.supports_detection = core.BNTransformSupportsDetection(self.handle)
 			self.name = core.BNGetTransformName(self.handle)
 			self.long_name = core.BNGetTransformLongName(self.handle)
 			self.group = core.BNGetTransformGroup(self.handle)
@@ -165,7 +171,7 @@ def register(cls):
 			cls.group = ""
 		xform = cls(None)
 		cls._registered_cb = xform._cb
-		xform.handle = core.BNRegisterTransformType(cls.transform_type, cls.name, cls.long_name, cls.group, xform._cb)
+		xform.handle = core.BNRegisterTransformTypeWithCapabilities(cls.transform_type, cls.capabilities, cls.name, cls.long_name, cls.group, xform._cb)
 
 	def _get_parameters(self, ctxt, count):
 		try:
@@ -226,6 +232,14 @@ def _encode(self, ctxt, input_buf, output_buf, params, count):
 			log_error_for_exception("Unhandled Python exception in Transform._encode")
 			return False
 
+	def _can_decode(self, ctxt, input):
+		try:
+			input_obj = binaryview.BinaryView(handle=core.BNNewViewReference(input))
+			return self.can_decode(input_obj)
+		except:
+			log_error_for_exception("Unhandled Python exception in Transform._can_decode")
+			return False
+
 	@abc.abstractmethod
 	def perform_decode(self, data, params):
 		if self.type == TransformType.InvertingTransform:
@@ -267,3 +281,18 @@ def encode(self, input_buf, params={}):
 		if not core.BNEncode(self.handle, input_buf.handle, output_buf.handle, param_buf, len(keys)):
 			return None
 		return bytes(output_buf)
+
+	def can_decode(self, input):
+		"""
+		``can_decode`` checks if this transform can decode the given input.
+
+		:param input: can be a :py:class:`bytes`, :py:class:`bytearray`, :py:class:`DataBuffer`, or :py:class:`BinaryView`
+		:return: :py:class:`bool` indicating whether the transform can decode the input
+		:rtype: bool
+		"""
+		if isinstance(input, bytes) or isinstance(input, bytearray) or isinstance(input, databuffer.DataBuffer):
+			with binaryview.BinaryView.new(input) as view:
+				return core.BNCanDecode(self.handle, view.handle)
+		elif isinstance(input, binaryview.BinaryView):
+				return core.BNCanDecode(self.handle, input.handle)
+		return False