binaryninja.settings.Settings

class Settings(instance_id='default', handle=None)[source]

Settings provides a way to define and access settings in a hierarchical fashion. The value of a setting can be defined for each hierarchical level, where each level overrides the preceding level. The backing-store for setting values at each level is also configurable. This allows for ephemeral or platform-independent persistent settings storage for components within Binary Ninja or consumers of the Binary Ninja API.

Each Settings instance has an instance_id which identifies a schema. The schema defines the settings contents and the way in which settings are retrieved and manipulated. A new Settings instance defaults to using a value of ‘default’ for the instance_id. The ‘default’ settings schema defines all of the settings available for the active Binary Ninja components which include at a minimum, the settings defined by the Binary Ninja core. The ‘default’ schema may additionally define settings for the UI and/or installed plugins. Extending existing schemas, or defining new ones is accomplished by calling register_group and register_setting methods, or by deserializing an existing schema with deserialize_schema.

Note

All settings in the ‘default’ settings schema are rendered with UI elements in the Settings View of Binary Ninja UI.

Allowing setting overrides is an important feature and Binary Ninja accomplishes this by allowing one to override a setting at various levels. The levels and their associated storage are shown in the following table. Default setting values are optional, and if specified, saved in the schema itself.

Setting Level

Settings Scope

Preference

Storage

Default

SettingsDefaultScope

Lowest

Settings Schema

User

SettingsUserScope

<User Directory>/settings.json

Project

SettingsProjectScope

<Project Directory>/.binaryninja/settings.json

Resource

SettingsResourceScope

Highest

Raw BinaryView (Storage in BNDB)

Settings are identified by a key, which is a string in the form of ‘<group>.<name>’ or ‘<group>.<subGroup>.<name>’. Groups provide a simple way to categorize settings. Sub-groups are optional and multiple sub-groups are allowed. When defining a settings group, the register_group method allows for specifying a UI friendly title for use in the Binary Ninja UI. Defining a new setting requires a unique setting key and a JSON string of property, value pairs. The following table describes the available properties and values.

Property

JSON Data Type

Prerequisite

Optional

{Allowed Values} and Notes

“title”

string

None

No

Concise Setting Title

“type”

string

None

No

{“array”, “boolean”, “number”, “string”}

“elementType”

string

“type” is “array”

No

{“string”}

“enum”

array : {string}

“type” is “array”

Yes

Enumeration definitions

“enumDescriptions”

array : {string}

“type” is “array”

Yes

Enumeration descriptions that match “enum” array

“minValue”

number

“type” is “number”

Yes

Specify 0 to infer unsigned (default is signed)

“maxValue”

number

“type” is “number”

Yes

Values less than or equal to INT_MAX infer a spinbox.

“precision”

number

“type” is “number”

Yes

Specify precision for a QDoubleSpinBox

“default”

{array, boolean, number, string, null}

None

Yes

Specify optimal default value

“aliases”

array : {string}

None

Yes

Array of deprecated setting key(s)

“description”

string

None

No

Detailed setting description

“ignore”

array : {string}

None

Yes

{“SettingsUserScope”, “SettingsProjectScope”, “SettingsResourceScope”}

“readOnly”

boolean

None

Yes

Only enforced by UI elements

“optional”

boolean

None

Yes

Indicates setting can be null

Note

In order to facilitate deterministic analysis results, settings from the ‘default’ schema that impact analysis are serialized from Default, User, and Project scope into Resource scope during initial BinaryView analysis. This allows an analysis database to be opened at a later time with the same settings, regardless if Default, User, or Project settings have been modified.

Note

Settings that do not impact analysis (e.g. many UI settings) should use the “ignore” property to exclude “SettingsProjectScope” and “SettingsResourceScope” from the applicable scopes for the setting.

Example analysis plugin setting:

>>> my_settings = Settings()
>>> title = "My Pre-Analysis Plugin"
>>> description = "Enable extra analysis before core analysis."
>>> properties = f'{{"title" : "{title}", "description" : "{description}", "type" : "boolean", "default" : false}}'
>>> my_settings.register_group("myPlugin", "My Plugin")
True
>>> my_settings.register_setting("myPlugin.enablePreAnalysis", properties)
True
>>> my_bv = open_view("/bin/ls", options={'myPlugin.enablePreAnalysis' : True})
>>> Settings().get_bool("myPlugin.enablePreAnalysis")
False
>>> Settings().get_bool("myPlugin.enablePreAnalysis", my_bv)
True

Example UI plugin setting:

>>> my_settings = Settings()
>>> title = "My UI Plugin"
>>> description = "Enable My UI Plugin table display."
>>> properties = f'{{"title" : "{title}", "description" : "{description}", "type" : "boolean", "default" : true, "ignore" : ["SettingsProjectScope", "SettingsResourceScope"]}}'
>>> my_settings.register_group("myPlugin", "My Plugin")
True
>>> my_settings.register_setting("myPlugin.enableTableView", properties)
True
>>> my_bv = open_view("/bin/ls", options={'myPlugin.enablePreAnalysis' : True})
>>> Settings().get_bool("myPlugin.enableTableView")
True
__init__(instance_id='default', handle=None)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([instance_id, handle])

Initialize self.

contains(key)

contains determine if a setting identifier exists in the active settings schema

deserialize_schema(schema[, scope, merge])

deserialize_settings(contents[, view, scope])

get_bool(key[, view])

get_bool_with_scope(key[, view, scope])

get_double(key[, view])

get_double_with_scope(key[, view, scope])

get_integer(key[, view])

get_integer_with_scope(key[, view, scope])

get_json(key[, view])

get_json_with_scope(key[, view, scope])

get_string(key[, view])

get_string_list(key[, view])

get_string_list_with_scope(key[, view, scope])

get_string_with_scope(key[, view, scope])

is_empty()

is_empty determine if the active settings schema is empty

keys()

keys retrieve the list of setting identifiers in the active settings schema

query_property_string_list(key, property_name)

register_group(group, title)

register_group registers a group in the schema for this Settings instance

register_setting(key, properties)

register_setting registers a new setting with this Settings instance

reset(key[, view, scope])

reset_all([view, scope, schema_only])

serialize_schema()

serialize_settings([view, scope])

set_bool(key, value[, view, scope])

set_double(key, value[, view, scope])

set_integer(key, value[, view, scope])

set_json(key, value[, view, scope])

set_resource_id([resource_id])

set_resource_id Sets the resource identifier for this class:Settings instance.

set_string(key, value[, view, scope])

set_string_list(key, value[, view, scope])

update_property(key, setting_property)

Attributes

handle

instance_id

Returns the instance_id for this Settings repository (read-only)