Skip to content

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.

Sign up for GitHub

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 2 commits into
base: main
Choose a base branch
from
Open

Improve README.md with package instructions and formatting (#1, #4) #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
490cdc2
Fix README.md formatting to use one sentence per line (#1)
editheman Sep 12, 2025
93ba529
Update: Add package installation instructions for multiple platforms …
editheman Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 37 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,51 @@
# 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.

### Dependencies
Copy link
Member

@razvand razvand Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use macOS, Ubuntu/Debian etc. as lists (* macOS, * Ubuntu/Debian etc.).


To build and run vfdecrypt locally, you need to install the following dependencies:

macOS

```
Copy link
Member

@razvand razvand Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```console

brew install openssl make
```

Ubuntu/Debian

```
Copy link
Member

@razvand razvand Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```console

sudo apt-get update sudo apt-get install -y build-essential libssl-dev coreutils
Copy link
Member

@razvand razvand Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
sudo apt-get update sudo apt-get install -y build-essential libssl-dev coreutils
sudo apt-get update
sudo apt-get install -y build-essential libssl-dev coreutils

```

Fedora/RHEL/CentOS

```
Copy link
Member

@razvand razvand Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```console

sudo dnf install -y gcc gcc-c++ make openssl-devel coreutils
```

Arch Linux

```
Copy link
Member

@razvand razvand Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```console

sudo pacman -S base-devel openssl coreutils
```

You build `vfdecrypt` using

```
Copy link
Member

@razvand razvand Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use triple backticks and console.

make
```

You runn `vfdecrypt` by passing it the root filesystem key, the root filesystem image and the output (decrypted) file:
You run `vfdecrypt` by passing it the root filesystem key, the root filesystem image and the output (decrypted) file:

```
Copy link
Member

@razvand razvand Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use triple backticks and console.

./vfdecrypt -i ~/Projects/store/out/iPhone5,1_9.3_13E237/058-25512-331.dmg -k 2a66fd6377af8f60d5e300ac3aa8d9c44a1c0dee94579ad3f8a26515debbf381bb971ae8 -o decrypted.dmg
Expand Down