diff options
| author | Peter LaFosse <peter@vector35.com> | 2018-08-29 15:26:00 -0400 |
|---|---|---|
| committer | Peter LaFosse <peter@vector35.com> | 2018-08-31 14:21:07 -0400 |
| commit | f0ccb75e7d80a6c0ae8b01d794b929f03bc6ea6d (patch) | |
| tree | 7569fe7689062b265329ad0f649705aa8caab922 /docs/getting-started.md | |
| parent | a6b801afadada75afd2b1779edee8d203f3b3140 (diff) | |
| parent | 426bb3d8b47b93658bf969c429a8b98adae13c30 (diff) | |
Merging with dev
Diffstat (limited to 'docs/getting-started.md')
| -rw-r--r-- | docs/getting-started.md | 57 |
1 files changed, 34 insertions, 23 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index 7e7e4acb..5148b9d5 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -33,7 +33,7 @@ Contents of the user folder includes: - `repositories/`: Folder containing files and plugins managed by the [Plugin Manager API](https://api.binary.ninja/binaryninja.pluginmanager-module.html) - `settings.json`: Advanced settings (see [settings](#settings)) - + ## License @@ -57,12 +57,12 @@ You can load files in many ways: 5. Opening a file from a URL via the `⌘-l` or `⌃-l` hotkey 6. Opening a file using the binaryninja: url handler. For security reasons, the url handler requires you to confirm a warning before opening a file via the url handler. The url handler can open remote URLs like: `binaryninja:https://captf.com/2015/plaidctf/pwnable/datastore_7e64104f876f0aa3f8330a409d9b9924.elf`, or even local files like `binarynina://bin/ls` in cases where you wish to script up Binary Ninja from a local webapp. - + ## Analysis - + As soon as you open a file, Binary Ninja begins its auto-analysis. @@ -76,7 +76,7 @@ Errors or warnings during the load of the binary are also shown in the status ba Navigating code in Binary Ninja is usually a case of just double-clicking where you want to go. Addresses, references, functions, jmp edges, etc, can all be double-clicked to navigate. Additionally, The `g` hotkey can navigate to a specific address in the current view. - + Switching views happens multiple ways. In some instances, it's automatic (clicking a data reference from graph view will navigate to linear view as data is not shown in the graph view), and there are multiple ways to manually change views as well. While navigating, you can use the view hotkeys (see below) to switch to a specific view at the same location as the current selection. Alternatively, the view menu in the bottom-right can be used to change views without navigating to any given location. @@ -111,11 +111,11 @@ Switching views happens multiple ways. In some instances, it's automatic (clicki ### Graph View - + The default view in Binary Ninja when opening a binary is a graph view that groups the basic blocks of disassembly into visually distinct blocks with edges showing control flow between them. - + Features of the graph view include: @@ -129,7 +129,7 @@ Features of the graph view include: ### View Options - + Each of the views (Hex, Graph, Linear) have a variety of options configurable in the bottom-right of the UI. @@ -162,7 +162,7 @@ Current options include: ### Hex View - + The hexadecimal view is useful for view raw binary files that may or may not even be executable binaries. The hex view is particularly good for transforming data in various ways via the `Copy as`, `Transform`, and `Paste from` menus. Note that `Transform` menu options will transform the data in-place, and that these options will only work when the Hex View is in the `Raw` mode as opposd to any of the binary views (such as "ELF", "Mach-O", or "PE"). @@ -170,15 +170,15 @@ Note that any changes made in the Hex view will take effect immediately in any o ### Xrefs View - + The xrefs view in the lower-left shows all cross-references to a given location or reference. Note that the cross-references pane will change depending on whether an entire line is selected (all cross-references to that address are shown), or whether a specific token within the line is selected. -One fun trick that the xrefs view has up its sleeve: when in [Hex View](#hexview), a large range of memory addresses can be selected and the xrefs pane will show all xrefs to any location within that range of data. +One fun trick that the xrefs view has up its sleeve: when in [Hex View](#hex-view), a large range of memory addresses can be selected and the xrefs pane will show all xrefs to any location within that range of data. ### Linear View - + Linear view is a hybrid view between a graph-based disassembly window and the raw hex view. It lists the entire binary's memory in a linear fashion and is especially useful when trying to find sections of a binary that were not properly identified as code or even just examining data. @@ -187,7 +187,7 @@ Linear view is most commonly used for identifying and adding type information fo ### Function List - + The function list in Binary Ninja shows the list of functions currently identified. As large binaries are analyzed, the list may grow during analysis. The function list starts with known functions such as the entry point, exports, or using other features of the binary file format and explores from there to identify other functions. @@ -198,7 +198,7 @@ The function list also highlights imports, and functions identified with symbols ### Script (Python) Console - + The integrated script console is useful for small scripts that aren't worth writing as full plugins. @@ -247,7 +247,7 @@ Binary Ninja supports loading PDB files through the built in PDB plugin. When se ## Preferences/Updates - + Binary Ninja automatically updates itself by default. This functionality can be disabled in the preferences by turning off the `Update to latest version automatically` option. Updates are silently downloaded in the background and when complete an option to restart is displayed in the status bar. Whenever Binary Ninja restarts next, it will replace itself with the new version as it launches. @@ -259,15 +259,21 @@ Settings are stored in the _user_ directory in the file `settings.json`. Each to |Plugin | Setting | Type | Default | Description | |----------:|-------------------------:|-------------:|-----------------------------------------------:|:----------------------------------------------------------------------------------------------| +| analysis | autorunLinearSweep | boolean | True | Automatically run linear sweep when opening a binary for analysis | +| analysis | enabledUnicodeBlocks | list(string) | [] | Defines which Unicode blocks to consider when searching for strings | +| analysis | enableUTF8 | boolean | True | Whether or not to consider UTF-8 code points when searching for strings | +| analysis | enableUTF16 | boolean | True | Whether or not to consider UTF-16 code points when searching for strings | +| analysis | enableUTF32 | boolean | True | Whether or not to consider UTF-32 code points when searching for strings | | analysis | max-function-size | integer | 65536 | Any functions over this size will not be automatically analyzed and require manual override | | core | linux\_ca\_bundle | string | "" | Certificate authority (.pem or .crt) file to be used for secure downloads | | core | linux\_ca\_dir | string | "" | Certificate authority directory (for distributions without a CA bundle) | | ui | activeContent | boolean | True | Allow Binary Ninja to connect to the web to check for updates | | ui | colorblind | boolean | True | Choose colors that are visible to those with red/green colorblind | | ui | debug | boolean | False | Enable developer debugging features (Additional views: Lifted IL, and SSA forms) | -| ui | recent-file-limit | integer | 10 | Specify limit for number of recent files | +| ui | recent-file-limit | integer | 10 | Specify limit for number of recent files | +| ui | scriptingProvider | string | "Python" | Specify the registered ScriptingProvider that controls the 'Console' in the UI | | pdb | local-store-absolute | string | "" | Absolute path specifying where the pdb symbol store exists on this machine, overrides relative path | -| pdb | local-store-relative | string | "symbols" | Path *relative* to the binaryninja _user_ directory, sepcifying the pdb symbol store | +| pdb | local-store-relative | string | "symbols" | Path *relative* to the binaryninja _user_ directory, sepcifying the pdb symbol store | | pdb | auto-download-pdb | boolean | True | Automatically download pdb files from specified symbol servers | | pdb | symbol-server-list | list(string) | ["http://msdl.microsoft.com/download/symbols"] | List of servers to query for pdb symbols. | | python | interpreter | string | "python27.{dylib,dll,so.1}" | Python interpreter to load if one is not already present when plugins are loaded | @@ -275,13 +281,13 @@ Settings are stored in the _user_ directory in the file `settings.json`. Each to Below is an example `settings.json` setting various options: ``` { - "ui" : - { - "activeContent" : false, - "colorblind" : false, - "debug" : true - "recent-file-limit" : 10 - } + "ui" : + { + "activeContent" : false, + "colorblind" : false, + "debug" : true + "recent-file-limit" : 10 + } "pdb" : { "local-store-absolute" : "C:\Symbols", @@ -290,6 +296,11 @@ Below is an example `settings.json` setting various options: } } ``` + +## Unicode Support + +Currently, Unicode support for Big Endian strings is very limited. Also, UTF-16 only supports Basic Latin code points. + ## Getting Support Vector 35 offers a number of ways to get Binary Ninja [support](https://binary.ninja/support/). |