summaryrefslogtreecommitdiff
path: root/view/minidump/README.md
diff options
context:
space:
mode:
authorMason Reed <mason@vector35.com>2026-04-21 18:10:51 -0700
committerMason Reed <35282038+emesare@users.noreply.github.com>2026-05-10 17:13:08 -0700
commitc4ba6d79ae3b96d56cc6b3744e7c64e004ecd161 (patch)
tree5762fc3ff58b57caec5f42176faf6635c464b4f3 /view/minidump/README.md
parent8269a8ac29e59c7949af753dac5c1f36bb700903 (diff)
[Rust] Refactor `binary_view` module
- Remove the "viral" `BinaryViewExt` trait and its blanket impl - Split up the binary view type from the custom trait impl - Simplify and fix bugs regarding custom binary view initialization - Rewrite Minidump binary view example, parses the PE headers to create proper sections now - Add some extra documentation - Add unit test for custom binary view
Diffstat (limited to 'view/minidump/README.md')
-rw-r--r--view/minidump/README.md38
1 files changed, 2 insertions, 36 deletions
diff --git a/view/minidump/README.md b/view/minidump/README.md
index 3c54ca8e..799cf4b9 100644
--- a/view/minidump/README.md
+++ b/view/minidump/README.md
@@ -1,21 +1,6 @@
-# Binary Ninja Minidump Loader
+# Binary Ninja Minidump View
-A Minidump memory dump loader plugin for Binary Ninja.
-
-![Screenshot of Binary Ninja using the "Minidump" Binary View, with a minidump loaded and the virtual addresses of the memory segments of the minidump showing in the Memory Map window](images/loaded-minidump-screenshot-border.png)
-
-This plugin adds a new _Minidump_ binary view type. When a binary with the magic number `MDMP` is opened, this plugin will automatically try to load in the binary as a minidump, and create a new _Minidump_ binary view to view the contents.
-
-The architecture is determined automatically from the platform information embedded in the minidump.
-
-![Screenshot showing the Minidump binary view type in the dropdown list of available binary views for an open binary](images/minidump-binary-view-type-screenshot-border.png)
-
-The loaded minidump's memory regions and modules can be navigated via the _Memory Map_ window. In the _Minidump_ binary view, the meanings of "Segments" and "Sections" in the Memory Map window are modified to mean the following:
-
-- The memory regions in the minidump are loaded as _Segments_. The _Data Offset_ and _Data Length_ fields of each segment are the corresponding addresses in the minidump file where the data for that memory region is located.
-- The modules in the minidump are loaded as _Sections_, with the name of each section being the path to the module.
-
-![Screenshot showing the Memory Map window with the loaded minidump's memory segments and modules (i.e. "sections")](images/minidump-segments-sections-screenshot-border.png)
+A Minidump binary view plugin for Binary Ninja.
## Supported Minidump Types
@@ -44,22 +29,3 @@ minidump dumpfile.dmp
- Loading Minidump files from platforms or APIs other than Windows' `MinidumpWriteDump`, such as those generated by [Google Breakpad](https://chromium.googlesource.com/breakpad/breakpad/).
- Loading and applyng debug information from the minidump file. In Windows minidump files, `MinidumpModuleList` streams contain information about the PDB file which contains the debug information for the module; this isn't currently read or applied, however.
-- Integration with Binary Ninja's built-in debugger. Minidump files can contain information about threads, register values, and stack frames, and it would be nice in the future for minidump files to be loadable back into the debugger in order to resume a debugging session. This isn't currently done, however.
-
-## Building and Installing
-
-This plugin currently needs to be built from source, then copied into your user plugin folder.
-
-```
-cargo build --release
-cp target/release/libminidump_bn.so ~/.binaryninja/plugins/
-```
-
-The code in this plugin targets the `dev` branch of the [Binary Ninja Rust API](https://github.com/Vector35/binaryninja-api/tree/dev/rust).
-
-To update the Binary Ninja Rust API dependency:
-
-```
-cargo update -p binaryninja
-cargo build --release
-``` \ No newline at end of file