You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guide/kernelcache.md
+14-13Lines changed: 14 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
Kernel Cache support in Binary Ninja provides you with tools to selectively load specific images, search for
4
4
specific symbols, and follow analysis references between any images loaded from an `kernelcache` in one view.
5
5
6
-
Our support for `kernelcache` is largely open source. The supporting code can can be found in our public API repository [here](https://github.com/Vector35/binaryninja-api/tree/dev/view/kernelcache). Instructions for setting up your development environment and building plugins like this yourself can be found in our [Developer Guide](../dev/plugins.md#writing-native-plugins). Contributions are welcome!
6
+
Our support for `kernelcache` is largely open source. The supporting code can be found in our public API repository [here](https://github.com/Vector35/binaryninja-api/tree/dev/view/kernelcache). Instructions for setting up your development environment and building plugins like this yourself can be found in our [Developer Guide](../dev/plugins.md#writing-native-plugins). Contributions are welcome!
7
7
8
8
## Support Matrix
9
9
@@ -18,36 +18,37 @@ List of supported features for the given `kernelcache` targets:
18
18
-**Core**: Core functionality, such as loading, navigating, and analyzing `kernelcache` files.
19
19
-**Objective-C**: Support for analyzing Objective-C information and symbols within the `kernelcache`.
20
20
21
-
**Note:***In general, this plugin does not support `kernelcache` files that are not in `MH_FILESET` format at this time.*
21
+
???+ Note "Note"
22
+
This plugin currently only supports `kernelcache` files in the `MH_FILESET` format.
22
23
23
24
## Obtaining a Kernel Cache
24
25
25
-
The `kernelcache` is a file that contains all the kernel and all of its extensions used by modern Apple operating systems (like macOS, iOS, and tvOS). These can be obtained directly from Apple, or with the help of a tool such as `blacktop/ipsw`.
26
+
The `kernelcache` is a file that contains all of the kernel and its extensions used by modern Apple operating systems like macOS, iOS, and tvOS. These can be obtained directly from Apple, or with the help of a tool such as [`blacktop/ipsw`](#using-blacktopipsw).
26
27
27
28
A `kernelcache` should typically be automatically decompressed by Binary Ninja. If automatic decompression fails, Binary Ninja can still load
28
29
caches decompressed by other tools as long as they are valid `MH_FILESET` Mach-O files.
29
30
30
-
### With`blacktop/ipsw`
31
+
### Using`blacktop/ipsw`
31
32
32
-
Our recommended way to retrieve a `kernelcache` is using blacktop's wonderful [`ipsw` tool](https://github.com/blacktop/ipsw).
33
+
Our recommended way to retrieve a `kernelcache` is using blacktop's [`ipsw` tool](https://github.com/blacktop/ipsw).
2. Run `ipsw download ipsw --version [target iOS version] --device [target device model (e.g. iPhone10,3)]`
36
37
3. Run `ipsw extract --kernel [filename]`
37
38
38
-
### From Local macOS Install
39
+
### Local macOS Install
39
40
40
-
Getting to the local `kernelcache` on macOS is not the easiest. Try some of the following:
41
+
Getting to the local `kernelcache` on macOS depends on the specific version. Try some of the following:
41
42
42
-
*`/System/Library/Kernel/`, which should have the `kernel`, but not necessarily the extensions
43
-
*`/System/Library/Extensions/` should have each of the individual extensions
44
-
*`/System/Library/PrelinkedKernels/`, which should have the full `kernelcache`, but may not exist on earlier versions of macOS
45
-
*`/System/Library/Caches/com.apple.kernelcaches/`, which may be empty
46
-
*`/System/Library/Caches/com.apple.kext.caches/Startup/kernelcache/`, which may be empty
43
+
*`/System/Library/Kernel/`, which should have the `kernel`, but not necessarily the extensions
44
+
*`/System/Library/Extensions/` should have each of the individual extensions
45
+
*`/System/Library/PrelinkedKernels/`, which should have the full `kernelcache`, but may not exist on earlier versions of macOS
46
+
*`/System/Library/Caches/com.apple.kernelcaches/`, which may be empty
47
+
*`/System/Library/Caches/com.apple.kext.caches/Startup/kernelcache/`, which may be empty
47
48
48
49
## Interacting With a Kernel Cache
49
50
50
-
After opening a `kernelcache`, you will be provided a custom binary view. Due to the large size of these files, we do not load all the information into the binary view by default. Instead, we do this selectively.
51
+
After opening a `kernelcache`, you will be provided a custom binary view. Due to the large size of these files, we do not load all the information into the binary view by default. Instead, this is done on-demand and selectively.
0 commit comments