Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neil-wu/SwiftDump
SwiftDump is a command-line tool for retriving the Swift Object info from Mach-O file.
https://github.com/neil-wu/SwiftDump
Last synced: 29 days ago
JSON representation
SwiftDump is a command-line tool for retriving the Swift Object info from Mach-O file.
- Host: GitHub
- URL: https://github.com/neil-wu/SwiftDump
- Owner: neil-wu
- License: other
- Created: 2020-07-05T09:18:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-18T02:54:54.000Z (over 1 year ago)
- Last Synced: 2024-10-22T16:44:19.217Z (about 2 months ago)
- Language: Swift
- Size: 1.27 MB
- Stars: 396
- Watchers: 16
- Forks: 56
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios-security - SwiftDump - A command-line tool for retriving the Swift Object info from Mach-O file. (Tools / Reverse Engineering Tools)
- awesome-hacking-lists - neil-wu/SwiftDump - SwiftDump is a command-line tool for retriving the Swift Object info from Mach-O file. (Swift)
README
#### SwiftDump
##### [中文文档](./README_zh.md)
SwiftDump is a command-line tool for retriving the Swift Object info from Mach-O file. Similar to [class-dump](https://github.com/nygard/class-dump/), but the difference is that SwiftDump focus on swift 5 objects. For Mach-O files mixed with Objective-C and swift, you can combine class-dump with SwiftDump.
There is alos a [Frida](https://www.frida.re/) version named [FridaSwiftDump](https://github.com/neil-wu/FridaSwiftDump/).
You can either use`SwiftDump` for a Mach-O file or `FridaSwiftDump` for a foreground running app.
If you are curious about the Mach-O format, check the image at the bottom of this article.
#### Usage
``` Text
USAGE: SwiftDump [--debug] [--arch ] [--version]
ARGUMENTS:
MachO File
OPTIONS:
-d, --debug Show debug log.
-a, --arch Choose architecture from a fat binary (only support x86_64/arm64).
(default: arm64)
-v, --version Version
-h, --help Show help information.
```
* SwiftDump ./TestMachO > result.txt
* SwiftDump -a x86_64 ./TestMachO > result.txt
#### Features
* Written entirely in swift, the project is tiny
* Dump swift 5 struct/class/enum/protocol
* Parse enum with payload case
* Support inheritance and protocol
* Since it is written in swift, the mangled names are demangled by swift's runtime function, such as `swift_getTypeByMangledNameInContext` and `swift_demangle_getDemangledName`.
Thanks to the runtime function, SwiftDump can demangle complex type, such as RxSwift variable. For example,
`RxSwift.Queue<(eventTime: Foundation.Date, event: RxSwift.Event)>`
#### TODO
* Parse swift function address
* More
#### Compile
1. Clone the repo
2. Open SwiftDump.xcodeproj with Xcode
3. Modify 'Signing & Capabilities' to use your own id
4. Build & Run
The default Mach-O file path is `Demo/test`, you can change it in `Xcode - Product - Scheme - Edit Scheme - Arguments`
(Tested on Xcode Version 11.5 (11E608c), MacOS 10.15.5)
#### Credit
* [Machismo](https://github.com/g-Off/Machismo) : Parsing of Mach-O binaries using swift.
* [swift-argument-parser](https://github.com/apple/swift-argument-parser) : Straightforward, type-safe argument parsing for Swift.
* [Swift metadata](https://knight.sc/reverse%20engineering/2019/07/17/swift-metadata.html) : High level description of all the Swift 5 sections that can show up in a Swift binary.
#### License
MIT
#### Mach-O File Format
The following image shows how SwiftDump parse swift types from file `Demo/test`. You can open this file with [MachOView](https://github.com/gdbinit/MachOView).
