Expose all version-specific info for extensions in API

Author: 0cyn

binaryninjaapi.cpp

@@ -207,31 +207,30 @@ string BinaryNinja::GetVersionString()
 }
 
 
-VersionInfo BinaryNinja::GetVersionInfo()
+static VersionInfo VersionInfoFromCoreStruct(const BNVersionInfo& result)
 {
-	BNVersionInfo result = BNGetVersionInfo();
 	VersionInfo info;
 	info.major = result.major;
 	info.minor = result.minor;
 	info.build = result.build;
-	info.channel = "";
-	if (result.channel)
-		info.channel = result.channel;
+	info.channel = result.channel ? result.channel : "";
+	return info;
+}
+
+
+VersionInfo BinaryNinja::GetVersionInfo()
+{
+	BNVersionInfo result = BNGetVersionInfo();
+	VersionInfo info = VersionInfoFromCoreStruct(result);
 	BNFreeString(result.channel);
 	return info;
 }
 
 
-VersionInfo ParseVersionString(const string &version)
+VersionInfo BinaryNinja::ParseVersionString(const string &version)
 {
 	BNVersionInfo result = BNParseVersionString(version.c_str());
-	VersionInfo info;
-	info.major = result.major;
-	info.minor = result.minor;
-	info.build = result.build;
-	info.channel = "";
-	if (result.channel)
-		info.channel = result.channel;
+	VersionInfo info = VersionInfoFromCoreStruct(result);
 	BNFreeString(result.channel);
 	return info;
 }

binaryninjaapi.h

@@ -1962,8 +1962,16 @@ namespace BinaryNinja {
 		{
 			char* smallerChan = BNAllocString(channel.c_str());
 			char* largerChan = BNAllocString(other.channel.c_str());
-			BNVersionInfo smaller = { major, minor, build, smallerChan };
-			BNVersionInfo larger = { other.major, other.minor, other.build, largerChan };
+			BNVersionInfo smaller = {};
+			smaller.major = major;
+			smaller.minor = minor;
+			smaller.build = build;
+			smaller.channel = smallerChan;
+			BNVersionInfo larger = {};
+			larger.major = other.major;
+			larger.minor = other.minor;
+			larger.build = other.build;
+			larger.channel = largerChan;
 			bool result = BNVersionLessThan(smaller, larger);
 			BNFreeString(smallerChan);
 			BNFreeString(largerChan);
@@ -19145,13 +19153,21 @@ namespace BinaryNinja {
 
 	struct ExtensionVersion
 	{
+		struct PlatformInfo
+		{
+			std::string name;
+			std::string downloadUrl;
+			std::string untrackedDownloadUrl;
+		};
+
 		std::string id;
 		std::string version;
 
 		std::string longDescription;
 		std::string changelog;
 
 		uint64_t minimumClientVersion;
+		std::vector<PlatformInfo> platforms;
 		std::string created;
 	};
 

binaryninjacore.h

@@ -354,6 +354,20 @@ extern "C"
 	typedef struct BNStringRecognizer BNStringRecognizer;
 	typedef struct BNCustomStringType BNCustomStringType;
 
+	typedef struct BNVersionInfo {
+		uint32_t major;
+		uint32_t minor;
+		uint32_t build;
+		char* channel;
+	} BNVersionInfo;
+
+	typedef struct BNPluginVersionPlatform
+	{
+		char* name;
+		char* downloadUrl;
+		char* untrackedDownloadUrl;
+	} BNPluginVersionPlatform;
+
 	typedef struct BNPluginVersion
 	{
 		char* id;
@@ -362,6 +376,8 @@ extern "C"
 		char* changelog;
 
 		uint64_t minimumClientVersion;
+		BNPluginVersionPlatform* platforms;
+		size_t platformCount;
 		char* created;
 
 	} BNPluginVersion;
@@ -2743,13 +2759,6 @@ extern "C"
 		char* latestVersion;
 	} BNUpdateChannel;
 
-	typedef struct BNVersionInfo {
-		uint32_t major;
-		uint32_t minor;
-		uint32_t build;
-		char* channel;
-	} BNVersionInfo;
-
 	typedef struct BNChangelogEntry {
 		BNVersionInfo version;
 		char* notes;

pluginmanager.cpp

@@ -70,26 +70,37 @@ string Extension::GetDescription() const
 	RETURN_STRING(BNPluginGetDescription(m_object));
 }
 
-VersionInfo Extension::GetMinimumVersionInfo() const
+static VersionInfo ConvertVersionInfo(const BNVersionInfo& coreInfo)
 {
-	auto coreInfo = BNPluginGetMinimumVersionInfo(m_object);
 	VersionInfo result;
 	result.major = coreInfo.major;
 	result.minor = coreInfo.minor;
 	result.build = coreInfo.build;
-	result.channel = coreInfo.channel;
+	result.channel = coreInfo.channel ? coreInfo.channel : "";
+	return result;
+}
+
+static ExtensionVersion::PlatformInfo ConvertVersionPlatform(const BNPluginVersionPlatform& corePlatform)
+{
+	ExtensionVersion::PlatformInfo result;
+	result.name = corePlatform.name ? corePlatform.name : "";
+	result.downloadUrl = corePlatform.downloadUrl ? corePlatform.downloadUrl : "";
+	result.untrackedDownloadUrl = corePlatform.untrackedDownloadUrl ? corePlatform.untrackedDownloadUrl : "";
+	return result;
+}
+
+VersionInfo Extension::GetMinimumVersionInfo() const
+{
+	auto coreInfo = BNPluginGetMinimumVersionInfo(m_object);
+	VersionInfo result = ConvertVersionInfo(coreInfo);
 	BNFreeString(coreInfo.channel);
 	return result;
 }
 
 VersionInfo Extension::GetMaximumVersionInfo() const
 {
 	auto coreInfo = BNPluginGetMaximumVersionInfo(m_object);
-	VersionInfo result;
-	result.major = coreInfo.major;
-	result.minor = coreInfo.minor;
-	result.build = coreInfo.build;
-	result.channel = coreInfo.channel;
+	VersionInfo result = ConvertVersionInfo(coreInfo);
 	BNFreeString(coreInfo.channel);
 	return result;
 }
@@ -146,6 +157,9 @@ std::vector<ExtensionVersion> Extension::GetVersions() const
 		version.longDescription = versionsPtr[i].longDescription ? versionsPtr[i].longDescription : "";
 		version.changelog = versionsPtr[i].changelog ? versionsPtr[i].changelog : "";
 		version.minimumClientVersion = versionsPtr[i].minimumClientVersion;
+		version.platforms.reserve(versionsPtr[i].platformCount);
+		for (size_t j = 0; j < versionsPtr[i].platformCount; j++)
+			version.platforms.push_back(ConvertVersionPlatform(versionsPtr[i].platforms[j]));
 		version.created = versionsPtr[i].created ? versionsPtr[i].created : "";
 		versions.push_back(version);
 	}
@@ -163,6 +177,9 @@ ExtensionVersion Extension::GetCurrentVersion() const
 	version.longDescription = currentVersion.longDescription ? currentVersion.longDescription : "";
 	version.changelog = currentVersion.changelog ? currentVersion.changelog : "";
 	version.minimumClientVersion = currentVersion.minimumClientVersion;
+	version.platforms.reserve(currentVersion.platformCount);
+	for (size_t i = 0; i < currentVersion.platformCount; i++)
+		version.platforms.push_back(ConvertVersionPlatform(currentVersion.platforms[i]));
 	version.created = currentVersion.created ? currentVersion.created : "";
 	BNPluginFreeVersion(currentVersion);
 	return version;

python/pluginmanager.py

@@ -20,6 +20,7 @@
 
 import ctypes
 import json
+from dataclasses import dataclass
 from datetime import datetime, date
 from typing import List, Dict, Optional
 
@@ -29,6 +30,24 @@
 from .enums import PluginType
 
 
+@dataclass(frozen=True)
+class ExtensionVersionPlatform:
+	name: str
+	download_url: str
+	untracked_download_url: str
+
+
+@dataclass(frozen=True)
+class ExtensionVersion:
+	id: str
+	version: str
+	long_description: str
+	changelog: str
+	minimum_client_version: int
+	platforms: List[ExtensionVersionPlatform]
+	created: str
+
+
 class Extension:
 	"""
 	``Extension`` is mostly read-only, however you can install/uninstall enable/disable plugins. Extensions are
@@ -152,13 +171,23 @@ def minimum_version(self) -> int:
 	def minimum_version_info(self) -> 'binaryninja.CoreVersionInfo':
 		"""Minimum version info the plugin was tested on"""
 		core_version_info = core.BNPluginGetMinimumVersionInfo(self.handle)
-		return binaryninja.CoreVersionInfo(core_version_info.major, core_version_info.minor, core_version_info.build)
+		return binaryninja.CoreVersionInfo(
+			core_version_info.major,
+			core_version_info.minor,
+			core_version_info.build,
+			core_version_info.channel or ""
+		)
 
 	@property
 	def maximum_version_info(self) -> 'binaryninja.CoreVersionInfo':
 		"""Maximum version info the plugin will support"""
 		core_version_info = core.BNPluginGetMaximumVersionInfo(self.handle)
-		return binaryninja.CoreVersionInfo(core_version_info.major, core_version_info.minor, core_version_info.build)
+		return binaryninja.CoreVersionInfo(
+			core_version_info.major,
+			core_version_info.minor,
+			core_version_info.build,
+			core_version_info.channel or ""
+		)
 
 	@property
 	def name(self) -> str:
@@ -206,14 +235,65 @@ def author(self) -> Optional[str]:
 	@deprecation.deprecated(deprecated_in="5.3", details='Use :py:attr:`current_version` in combination with :py:attr:`versions` instead.')
 	def version(self) -> Optional[str]:
 		"""String version of the plugin"""
+		return self.current_version.version
+
+	@property
+	def current_version(self) -> ExtensionVersion:
+		"""Current version metadata for the plugin"""
 		version: core.BNPluginVersion = core.BNPluginGetCurrentVersion(self.handle)
 		try:
-			version_string = version.versionString
-		except AttributeError:
-			version_string = ""
+			platforms = []
+			for i in range(version.platformCount):
+				platform = version.platforms[i]
+				platforms.append(ExtensionVersionPlatform(
+					name=platform.name or "",
+					download_url=platform.downloadUrl or "",
+					untracked_download_url=platform.untrackedDownloadUrl or ""
+				))
+			return ExtensionVersion(
+				id=version.id or "",
+				version=version.versionString or "",
+				long_description=version.longDescription or "",
+				changelog=version.changelog or "",
+				minimum_client_version=version.minimumClientVersion,
+				platforms=platforms,
+				created=version.created or ""
+			)
 		finally:
 			core.BNPluginFreeVersion(version)
-		return version_string
+
+	@property
+	def versions(self) -> List[ExtensionVersion]:
+		"""Version metadata for all available plugin versions"""
+		result = []
+		count = ctypes.c_ulonglong(0)
+		versions = core.BNPluginGetVersions(self.handle, count)
+		try:
+			if versions is None:
+				return result
+			for i in range(count.value):
+				version = versions[i]
+				platforms = []
+				for j in range(version.platformCount):
+					platform = version.platforms[j]
+					platforms.append(ExtensionVersionPlatform(
+						name=platform.name or "",
+						download_url=platform.downloadUrl or "",
+						untracked_download_url=platform.untrackedDownloadUrl or ""
+					))
+				result.append(ExtensionVersion(
+					id=version.id or "",
+					version=version.versionString or "",
+					long_description=version.longDescription or "",
+					changelog=version.changelog or "",
+					minimum_client_version=version.minimumClientVersion,
+					platforms=platforms,
+					created=version.created or ""
+				))
+			return result
+		finally:
+			if versions is not None:
+				core.BNFreePluginVersions(versions, count.value)
 
 	@property
 	def install_platforms(self) -> List[str]:

rust/src/repository.rs

@@ -11,10 +11,10 @@ use std::ptr::NonNull;
 use binaryninjacore_sys::*;
 
 use crate::rc::{Array, CoreArrayProvider, CoreArrayProviderInner, Guard, Ref, RefCountable};
-use crate::repository::plugin::Extension;
 use crate::string::{BnString, IntoCStr};
 
 pub use manager::RepositoryManager;
+pub use plugin::{Extension, ExtensionVersion, ExtensionVersionPlatform};
 
 pub type PluginType = BNPluginType;
 pub type PluginStatus = BNPluginStatus;