summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2025-04-03 13:36:47 -0400
committerJordan Wiens <jordan@psifertex.com>2025-04-03 13:36:47 -0400
commit6d5500db005aa69f29518c2eb7a363ceca48499b (patch)
tree823adfdaa140b571ae54051269cf58971d560cd6 /docs
parent4a42eac06f51f5e84f5ed3f155afb5613d4a0424 (diff)
default image width narrower on fwn docs
Diffstat (limited to 'docs')
-rw-r--r--docs/guide/firmwareninja.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/guide/firmwareninja.md b/docs/guide/firmwareninja.md
index 8908b19b..db49e99f 100644
--- a/docs/guide/firmwareninja.md
+++ b/docs/guide/firmwareninja.md
@@ -1,6 +1,6 @@
# Firmware Ninja
-Firmware Ninja speeds up firmware analysis by offering analytical capabilities tailored to the complexities of
+Firmware Ninja (FWN) speeds up firmware analysis by offering analytical capabilities tailored to the complexities of
embedded reverse engineering.
???+ Important "Supported Editions"
@@ -9,7 +9,7 @@ embedded reverse engineering.
## Entropy Analysis
Firmware Ninja provides an entropy analysis tool that aids in triaging raw binaries to identify code and data regions
-and to discover “interesting” blobs. This tool can also be used to quickly create sections within file-backed memory
+and to discover "interesting" blobs. This tool can also be used to quickly create sections within file-backed memory
regions.
### Identifying Memory Regions
@@ -17,7 +17,7 @@ regions.
To run entropy analysis, open the Firmware Ninja sidebar widget, navigate to the `File Entropy` tab, and click the
`Run Analysis` button.
-![Entropy Analysis](../img/firmwareninja/fwn-entropy-sections.png "Entropy Analysis")
+![Entropy Analysis](../img/firmwareninja/fwn-entropy-sections.png "Entropy Analysis"){ width="600" }
Adjust the block size and code threshold sliders to change the granularity of the entropy analysis. The block size
determines the size of the blocks that the file is divided into for entropy calculations. The code threshold
@@ -36,7 +36,7 @@ To create sections, shift-click and select one or more rows in the entropy table
`Create Section from Selected Regions`. The top color-coded bar below the entropy table visualizes memory regions
identified by entropy analysis, while the bottom bar displays the sections created within the file-backed memory.
-![Entropy Bars](../img/firmwareninja/fwn-entropy-bars.png "Entropy Bars")
+![Entropy Bars](../img/firmwareninja/fwn-entropy-bars.png "Entropy Bars"){ width="600" }
## Memory Insights
@@ -49,7 +49,7 @@ repeated reads and writes to specific locations, and other indicative behaviors.
To run memory insights analysis, navigate to the `Memory Insights` tab and click the `Run Analysis` button. Memory
insights analysis can take some time to complete, depending on the size of the binary.
-![Memory Insights](../img/firmwareninja/fwn-memory-insights.png "Memory Insights")
+![Memory Insights](../img/firmwareninja/fwn-memory-insights.png "Memory Insights"){ width="600" }
Use the search bar to filter results by address, value, function name, or section name. Results can also be ordered by
clicking the column headers. A description of each column is provided in the table below:
@@ -70,7 +70,7 @@ Reference trees visualize which functions and data variables are capable of acce
and how they are related. To generate reference trees, click the `Show/Hide Reference Tree` button and select a
cell in the `Section`, `Function`, or `Access` column of the memory insights results table.
-![Reference Trees](../img/firmwareninja/fwn-reference-tree.png "Reference Trees")
+![Reference Trees](../img/firmwareninja/fwn-reference-tree.png "Reference Trees"){ width="600" }
Reference trees can be constrained by the value written to the accessed location. To do this, select a cell in the
`Value` column containing a constant value. Only reference trees that write that value to the accessed location will be
@@ -84,9 +84,9 @@ can be used to rapidly create sections to represent memory regions that are not
### Selecting a Board
-If you know the target board, navigate to the `Board Description` tab and select the board in the dropdown menu.
+If you know the target board, navigate to the `Board Description` tab and select the board in the drop-down menu.
-![Select Board](../img/firmwareninja/fwn-select-board.png "Select Board")
+![Select Board](../img/firmwareninja/fwn-select-board.png "Select Board"){ width="600" }
Once a board is selected, information about each of the board's hardware peripherals is displayed. To create memory
regions for the peripherals, shift-click and select one or more rows in the table. Right-click and select `Create
@@ -101,7 +101,7 @@ memory regions for selected devices`.
### Auto Identifying a Board
-![Auto Identify Board >](../img/firmwareninja/fwn-auto-identify-board.png "Auto Identify Board"){ width="400"}
+![Auto Identify Board >](../img/firmwareninja/fwn-auto-identify-board.png "Auto Identify Board"){ width="400" }
If you are unsure of the target board, click the `Auto Identify Board` button. Firmware Ninja attempts to identify the
target board by comparing access locations found in the memory insights analysis against known memory-mapped I/O
@@ -119,11 +119,11 @@ Firmware Ninja's relationships tool provides a way to model both inter-binary an
functions, data variables, symbols, and memory addresses. This tool facilitates navigation between related items
internal to a single binary or across multiple binaries in a Binary Ninja project.
-![Relationships](../img/firmwareninja/fwn-relationships.png "Relationships")
+![Relationships](../img/firmwareninja/fwn-relationships.png "Relationships"){ width="600" }
### Creating a Relationship
-![Create Relationship >](../img/firmwareninja/fwn-create-relationship.png "Create Relationship"){width="300"}
+![Create Relationship >](../img/firmwareninja/fwn-create-relationship.png "Create Relationship"){ width="300" }
To create a new relationship, right-click and select `Create relationship`. This opens a dialog where you can define
the primary entity, secondary entity, and description of the relationship.