From 1e6336e12229add2f1716019d1b050c7f989dbaa Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Mon, 20 Aug 2018 08:12:56 -0400 Subject: update user docs example to use dest.name --- docs/dev/bnil-llil.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/dev') diff --git a/docs/dev/bnil-llil.md b/docs/dev/bnil-llil.md index 7748d140..4f5ff0c3 100644 --- a/docs/dev/bnil-llil.md +++ b/docs/dev/bnil-llil.md @@ -143,7 +143,7 @@ Now with some knowledge of the `LowLevelIL` class lets try to do something with ``` >>> for block in current_function.low_level_il: ... for instr in block: -... if instr.operation == LowLevelILOperation.LLIL_SET_REG and instr.dest == 'rdx': +... if instr.operation == LowLevelILOperation.LLIL_SET_REG and instr.dest.name == 'rdx': ... print instr.address, instr.instr_index, instr ... 4196490 14 rdx = [rax].q -- cgit v1.3.1 From a173cda05dcc95c352e6659398de257978efa4c5 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Mon, 27 Aug 2018 16:23:36 -0400 Subject: fix mkdoc command --- docs/dev/documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/dev') diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index 830bd4ec..16a1c9ee 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -27,7 +27,7 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li Changing documentation for the API itself is fairly straight forward. Use [doxygen style comment blocks](https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html) in C++ and C, and [restructured text blocks](http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html) for python for the source. The user documentation is located in the `api/docs/` folder and the API documentation is generated from the config in the `api/api-docs` folder. !!! Tip "Tip" - When updating user documentation, the `mkdoc serve` feature is particularly helpful. + When updating user documentation, the `mkdocs serve` feature is particularly helpful. [contribution license agreement]: https://binary.ninja/cla.pdf [Vector 35]: https://vector35.com/ -- cgit v1.3.1 From 6a62aa029f791d848f91b4ce514fca127d4a9afe Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Mon, 27 Aug 2018 19:10:25 -0400 Subject: move img files for new mkdocs version --- docs/dev/bnil-llil.md | 4 ++-- docs/getting-started.md | 26 +++++++++++++------------- docs/img/BNIL.png | Bin 0 -> 297068 bytes docs/img/analysis.png | Bin 0 -> 13094 bytes docs/img/console.png | Bin 0 -> 59637 bytes docs/img/functionlist.png | Bin 0 -> 19729 bytes docs/img/graphcontext.png | Bin 0 -> 69458 bytes docs/img/graphview.png | Bin 0 -> 135390 bytes docs/img/hex.png | Bin 0 -> 168621 bytes docs/img/license-popup.png | Bin 0 -> 51346 bytes docs/img/linear.png | Bin 0 -> 194106 bytes docs/img/llil_option.png | Bin 0 -> 29139 bytes docs/img/logo.png | Bin 0 -> 15720 bytes docs/img/options.png | Bin 0 -> 44410 bytes docs/img/preferences.png | Bin 0 -> 72367 bytes docs/img/recent.png | Bin 0 -> 157450 bytes docs/img/view-choices.png | Bin 0 -> 69839 bytes docs/img/xrefs.png | Bin 0 -> 17078 bytes 18 files changed, 15 insertions(+), 15 deletions(-) create mode 100644 docs/img/BNIL.png create mode 100644 docs/img/analysis.png create mode 100644 docs/img/console.png create mode 100644 docs/img/functionlist.png create mode 100644 docs/img/graphcontext.png create mode 100644 docs/img/graphview.png create mode 100644 docs/img/hex.png create mode 100644 docs/img/license-popup.png create mode 100644 docs/img/linear.png create mode 100644 docs/img/llil_option.png create mode 100644 docs/img/logo.png create mode 100644 docs/img/options.png create mode 100644 docs/img/preferences.png create mode 100644 docs/img/recent.png create mode 100644 docs/img/view-choices.png create mode 100644 docs/img/xrefs.png (limited to 'docs/dev') diff --git a/docs/dev/bnil-llil.md b/docs/dev/bnil-llil.md index 4f5ff0c3..71cedd96 100644 --- a/docs/dev/bnil-llil.md +++ b/docs/dev/bnil-llil.md @@ -2,7 +2,7 @@ The Binary Ninja Intermediate Language (BNIL) is a semantic representation of the assembly language instructions for a native architecture in Binary Ninja. BNIL is actually a family of intermediate languages that work together to provide functionality at different abstraction layers. This developer guide is intended to cover some of the mechanics of the LLIL to distinguish it from the other ILs in the BNIL family. -![BNIL-LLIL Selected](/images/BNIL.png) +![BNIL-LLIL Selected](/img/BNIL.png) The Lifted IL is very similar to the LLIL and is primarily of interest for Architecture plugin authors. If you're writing an analysis plugin, you'll always want to be working at LLIL or higher. During each stage of the lifting process a number of transformations take place, and each layer of IL can have different instructions. Because of this, you can not rely on an instruction from one layer existing in another. @@ -10,7 +10,7 @@ The Lifted IL is very similar to the LLIL and is primarily of interest for Archi Since doing is the easiest way to learn lets start with a simple example binary and step through analyzing it using the python console. -![Low Level IL Option >](/images/llil_option.png) +![Low Level IL Option >](/img/llil_option.png) - Download [chal1](../files/chal1) and open it with Binary Ninja - Next, bring up the `Low Level IL` view by clicking in the options pane at the bottom of the screen diff --git a/docs/getting-started.md b/docs/getting-started.md index 2d543b75..b3c07f9c 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 popup >](/images/license-popup.png "License Popup") +![license popup >](/img/license-popup.png "License Popup") ## 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. -![recent files](/images/recent.png "Recent Files") +![recent files](/img/recent.png "Recent Files") ## Analysis -![auto analysis ><](/images/analysis.png "Auto Analysis") +![auto analysis ><](/img/analysis.png "Auto 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. -![graph view](/images/view-choices.png "Different Views") +![graph view](/img/view-choices.png "Different Views") 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 -![graph view](/images/graphview.png "Graph View") +![graph view](/img/graphview.png "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. -![graph view context >](/images/graphcontext.png "Graph View Contet Menu") +![graph view context >](/img/graphcontext.png "Graph View Contet Menu") Features of the graph view include: @@ -129,7 +129,7 @@ Features of the graph view include: ### View Options -![options ><](/images/options.png "options") +![options ><](/img/options.png "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 -![hex >](/images/hex.png "hex view") +![hex >](/img/hex.png "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,7 +170,7 @@ Note that any changes made in the Hex view will take effect immediately in any o ### Xrefs View -![xrefs >](/images/xrefs.png "xrefs") +![xrefs >](/img/xrefs.png "xrefs") 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. @@ -178,7 +178,7 @@ One fun trick that the xrefs view has up its sleeve: when in [Hex View](#hexview ### Linear View -![linear](/images/linear.png "linear view") +![linear](/img/linear.png "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 -![function list >](/images/functionlist.png "Function List") +![function list >](/img/functionlist.png "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 -![console >](/images/console.png "Console") +![console >](/img/console.png "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 -![preferences >](/images/preferences.png "Preferences") +![preferences >](/img/preferences.png "Preferences") 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. diff --git a/docs/img/BNIL.png b/docs/img/BNIL.png new file mode 100644 index 00000000..37fc9997 Binary files /dev/null and b/docs/img/BNIL.png differ diff --git a/docs/img/analysis.png b/docs/img/analysis.png new file mode 100644 index 00000000..088d4f32 Binary files /dev/null and b/docs/img/analysis.png differ diff --git a/docs/img/console.png b/docs/img/console.png new file mode 100644 index 00000000..e4401dea Binary files /dev/null and b/docs/img/console.png differ diff --git a/docs/img/functionlist.png b/docs/img/functionlist.png new file mode 100644 index 00000000..2fb2d475 Binary files /dev/null and b/docs/img/functionlist.png differ diff --git a/docs/img/graphcontext.png b/docs/img/graphcontext.png new file mode 100644 index 00000000..d453f5e1 Binary files /dev/null and b/docs/img/graphcontext.png differ diff --git a/docs/img/graphview.png b/docs/img/graphview.png new file mode 100644 index 00000000..0d190a9f Binary files /dev/null and b/docs/img/graphview.png differ diff --git a/docs/img/hex.png b/docs/img/hex.png new file mode 100644 index 00000000..f30440a6 Binary files /dev/null and b/docs/img/hex.png differ diff --git a/docs/img/license-popup.png b/docs/img/license-popup.png new file mode 100644 index 00000000..d61b2b13 Binary files /dev/null and b/docs/img/license-popup.png differ diff --git a/docs/img/linear.png b/docs/img/linear.png new file mode 100644 index 00000000..8eaeb50f Binary files /dev/null and b/docs/img/linear.png differ diff --git a/docs/img/llil_option.png b/docs/img/llil_option.png new file mode 100644 index 00000000..ee42c3b9 Binary files /dev/null and b/docs/img/llil_option.png differ diff --git a/docs/img/logo.png b/docs/img/logo.png new file mode 100644 index 00000000..c1e1ecb1 Binary files /dev/null and b/docs/img/logo.png differ diff --git a/docs/img/options.png b/docs/img/options.png new file mode 100644 index 00000000..10af6920 Binary files /dev/null and b/docs/img/options.png differ diff --git a/docs/img/preferences.png b/docs/img/preferences.png new file mode 100644 index 00000000..29b3033e Binary files /dev/null and b/docs/img/preferences.png differ diff --git a/docs/img/recent.png b/docs/img/recent.png new file mode 100644 index 00000000..13f3ebe7 Binary files /dev/null and b/docs/img/recent.png differ diff --git a/docs/img/view-choices.png b/docs/img/view-choices.png new file mode 100644 index 00000000..9ea16dcf Binary files /dev/null and b/docs/img/view-choices.png differ diff --git a/docs/img/xrefs.png b/docs/img/xrefs.png new file mode 100644 index 00000000..ab7f056f Binary files /dev/null and b/docs/img/xrefs.png differ -- cgit v1.3.1