diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2022-10-17 14:27:52 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2022-10-17 14:27:52 -0400 |
| commit | 6b09d4d92fbf4eec98ae1db42e57ba9d2a94de4c (patch) | |
| tree | 0f0a3f5866a4da102783836aa2458fb1cf101942 /docs | |
| parent | 4942700ca3387b64cc6443a80bac60b470588bb9 (diff) | |
fix images and some user manual links
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/concepts.md | 2 | ||||
| -rw-r--r-- | docs/dev/index.md | 6 | ||||
| -rw-r--r-- | docs/getting-started.md | 40 | ||||
| -rw-r--r-- | docs/guide/index.md | 70 | ||||
| -rw-r--r-- | docs/guide/plugins.md | 2 | ||||
| -rw-r--r-- | docs/guide/settings.md | 2 | ||||
| -rw-r--r-- | docs/index.md | 4 |
7 files changed, 63 insertions, 63 deletions
diff --git a/docs/dev/concepts.md b/docs/dev/concepts.md index eae79854..fc74e0e1 100644 --- a/docs/dev/concepts.md +++ b/docs/dev/concepts.md @@ -6,7 +6,7 @@ ILs in general are critical to how Binary Ninja analyzes binaries and we have mu APIs that query these mappings are plural. So for example, while `current_hlil.llil` will give a single mapping, `current_hlil.llils` will return a list that may contain multiple mappings. - + ## Operating on IL versus Native diff --git a/docs/dev/index.md b/docs/dev/index.md index d379de0d..983655c2 100644 --- a/docs/dev/index.md +++ b/docs/dev/index.md @@ -1,6 +1,6 @@ # Using the Binary Ninja API -Welcome to the Binary Ninja API documentation. Much like the [User Manual](/guide/), some larger sections have been split off into their own sections on the left, while the table of contents for this documentation is on the right. +Welcome to the Binary Ninja API documentation. Much like the [User Manual](./guide/index.html), some larger sections have been split off into their own sections on the left, while the table of contents for this documentation is on the right. ## Language Specific Bindings @@ -8,10 +8,10 @@ The Binary Ninja API is available through a [Core API](#core-api), through the [ ### Python API -The most heavily documented of all of the APIs, the Python API serves as a useful documentation for the other APIs. Here's a list of the most important Python API documentation resources: +The Python API is the most common third-party API and is used in many [public plugins](https://github.com/vector35/community-plugins). Here's a list of the most important Python API documentation resources: - [Writing Python Plugins](plugins.md) - - [Python API](https://api.binary.ninja/) + - [Python API Reference](https://api.binary.ninja/) (available offline via the Help menu) - [API Source](https://github.com/Vector35/binaryninja-api/tree/dev/python) ### Core API diff --git a/docs/getting-started.md b/docs/getting-started.md index 4fec347e..d7724f5c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,8 +1,8 @@ # Getting Started -Welcome to Binary Ninja. This introduction document is meant to quickly guide you over some of the most common uses of Binary Ninja. If you're interested in more detailed information, check out the [User Manual](/guide/). +Welcome to Binary Ninja. This introduction document is meant to quickly guide you over some of the most common uses of Binary Ninja. If you're interested in more detailed information, check out the [User Manual](guide/index.md). - + ## Installing Binary Ninja The download links you receive after purchasing expire after 72hrs but as long as you have [active support](https://binary.ninja/faq/#updates) you can [request download links](https://binary.ninja/recover/) any time! @@ -23,35 +23,35 @@ When you first run Binary Ninja, it will prompt you for your license key. You sh ## Opening Files -While there are [more ways than shown here](/guide/#loading-files), the most common ways to open a file are: +While there are [more ways than shown here](./guide/index.md#loading-files), the most common ways to open a file are: - Drag-and-drop - File Open - Run via CLI -But you can also change how analysis happens using [open with options](/guide/#loading-files). +But you can also change how analysis happens using [open with options](./guide/index.md#loading-files). ## UI Basics - + By default, you'll see four main areas in Binary Ninja: -1. Symbol List (one of many [sidebars](guide/#the-sidebar)) -1. [Cross References](guide/#cross-references-pane) -1. Main View (defaults to High Level IL and can have many [panes](guide/#tiling-panes)) -1. [Feature Map](guide/#feature-map) +1. Symbol List (one of many [sidebars](./guide/index.md#the-sidebar)) +1. [Cross References](./guide/index.md#cross-references-pane) +1. Main View (defaults to High Level IL and can have many [panes](./guide/index.md#tiling-panes)) +1. [Feature Map](guide/index.md#feature-map) -Not enabled by default but can be made visible is the global area which includes the [scripting console](guide/#script-python-console) and log window. +Not enabled by default but can be made visible is the global area which includes the [scripting console](guide/index.md#script-python-console) and log window. -Make sure to check out the many view options available in the various ☰ ("hamburger") menus. However, most configuration settings are available in the [settings](guide/#settings) menu. (`[CMD/CTRL] ,` is the hotkey for settings) +Make sure to check out the many view options available in the various ☰ ("hamburger") menus. However, most configuration settings are available in the [settings](./guide/index.md#settings) menu. (`[CMD/CTRL] ,` is the hotkey for settings) in the top right of each pane allows for additional customization, including locking the pane to a single function. ### Interacting - + -One of the most useful features of Binary Ninja is that everything can be quickly and easily accessed through a [command-palette](/guide/#command-palette) (`[CMD/CTRL] p`). You'll be surprised how often it saves you from looking through menus to find out just what you need. Also, any action in the command-palette can be changed to a [custom hotkey](/guide/#custom-hotkeys). That said, here are a few of the more useful default hotkeys: +One of the most useful features of Binary Ninja is that everything can be quickly and easily accessed through a [command-palette](./guide/index.md#command-palette) (`[CMD/CTRL] p`). You'll be surprised how often it saves you from looking through menus to find out just what you need. Also, any action in the command-palette can be changed to a [custom hotkey](./guide/index.md#custom-hotkeys). That said, here are a few of the more useful default hotkeys: - `[ESC]` : Navigate backward - `[SPACE]` : Toggle between linear view and graph view @@ -66,29 +66,29 @@ One of the most useful features of Binary Ninja is that everything can be quickl - `r` : Change the data type to single ASCII character - `o` : Create a pointer data type -For more hotkeys, see the [User Manual](/guide/). +For more hotkeys, see the [User Manual](./guide/index.md). ## Intermediate Languages -Binary Ninja is one of the most advanced binary analysis platforms, and it has a unique stack of related intermediate languages. If that gets you excited, you'll surely want to check out the [developer guide](/dev/bnil-overview.md) for more information. If it doesn't mean anything to you, no worries, here's a few tips to make your life easier. The default view is "High Level IL". It looks and reads almost like pseudo code. There's a few extra notations (usually just around comparisons for whether they are signed or not, or between moves of data indicating the size of the operation) but it should otherwise be very understandable. If you prefer disassembly or even [Pseudo C](/guide/#pseudo-c) as your default view, no worries, just check out the `UI`/`view.graph` and `view.linear` settings. +Binary Ninja is one of the most advanced binary analysis platforms, and it has a unique stack of related intermediate languages. If that gets you excited, you'll surely want to check out the [developer guide](./dev/bnil-overview.md) for more information. If it doesn't mean anything to you, no worries, here's a few tips to make your life easier. The default view is "High Level IL". It looks and reads almost like pseudo code. There's a few extra notations (usually just around comparisons for whether they are signed or not, or between moves of data indicating the size of the operation) but it should otherwise be very understandable. If you prefer disassembly or even [Pseudo C](./guide/index.md#pseudo-c) as your default view, no worries, just check out the `UI`/`view.graph` and `view.linear` settings. ## Using Plugins -Plugins can be installed by one of two methods. First, they can be manually installed by copying the plugin to the appropriate [folder](guide/#user-folder), or using the [Plugin Manager](guide/plugins.md#plugin-manager). +Plugins can be installed by one of two methods. First, they can be manually installed by copying the plugin to the appropriate [folder](./guide/index.md#user-folder), or using the [Plugin Manager](./guide/plugins.md#plugin-manager). ## Debugger Binary Ninja includes a debugger that can debug executables on Windows, Linux, and macOS. -For more detailed information, see the [debugger guide](/guide/debugger.md). +For more detailed information, see the [debugger guide](./guide/debugger.md). ## Updates -While Binary Ninja automatically updates itself, by default you will only use the Stable Branch and you can check out features much faster on the development branch using the [update channel](guide/#updates) dialog. +While Binary Ninja automatically updates itself, by default you will only use the Stable Branch and you can check out features much faster on the development branch using the [update channel](./guide/index.md#updates) dialog. ## What's next? -- Consider writing your first [plugin](/dev/) +- Consider writing your first [plugin](./dev/index.md) - Watch our [Binary Ninja Basics](https://www.youtube.com/watch?v=xKBQatwshs0&list=PLCVV6Y9LmwOgqqT5obf0OmN9fp5495bLr) videos -- Read the rest of the more detailed [User Manual](/guide/)
\ No newline at end of file +- Read the rest of the more detailed [User Manual](./guide/index.md)
\ No newline at end of file diff --git a/docs/guide/index.md b/docs/guide/index.md index e52bf5e4..21eacce5 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -52,7 +52,7 @@ The following files and folders may be created in the user folder but are not cr - `themes/`: For user themes or user-modified versions of official themes - `community-themes/`: Can also be used to store themes, useful to clone the [plugin theme collection](https://github.com/vector35/community-themes) directly into your user folder - + ### QSettings Locations @@ -74,7 +74,7 @@ Because Linux install locations can vary widely, we do not assume that Binary Ni You can load files in many ways: - + 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`) @@ -94,7 +94,7 @@ You can load files in many ways: ## Saving Files - + There are five menu items that can be used to save some combination of a raw file or a file's analysis information. Analysis information is saved into files that end in `.bndb` and have the same prefix as the original file. The default behavior for each of the "save" menu choices is described below: @@ -115,11 +115,11 @@ There are five menu items that can be used to save some combination of a raw fil 5. "Save Analysis Database With Options" - Allows for saving a `.bndb` without additional undo information, or by cleaning up some internal snapshot information to decrease the file size. - <!-- this image is getting floated down into the next section --> + <!-- this image is getting floated down into the next section --> ## Status Bar - <!-- this image needs updating to reflect new status bar --> + <!-- this image needs updating to reflect new status bar --> The status bar provides current information about the open file as well as some interactive controls. Summary features are listed below: @@ -152,14 +152,14 @@ Additionally, using the [open with options](#loading-files) feature allows for c ### Navigating - + Navigating code in Binary Ninja is usually a case of just double-clicking where you want to go. Addresses, references, functions, jump edges etc, can all be double-clicked to navigate. Additionally, the `g` hotkey can navigate to a specific address in the current view. Syntax for this field is very flexible. Full expressions can be entered including basic arithmetic, dereferencing, and name resolution (function names, data variable names, segment names, etc). Numerics default to hexadecimal but that can be controlled as well if you wish to use octal decimal or other base/radix. Full documentation on the syntax of this field can be found [here](https://api.binary.ninja/binaryninja.binaryview-module.html?highlight=parse_expression#binaryninja.binaryview.BinaryView.parse_expression). Additionally, middle-clicking (scroll-wheel clicking) items that can be double-clicked can be used to navigate to that location in a new Split Pane. Shift + middle-click can also be used to navigate to that location in a new Tab. These bindings can be configured in the Settings ([ui.middleClickNavigationAction](settings.md#ui.middleClickNavigationAction), [ui.middleClickShiftNavigationAction](settings.md#ui.middleClickShiftNavigationAction)). These "Split and Navigate" actions can also be accessed in the Context (right-click) menu, and can be separately bound to keys in the Keybindings view. ### The Sidebar - + Once you have a file open, the sidebar lets you quickly access the most common features and keeps them available while you work, including: - symbols @@ -173,7 +173,7 @@ Once you have a file open, the sidebar lets you quickly access the most common f ### Tiling Panes - + Binary Ninja displays binaries in panes, whether shown as disassembly, hex, IL, or decompiler output. Tiling these panes allows for a wide variety of information to be displayed at the same time. @@ -181,7 +181,7 @@ Each pane has display options at the top and can be split and synchronized with ### Feature Map - + The Feature Map is also displayed on the right of the main pane area. It provides a visual summary of the entire binary with different colors representing data variables, code, strings, functions/code, imports, externs, and libraries. It can be moved or hidden via the right-click menu. Note that these colors are theme-aware and will change if your theme does, but on the default dark-theme: @@ -193,13 +193,13 @@ The Feature Map is also displayed on the right of the main pane area. It provide - <span style="background-color: rgb(0, 0, 0); color: rgb(0, 0, 0);"> </span> Black is the base color when nothing else exists there ### Switching Views - <!-- this image needs updating to the pane header --> + <!-- this image needs updating to the pane header --> Switching views happens multiple ways. In some instances, it is 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 header at the top of each pane can be used to change views without navigating to any given location. ### Command Palette - + One great feature for quickly navigating through a variety of options and actions is the `command palette`. Inspired by similar features in [Sublime](https://sublime-text-unofficial-documentation.readthedocs.io/en/sublime-text-2/extensibility/command_palette.html) and [VS Code](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette), the command-palette is a front end into an application-wide, context-sensitive action system that all actions, plugins, and hotkeys in the system are routed through. @@ -207,7 +207,7 @@ To trigger it, simply use the `[CMD/CTRL] p` hotkey. Note that the command-palet ### Custom Hotkeys - + Any action in the [action system](#command-palette) can have a custom hotkey mapped to it. To access the keybindings menu, use the `[CMD/CTRL-SHIFT] b` hotkey, via the `Edit / Keybindings...` (`Binary Ninja / Preferences / Keybindings...` on macOS) menu, or the `Keybindings` [command palette](#command-palette) entry. Any overlapping keybindings will be highlighted. Click the `Keybinding` column header to sort by keybindings in order to see what bindings are overlapping. @@ -254,7 +254,7 @@ The settings themselves are saved directly in the `keybindings.json` file in you ### Graph View - + Binary Ninja offers a graph view that groups the basic blocks of disassembly into visually distinct blocks with edges showing control flow between them. @@ -277,7 +277,7 @@ Features of the graph view include: ### View Options - + Each of the views (Hex, Graph, Linear) have a variety of options configurable from the ☰ menu on the top right of the view pane. @@ -324,7 +324,7 @@ Current options include: ### Hex View - + The hexadecimal view is useful for viewing raw binary files that may or may not even be executable binaries and allows direct editing of the binary contents in place, regardless of the type of the binary. Any changes made in hex view will be reflected in all other [open views](#tiling-panes) of the same binary. The lock button on the right edge of the bottom status bar must be toggled off (🔓) to perform any direct editing in hex view -- this is to prevent unintended modification of the binary by accidental pasting or typing. @@ -337,7 +337,7 @@ The hex view is particularly good for transforming data in various ways via the The Cross References view in the lower-left section of the sidebar shows all cross-references to the currently selected address, address range, variable or type. This pane will change depending on whether an entire line is selected (all cross-references to that address/type/variable are shown), or whether a specific token within the line is selected. For instance if you click on the symbol `memmove` in `call memmove` it will display all known cross-references to `memmove`, whereas if you click on the line the `call` instruction is on, you will only get cross-references to the address of the call instruction. Cross-references can be either incoming or outgoing, and they can be either data, code, type, or variable. - + #### Code References @@ -360,7 +360,7 @@ The cross-references pane comes in two different layouts: tree-based (default an #### Table-based Layout - + The table-based layout provides field-based sorting and multi-select. Clicking the `Filter` text expands the filter pane, showing options for filtering the current results. @@ -375,13 +375,13 @@ The [`analysis.types.templateSimplifier`](settings.md#analysis.types.templateSim #### Cross-Reference Filtering - + The first of the two drop down boxes allows the selection of incoming, outgoing, or both incoming and outgoing (default). The second allows selection of code, data, type, or variable or any combination thereof. The text box allows regular expression matching of results. When a filter is selected the `Filter` display changes from `Filter (<total-count>)` to `Filter (<total-filtered>/<total-count>)` #### Cross-Reference Pinning - + By default Binary Ninja's cross-reference pane is dynamic, allowing quick navigation to relevant references. Sometimes you might rather have the current references stick around so they can be used as a sort of work-list. This workflow is supported in four different ways. First is the `Pin` checkbox (which is only visible if the `Filter` drop-down is open). This prevents the list of cross-references from being updated even after the current selection is changed. @@ -406,7 +406,7 @@ The following are only available when the cross-references pane is in focus: ### 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. @@ -414,7 +414,7 @@ Linear view is most commonly used for identifying and adding type information fo ### Symbols List - + The symbols list in Binary Ninja shows the list of symbols for functions and/or data variables currently identified. As large binaries are analyzed, the list may grow during analysis. The symbols list starts with known functions and data variables such as the entry point, exports, or using other features of the binary file format and explores from there to identify other functions and data variables. @@ -425,7 +425,7 @@ The symbols list highlights symbols according to whether they are functions or d ### Memory Map - + The "Memory Map" sidebar widget shows segments and sections currently present in the binary, allows some modification of automatically added sections, and allows adding, modifying, and deleting user segments and sections. @@ -437,7 +437,7 @@ The sorting order of segments and sections can be changed by clicking on any col ### Edit Function Properties Dialog - + The “Edit Function Properties” dialog provides the ability to easily configure some of a function’s more advanced properties. It can be opened via the context menu when a function is focused in the graph or linear views, or via the command palette. An overview of the UI is as follows: @@ -465,15 +465,15 @@ The “Edit Function Properties” dialog provides the ability to easily configu - View BNILs and assembly for the same file side-by-side - + - Settings to control the synchronization behavior - + - Right Click the Function Header for quick access to synchronization mode changes - + - Reflection currently presents in graph view only @@ -482,7 +482,7 @@ The “Edit Function Properties” dialog provides the ability to easily configu ### High Level IL - + Binary Ninja features a decompiler that produces High Level IL (HLIL) as output. HLIL is not intended to be a representation of the code in C, but some users prefer to have a more C-like scoping style. @@ -490,11 +490,11 @@ You can control the way HLIL appears in the settings. The different options are shown below: - + ### Pseudo C - + Binary Ninja offers an option to render the HLIL as a decompilation to "pseudo C". This decompilation is intended to be more familiar to the user than the HLIL. It is not necessarily intended to be "compliant" C or even recompilable. In some cases, it may be possible to edit it into a form that a C compiler will accept, but the amount of effort required will vary widely, and no guarantee is made that it will be possible in all cases. @@ -502,19 +502,19 @@ Binary Ninja offers an option to render the HLIL as a decompilation to "pseudo C Binary Ninja tries to be conservative with eliminating unused variables on the stack. When the analysis finds a variable that cannot be eliminated but does not appear to be used, the assignment will appear grayed out in the decompiler output. The first two lines of the function below show this: - + In this case, these variables are actually unused and can be eliminated. You can tell Binary Ninja to do this by right clicking on the variable and choosing "Allow" from the "Dead Store Elimination" submenu. - + Performing this action on both variables in the example results in the following output: - + ### Script (Python) Console - + The integrated script console is useful for small scripts that aren't worth writing as full plugins. @@ -523,7 +523,7 @@ To trigger the console, either use `<BACKTICK>`, or use the `View`/`Python Conso ???+ Warning "Tip" Note that `<BACKTICK>` will work in most contexts to open the console and focus its command line, unless the UI focus is in an editor widget. - + When both the Script Console and the Log view are open, the title of both acts as a tab that can be dragged to either a tabbed view showing only one at a time (the default) or a split view showing both. Currently, the console and log views are part of a "Global Area", meaning they are always visible in the same position when switching between open binary tabs in the same window. This means they can only dock with each other, and not with the sidebar or the main pane view area. It is possible to open additional scripting consoles via the `Create Python Console` action in the [command palette](#command-palette), and these new consoles will appear as additional tabs in the topmost, leftmost tab in the global area. Note that `<BACKTICK>` will always focus the original main scripting console, and while any of the other created consoles can be closed (using the button that will appear when hovering over the right edge of its tab), the original one cannot be closed. @@ -591,7 +591,7 @@ defined within the console, but within the script, it will be set to the absolut Any variables or functions defined globally within the script will be available within the console, and to future scripts. #### Python Debugging -See the [plugin development guide](/dev/plugins.md#debugging-python). +See the [plugin development guide](../dev/plugins.md#debugging-python). Note ???+ Warning "Tip" diff --git a/docs/guide/plugins.md b/docs/guide/plugins.md index dc804d2e..fed781ed 100644 --- a/docs/guide/plugins.md +++ b/docs/guide/plugins.md @@ -111,4 +111,4 @@ Additionally, running a python plugin with an environment variable of `BN_DISABL ## Writing Plugins -See the [developer documentation](../dev/) for documentation on creating plugins. +See the [developer documentation](../dev/index.md) for documentation on creating plugins. diff --git a/docs/guide/settings.md b/docs/guide/settings.md index 9071ec41..b60c9d0e 100644 --- a/docs/guide/settings.md +++ b/docs/guide/settings.md @@ -2,7 +2,7 @@ ## UI - + Binary Ninja provides various settings which are available via the `[CMD/CTRL] ,` hotkey. These settings allow a wide variety of customization of the user interface and functional aspects of the analysis environment. diff --git a/docs/index.md b/docs/index.md index d3422274..1e6f5daf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,7 +7,7 @@ A new kind of reverse engineering platform [Binary Ninja](https://binary.ninja/) is a reverse engineering platform. It focuses on a clean and easy to use interface with a powerful multithreaded analysis built on a custom IL to quickly adapt to a variety of architectures, platforms, and compilers. - To quickly get started as a new user, check out our [getting started guide](getting-started.md). -- More in-depth user questions are probably answered in our [user manual](/guide/index.md). -- Anyone wanting to get started with our powerful API should check out the [developer section](/dev/index.md). Note that this section is different from our API reference for [Python](https://api.binary.ninja/), [CPP](https://api.binary.ninja/cpp/), and [Rust](https://rust.binary.ninja/binaryninja/). +- More in-depth user questions are probably answered in our [user manual](./guide/index.md). +- Anyone wanting to get started with our powerful API should check out the [developer section](./dev/index.md). Note that this section is different from our API reference for [Python](https://api.binary.ninja/), [CPP](https://api.binary.ninja/cpp/), and [Rust](https://rust.binary.ninja/binaryninja/). Of course, if you just have some questions, you might find our [discussions](https://github.com/Vector35/binaryninja-api/discussions) forum helpful, search [search our public issue tracker](https://github.com/Vector35/binaryninja-api/issues) or join the more interactive [slack channel](https://slack.binary.ninja/). |