Skip to content

Commit

Permalink
Update README, description and keywords for PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
jsharkey13 committed Dec 24, 2023
1 parent 7f6590f commit 0e6b88c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 15 deletions.
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ itself based on the [iphone-dataprotection](https://code.google.com/p/iphone-dat

## Install

Requires [Python 3.4](https://www.python.org/) or higher.
Requires [Python 3.8](https://www.python.org/) or higher.

The code requires a cryptographic library providing the `Crypto` name.
Use `pycryptodome` (but note that this clashes with `pycrypto`, if that is already installed).
Expand All @@ -15,19 +15,9 @@ The backup decryption keys are protected using 10 million rounds of PBKDF2 with
To speed up decryption, `fastpbkdf2` is desirable; otherwise the code will fall back to using standard library functions.
The fallback is much slower, but does not require the complicated build and install of `fastpbkdf2`.

Ideal dependencies:
Install via `pip`:
```shell script
pip install biplist pycryptodome fastpbkdf2
```

Minimal required dependencies (automatically installed):
```shell script
pip install biplist pycryptodome
```

Install directly from GitHub via `pip`:
```shell script
pip install git+https://github.com/jsharkey13/iphone_backup_decrypt
pip install iphone_backup_decrypt
# Optionally:
pip install fastpbkdf2
```
Expand Down
6 changes: 4 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
[project]
name = "iphone_backup_decrypt"
version = "0.3.0"
version = "0.3.1"
authors = [
{ name="James Sharkey" },
]
description = "Decrypt an iOS13+ encrypted local backup."
description = "Decrypt and extract files from an iOS13+ encrypted local backup."
readme = "README.md"
requires-python = ">=3.8"
classifiers = [
"Programming Language :: Python :: 3",
"Topic :: Security :: Cryptography"
]

keywords = ["iPhone", "backup", "forensics", "iOS", "WhatsApp", "decryption", "iOS backup", "iTunes Backup"]

dependencies = [
"biplist>=1.0.3",
"pycryptodome>=3.9.1"
Expand Down

0 comments on commit 0e6b88c

Please sign in to comment.