├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── workflows │ ├── codeql.yml │ ├── python-app.yml │ └── python-publish.yml ├── .gitignore ├── .pre-commit-config.yaml ├── CODE_OF_CONDUCT.md ├── LICENSE ├── README.md ├── ipsw_parser ├── __init__.py ├── __main__.py ├── build_identity.py ├── build_manifest.py ├── component.py ├── exceptions.py ├── firmware.py └── ipsw.py ├── pyproject.toml ├── pytest.ini └── requirements.txt /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | *.py filter=tabspace 3 | *.py filter=indent 4 | *.py filter=ident 5 | utils/*.py filter=tabspace 6 | utils/*.py filter=indent 7 | utils/*py filter=ident 8 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Test environment** 11 | - Host OS version 12 | - Python version 13 | - Input IPSW 14 | 15 | **Describe the bug** 16 | A clear and concise description of what the bug is. 17 | 18 | **To Reproduce** 19 | Steps to reproduce the behavior: 20 | 1. Go to '...' 21 | 2. Click on '....' 22 | 3. Scroll down to '....' 23 | 4. See error 24 | 25 | **Expected behavior** 26 | A clear and concise description of what you expected to happen. 27 | 28 | **Logs** 29 | If applicable, add logs including backtraces for the given error that help explain your problem. 30 | 31 | **Additional context** 32 | Add any other context about the problem here. 33 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/workflows/codeql.yml: -------------------------------------------------------------------------------- 1 | # For most projects, this workflow file will not need changing; you simply need 2 | # to commit it to your repository. 3 | # 4 | # You may wish to alter this file to override the set of languages analyzed, 5 | # or to provide custom queries or build logic. 6 | # 7 | # ******** NOTE ******** 8 | # We have attempted to detect the languages in your repository. Please check 9 | # the `language` matrix defined below to confirm you have the correct set of 10 | # supported CodeQL languages. 11 | # 12 | name: "CodeQL" 13 | 14 | on: 15 | push: 16 | branches: [ "master" ] 17 | pull_request: 18 | # The branches below must be a subset of the branches above 19 | branches: [ "master" ] 20 | schedule: 21 | - cron: '25 3 * * 5' 22 | 23 | jobs: 24 | analyze: 25 | name: Analyze 26 | runs-on: ubuntu-latest 27 | permissions: 28 | actions: read 29 | contents: read 30 | security-events: write 31 | 32 | strategy: 33 | fail-fast: false 34 | matrix: 35 | language: [ 'python' ] 36 | # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] 37 | # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support 38 | 39 | steps: 40 | - name: Checkout repository 41 | uses: actions/checkout@v3 42 | 43 | # Initializes the CodeQL tools for scanning. 44 | - name: Initialize CodeQL 45 | uses: github/codeql-action/init@v2 46 | with: 47 | languages: ${{ matrix.language }} 48 | # If you wish to specify custom queries, you can do so here or in a config file. 49 | # By default, queries listed here will override any specified in a config file. 50 | # Prefix the list here with "+" to use these queries and those in the config file. 51 | 52 | # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs 53 | # queries: security-extended,security-and-quality 54 | 55 | 56 | # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java). 57 | # If this step fails, then you should remove it and run the build manually (see below) 58 | - name: Autobuild 59 | uses: github/codeql-action/autobuild@v2 60 | 61 | # ℹ️ Command-line programs to run using the OS shell. 62 | # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun 63 | 64 | # If the Autobuild fails above, remove it and uncomment the following three lines. 65 | # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. 66 | 67 | # - run: | 68 | # echo "Run, Build Application using script" 69 | # ./location_of_script_within_repo/buildscript.sh 70 | 71 | - name: Perform CodeQL Analysis 72 | uses: github/codeql-action/analyze@v2 73 | with: 74 | category: "/language:${{matrix.language}}" 75 | -------------------------------------------------------------------------------- /.github/workflows/python-app.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a single version of Python 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Python application 5 | 6 | on: 7 | push: 8 | branches: [ '**' ] 9 | 10 | jobs: 11 | build: 12 | runs-on: ${{ matrix.os }} 13 | 14 | strategy: 15 | matrix: 16 | python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ] 17 | os: [ ubuntu-latest, macos-latest, windows-latest ] 18 | 19 | steps: 20 | - uses: actions/checkout@v2 21 | - name: Set up Python ${{ matrix.python-version }} 22 | uses: actions/setup-python@v2 23 | with: 24 | python-version: ${{ matrix.python-version }} 25 | - name: Install dependencies 26 | run: | 27 | python3 -m pip install --upgrade pip 28 | python3 -m pip install pre-commit 29 | - name: Run pre-commit hooks 30 | run: | 31 | pre-commit run --all-files 32 | - name: Test install 33 | run: | 34 | python -m pip install -U . 35 | - name: Test show usage 36 | run: | 37 | python -m ipsw_parser --help 38 | -------------------------------------------------------------------------------- /.github/workflows/python-publish.yml: -------------------------------------------------------------------------------- 1 | # This workflows will upload a Python Package using Twine when a release is created 2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries 3 | 4 | name: Upload Python Package 5 | 6 | on: 7 | release: 8 | types: [created] 9 | 10 | jobs: 11 | deploy: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Set up Python 18 | uses: actions/setup-python@v2 19 | with: 20 | python-version: '3.x' 21 | - name: Install dependencies 22 | run: | 23 | python -m pip install --upgrade pip 24 | pip install build setuptools wheel twine 25 | - name: Build and publish 26 | env: 27 | TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} 28 | TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} 29 | run: | 30 | python -m build 31 | twine upload dist/* -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .idea/ 3 | venv/ 4 | build/ 5 | dist/ 6 | version.txt 7 | debug/ 8 | *.pyc 9 | *.egg-info/ 10 | /ipsw_parser/_version.py 11 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/mirrors-isort 3 | rev: v5.9.3 4 | hooks: 5 | - id: isort 6 | args: [ '-m', 'HANGING_INDENT', '-l', '120','--check-only' ] 7 | files: \.py$ 8 | 9 | - repo: https://github.com/pycqa/flake8 10 | rev: "7.0.0" 11 | hooks: 12 | - id: flake8 13 | args: [ '--count', '--select=E9,F63,F7,F82,F401,E741', '--show-source', '--statistics', '--max-complexity=10', '--max-line-length=127' ] 14 | files: \.py$ -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement. 63 | All complaints will be reviewed and investigated promptly and fairly. 64 | 65 | All community leaders are obligated to respect the privacy and security of the 66 | reporter of any incident. 67 | 68 | ## Enforcement Guidelines 69 | 70 | Community leaders will follow these Community Impact Guidelines in determining 71 | the consequences for any action they deem in violation of this Code of Conduct: 72 | 73 | ### 1. Correction 74 | 75 | **Community Impact**: Use of inappropriate language or other behavior deemed 76 | unprofessional or unwelcome in the community. 77 | 78 | **Consequence**: A private, written warning from community leaders, providing 79 | clarity around the nature of the violation and an explanation of why the 80 | behavior was inappropriate. A public apology may be requested. 81 | 82 | ### 2. Warning 83 | 84 | **Community Impact**: A violation through a single incident or series 85 | of actions. 86 | 87 | **Consequence**: A warning with consequences for continued behavior. No 88 | interaction with the people involved, including unsolicited interaction with 89 | those enforcing the Code of Conduct, for a specified period of time. This 90 | includes avoiding interactions in community spaces as well as external channels 91 | like social media. Violating these terms may lead to a temporary or 92 | permanent ban. 93 | 94 | ### 3. Temporary Ban 95 | 96 | **Community Impact**: A serious violation of community standards, including 97 | sustained inappropriate behavior. 98 | 99 | **Consequence**: A temporary ban from any sort of interaction or public 100 | communication with the community for a specified period of time. No public or 101 | private interaction with the people involved, including unsolicited interaction 102 | with those enforcing the Code of Conduct, is allowed during this period. 103 | Violating these terms may lead to a permanent ban. 104 | 105 | ### 4. Permanent Ban 106 | 107 | **Community Impact**: Demonstrating a pattern of violation of community 108 | standards, including sustained inappropriate behavior, harassment of an 109 | individual, or aggression toward or disparagement of classes of individuals. 110 | 111 | **Consequence**: A permanent ban from any sort of public interaction within 112 | the community. 113 | 114 | ## Attribution 115 | 116 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 117 | version 2.0, available at 118 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 119 | 120 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 121 | enforcement ladder](https://github.com/mozilla/diversity). 122 | 123 | [homepage]: https://www.contributor-covenant.org 124 | 125 | For answers to common questions about this code of conduct, see the FAQ at 126 | https://www.contributor-covenant.org/faq. Translations are available at 127 | https://www.contributor-covenant.org/translations. 128 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ipsw-parser 2 | 3 | [![Python application](https://github.com/doronz88/ipsw_parser/workflows/Python%20application/badge.svg)](https://github.com/doronz88/ipsw_parser/actions/workflows/python-app.yml "Python application action") 4 | [![Pypi version](https://img.shields.io/pypi/v/ipsw_parser.svg)](https://pypi.org/project/ipsw_parser/ "PyPi package") 5 | [![Downloads](https://static.pepy.tech/personalized-badge/ipsw_parser?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/ipsw_parser) 6 | 7 | ## Overview 8 | 9 | python3 utility for parsing and extracting data from IPSW. 10 | 11 | ## Installation 12 | 13 | ```shell 14 | python3 -m pip install ipsw-parser 15 | ``` 16 | 17 | Additionally, if you installed [blacktop/ipsw](https://github.com/blacktop/ipsw), the IPSW extraction will also contain 18 | the split DSC. 19 | 20 | ## Usage 21 | 22 | ``` 23 | Usage: ipsw-parser [OPTIONS] COMMAND [ARGS]... 24 | 25 | CLI utility for extracting info from IPSW files 26 | 27 | Options: 28 | --help Show this message and exit. 29 | 30 | Commands: 31 | device-support Create DeviceSupport directory 32 | extract Extract .ipsw into filesystem layout 33 | info Parse given .ipsw basic info 34 | ``` 35 | -------------------------------------------------------------------------------- /ipsw_parser/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/doronz88/ipsw_parser/a33d89afcc6a77fdf2b0c7d9e57a30e830448ad3/ipsw_parser/__init__.py -------------------------------------------------------------------------------- /ipsw_parser/__main__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import logging 3 | from pathlib import Path 4 | from typing import Optional 5 | from zipfile import ZipFile 6 | 7 | import click 8 | import coloredlogs 9 | from remotezip2 import RemoteZip 10 | 11 | from ipsw_parser.ipsw import IPSW 12 | 13 | coloredlogs.install(level=logging.DEBUG) 14 | 15 | logging.getLogger('asyncio').disabled = True 16 | logging.getLogger('parso.cache').disabled = True 17 | logging.getLogger('parso.cache.pickle').disabled = True 18 | logging.getLogger('parso.python.diff').disabled = True 19 | logging.getLogger('humanfriendly.prompts').disabled = True 20 | logging.getLogger('blib2to3.pgen2.driver').disabled = True 21 | logging.getLogger('urllib3.connectionpool').disabled = True 22 | 23 | logger = logging.getLogger(__name__) 24 | 25 | PEM_DB_ENV_VAR = 'IPSW_PARSER_PEM_DB' 26 | 27 | 28 | def handle_ipsw_argument(ctx: click.Context, param: click.Argument, value: str) -> IPSW: 29 | if value.startswith('http://') or value.startswith('https://'): 30 | return IPSW(RemoteZip(value)) 31 | return IPSW(ZipFile(Path(value).expanduser())) 32 | 33 | 34 | ipsw_argument = click.argument('ipsw', callback=handle_ipsw_argument) 35 | pem_db_option = click.option('--pem-db', envvar=PEM_DB_ENV_VAR, 36 | help='Path DB file url (can be either a filesystem path or an HTTP URL). ' 37 | 'Alternatively, use the IPSW_PARSER_PEM_DB envvar.') 38 | 39 | 40 | @click.group() 41 | def cli() -> None: 42 | """ CLI utility for extracting info from IPSW files """ 43 | pass 44 | 45 | 46 | @cli.command('info') 47 | @ipsw_argument 48 | def info(ipsw) -> None: 49 | """ Parse given .ipsw basic info """ 50 | print(f'SupportedProductTypes: {ipsw.build_manifest.supported_product_types}') 51 | print(f'ProductVersion: {ipsw.build_manifest.product_version}') 52 | print(f'ProductBuildVersion: {ipsw.build_manifest.product_build_version}') 53 | 54 | development_files = ipsw.get_development_files() 55 | if development_files: 56 | print('DevelopmentFiles:') 57 | for file in development_files: 58 | print(f'- {file}') 59 | 60 | 61 | @cli.command('extract') 62 | @ipsw_argument 63 | @click.argument('output', type=click.Path(exists=False)) 64 | @pem_db_option 65 | def extract(ipsw: IPSW, output: str, pem_db: Optional[str]) -> None: 66 | """ Extract .ipsw into filesystem layout """ 67 | output = Path(output) 68 | 69 | if not output.exists(): 70 | output.mkdir(parents=True, exist_ok=True) 71 | 72 | ipsw.build_manifest.build_identities[0].extract(output, pem_db=pem_db) 73 | ipsw.archive.extractall( 74 | path=output, members=[f for f in ipsw.archive.filelist if f.filename.startswith('Firmware')]) 75 | 76 | 77 | @cli.command('extract-kernel') 78 | @ipsw_argument 79 | @click.argument('output', type=click.Path(exists=False)) 80 | @click.option('--arch', help='Arch name to extract using lipo') 81 | def extract_kernel(ipsw: IPSW, output: str, arch: Optional[str]) -> None: 82 | """ Extract kernelcache from given .ipsw into given output filename """ 83 | Path(output).write_bytes(ipsw.build_manifest.build_identities[0].get_kernelcache_payload(arch=arch)) 84 | 85 | 86 | @cli.command('device-support') 87 | @ipsw_argument 88 | @pem_db_option 89 | def device_support(ipsw: IPSW, pem_db: Optional[str]) -> None: 90 | """ Create DeviceSupport directory """ 91 | ipsw.create_device_support(pem_db=pem_db) 92 | 93 | 94 | if __name__ == '__main__': 95 | cli() 96 | -------------------------------------------------------------------------------- /ipsw_parser/build_identity.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import shutil 3 | from collections import UserDict 4 | from pathlib import Path 5 | from tempfile import TemporaryDirectory 6 | from typing import Optional 7 | 8 | import requests 9 | from cached_property import cached_property 10 | from plumbum import ProcessExecutionError, local 11 | from pyimg4 import IM4P 12 | 13 | from ipsw_parser.component import Component 14 | 15 | logger = logging.getLogger(__name__) 16 | 17 | 18 | def _extract_dmg(buf: bytes, output: Path, sub_path: Optional[Path] = None, pem_db: Optional[str] = None) -> None: 19 | ipsw = local['ipsw'] 20 | hdiutil = local['hdiutil'] 21 | # darwin system statistically have problems cleaning up after detaching the mountpoint 22 | with TemporaryDirectory() as temp_dir: 23 | temp_dir = Path(temp_dir) 24 | mnt = temp_dir / 'mnt' 25 | mnt.mkdir() 26 | dmg = temp_dir / 'image.dmg' 27 | 28 | if buf.startswith(b'AEA1'): 29 | logger.debug('Found Apple Encrypted Archive. Decrypting...') 30 | dmg_aea = Path(str(dmg) + '.aea') 31 | dmg_aea.write_bytes(buf) 32 | args = ['fw', 'aea', dmg_aea, '-o', temp_dir] 33 | if pem_db is not None: 34 | if '://' in pem_db: 35 | # create a local file containing it 36 | temp_pem_db = temp_dir / 'pem-db.json' 37 | temp_pem_db.write_text(requests.get(pem_db, verify=False).text) 38 | pem_db = temp_pem_db 39 | args += ['--pem-db', pem_db] 40 | ipsw(args) 41 | else: 42 | dmg.write_bytes(buf) 43 | 44 | hdiutil('attach', '-mountpoint', mnt, dmg) 45 | 46 | try: 47 | if sub_path is None: 48 | src = mnt 49 | else: 50 | src = mnt / sub_path 51 | shutil.copytree(src, output, symlinks=True, dirs_exist_ok=True) 52 | except shutil.Error: 53 | # when overwriting the same files, some of them don't contain write permissions 54 | pass 55 | 56 | hdiutil('detach', '-force', mnt) 57 | 58 | 59 | def _split_dsc(root: Path) -> None: 60 | ipsw = local['ipsw'] 61 | dsc_paths = [ 62 | root / 'System/Library/Caches/com.apple.dyld/dyld_shared_cache_arm64', 63 | root / 'System/Library/Caches/com.apple.dyld/dyld_shared_cache_arm64e', 64 | root / 'private/preboot/Cryptexes/OS/System/Library/Caches/com.apple.dyld/dyld_shared_cache_arm64', 65 | root / 'private/preboot/Cryptexes/OS/System/Library/Caches/com.apple.dyld/dyld_shared_cache_arm64e'] 66 | 67 | for dsc in dsc_paths: 68 | if not dsc.exists(): 69 | continue 70 | 71 | logger.info(f'splitting DSC: {dsc}') 72 | ipsw('dyld', 'split', dsc, '-o', root) 73 | 74 | 75 | class BuildIdentity(UserDict): 76 | def __init__(self, build_manifest, data): 77 | super().__init__(data) 78 | self.build_manifest = build_manifest 79 | 80 | @cached_property 81 | def device_class(self) -> str: 82 | return self['Info']['DeviceClass'].lower() 83 | 84 | @cached_property 85 | def restore_behavior(self) -> str: 86 | return self['Info'].get('RestoreBehavior') 87 | 88 | @cached_property 89 | def variant(self): 90 | return self['Info'].get('Variant') 91 | 92 | @cached_property 93 | def macos_variant(self) -> str: 94 | return self['Info'].get('MacOSVariant') 95 | 96 | @cached_property 97 | def manifest(self) -> dict: 98 | return self['Manifest'] 99 | 100 | @cached_property 101 | def minimum_system_partition(self): 102 | return self['Info'].get('MinimumSystemPartition') 103 | 104 | def get_component_path(self, component: str) -> str: 105 | return self.manifest[component]['Info']['Path'] 106 | 107 | def has_component(self, name: str) -> bool: 108 | return name in self.manifest 109 | 110 | def get_component(self, name: str, **args) -> Component: 111 | return Component(self, name, **args) 112 | 113 | def extract_dsc(self, output: Path, pem_db: Optional[str] = None) -> None: 114 | build_identity = self.build_manifest.build_identities[0] 115 | if not build_identity.has_component('Cryptex1,SystemOS'): 116 | return 117 | 118 | device_support_symbols_path = output / 'private/preboot/Cryptexes/OS/System' 119 | device_support_symbols_path.mkdir(parents=True, exist_ok=True) 120 | 121 | _extract_dmg(build_identity.get_component('Cryptex1,SystemOS').data, device_support_symbols_path, 122 | sub_path=Path('System'), pem_db=pem_db) 123 | _split_dsc(output) 124 | 125 | def get_kernelcache_payload(self, arch: Optional[str] = None) -> bytes: 126 | im4p = IM4P(self.build_manifest.build_identities[0].get_component('KernelCache').data) 127 | im4p.payload.decompress() 128 | payload = im4p.payload.output().data 129 | if arch is None: 130 | return payload 131 | 132 | with TemporaryDirectory() as temp_dir: 133 | kernel_output = Path(temp_dir) / 'kernel' 134 | local['ipsw']('macho', 'lipo', '-a', arch, kernel_output) 135 | return Path(next(kernel_output.parent.glob(f'*.{arch}'))).read_bytes() 136 | 137 | def extract(self, output: Path, pem_db: Optional[str] = None) -> None: 138 | logger.info(f'extracting into: {output}') 139 | 140 | build_identity = self.build_manifest.build_identities[0] 141 | 142 | logger.info(f'extracting OS into: {output}') 143 | _extract_dmg(build_identity.get_component('OS').data, output, pem_db=pem_db) 144 | 145 | kernel_component = build_identity.get_component('KernelCache') 146 | kernel_path = Path(kernel_component.path) 147 | kernel_output = output / 'System/Library/Caches/com.apple.kernelcaches' / kernel_path.parts[-1] 148 | kernel_output.parent.mkdir(parents=True, exist_ok=True) 149 | 150 | logger.info(f'extracting kernel into: {kernel_output}') 151 | im4p = IM4P(kernel_component.data) 152 | im4p.payload.decompress() 153 | kernel_output.write_bytes(im4p.payload.output().data) 154 | try: 155 | # In case the kernel is a FAT image, extract the arm64 macho 156 | local['ipsw']('macho', 'lipo', '-a', 'arm64', kernel_output) 157 | list(kernel_output.parent.glob('*.arm64'))[0].rename(kernel_output) 158 | except ProcessExecutionError: 159 | pass 160 | 161 | for cryptex in ('App', 'OS'): 162 | name = { 163 | 'App': 'Cryptex1,AppOS', 164 | 'OS': 'Cryptex1,SystemOS', 165 | }[cryptex] 166 | 167 | if not build_identity.has_component(name): 168 | continue 169 | 170 | cryptex_path = output / 'private/preboot/Cryptexes' / cryptex 171 | cryptex_path.mkdir(parents=True, exist_ok=True) 172 | 173 | logger.info(f'extracting {name} into: {cryptex_path}') 174 | _extract_dmg(build_identity.get_component(name).data, cryptex_path, pem_db=pem_db) 175 | 176 | _split_dsc(output) 177 | -------------------------------------------------------------------------------- /ipsw_parser/build_manifest.py: -------------------------------------------------------------------------------- 1 | import plistlib 2 | 3 | from cached_property import cached_property 4 | 5 | from ipsw_parser.build_identity import BuildIdentity 6 | from ipsw_parser.exceptions import NoSuchBuildIdentityError 7 | 8 | 9 | class BuildManifest: 10 | def __init__(self, ipsw, manifest: bytes): 11 | self.ipsw = ipsw 12 | self._manifest = plistlib.loads(manifest) 13 | self._parse_build_identities() 14 | 15 | @cached_property 16 | def build_major(self) -> int: 17 | build_major = '' 18 | for i in self._manifest['ProductBuildVersion']: 19 | if i.isdigit(): 20 | build_major += i 21 | else: 22 | break 23 | 24 | return int(build_major) 25 | 26 | @cached_property 27 | def supported_product_types(self) -> list[str]: 28 | return self._manifest['SupportedProductTypes'] 29 | 30 | @cached_property 31 | def supported_product_types_family(self) -> str: 32 | product = self.supported_product_types[0] 33 | if product.startswith('iBridge'): 34 | return 'iBridge' 35 | elif product.startswith('iPhone'): 36 | return 'iPhone' 37 | elif 'Mac' in product: 38 | return 'Mac' 39 | else: 40 | raise ValueError() 41 | 42 | @cached_property 43 | def product_version(self) -> str: 44 | return self._manifest['ProductVersion'] 45 | 46 | @cached_property 47 | def product_build_version(self) -> str: 48 | return self._manifest['ProductBuildVersion'] 49 | 50 | def get_build_identity(self, device_class: str, restore_behavior: str = None, variant: str = None) -> BuildIdentity: 51 | for build_identity in self.build_identities: 52 | if variant is not None: 53 | if variant not in build_identity.variant: 54 | continue 55 | 56 | if build_identity.device_class != device_class: 57 | continue 58 | 59 | if restore_behavior is not None: 60 | if build_identity.restore_behavior != restore_behavior: 61 | continue 62 | 63 | return build_identity 64 | raise NoSuchBuildIdentityError('failed to find the correct BuildIdentity from the BuildManifest') 65 | 66 | def _parse_build_identities(self) -> None: 67 | self.build_identities = [] 68 | for build_identity in self._manifest['BuildIdentities']: 69 | self.build_identities.append(BuildIdentity(self, build_identity)) 70 | -------------------------------------------------------------------------------- /ipsw_parser/component.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os.path 3 | 4 | from cached_property import cached_property 5 | 6 | from ipsw_parser.exceptions import IpswException 7 | 8 | 9 | class TSSResponse(dict): 10 | @property 11 | def ap_img4_ticket(self): 12 | ticket = self.get('ApImg4Ticket') 13 | 14 | if ticket is None: 15 | raise IpswException('TSS response doesn\'t contain a ApImg4Ticket') 16 | 17 | return ticket 18 | 19 | @property 20 | def bb_ticket(self): 21 | return self.get('BBTicket') 22 | 23 | def get_path_by_entry(self, component: str): 24 | node = self.get(component) 25 | if node is not None: 26 | return node.get('Path') 27 | 28 | return None 29 | 30 | 31 | class Component: 32 | def __init__(self, build_identity, name: str, tss: TSSResponse = None, data: bytes = None, path: str = None): 33 | self.logger = logging.getLogger(__name__) 34 | self._tss = tss 35 | self.build_identity = build_identity 36 | self.name = name 37 | self._data = data 38 | self._path = path 39 | 40 | @cached_property 41 | def path(self) -> str: 42 | if self._path: 43 | return self._path 44 | 45 | path = None 46 | if self._tss: 47 | path = self._tss.get_path_by_entry(self.name) 48 | 49 | if path is None: 50 | self.logger.debug(f'NOTE: No path for component {self.name} in TSS, will fetch from build_identity') 51 | 52 | if path is None: 53 | path = self.build_identity.get_component_path(self.name) 54 | 55 | if path is None: 56 | raise IpswException(f'Failed to find component path for: {self.name}') 57 | 58 | return path 59 | 60 | @cached_property 61 | def data(self) -> bytes: 62 | if self._data is None: 63 | self.logger.debug(f'Extracting {os.path.basename(self.path)} ({self.path})') 64 | return self.build_identity.build_manifest.ipsw.read(self.path) 65 | return self._data 66 | -------------------------------------------------------------------------------- /ipsw_parser/exceptions.py: -------------------------------------------------------------------------------- 1 | class IpswException(Exception): 2 | pass 3 | 4 | 5 | class NoSuchBuildIdentityError(IpswException): 6 | pass 7 | -------------------------------------------------------------------------------- /ipsw_parser/firmware.py: -------------------------------------------------------------------------------- 1 | class Firmware: 2 | def __init__(self, firmware_path: str, ipsw): 3 | self._ipsw = ipsw 4 | self._firmware_path = firmware_path 5 | self._manifest_data = self._ipsw.read(self.get_relative_path('manifest')) 6 | self._firmware_files = {} 7 | for filename in self._manifest_data.splitlines(): 8 | filename = filename.strip() 9 | component_name = self.get_component_name(filename) 10 | self._firmware_files[component_name] = f'{firmware_path}/{filename}' 11 | 12 | def get_relative_path(self, path: str): 13 | return f'{self._firmware_path}/{path}' 14 | 15 | def get_files(self): 16 | return self._firmware_files 17 | 18 | @staticmethod 19 | def get_component_name(filename): 20 | names = { 21 | 'LLB': 'LLB', 22 | 'iBoot': 'iBoot', 23 | 'DeviceTree': 'DeviceTree', 24 | 'applelogo': 'AppleLogo', 25 | 'liquiddetect': 'Liquid', 26 | 'lowpowermode': 'LowPowerWallet0', 27 | 'recoverymode': 'RecoveryMode', 28 | 'batterylow0': 'BatteryLow0', 29 | 'batterylow1': 'BatteryLow1', 30 | 'glyphcharging': 'BatteryCharging', 31 | 'glyphplugin': 'BatteryPlugin', 32 | 'batterycharging0': 'BatteryCharging0', 33 | 'batterycharging1': 'BatteryCharging1', 34 | 'batteryfull': 'BatteryFull', 35 | 'needservice': 'NeedService', 36 | 'SCAB': 'SCAB', 37 | 'sep-firmware': 'RestoreSEP', 38 | } 39 | return names.get(filename) 40 | -------------------------------------------------------------------------------- /ipsw_parser/ipsw.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import plistlib 3 | import zipfile 4 | from contextlib import contextmanager 5 | from datetime import datetime 6 | from pathlib import Path 7 | from typing import Optional 8 | 9 | from cached_property import cached_property 10 | from construct import Const, Default, PaddedString, Struct 11 | 12 | from ipsw_parser.build_manifest import BuildManifest 13 | from ipsw_parser.firmware import Firmware 14 | 15 | logger = logging.getLogger(__name__) 16 | 17 | cpio_odc_header = Struct( 18 | 'c_magic' / Const('070707', PaddedString(6, 'utf8')), 19 | 'c_dev' / Default(PaddedString(6, 'utf8'), '0' * 6, ), 20 | 'c_ino' / PaddedString(6, 'utf8'), 21 | 'c_mode' / PaddedString(6, 'utf8'), 22 | 'c_uid' / Default(PaddedString(6, 'utf8'), '0' * 6), 23 | 'c_gid' / Default(PaddedString(6, 'utf8'), '0' * 6), 24 | 'c_nlink' / PaddedString(6, 'utf8'), 25 | 'c_rdev' / Default(PaddedString(6, 'utf8'), '0' * 6), 26 | 'c_mtime' / Default(PaddedString(11, 'utf8'), '0' * 11), 27 | 'c_namesize' / PaddedString(6, 'utf8'), 28 | 'c_filesize' / Default(PaddedString(11, 'utf8'), '0' * 11), 29 | ) 30 | 31 | 32 | class IPSW: 33 | def __init__(self, archive: zipfile.ZipFile): 34 | self.archive = archive 35 | self._logger = logging.getLogger(__file__) 36 | self.build_manifest = BuildManifest(self, self.archive.read( 37 | next(f for f in self.archive.namelist() if f.startswith('BuildManifest') and f.endswith('.plist')))) 38 | 39 | @cached_property 40 | def restore_version(self) -> bytes: 41 | return self.read('RestoreVersion.plist') 42 | 43 | @cached_property 44 | def system_version(self) -> bytes: 45 | return self.read('SystemVersion.plist') 46 | 47 | @cached_property 48 | def filelist(self) -> list[zipfile.ZipInfo]: 49 | return self.archive.filelist 50 | 51 | @contextmanager 52 | def open_path(self, path: str): 53 | file = self.archive.open(path) 54 | try: 55 | yield file 56 | finally: 57 | file.close() 58 | 59 | @property 60 | def bootability(self) -> bytes: 61 | result = b'' 62 | prefix = 'BootabilityBundle/Restore/Bootability/' 63 | inode = 1 64 | nlink = 1 65 | 66 | for e in self.filelist: 67 | if e.filename == 'BootabilityBundle/Restore/Firmware/Bootability.dmg.trustcache': 68 | subpath = 'Bootability.trustcache' 69 | elif not e.filename.startswith(prefix): 70 | continue 71 | else: 72 | subpath = e.filename[len(prefix):] 73 | 74 | self._logger.debug(f'BootabilityBundle: adding {subpath}') 75 | 76 | filename = subpath 77 | filename = f'{filename}\0'.encode() 78 | mode = e.external_attr >> 16 79 | result += cpio_odc_header.build({ 80 | 'c_ino': f'{inode:06o}', 'c_nlink': f'{nlink:06o}', 'c_mode': f'{mode:06o}', 81 | 'c_namesize': f'{len(filename):06o}', 'c_filesize': f'{e.file_size:011o}'}) 82 | inode += 1 83 | result += filename 84 | if not e.file_size: 85 | continue 86 | 87 | with self.open_path(e.filename) as f: 88 | result += f.read() 89 | 90 | filename = b'TRAILER!!!\0' 91 | inode = 0 92 | mode = 0 93 | result += cpio_odc_header.build( 94 | {'c_ino': f'{inode:06o}', 'c_mode': f'{mode:06o}', 'c_nlink': f'{nlink:06o}', 95 | 'c_namesize': f'{len(filename):06o}'}) + filename 96 | return result 97 | 98 | def read(self, path: str) -> bytes: 99 | return self.archive.read(path) 100 | 101 | def get_global_manifest(self, macos_variant: str, device_class: str) -> bytes: 102 | manifest_path = f'Firmware/Manifests/restore/{macos_variant}/apticket.{device_class}.im4m' 103 | return self.read(manifest_path) 104 | 105 | def get_firmware(self, firmware_path: str) -> Firmware: 106 | return Firmware(firmware_path, self) 107 | 108 | def get_development_files(self) -> list[str]: 109 | result = [] 110 | for entry in self.archive.namelist(): 111 | for release in ('devel', 'kasan', 'research'): 112 | if release in entry.lower(): 113 | result.append(entry) 114 | return result 115 | 116 | def create_device_support(self, pem_db: Optional[str] = None) -> None: 117 | device_support_path = Path('~/Library/Developer/Xcode/iOS DeviceSupport').expanduser() 118 | device_support_path /= (f'{self.build_manifest.supported_product_types[0]} ' 119 | f'{self.build_manifest.product_version} ({self.build_manifest.product_build_version})') 120 | build_identity = self.build_manifest.build_identities[0] 121 | symbols_path = device_support_path / 'Symbols' 122 | build_identity.extract_dsc(symbols_path, pem_db=pem_db) 123 | for file in (symbols_path / 'private/preboot/Cryptexes/OS/System/Library/Caches/com.apple.dyld').iterdir(): 124 | file.unlink() 125 | (device_support_path / 'Info.plist').write_bytes(plistlib.dumps({ 126 | 'DSC Extractor Version': '1228.0.0.0.0', 127 | 'DateCollected': datetime.now(), 128 | 'Version': '16.0', 129 | })) 130 | (device_support_path / '.finalized').write_bytes(plistlib.dumps({})) 131 | (device_support_path / '.processed_dyld_shared_cache_arm64e').touch() 132 | (device_support_path / '.processing_lock').touch() 133 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "ipsw-parser" 3 | description = "python3 utility for parsing and extracting data from IPSW" 4 | readme = "README.md" 5 | requires-python = ">=3.9" 6 | license = { file = "LICENSE" } 7 | keywords = ["ios", "cli", "firmware", "ipsw"] 8 | authors = [ 9 | { name = "doronz88", email = "doron88@gmail.com" } 10 | ] 11 | maintainers = [ 12 | { name = "doronz88", email = "doron88@gmail.com" } 13 | ] 14 | classifiers = [ 15 | "Development Status :: 5 - Production/Stable", 16 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 17 | "Programming Language :: Python :: 3", 18 | "Programming Language :: Python :: 3.9", 19 | "Programming Language :: Python :: 3.10", 20 | "Programming Language :: Python :: 3.11", 21 | "Programming Language :: Python :: 3.12", 22 | "Programming Language :: Python :: 3.13", 23 | "Programming Language :: Python :: 3 :: Only", 24 | ] 25 | dynamic = ["dependencies", "version"] 26 | 27 | [project.optional-dependencies] 28 | test = ["pytest"] 29 | 30 | [project.urls] 31 | "Homepage" = "https://github.com/doronz88/ipsw_parser" 32 | "Bug Reports" = "https://github.com/doronz88/ipsw_parser/issues" 33 | 34 | [project.scripts] 35 | ipsw-parser = "ipsw_parser.__main__:cli" 36 | 37 | [tool.setuptools.packages.find] 38 | exclude = ["docs*", "tests*"] 39 | 40 | [tool.setuptools.dynamic] 41 | dependencies = { file = ["requirements.txt"] } 42 | version = { attr = "ipsw_parser._version.__version__" } 43 | 44 | [tool.setuptools_scm] 45 | version_file = "ipsw_parser/_version.py" 46 | 47 | [build-system] 48 | requires = ["setuptools>=43.0.0", "setuptools_scm>=8", "wheel"] 49 | build-backend = "setuptools.build_meta" 50 | -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | filterwarnings = 3 | error 4 | error::ResourceWarning 5 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | construct>=2.9.29 2 | click 3 | coloredlogs 4 | cached_property 5 | plumbum 6 | pyimg4>=0.8.8 7 | requests 8 | remotezip2 --------------------------------------------------------------------------------