Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blacktop/ipsw

iOS/macOS Research Swiss Army Knife
https://github.com/blacktop/ipsw

apple class-dump dyld dyld-shared-cache firmware golang img4 ios ipsw kernelcache lzfse lzss macho macho-parser macos ota swift swift-dump

Last synced: about 2 months ago
JSON representation

iOS/macOS Research Swiss Army Knife

Host: GitHub
URL: https://github.com/blacktop/ipsw
Owner: blacktop
License: mit
Created: 2018-08-25T03:05:41.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-07-31T21:30:23.000Z (about 2 months ago)
Last Synced: 2024-08-01T05:35:35.500Z (about 2 months ago)
Topics: apple, class-dump, dyld, dyld-shared-cache, firmware, golang, img4, ios, ipsw, kernelcache, lzfse, lzss, macho, macho-parser, macos, ota, swift, swift-dump
Language: Go
Homepage: https://blacktop.github.io/ipsw
Size: 135 MB
Stars: 1,711
Watchers: 31
Forks: 132
Open Issues: 39
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

ipsw

iOS/macOS Research Swiss Army Knife

## What is `ipsw` 🤔

- IPSW downloader/exploder
- OTA downloader/exploder
- macho parser
- ObjC class-dump
- Swift class-dump 🚧
- dyld_shared_cache parser
- kernelcache parser
- img4 parser/decrypter
- device-tree parser
- ARM v9-a disassember
- research tool

## Install

### macOS

```bash
brew install blacktop/tap/ipsw
```

### Linux

```bash
sudo snap install ipsw
```

### Windows

```bash
scoop bucket add blacktop https://github.com/blacktop/scoop-bucket.git
scoop install blacktop/ipsw
```

## Getting Started

```
❯ ipsw

Download and Parse IPSWs (and SO much more)

Usage:
ipsw [command]

Available Commands:
appstore Interact with the App Store Connect API
class-dump ObjC class-dump a dylib from a DSC or MachO
device-list List all iOS devices
diff Diff IPSWs
download Download Apple Firmware files (and more)
dtree Parse DeviceTree
dyld Parse dyld_shared_cache
ent Search IPSW filesystem DMG or Folder for MachOs with a given entitlement
extract Extract kernelcache, dyld_shared_cache or DeviceTree from IPSW/OTA
fw Firmware commands
help Help about any command
idev USB connected device commands
img4 Parse Img4
info Display IPSW/OTA Info
kernel Parse kernelcache
macho Parse MachO
mdevs List all MobileDevices in IPSW
mount Mount DMG from IPSW
ota Parse OTAs
plist Dump plist as JSON
pongo PongoOS Terminal
ssh SSH into a jailbroken device
swift-dump 🚧 Swift class-dump a dylib from a DSC or MachO
symbolicate Symbolicate ARM 64-bit crash logs (similar to Apple's symbolicatecrash)
version Print the version number of ipsw
watch Watch Github Commits

Flags:
--color colorize output
--config string config file (default is $HOME/.config/ipsw/config.yaml)
-h, --help help for ipsw
--no-color disable colorize output
-V, --verbose verbose output

Use "ipsw [command] --help" for more information about a command.
```

## Documentation

- [https://blacktop.github.io/ipsw](https://blacktop.github.io/ipsw)

```mermaid
graph TD
A[Download] --> B[Extract]
B --> C[Parse]
C --> D[Dump]
D --> E[Search]
E --> F[Symbolicate]
```

## `ipsw` Diffs

A collection of `ipsw` diffs can be found here:
-

## Community

You have questions, need support and or just want to talk about `ipsw`?

Here are ways to get in touch with the `ipsw` community:

[![Follow Twitter](https://img.shields.io/badge/follow_on_twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/blacktop__)
[![Follow Mastodon](https://img.shields.io/badge/follow_on_mastodon-6364FF?style=for-the-badge&logo=mastodon&logoColor=white)](https://mastodon.social/@blacktop)
[![GitHub Discussions](https://img.shields.io/badge/GITHUB_DISCUSSION-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/blacktop/ipsw/discussions)

## Known Issues

- `macOS` IPSW etc support is sometimes broken

Automated testing of `ipsw` is challenging as it requires a lot of resources to test all the different IPSW flavors and OS versions etc. No CI/CD can really handle that unless I want to wait forever for it to run on each commit. Please create an [issue](https://github.com/blacktop/ipsw/issues) and I'll fix it as soon as I can ❤️ *(**NOTE:** a comprehensive test suite is in the roadmap so I can at least test on the few local IPSWs I have)*

## Credit

Big shout out to Jonathan Levin's amazing books and his legendary `jtool`

## Stargazers

[![Stargazers over time](https://starchart.cc/blacktop/ipsw.svg?variant=adaptive)](https://starchart.cc/blacktop/ipsw)

## License