WARP 1.0

- Added FFI
- Added a sidebar to the UI
- Added project, directory and archive processing
- Added generic `Container` interface for extensible stores of WARP data
- Fixed type references being constructed and pulled incorrectly
- Added HTML, Markdown and JSON report generation
- Made the WARP information added as an analysis activity
- Flattened the signatures directory, the target information is stored in the file now
- Matched function information is stored as function metadata in the database to reliably persist, alongside the function GUID
- Split the matching out from the application, allowing you to match on a given function without applying it
- Added more/better tests
- Added support for binaries with multiple architectures, the functions are now also queried based off the Target, see WARP spec for more details
- Greatly improved support for RISC architectures, see WARP spec for more details
- Greatly improved UX when loading files after the fact, will now sanely rerun the matcher
- Omitted the function type if not a user type, this greatly reduces file size
- Improved support for functions that reference a page aligned base pointer, see WARP spec for more details
- Removed some extra cache structures that were causing erroneous behavior
- Fixed edge-case in LLIL traversal missing some constant pointers, this was a bug in the Rust bindings
- Added support for function comments
- Made long running tasks, such as generating, matching and loading signatures, cancellable where possible
- Made function constraints more versatile, allowing for easy extensions in the future, see WARP spec for details
- Added options to signature generation, such as what data to store, and whether to compress the data or not
- Made all long running tasks prompt the user for required information before the task starts, allowing users to "set it and forget it" and not have to baby sit the finalization of the task
- Myriad of other changes to the actual WARP format that impact performance, file size and general feature set, see https://github.com/Vector35/warp for more details

1 files changed, 129 insertions, 0 deletions

diff --git a/plugins/warp/src/plugin/settings.rs b/plugins/warp/src/plugin/settings.rs
new file mode 100644
index 00000000..6cd2e0cc
--- /dev/null
+++ b/plugins/warp/src/plugin/settings.rs
@@ -0,0 +1,129 @@
+use binaryninja::settings::Settings as BNSettings;
+use serde_json::json;
+use std::string::ToString;
+
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+pub struct PluginSettings {
+    /// Whether to load bundled WARP files on startup. Turn this off if you want to manually load them.
+    ///
+    /// This is set to [PluginSettings::LOAD_BUNDLED_FILES_DEFAULT] by default.
+    pub load_bundled_files: bool,
+    /// Whether to load user WARP files on startup. Turn this off if you want to manually load them.
+    ///
+    /// This is set to [PluginSettings::LOAD_USER_FILES_DEFAULT] by default.
+    pub load_user_files: bool,
+    /// The WARP server to use.
+    ///
+    /// This is set to [PluginSettings::SERVER_URL_DEFAULT] by default.
+    pub server_url: String,
+    /// The API key to use for the selected WARP server, if not specified, you will be unable to push data and may be rate-limited.
+    ///
+    /// This is set to [PluginSettings::SERVER_API_KEY_DEFAULT] by default.
+    pub server_api_key: String,
+    /// Whether to allow networked WARP requests. Turning this off will not disable local WARP functionality.
+    ///
+    /// This is set to [PluginSettings::ENABLE_SERVER_DEFAULT] by default.
+    pub enable_server: bool,
+}
+
+impl PluginSettings {
+    pub const LOAD_BUNDLED_FILES_DEFAULT: bool = true;
+    pub const LOAD_BUNDLED_FILES_SETTING: &'static str = "analysis.warp.loadBundledFiles";
+    pub const LOAD_USER_FILES_DEFAULT: bool = true;
+    pub const LOAD_USER_FILES_SETTING: &'static str = "analysis.warp.loadUserFiles";
+    pub const SERVER_URL_DEFAULT: &'static str = "https://warp.binary.ninja";
+    pub const SERVER_URL_SETTING: &'static str = "analysis.warp.serverUrl";
+    pub const SERVER_API_KEY_DEFAULT: &'static str = "";
+    pub const SERVER_API_KEY_SETTING: &'static str = "analysis.warp.serverApiKey";
+    pub const ENABLE_SERVER_DEFAULT: bool = true;
+    pub const ENABLE_SERVER_SETTING: &'static str = "network.enableWARP";
+
+    pub fn register(bn_settings: &mut BNSettings) {
+        let load_bundled_files_prop = json!({
+            "title" : "Load Bundled Files",
+            "type" : "boolean",
+            "default" : Self::LOAD_BUNDLED_FILES_DEFAULT,
+            "description" : "Whether to load bundled WARP files on startup. Turn this off if you want to manually load them.",
+            "ignore" : ["SettingsProjectScope", "SettingsResourceScope"]
+        });
+        bn_settings.register_setting_json(
+            Self::LOAD_BUNDLED_FILES_SETTING,
+            &load_bundled_files_prop.to_string(),
+        );
+        let load_user_files_prop = json!({
+            "title" : "Load User Files",
+            "type" : "boolean",
+            "default" : Self::LOAD_USER_FILES_DEFAULT,
+            "description" : "Whether to load user WARP files on startup. Turn this off if you want to manually load them.",
+            "ignore" : ["SettingsProjectScope", "SettingsResourceScope"]
+        });
+        bn_settings.register_setting_json(
+            Self::LOAD_USER_FILES_SETTING,
+            &load_user_files_prop.to_string(),
+        );
+        let server_url_prop = json!({
+            "title" : "Server URL",
+            "type" : "string",
+            "default" : Self::SERVER_URL_DEFAULT,
+            "description" : "The WARP server to use.",
+            "ignore" : ["SettingsProjectScope", "SettingsResourceScope"]
+        });
+        bn_settings.register_setting_json(Self::SERVER_URL_SETTING, &server_url_prop.to_string());
+        let server_api_key_prop = json!({
+            "title" : "Server API Key",
+            "type" : "string",
+            "default" : Self::SERVER_API_KEY_DEFAULT,
+            "description" : "The API key to use for the selected WARP server, if not specified you will be unable to push data, and may be rate limited.",
+            "ignore" : ["SettingsProjectScope", "SettingsResourceScope"],
+            "hidden": true
+        });
+        bn_settings.register_setting_json(
+            Self::SERVER_API_KEY_SETTING,
+            &server_api_key_prop.to_string(),
+        );
+        let server_enabled_prop = json!({
+            "title" : "Enable WARP",
+            "type" : "boolean",
+            "default" : Self::ENABLE_SERVER_DEFAULT,
+            "description" : "Whether or not to allow networked WARP requests. Turning this off will not disable local WARP functionality.",
+            "ignore" : ["SettingsProjectScope", "SettingsResourceScope"]
+        });
+        bn_settings.register_setting_json(
+            Self::ENABLE_SERVER_SETTING,
+            &server_enabled_prop.to_string(),
+        );
+    }
+
+    /// Retrieve plugin settings from [`BNSettings`].
+    pub fn from_settings(bn_settings: &BNSettings) -> Self {
+        let mut settings = PluginSettings::default();
+        if bn_settings.contains(Self::LOAD_BUNDLED_FILES_SETTING) {
+            settings.load_bundled_files = bn_settings.get_bool(Self::LOAD_BUNDLED_FILES_SETTING);
+        }
+        if bn_settings.contains(Self::LOAD_USER_FILES_SETTING) {
+            settings.load_user_files = bn_settings.get_bool(Self::LOAD_USER_FILES_SETTING);
+        }
+        if bn_settings.contains(Self::SERVER_URL_SETTING) {
+            settings.server_url = bn_settings.get_string(Self::SERVER_URL_SETTING);
+        }
+        if bn_settings.contains(Self::SERVER_API_KEY_SETTING) {
+            settings.server_url = bn_settings.get_string(Self::SERVER_API_KEY_SETTING);
+        }
+        if bn_settings.contains(Self::ENABLE_SERVER_SETTING) {
+            settings.enable_server = bn_settings.get_bool(Self::ENABLE_SERVER_SETTING);
+        }
+        settings
+    }
+}
+
+impl Default for PluginSettings {
+    fn default() -> Self {
+        Self {
+            load_bundled_files: PluginSettings::LOAD_BUNDLED_FILES_DEFAULT,
+            load_user_files: PluginSettings::LOAD_USER_FILES_DEFAULT,
+            server_url: PluginSettings::SERVER_URL_DEFAULT.to_string(),
+            server_api_key: PluginSettings::SERVER_API_KEY_DEFAULT.to_string(),
+            enable_server: PluginSettings::ENABLE_SERVER_DEFAULT,
+        }
+    }
+}