diff options
| author | Brian Potchik <brian@vector35.com> | 2021-02-24 15:41:43 -0500 |
|---|---|---|
| committer | Brian Potchik <brian@vector35.com> | 2021-02-24 15:41:43 -0500 |
| commit | 9d92d7324f56ca8a1e85b4b8431ac2abe53e9730 (patch) | |
| tree | 3f778f6182dd9cf4f6df776dd1483a7a7281619c /docs | |
| parent | fc46da97279b18d0d682e3e9b78b39d9c7c98836 (diff) | |
Miscellaneous getting started guide updates.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting-started.md | 23 | ||||
| -rw-r--r-- | docs/img/analysis.png | bin | 13094 -> 0 bytes | |||
| -rw-r--r-- | docs/img/open-with-options.png | bin | 175219 -> 121934 bytes | |||
| -rw-r--r-- | docs/img/status-bar.png | bin | 0 -> 14944 bytes | |||
| -rw-r--r-- | docs/img/view-choices.png | bin | 46334 -> 28602 bytes |
5 files changed, 21 insertions, 2 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index 1c61605d..632fd9a7 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -54,7 +54,7 @@ You can load files in many ways:  -1. Drag-and-drop a file onto the Binary Ninja window +1. Drag-and-drop a file onto the Binary Ninja window (hold `[CMD/CTRL-SHIFT]` while dropping to use the `Open with Options` workflow) 2. Use the `File/Open` menu or `Open` button on the start screen (`[CMD/CTRL] o`) 3. Use the `File/Open with Options` menu which allows you to customize the analysis options (`[CMD/CTRL-SHIFT] o`) 4. Open a file from the Triage picker (`File/Open for Triage`) which enables several minimal analysis options and shows a summary view first @@ -69,14 +69,33 @@ You can load files in many ways: * URLs For referencing remote file files either the url should be prefixed with `binaryninja:` and optionally suffixed with the `expr` query parameter * `binaryninja:file://<remote_path>?expr=[.data + 400]` - Download the remote file and navigate to the address at `.data` plus `0x400` +## Status Bar + + + +The status bar provides current information about the open file as well as some interactive controls. Summary features are listed below: + +* Update Notification - perform updates, download status, and restart notification +* Analysis progress - ongoing analysis progress of current active file +* Cursor offset or selection +* BinaryView Switcher +* View Layer Selection - present a layer of analysis information from the BinaryView (e.g. hex, graph, linear, strings, types, etc.) +* File Contents Lock - interactive control to prevent accidental changes to the underlying file + ## Analysis - + As soon as you open a file, Binary Ninja begins its auto-analysis which is fairly similar to decompiling the entire binary. Even while Binary Ninja is analyzing a binary, the UI should be responsive. Not only that, but because the analysis prioritizes user-requested analysis, you can start navigating a binary immediately and wherever you are viewing will be prioritized for analysis. The current progress through a binary is shown in the status bar (more details are available via `bv.analysis_info` in the Python console), but note that the total number of items left to analyze will go up as well as the binary is processed and more items are discovered that require analysis. +Analysis proceeds through several phases summarized below: + +* Phase 1 - Initial Recursive Descent +* Phase 2 - Call Target Analysis (Part of Linear Sweep) +* Phase 3.x - Control Flow Graph Analysis (Part of Linear Sweep) + Errors or warnings during the load of the binary are also shown in the status bar, along with an icon (in the case of the image above, a large number of warnings were shown). The most common warnings are from incomplete lifting and can be safely ignored. If the warnings include a message like `Data flow for function at 0x41414141 did not terminate`, then please report the binary to the [bug database](https://github.com/Vector35/binaryninja-api/issues). ### Analysis Speed diff --git a/docs/img/analysis.png b/docs/img/analysis.png Binary files differdeleted file mode 100644 index 088d4f32..00000000 --- a/docs/img/analysis.png +++ /dev/null diff --git a/docs/img/open-with-options.png b/docs/img/open-with-options.png Binary files differindex 35a4f29f..c7f85e10 100644 --- a/docs/img/open-with-options.png +++ b/docs/img/open-with-options.png diff --git a/docs/img/status-bar.png b/docs/img/status-bar.png Binary files differnew file mode 100644 index 00000000..cb0cdd4a --- /dev/null +++ b/docs/img/status-bar.png diff --git a/docs/img/view-choices.png b/docs/img/view-choices.png Binary files differindex 506ab670..da807965 100644 --- a/docs/img/view-choices.png +++ b/docs/img/view-choices.png |
