developer-disk-image 0.1.0__tar.gz → 0.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- developer_disk_image-0.3.0/PKG-INFO +134 -0
- developer_disk_image-0.3.0/README.md +110 -0
- developer_disk_image-0.3.0/developer_disk_image/_version.py +24 -0
- developer_disk_image-0.3.0/developer_disk_image/repo.py +125 -0
- developer_disk_image-0.3.0/developer_disk_image.egg-info/PKG-INFO +134 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/developer_disk_image.egg-info/SOURCES.txt +3 -0
- developer_disk_image-0.3.0/developer_disk_image.egg-info/scm_file_list.json +107 -0
- developer_disk_image-0.3.0/developer_disk_image.egg-info/scm_version.json +8 -0
- developer_disk_image-0.3.0/tests/test_repo.py +49 -0
- developer_disk_image-0.3.0/update_ddi.py +309 -0
- developer_disk_image-0.1.0/PKG-INFO +0 -62
- developer_disk_image-0.1.0/README.md +0 -38
- developer_disk_image-0.1.0/developer_disk_image/_version.py +0 -21
- developer_disk_image-0.1.0/developer_disk_image/repo.py +0 -78
- developer_disk_image-0.1.0/developer_disk_image.egg-info/PKG-INFO +0 -62
- developer_disk_image-0.1.0/tests/test_repo.py +0 -17
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/.github/workflows/codeql.yml +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/.github/workflows/python-app.yml +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/.github/workflows/python-publish.yml +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/.gitignore +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/MANIFEST.in +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/developer_disk_image/__init__.py +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/developer_disk_image/exceptions.py +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/developer_disk_image.egg-info/dependency_links.txt +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/developer_disk_image.egg-info/entry_points.txt +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/developer_disk_image.egg-info/requires.txt +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/developer_disk_image.egg-info/top_level.txt +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/pyproject.toml +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/requirements.txt +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/setup.cfg +0 -0
- {developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/tests/__init__.py +0 -0
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: developer_disk_image
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Download DeveloperDiskImage ans Personalized images from GitHub
|
|
5
|
+
Author-email: doronz88 <doron88@gmail.com>
|
|
6
|
+
Maintainer-email: doronz88 <doron88@gmail.com>
|
|
7
|
+
Project-URL: Homepage, https://github.com/doronz88/DeveloperDiskImage
|
|
8
|
+
Project-URL: Bug Reports, https://github.com/doronz88/DeveloperDiskImage/issues
|
|
9
|
+
Keywords: ios,DeveloperDiskImage
|
|
10
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
11
|
+
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
19
|
+
Requires-Python: >=3.9
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
Requires-Dist: requests
|
|
22
|
+
Provides-Extra: test
|
|
23
|
+
Requires-Dist: pytest; extra == "test"
|
|
24
|
+
|
|
25
|
+
[](https://pypi.org/project/developer_disk_image/ "PyPi package")
|
|
26
|
+
|
|
27
|
+
# Overview
|
|
28
|
+
|
|
29
|
+
Store both types of Apple's DeveloperDiskImage files:
|
|
30
|
+
|
|
31
|
+
- `DeveloperDiskImage.dmg` & `DeveloperDiskImage.dmg.signature`
|
|
32
|
+
- Used for each iOS version < 17.0
|
|
33
|
+
- The new Personalized images, but splitted to:
|
|
34
|
+
- APFS
|
|
35
|
+
- `BuildManifest.plist`
|
|
36
|
+
- Trustcache
|
|
37
|
+
- The Cryptex1 assets, for installing the same DDI through `cryptexd` instead of the image mounter:
|
|
38
|
+
- APFS
|
|
39
|
+
- `BuildManifest.plist`
|
|
40
|
+
- Trustcache
|
|
41
|
+
- Cryptex info plist
|
|
42
|
+
- Volume root hash
|
|
43
|
+
|
|
44
|
+
The split of the new format is requires for OS* other than macOS that will have trouble extracting the original APFS
|
|
45
|
+
image inside: `~/Library/Developer/DeveloperDiskImages`.
|
|
46
|
+
|
|
47
|
+
## Layout
|
|
48
|
+
|
|
49
|
+
| Directory | Consumed by |
|
|
50
|
+
|---|---|
|
|
51
|
+
| `DeveloperDiskImages/<version>/` | iOS < 17.0 |
|
|
52
|
+
| `PersonalizedImages/Xcode_iOS_DDI_Personalized/` | the image mounter (`mounter auto-mount`) |
|
|
53
|
+
| `PersonalizedImages/Xcode_iOS_DDI_Cryptex/` | `cryptexd` (`cryptex auto-install`) |
|
|
54
|
+
|
|
55
|
+
Every payload is published under a fixed file name, so download URLs stay predictable across
|
|
56
|
+
releases:
|
|
57
|
+
|
|
58
|
+
| File | Personalized | Cryptex |
|
|
59
|
+
|---|---|---|
|
|
60
|
+
| `BuildManifest.plist` | yes | yes |
|
|
61
|
+
| `Image.dmg` | `PersonalizedDMG` | `Cryptex1,GenericDmg` |
|
|
62
|
+
| `Image.dmg.trustcache` | `LoadableTrustCache` | `Cryptex1,GenericTrustCache` |
|
|
63
|
+
| `Image.dmg.cryptex_info` | -- | `Cryptex1,CryptexInfoPlist` |
|
|
64
|
+
| `Image.dmg.root_hash` | -- | `Cryptex1,GenericVolume` |
|
|
65
|
+
|
|
66
|
+
Apple's own paths embed a build number (`022-22107-072.dmg`), so the published
|
|
67
|
+
`BuildManifest.plist` is rewritten to declare the fixed names instead. Only `Info.Path` is
|
|
68
|
+
adjusted -- the digests personalization depends on are untouched -- which keeps a downloaded
|
|
69
|
+
cryptex directory usable as a drop-in `Restore` directory.
|
|
70
|
+
|
|
71
|
+
## Updating
|
|
72
|
+
|
|
73
|
+
`update_ddi.py` refreshes every variant from a local Xcode installation. macOS only, no
|
|
74
|
+
dependencies, run it with [uv](https://docs.astral.sh/uv/):
|
|
75
|
+
|
|
76
|
+
```shell
|
|
77
|
+
uv run --script update_ddi.py # refresh every variant of the iOS DDI
|
|
78
|
+
uv run --script update_ddi.py --dry-run # report what would change, write nothing
|
|
79
|
+
uv run --script update_ddi.py --platform tvOS --variant cryptex
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Pass `--script` so uv runs it as a standalone script rather than treating this repository as a uv
|
|
83
|
+
project (which would leave a stray `uv.lock` and `.venv` behind).
|
|
84
|
+
|
|
85
|
+
It reads Xcode's bundle from `/Library/Developer` (falling back to attaching
|
|
86
|
+
`CoreDevice/CandidateDDIs/<platform>_DDI.dmg` when no expanded copy exists), verifies every payload
|
|
87
|
+
against the SHA-384 digests in the build manifest before publishing it, and removes stale files
|
|
88
|
+
left over from a previous build. Remember to bump `LATEST_DDI_BUILD_ID` in pymobiledevice3 to match
|
|
89
|
+
whatever build it reports.
|
|
90
|
+
|
|
91
|
+
# Python package
|
|
92
|
+
|
|
93
|
+
Additionally, this repo provides a python API for accessing this repository.
|
|
94
|
+
You can install it as follows:
|
|
95
|
+
|
|
96
|
+
```shell
|
|
97
|
+
python3 -m pip install -U developer_disk_image
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Example usage
|
|
101
|
+
|
|
102
|
+
Payloads are fetched from `raw.githubusercontent.com`, which is not subject to the REST API's
|
|
103
|
+
60-requests-per-hour anonymous quota, so no GitHub token is needed. `create()` accepts a `ref`
|
|
104
|
+
(branch, tag or commit) to read a revision other than `main`.
|
|
105
|
+
|
|
106
|
+
```python
|
|
107
|
+
from developer_disk_image.repo import DeveloperDiskImageRepository
|
|
108
|
+
|
|
109
|
+
repo = DeveloperDiskImageRepository.create()
|
|
110
|
+
|
|
111
|
+
# will get both the APFS and the signature file
|
|
112
|
+
developer_disk_image = repo.get_developer_disk_image('16.4')
|
|
113
|
+
|
|
114
|
+
# will get all necessary files for mount
|
|
115
|
+
personalized_disk_image = repo.get_personalized_disk_image()
|
|
116
|
+
|
|
117
|
+
# will get all necessary files for installing the DDI as a cryptex
|
|
118
|
+
cryptex_disk_image = repo.get_cryptex_disk_image()
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Writing the cryptex assets back out under their published names produces a directory that
|
|
122
|
+
`cryptexd` clients accept as-is:
|
|
123
|
+
|
|
124
|
+
```python
|
|
125
|
+
from pathlib import Path
|
|
126
|
+
|
|
127
|
+
from developer_disk_image.repo import CRYPTEX_IMAGE_PAYLOADS
|
|
128
|
+
|
|
129
|
+
restore = Path('Xcode_iOS_DDI_Cryptex')
|
|
130
|
+
restore.mkdir(parents=True, exist_ok=True)
|
|
131
|
+
(restore / 'BuildManifest.plist').write_bytes(cryptex_disk_image.build_manifest)
|
|
132
|
+
for field, name in CRYPTEX_IMAGE_PAYLOADS.items():
|
|
133
|
+
(restore / name).write_bytes(getattr(cryptex_disk_image, field))
|
|
134
|
+
```
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
[](https://pypi.org/project/developer_disk_image/ "PyPi package")
|
|
2
|
+
|
|
3
|
+
# Overview
|
|
4
|
+
|
|
5
|
+
Store both types of Apple's DeveloperDiskImage files:
|
|
6
|
+
|
|
7
|
+
- `DeveloperDiskImage.dmg` & `DeveloperDiskImage.dmg.signature`
|
|
8
|
+
- Used for each iOS version < 17.0
|
|
9
|
+
- The new Personalized images, but splitted to:
|
|
10
|
+
- APFS
|
|
11
|
+
- `BuildManifest.plist`
|
|
12
|
+
- Trustcache
|
|
13
|
+
- The Cryptex1 assets, for installing the same DDI through `cryptexd` instead of the image mounter:
|
|
14
|
+
- APFS
|
|
15
|
+
- `BuildManifest.plist`
|
|
16
|
+
- Trustcache
|
|
17
|
+
- Cryptex info plist
|
|
18
|
+
- Volume root hash
|
|
19
|
+
|
|
20
|
+
The split of the new format is requires for OS* other than macOS that will have trouble extracting the original APFS
|
|
21
|
+
image inside: `~/Library/Developer/DeveloperDiskImages`.
|
|
22
|
+
|
|
23
|
+
## Layout
|
|
24
|
+
|
|
25
|
+
| Directory | Consumed by |
|
|
26
|
+
|---|---|
|
|
27
|
+
| `DeveloperDiskImages/<version>/` | iOS < 17.0 |
|
|
28
|
+
| `PersonalizedImages/Xcode_iOS_DDI_Personalized/` | the image mounter (`mounter auto-mount`) |
|
|
29
|
+
| `PersonalizedImages/Xcode_iOS_DDI_Cryptex/` | `cryptexd` (`cryptex auto-install`) |
|
|
30
|
+
|
|
31
|
+
Every payload is published under a fixed file name, so download URLs stay predictable across
|
|
32
|
+
releases:
|
|
33
|
+
|
|
34
|
+
| File | Personalized | Cryptex |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| `BuildManifest.plist` | yes | yes |
|
|
37
|
+
| `Image.dmg` | `PersonalizedDMG` | `Cryptex1,GenericDmg` |
|
|
38
|
+
| `Image.dmg.trustcache` | `LoadableTrustCache` | `Cryptex1,GenericTrustCache` |
|
|
39
|
+
| `Image.dmg.cryptex_info` | -- | `Cryptex1,CryptexInfoPlist` |
|
|
40
|
+
| `Image.dmg.root_hash` | -- | `Cryptex1,GenericVolume` |
|
|
41
|
+
|
|
42
|
+
Apple's own paths embed a build number (`022-22107-072.dmg`), so the published
|
|
43
|
+
`BuildManifest.plist` is rewritten to declare the fixed names instead. Only `Info.Path` is
|
|
44
|
+
adjusted -- the digests personalization depends on are untouched -- which keeps a downloaded
|
|
45
|
+
cryptex directory usable as a drop-in `Restore` directory.
|
|
46
|
+
|
|
47
|
+
## Updating
|
|
48
|
+
|
|
49
|
+
`update_ddi.py` refreshes every variant from a local Xcode installation. macOS only, no
|
|
50
|
+
dependencies, run it with [uv](https://docs.astral.sh/uv/):
|
|
51
|
+
|
|
52
|
+
```shell
|
|
53
|
+
uv run --script update_ddi.py # refresh every variant of the iOS DDI
|
|
54
|
+
uv run --script update_ddi.py --dry-run # report what would change, write nothing
|
|
55
|
+
uv run --script update_ddi.py --platform tvOS --variant cryptex
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Pass `--script` so uv runs it as a standalone script rather than treating this repository as a uv
|
|
59
|
+
project (which would leave a stray `uv.lock` and `.venv` behind).
|
|
60
|
+
|
|
61
|
+
It reads Xcode's bundle from `/Library/Developer` (falling back to attaching
|
|
62
|
+
`CoreDevice/CandidateDDIs/<platform>_DDI.dmg` when no expanded copy exists), verifies every payload
|
|
63
|
+
against the SHA-384 digests in the build manifest before publishing it, and removes stale files
|
|
64
|
+
left over from a previous build. Remember to bump `LATEST_DDI_BUILD_ID` in pymobiledevice3 to match
|
|
65
|
+
whatever build it reports.
|
|
66
|
+
|
|
67
|
+
# Python package
|
|
68
|
+
|
|
69
|
+
Additionally, this repo provides a python API for accessing this repository.
|
|
70
|
+
You can install it as follows:
|
|
71
|
+
|
|
72
|
+
```shell
|
|
73
|
+
python3 -m pip install -U developer_disk_image
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Example usage
|
|
77
|
+
|
|
78
|
+
Payloads are fetched from `raw.githubusercontent.com`, which is not subject to the REST API's
|
|
79
|
+
60-requests-per-hour anonymous quota, so no GitHub token is needed. `create()` accepts a `ref`
|
|
80
|
+
(branch, tag or commit) to read a revision other than `main`.
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
from developer_disk_image.repo import DeveloperDiskImageRepository
|
|
84
|
+
|
|
85
|
+
repo = DeveloperDiskImageRepository.create()
|
|
86
|
+
|
|
87
|
+
# will get both the APFS and the signature file
|
|
88
|
+
developer_disk_image = repo.get_developer_disk_image('16.4')
|
|
89
|
+
|
|
90
|
+
# will get all necessary files for mount
|
|
91
|
+
personalized_disk_image = repo.get_personalized_disk_image()
|
|
92
|
+
|
|
93
|
+
# will get all necessary files for installing the DDI as a cryptex
|
|
94
|
+
cryptex_disk_image = repo.get_cryptex_disk_image()
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Writing the cryptex assets back out under their published names produces a directory that
|
|
98
|
+
`cryptexd` clients accept as-is:
|
|
99
|
+
|
|
100
|
+
```python
|
|
101
|
+
from pathlib import Path
|
|
102
|
+
|
|
103
|
+
from developer_disk_image.repo import CRYPTEX_IMAGE_PAYLOADS
|
|
104
|
+
|
|
105
|
+
restore = Path('Xcode_iOS_DDI_Cryptex')
|
|
106
|
+
restore.mkdir(parents=True, exist_ok=True)
|
|
107
|
+
(restore / 'BuildManifest.plist').write_bytes(cryptex_disk_image.build_manifest)
|
|
108
|
+
for field, name in CRYPTEX_IMAGE_PAYLOADS.items():
|
|
109
|
+
(restore / name).write_bytes(getattr(cryptex_disk_image, field))
|
|
110
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# file generated by vcs-versioning
|
|
2
|
+
# don't change, don't track in version control
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
__all__ = [
|
|
6
|
+
"__version__",
|
|
7
|
+
"__version_tuple__",
|
|
8
|
+
"version",
|
|
9
|
+
"version_tuple",
|
|
10
|
+
"__commit_id__",
|
|
11
|
+
"commit_id",
|
|
12
|
+
]
|
|
13
|
+
|
|
14
|
+
version: str
|
|
15
|
+
__version__: str
|
|
16
|
+
__version_tuple__: tuple[int | str, ...]
|
|
17
|
+
version_tuple: tuple[int | str, ...]
|
|
18
|
+
commit_id: str | None
|
|
19
|
+
__commit_id__: str | None
|
|
20
|
+
|
|
21
|
+
__version__ = version = '0.3.0'
|
|
22
|
+
__version_tuple__ = version_tuple = (0, 3, 0)
|
|
23
|
+
|
|
24
|
+
__commit_id__ = commit_id = 'g1daa8aa4a'
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import dataclasses
|
|
2
|
+
from datetime import datetime, timezone
|
|
3
|
+
from typing import Optional
|
|
4
|
+
|
|
5
|
+
import requests
|
|
6
|
+
|
|
7
|
+
from developer_disk_image.exceptions import DeveloperDiskImageException, GithubRateLimitExceededError
|
|
8
|
+
|
|
9
|
+
#: Payloads are served straight off raw.githubusercontent.com rather than through the REST API.
|
|
10
|
+
#: That host is not subject to the API's 60-requests-per-hour anonymous quota, so no token is
|
|
11
|
+
#: needed, and it saves downloading a recursive tree listing of a repository full of disk images
|
|
12
|
+
#: just to resolve a handful of known paths.
|
|
13
|
+
DEVELOPER_DISK_IMAGE_REPO_RAW_URL_FORMAT = \
|
|
14
|
+
'https://raw.githubusercontent.com/doronz88/DeveloperDiskImage/{ref}/{path}'
|
|
15
|
+
DEFAULT_REF = 'main'
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
@dataclasses.dataclass
|
|
19
|
+
class DeveloperDiskImage:
|
|
20
|
+
image: bytes
|
|
21
|
+
signature: bytes
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
@dataclasses.dataclass
|
|
25
|
+
class PersonalizedImage:
|
|
26
|
+
image: bytes
|
|
27
|
+
build_manifest: bytes
|
|
28
|
+
trustcache: bytes
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
@dataclasses.dataclass
|
|
32
|
+
class CryptexImage:
|
|
33
|
+
"""The Cryptex1 assets cryptexd needs in order to install a DeveloperDiskImage cryptex."""
|
|
34
|
+
image: bytes
|
|
35
|
+
build_manifest: bytes
|
|
36
|
+
trustcache: bytes
|
|
37
|
+
cryptex_info: bytes
|
|
38
|
+
root_hash: bytes
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
CRYPTEX_IMAGE_ROOT = 'PersonalizedImages/Xcode_iOS_DDI_Cryptex'
|
|
42
|
+
|
|
43
|
+
#: Field of `CryptexImage` -> its published file name. Fixed, so the URLs stay predictable across
|
|
44
|
+
#: releases; the published BuildManifest.plist is rewritten to declare these same names.
|
|
45
|
+
CRYPTEX_IMAGE_PAYLOADS = {
|
|
46
|
+
'image': 'Image.dmg',
|
|
47
|
+
'trustcache': 'Image.dmg.trustcache',
|
|
48
|
+
'cryptex_info': 'Image.dmg.cryptex_info',
|
|
49
|
+
'root_hash': 'Image.dmg.root_hash',
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
class DeveloperDiskImageRepository:
|
|
54
|
+
@classmethod
|
|
55
|
+
def create(cls, github_token: Optional[str] = None, ref: str = DEFAULT_REF) -> 'DeveloperDiskImageRepository':
|
|
56
|
+
"""Create a repository client. Performs no request of its own.
|
|
57
|
+
|
|
58
|
+
:param github_token: optional token, forwarded on every request.
|
|
59
|
+
:param ref: branch, tag or commit to read. Defaults to `DEFAULT_REF`; pass a commit to read
|
|
60
|
+
a revision that is not merged yet, which is how CI checks a pull request against the
|
|
61
|
+
payloads that pull request adds.
|
|
62
|
+
"""
|
|
63
|
+
return cls(github_token=github_token, ref=ref)
|
|
64
|
+
|
|
65
|
+
def __init__(self, github_token: Optional[str] = None, ref: str = DEFAULT_REF):
|
|
66
|
+
"""
|
|
67
|
+
:param github_token: optional token, forwarded on every request.
|
|
68
|
+
:param ref: branch, tag or commit to read payloads from.
|
|
69
|
+
"""
|
|
70
|
+
self.github_token = github_token
|
|
71
|
+
self.ref = ref
|
|
72
|
+
|
|
73
|
+
def get_developer_disk_image(self, version: str) -> Optional[DeveloperDiskImage]:
|
|
74
|
+
image = self._get_blob(f'DeveloperDiskImages/{version}/DeveloperDiskImage.dmg')
|
|
75
|
+
signature = self._get_blob(f'DeveloperDiskImages/{version}/DeveloperDiskImage.dmg.signature')
|
|
76
|
+
|
|
77
|
+
if image is None:
|
|
78
|
+
return None
|
|
79
|
+
|
|
80
|
+
return DeveloperDiskImage(image=image, signature=signature)
|
|
81
|
+
|
|
82
|
+
def get_personalized_disk_image(self) -> PersonalizedImage:
|
|
83
|
+
image = self._get_blob('PersonalizedImages/Xcode_iOS_DDI_Personalized/Image.dmg')
|
|
84
|
+
build_manifest = self._get_blob('PersonalizedImages/Xcode_iOS_DDI_Personalized/BuildManifest.plist')
|
|
85
|
+
trustcache = self._get_blob(
|
|
86
|
+
'PersonalizedImages/Xcode_iOS_DDI_Personalized/Image.dmg.trustcache')
|
|
87
|
+
return PersonalizedImage(image=image, build_manifest=build_manifest, trustcache=trustcache)
|
|
88
|
+
|
|
89
|
+
def get_cryptex_disk_image(self) -> CryptexImage:
|
|
90
|
+
"""Fetch the Cryptex1 DeveloperDiskImage assets, for installing the DDI over cryptexd.
|
|
91
|
+
|
|
92
|
+
Writing these out under their published names reproduces a directory that cryptexd clients
|
|
93
|
+
accept as-is, since the build manifest shipped alongside them declares those same names.
|
|
94
|
+
"""
|
|
95
|
+
payloads = {'build_manifest': self._get_blob(f'{CRYPTEX_IMAGE_ROOT}/BuildManifest.plist')}
|
|
96
|
+
for field, name in CRYPTEX_IMAGE_PAYLOADS.items():
|
|
97
|
+
payloads[field] = self._get_blob(f'{CRYPTEX_IMAGE_ROOT}/{name}')
|
|
98
|
+
|
|
99
|
+
missing = sorted(field for field, blob in payloads.items() if blob is None)
|
|
100
|
+
if missing:
|
|
101
|
+
raise DeveloperDiskImageException(f'not published under {CRYPTEX_IMAGE_ROOT}: {", ".join(missing)}')
|
|
102
|
+
return CryptexImage(**payloads)
|
|
103
|
+
|
|
104
|
+
def _get_blob(self, path: str) -> Optional[bytes]:
|
|
105
|
+
"""Fetch one payload, or ``None`` if this revision does not publish it."""
|
|
106
|
+
url = DEVELOPER_DISK_IMAGE_REPO_RAW_URL_FORMAT.format(ref=self.ref, path=path)
|
|
107
|
+
headers = {}
|
|
108
|
+
if self.github_token is not None:
|
|
109
|
+
headers['Authorization'] = 'Bearer ' + self.github_token
|
|
110
|
+
|
|
111
|
+
response = requests.get(url, headers=headers)
|
|
112
|
+
if response.status_code == 404:
|
|
113
|
+
return None
|
|
114
|
+
if response.status_code != 200:
|
|
115
|
+
# raw.githubusercontent.com is not under the REST API's hourly quota, but it can still
|
|
116
|
+
# throttle abusive traffic, and an authenticated request can still be limited.
|
|
117
|
+
# https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api
|
|
118
|
+
remaining = response.headers.get('x-ratelimit-remaining')
|
|
119
|
+
if response.status_code in (403, 429) and remaining is not None and int(remaining) == 0:
|
|
120
|
+
reset_utc = datetime.fromtimestamp(int(response.headers['x-ratelimit-reset']), timezone.utc)
|
|
121
|
+
raise GithubRateLimitExceededError(
|
|
122
|
+
f'GitHub: rate limit exceeded. Wait until {reset_utc.astimezone()} '
|
|
123
|
+
f'or use a custom GitHub access token')
|
|
124
|
+
raise DeveloperDiskImageException(f'GitHub: request for {path} failed: {response.status_code}')
|
|
125
|
+
return response.content
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: developer_disk_image
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Download DeveloperDiskImage ans Personalized images from GitHub
|
|
5
|
+
Author-email: doronz88 <doron88@gmail.com>
|
|
6
|
+
Maintainer-email: doronz88 <doron88@gmail.com>
|
|
7
|
+
Project-URL: Homepage, https://github.com/doronz88/DeveloperDiskImage
|
|
8
|
+
Project-URL: Bug Reports, https://github.com/doronz88/DeveloperDiskImage/issues
|
|
9
|
+
Keywords: ios,DeveloperDiskImage
|
|
10
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
11
|
+
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
19
|
+
Requires-Python: >=3.9
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
Requires-Dist: requests
|
|
22
|
+
Provides-Extra: test
|
|
23
|
+
Requires-Dist: pytest; extra == "test"
|
|
24
|
+
|
|
25
|
+
[](https://pypi.org/project/developer_disk_image/ "PyPi package")
|
|
26
|
+
|
|
27
|
+
# Overview
|
|
28
|
+
|
|
29
|
+
Store both types of Apple's DeveloperDiskImage files:
|
|
30
|
+
|
|
31
|
+
- `DeveloperDiskImage.dmg` & `DeveloperDiskImage.dmg.signature`
|
|
32
|
+
- Used for each iOS version < 17.0
|
|
33
|
+
- The new Personalized images, but splitted to:
|
|
34
|
+
- APFS
|
|
35
|
+
- `BuildManifest.plist`
|
|
36
|
+
- Trustcache
|
|
37
|
+
- The Cryptex1 assets, for installing the same DDI through `cryptexd` instead of the image mounter:
|
|
38
|
+
- APFS
|
|
39
|
+
- `BuildManifest.plist`
|
|
40
|
+
- Trustcache
|
|
41
|
+
- Cryptex info plist
|
|
42
|
+
- Volume root hash
|
|
43
|
+
|
|
44
|
+
The split of the new format is requires for OS* other than macOS that will have trouble extracting the original APFS
|
|
45
|
+
image inside: `~/Library/Developer/DeveloperDiskImages`.
|
|
46
|
+
|
|
47
|
+
## Layout
|
|
48
|
+
|
|
49
|
+
| Directory | Consumed by |
|
|
50
|
+
|---|---|
|
|
51
|
+
| `DeveloperDiskImages/<version>/` | iOS < 17.0 |
|
|
52
|
+
| `PersonalizedImages/Xcode_iOS_DDI_Personalized/` | the image mounter (`mounter auto-mount`) |
|
|
53
|
+
| `PersonalizedImages/Xcode_iOS_DDI_Cryptex/` | `cryptexd` (`cryptex auto-install`) |
|
|
54
|
+
|
|
55
|
+
Every payload is published under a fixed file name, so download URLs stay predictable across
|
|
56
|
+
releases:
|
|
57
|
+
|
|
58
|
+
| File | Personalized | Cryptex |
|
|
59
|
+
|---|---|---|
|
|
60
|
+
| `BuildManifest.plist` | yes | yes |
|
|
61
|
+
| `Image.dmg` | `PersonalizedDMG` | `Cryptex1,GenericDmg` |
|
|
62
|
+
| `Image.dmg.trustcache` | `LoadableTrustCache` | `Cryptex1,GenericTrustCache` |
|
|
63
|
+
| `Image.dmg.cryptex_info` | -- | `Cryptex1,CryptexInfoPlist` |
|
|
64
|
+
| `Image.dmg.root_hash` | -- | `Cryptex1,GenericVolume` |
|
|
65
|
+
|
|
66
|
+
Apple's own paths embed a build number (`022-22107-072.dmg`), so the published
|
|
67
|
+
`BuildManifest.plist` is rewritten to declare the fixed names instead. Only `Info.Path` is
|
|
68
|
+
adjusted -- the digests personalization depends on are untouched -- which keeps a downloaded
|
|
69
|
+
cryptex directory usable as a drop-in `Restore` directory.
|
|
70
|
+
|
|
71
|
+
## Updating
|
|
72
|
+
|
|
73
|
+
`update_ddi.py` refreshes every variant from a local Xcode installation. macOS only, no
|
|
74
|
+
dependencies, run it with [uv](https://docs.astral.sh/uv/):
|
|
75
|
+
|
|
76
|
+
```shell
|
|
77
|
+
uv run --script update_ddi.py # refresh every variant of the iOS DDI
|
|
78
|
+
uv run --script update_ddi.py --dry-run # report what would change, write nothing
|
|
79
|
+
uv run --script update_ddi.py --platform tvOS --variant cryptex
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Pass `--script` so uv runs it as a standalone script rather than treating this repository as a uv
|
|
83
|
+
project (which would leave a stray `uv.lock` and `.venv` behind).
|
|
84
|
+
|
|
85
|
+
It reads Xcode's bundle from `/Library/Developer` (falling back to attaching
|
|
86
|
+
`CoreDevice/CandidateDDIs/<platform>_DDI.dmg` when no expanded copy exists), verifies every payload
|
|
87
|
+
against the SHA-384 digests in the build manifest before publishing it, and removes stale files
|
|
88
|
+
left over from a previous build. Remember to bump `LATEST_DDI_BUILD_ID` in pymobiledevice3 to match
|
|
89
|
+
whatever build it reports.
|
|
90
|
+
|
|
91
|
+
# Python package
|
|
92
|
+
|
|
93
|
+
Additionally, this repo provides a python API for accessing this repository.
|
|
94
|
+
You can install it as follows:
|
|
95
|
+
|
|
96
|
+
```shell
|
|
97
|
+
python3 -m pip install -U developer_disk_image
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Example usage
|
|
101
|
+
|
|
102
|
+
Payloads are fetched from `raw.githubusercontent.com`, which is not subject to the REST API's
|
|
103
|
+
60-requests-per-hour anonymous quota, so no GitHub token is needed. `create()` accepts a `ref`
|
|
104
|
+
(branch, tag or commit) to read a revision other than `main`.
|
|
105
|
+
|
|
106
|
+
```python
|
|
107
|
+
from developer_disk_image.repo import DeveloperDiskImageRepository
|
|
108
|
+
|
|
109
|
+
repo = DeveloperDiskImageRepository.create()
|
|
110
|
+
|
|
111
|
+
# will get both the APFS and the signature file
|
|
112
|
+
developer_disk_image = repo.get_developer_disk_image('16.4')
|
|
113
|
+
|
|
114
|
+
# will get all necessary files for mount
|
|
115
|
+
personalized_disk_image = repo.get_personalized_disk_image()
|
|
116
|
+
|
|
117
|
+
# will get all necessary files for installing the DDI as a cryptex
|
|
118
|
+
cryptex_disk_image = repo.get_cryptex_disk_image()
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Writing the cryptex assets back out under their published names produces a directory that
|
|
122
|
+
`cryptexd` clients accept as-is:
|
|
123
|
+
|
|
124
|
+
```python
|
|
125
|
+
from pathlib import Path
|
|
126
|
+
|
|
127
|
+
from developer_disk_image.repo import CRYPTEX_IMAGE_PAYLOADS
|
|
128
|
+
|
|
129
|
+
restore = Path('Xcode_iOS_DDI_Cryptex')
|
|
130
|
+
restore.mkdir(parents=True, exist_ok=True)
|
|
131
|
+
(restore / 'BuildManifest.plist').write_bytes(cryptex_disk_image.build_manifest)
|
|
132
|
+
for field, name in CRYPTEX_IMAGE_PAYLOADS.items():
|
|
133
|
+
(restore / name).write_bytes(getattr(cryptex_disk_image, field))
|
|
134
|
+
```
|
{developer_disk_image-0.1.0 → developer_disk_image-0.3.0}/developer_disk_image.egg-info/SOURCES.txt
RENAMED
|
@@ -3,6 +3,7 @@ MANIFEST.in
|
|
|
3
3
|
README.md
|
|
4
4
|
pyproject.toml
|
|
5
5
|
requirements.txt
|
|
6
|
+
update_ddi.py
|
|
6
7
|
.github/ISSUE_TEMPLATE/feature_request.md
|
|
7
8
|
.github/workflows/codeql.yml
|
|
8
9
|
.github/workflows/python-app.yml
|
|
@@ -16,6 +17,8 @@ developer_disk_image.egg-info/SOURCES.txt
|
|
|
16
17
|
developer_disk_image.egg-info/dependency_links.txt
|
|
17
18
|
developer_disk_image.egg-info/entry_points.txt
|
|
18
19
|
developer_disk_image.egg-info/requires.txt
|
|
20
|
+
developer_disk_image.egg-info/scm_file_list.json
|
|
21
|
+
developer_disk_image.egg-info/scm_version.json
|
|
19
22
|
developer_disk_image.egg-info/top_level.txt
|
|
20
23
|
tests/__init__.py
|
|
21
24
|
tests/test_repo.py
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
{
|
|
2
|
+
"files": [
|
|
3
|
+
"requirements.txt",
|
|
4
|
+
"MANIFEST.in",
|
|
5
|
+
"update_ddi.py",
|
|
6
|
+
"pyproject.toml",
|
|
7
|
+
"README.md",
|
|
8
|
+
".gitignore",
|
|
9
|
+
".github/ISSUE_TEMPLATE/feature_request.md",
|
|
10
|
+
".github/workflows/python-publish.yml",
|
|
11
|
+
".github/workflows/python-app.yml",
|
|
12
|
+
".github/workflows/codeql.yml",
|
|
13
|
+
"PersonalizedImages/Xcode_iOS_DDI_Cryptex/Image.dmg.cryptex_info",
|
|
14
|
+
"PersonalizedImages/Xcode_iOS_DDI_Cryptex/BuildManifest.plist",
|
|
15
|
+
"PersonalizedImages/Xcode_iOS_DDI_Cryptex/Image.dmg.trustcache",
|
|
16
|
+
"PersonalizedImages/Xcode_iOS_DDI_Cryptex/Image.dmg.root_hash",
|
|
17
|
+
"PersonalizedImages/Xcode_iOS_DDI_Cryptex/Image.dmg",
|
|
18
|
+
"PersonalizedImages/Xcode_iOS_DDI_Personalized/BuildManifest.plist",
|
|
19
|
+
"PersonalizedImages/Xcode_iOS_DDI_Personalized/Image.dmg.trustcache",
|
|
20
|
+
"PersonalizedImages/Xcode_iOS_DDI_Personalized/Image.dmg",
|
|
21
|
+
"tests/__init__.py",
|
|
22
|
+
"tests/test_repo.py",
|
|
23
|
+
"developer_disk_image/__init__.py",
|
|
24
|
+
"developer_disk_image/exceptions.py",
|
|
25
|
+
"developer_disk_image/repo.py",
|
|
26
|
+
"DeveloperDiskImages/13.7/DeveloperDiskImage.dmg.signature",
|
|
27
|
+
"DeveloperDiskImages/13.7/DeveloperDiskImage.dmg",
|
|
28
|
+
"DeveloperDiskImages/16.0/DeveloperDiskImage.dmg.signature",
|
|
29
|
+
"DeveloperDiskImages/16.0/DeveloperDiskImage.dmg",
|
|
30
|
+
"DeveloperDiskImages/15.4/DeveloperDiskImage.dmg.signature",
|
|
31
|
+
"DeveloperDiskImages/15.4/DeveloperDiskImage.dmg",
|
|
32
|
+
"DeveloperDiskImages/16.4/DeveloperDiskImage.dmg.signature",
|
|
33
|
+
"DeveloperDiskImages/16.4/DeveloperDiskImage.dmg",
|
|
34
|
+
"DeveloperDiskImages/12.4/DeveloperDiskImage.dmg.signature",
|
|
35
|
+
"DeveloperDiskImages/12.4/DeveloperDiskImage.dmg",
|
|
36
|
+
"DeveloperDiskImages/16.6/DeveloperDiskImage.dmg.signature",
|
|
37
|
+
"DeveloperDiskImages/16.6/DeveloperDiskImage.dmg",
|
|
38
|
+
"DeveloperDiskImages/14.2/DeveloperDiskImage.dmg.signature",
|
|
39
|
+
"DeveloperDiskImages/14.2/DeveloperDiskImage.dmg",
|
|
40
|
+
"DeveloperDiskImages/14.5/DeveloperDiskImage.dmg.signature",
|
|
41
|
+
"DeveloperDiskImages/14.5/DeveloperDiskImage.dmg",
|
|
42
|
+
"DeveloperDiskImages/15.0/DeveloperDiskImage.dmg.signature",
|
|
43
|
+
"DeveloperDiskImages/15.0/DeveloperDiskImage.dmg",
|
|
44
|
+
"DeveloperDiskImages/12.0/DeveloperDiskImage.dmg.signature",
|
|
45
|
+
"DeveloperDiskImages/12.0/DeveloperDiskImage.dmg",
|
|
46
|
+
"DeveloperDiskImages/16.2/DeveloperDiskImage.dmg.signature",
|
|
47
|
+
"DeveloperDiskImages/16.2/DeveloperDiskImage.dmg",
|
|
48
|
+
"DeveloperDiskImages/13.6/DeveloperDiskImage.dmg.signature",
|
|
49
|
+
"DeveloperDiskImages/13.6/DeveloperDiskImage.dmg",
|
|
50
|
+
"DeveloperDiskImages/13.4/DeveloperDiskImage.dmg.signature",
|
|
51
|
+
"DeveloperDiskImages/13.4/DeveloperDiskImage.dmg",
|
|
52
|
+
"DeveloperDiskImages/15.6/DeveloperDiskImage.dmg.signature",
|
|
53
|
+
"DeveloperDiskImages/15.6/DeveloperDiskImage.dmg",
|
|
54
|
+
"DeveloperDiskImages/15.8/DeveloperDiskImage.dmg.signature",
|
|
55
|
+
"DeveloperDiskImages/15.8/DeveloperDiskImage.dmg",
|
|
56
|
+
"DeveloperDiskImages/14.3/DeveloperDiskImage.dmg.signature",
|
|
57
|
+
"DeveloperDiskImages/14.3/DeveloperDiskImage.dmg",
|
|
58
|
+
"DeveloperDiskImages/14.4/DeveloperDiskImage.dmg.signature",
|
|
59
|
+
"DeveloperDiskImages/14.4/DeveloperDiskImage.dmg",
|
|
60
|
+
"DeveloperDiskImages/14.6/DeveloperDiskImage.dmg.signature",
|
|
61
|
+
"DeveloperDiskImages/14.6/DeveloperDiskImage.dmg",
|
|
62
|
+
"DeveloperDiskImages/13.2/DeveloperDiskImage.dmg.signature",
|
|
63
|
+
"DeveloperDiskImages/13.2/DeveloperDiskImage.dmg",
|
|
64
|
+
"DeveloperDiskImages/16.1/DeveloperDiskImage.dmg.signature",
|
|
65
|
+
"DeveloperDiskImages/16.1/DeveloperDiskImage.dmg",
|
|
66
|
+
"DeveloperDiskImages/16.7/DeveloperDiskImage.dmg.signature",
|
|
67
|
+
"DeveloperDiskImages/16.7/DeveloperDiskImage.dmg",
|
|
68
|
+
"DeveloperDiskImages/14.7/DeveloperDiskImage.dmg.signature",
|
|
69
|
+
"DeveloperDiskImages/14.7/DeveloperDiskImage.dmg",
|
|
70
|
+
"DeveloperDiskImages/15.2/DeveloperDiskImage.dmg.signature",
|
|
71
|
+
"DeveloperDiskImages/15.2/DeveloperDiskImage.dmg",
|
|
72
|
+
"DeveloperDiskImages/16.5/DeveloperDiskImage.dmg.signature",
|
|
73
|
+
"DeveloperDiskImages/16.5/DeveloperDiskImage.dmg",
|
|
74
|
+
"DeveloperDiskImages/12.2/DeveloperDiskImage.dmg.signature",
|
|
75
|
+
"DeveloperDiskImages/12.2/DeveloperDiskImage.dmg",
|
|
76
|
+
"DeveloperDiskImages/13.5/DeveloperDiskImage.dmg.signature",
|
|
77
|
+
"DeveloperDiskImages/13.5/DeveloperDiskImage.dmg",
|
|
78
|
+
"DeveloperDiskImages/14.8/DeveloperDiskImage.dmg.signature",
|
|
79
|
+
"DeveloperDiskImages/14.8/DeveloperDiskImage.dmg",
|
|
80
|
+
"DeveloperDiskImages/13.3/DeveloperDiskImage.dmg.signature",
|
|
81
|
+
"DeveloperDiskImages/13.3/DeveloperDiskImage.dmg",
|
|
82
|
+
"DeveloperDiskImages/15.1/DeveloperDiskImage.dmg.signature",
|
|
83
|
+
"DeveloperDiskImages/15.1/DeveloperDiskImage.dmg",
|
|
84
|
+
"DeveloperDiskImages/16.3/DeveloperDiskImage.dmg.signature",
|
|
85
|
+
"DeveloperDiskImages/16.3/DeveloperDiskImage.dmg",
|
|
86
|
+
"DeveloperDiskImages/15.5/DeveloperDiskImage.dmg.signature",
|
|
87
|
+
"DeveloperDiskImages/15.5/DeveloperDiskImage.dmg",
|
|
88
|
+
"DeveloperDiskImages/15.3/DeveloperDiskImage.dmg.signature",
|
|
89
|
+
"DeveloperDiskImages/15.3/DeveloperDiskImage.dmg",
|
|
90
|
+
"DeveloperDiskImages/13.0/DeveloperDiskImage.dmg.signature",
|
|
91
|
+
"DeveloperDiskImages/13.0/DeveloperDiskImage.dmg",
|
|
92
|
+
"DeveloperDiskImages/11.4/DeveloperDiskImage.dmg.signature",
|
|
93
|
+
"DeveloperDiskImages/11.4/DeveloperDiskImage.dmg",
|
|
94
|
+
"DeveloperDiskImages/12.1/DeveloperDiskImage.dmg.signature",
|
|
95
|
+
"DeveloperDiskImages/12.1/DeveloperDiskImage.dmg",
|
|
96
|
+
"DeveloperDiskImages/15.7/DeveloperDiskImage.dmg.signature",
|
|
97
|
+
"DeveloperDiskImages/15.7/DeveloperDiskImage.dmg",
|
|
98
|
+
"DeveloperDiskImages/14.0/DeveloperDiskImage.dmg.signature",
|
|
99
|
+
"DeveloperDiskImages/14.0/DeveloperDiskImage.dmg",
|
|
100
|
+
"DeveloperDiskImages/13.1/DeveloperDiskImage.dmg.signature",
|
|
101
|
+
"DeveloperDiskImages/13.1/DeveloperDiskImage.dmg",
|
|
102
|
+
"DeveloperDiskImages/12.3/DeveloperDiskImage.dmg.signature",
|
|
103
|
+
"DeveloperDiskImages/12.3/DeveloperDiskImage.dmg",
|
|
104
|
+
"DeveloperDiskImages/14.1/DeveloperDiskImage.dmg.signature",
|
|
105
|
+
"DeveloperDiskImages/14.1/DeveloperDiskImage.dmg"
|
|
106
|
+
]
|
|
107
|
+
}
|