-
Notifications
You must be signed in to change notification settings - Fork 1
Improve README.md with package instructions and formatting (#1, #4) #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
editheman
wants to merge
1
commit into
malus-security:main
Choose a base branch
from
editheman:solve-issue-1-4
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,61 @@ | ||
| # VFDecrypt | ||
|
|
||
| [VFDecrypt](https://www.theiphonewiki.com/wiki/VFDecrypt) is used to decrypt Apple iOS root filesystem images. Root filesystem images inside IPSW files are encrypted for iOS >= 9. Since iOS 10, root filesystem images are not encrypted and VFDecrypt is no longer required. | ||
| [VFDecrypt](https://www.theiphonewiki.com/wiki/VFDecrypt) is used to decrypt Apple iOS root filesystem images. | ||
| Root filesystem images inside IPSW files are encrypted for iOS >= 9. | ||
| Since iOS 10, root filesystem images are not encrypted and VFDecrypt is no longer required. | ||
|
|
||
| Decrypting root filesystem images requires the decryption key. This is provided for most root filesystem images version by the community at [The iPhone Wiki](https://www.theiphonewiki.com/wiki/Firmware_Keys). | ||
| Decrypting root filesystem images requires the decryption key. | ||
| This is provided for most root filesystem images version by the community at [The iPhone Wiki](https://www.theiphonewiki.com/wiki/Firmware_Keys). | ||
|
|
||
| There are several VFDecrypt builds available on the Internet. We've used and updated the implementation [here](https://github.com/trailofbits/iverify-oss/tree/master/vendor/vfdecrypt). We've updated `vfdecrypt.c` to support OpenSSL >= 1.1.0 and the `Makefile` to be OS-dependent. | ||
| There are several VFDecrypt builds available on the internet. | ||
| We've used and updated the implementation [here](https://github.com/trailofbits/iverify-oss/tree/master/vendor/vfdecrypt). | ||
| We've updated `vfdecrypt.c` to support OpenSSL >= 1.1.0 and the `Makefile` to be OS-dependent. | ||
|
|
||
| You build `vfdecrypt` using | ||
| ### Dependencies | ||
|
|
||
| To build and run vfdecrypt locally, you need to install the following dependencies: | ||
|
|
||
| * macOS | ||
|
|
||
| ```console | ||
| brew install openssl make | ||
| ``` | ||
| make | ||
|
|
||
| * Ubuntu/Debian | ||
|
|
||
| ```console | ||
| sudo apt-get update | ||
| sudo apt-get install -y build-essential libssl-dev coreutils | ||
| ``` | ||
|
|
||
| * Fedora/RHEL/CentOS | ||
|
|
||
| ```console | ||
| sudo dnf install -y gcc gcc-c++ make openssl-devel coreutils | ||
| ``` | ||
|
|
||
| You runn `vfdecrypt` by passing it the root filesystem key, the root filesystem image and the output (decrypted) file: | ||
| * Arch Linux | ||
|
|
||
| ```console | ||
| sudo pacman -S base-devel openssl coreutils | ||
| ``` | ||
|
|
||
| You build `vfdecrypt` using | ||
|
|
||
| ```console | ||
| make | ||
| ``` | ||
|
|
||
| You run `vfdecrypt` by passing it the root filesystem key, the root filesystem image and the output (decrypted) file: | ||
|
|
||
| ```console | ||
| ./vfdecrypt -i ~/Projects/store/out/iPhone5,1_9.3_13E237/058-25512-331.dmg -k 2a66fd6377af8f60d5e300ac3aa8d9c44a1c0dee94579ad3f8a26515debbf381bb971ae8 -o decrypted.dmg | ||
| ``` | ||
|
|
||
| iExtractor runs `vfdecrypt` as part of the `bin/decrypt_fs` and `scripts/decrypt_fs` scripts. | ||
|
|
||
| The usage inside iExtractor: | ||
|
|
||
| ``` | ||
| ```console | ||
| docker run -v "<input_absolute_path>":/in -v "<output_absolute_path>":/out -t ghcr.io/malus-security/vfdecrypt:latest -k<rootfs_key> /in /out > /dev/null 2>&1 | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.