├── .github └── workflows │ └── liblk.yml ├── .gitignore ├── LICENSE ├── README.md ├── examples ├── __init__.py ├── apply_binary_patch.py └── dump_partitions.py ├── format.sh ├── liblk ├── __init__.py ├── constants.py ├── exceptions.py ├── image.py └── structures │ ├── __init__.py │ ├── ext_header.py │ ├── header.py │ └── partition.py ├── pyproject.toml ├── ruff.toml └── tests ├── files ├── lk.img └── lk_legacy.img └── lk_image_test.py /.github/workflows/liblk.yml: -------------------------------------------------------------------------------- 1 | name: liblk 2 | on: 3 | push: 4 | branches: [ master ] 5 | pull_request: 6 | branches: [ master ] 7 | workflow_dispatch: 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | python-version: ['3.8', '3.9', '3.10', '3.11'] 15 | 16 | steps: 17 | - uses: actions/checkout@v4 18 | - name: Set up Python ${{ matrix.python-version }} 19 | uses: actions/setup-python@v5 20 | with: 21 | python-version: ${{ matrix.python-version }} 22 | 23 | - name: Install dependencies 24 | run: | 25 | python -m pip install --upgrade pip 26 | pip install ruff pytest mypy 27 | pip install -e . 28 | 29 | - name: Lint with Ruff 30 | run: | 31 | ruff check liblk tests examples 32 | 33 | - name: Type check with MyPy 34 | run: | 35 | mypy liblk 36 | 37 | - name: Run tests 38 | run: | 39 | python -m pytest tests/ -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # LK Images 2 | *.bin 3 | *.img 4 | 5 | # Byte-compiled / optimized / DLL files 6 | __pycache__/ 7 | *.py[cod] 8 | *$py.class 9 | 10 | # C extensions 11 | *.so 12 | 13 | # Distribution / packaging 14 | .Python 15 | build/ 16 | develop-eggs/ 17 | dist/ 18 | downloads/ 19 | eggs/ 20 | .eggs/ 21 | lib/ 22 | lib64/ 23 | parts/ 24 | sdist/ 25 | var/ 26 | wheels/ 27 | share/python-wheels/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | MANIFEST 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Unit test / coverage reports 44 | htmlcov/ 45 | .tox/ 46 | .nox/ 47 | .coverage 48 | .coverage.* 49 | .cache 50 | nosetests.xml 51 | coverage.xml 52 | *.cover 53 | *.py,cover 54 | .hypothesis/ 55 | .pytest_cache/ 56 | cover/ 57 | 58 | # Translations 59 | *.mo 60 | *.pot 61 | 62 | # Django stuff: 63 | *.log 64 | local_settings.py 65 | db.sqlite3 66 | db.sqlite3-journal 67 | 68 | # Flask stuff: 69 | instance/ 70 | .webassets-cache 71 | 72 | # Scrapy stuff: 73 | .scrapy 74 | 75 | # Sphinx documentation 76 | docs/_build/ 77 | 78 | # PyBuilder 79 | .pybuilder/ 80 | target/ 81 | 82 | # Jupyter Notebook 83 | .ipynb_checkpoints 84 | 85 | # IPython 86 | profile_default/ 87 | ipython_config.py 88 | 89 | # pyenv 90 | # For a library or package, you might want to ignore these files since the code is 91 | # intended to run in multiple environments; otherwise, check them in: 92 | # .python-version 93 | 94 | # pipenv 95 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 96 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 97 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 98 | # install all needed dependencies. 99 | #Pipfile.lock 100 | 101 | # poetry 102 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 103 | # This is especially recommended for binary packages to ensure reproducibility, and is more 104 | # commonly ignored for libraries. 105 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 106 | #poetry.lock 107 | 108 | # pdm 109 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 110 | #pdm.lock 111 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 112 | # in version control. 113 | # https://pdm.fming.dev/#use-with-ide 114 | .pdm.toml 115 | 116 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 117 | __pypackages__/ 118 | 119 | # Celery stuff 120 | celerybeat-schedule 121 | celerybeat.pid 122 | 123 | # SageMath parsed files 124 | *.sage.py 125 | 126 | # Environments 127 | .env 128 | .venv 129 | env/ 130 | venv/ 131 | ENV/ 132 | env.bak/ 133 | venv.bak/ 134 | 135 | # Spyder project settings 136 | .spyderproject 137 | .spyproject 138 | 139 | # Rope project settings 140 | .ropeproject 141 | 142 | # mkdocs documentation 143 | /site 144 | 145 | # mypy 146 | .mypy_cache/ 147 | .dmypy.json 148 | dmypy.json 149 | 150 | # Pyre type checker 151 | .pyre/ 152 | 153 | # pytype static type analyzer 154 | .pytype/ 155 | 156 | # Cython debug symbols 157 | cython_debug/ 158 | 159 | # PyCharm 160 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 161 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 162 | # and can be added to the global gitignore or merged into this file. For a more nuclear 163 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 164 | .idea/ 165 | -------------------------------------------------------------------------------- /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 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # liblk 2 | 3 | ![License](https://img.shields.io/github/license/R0rt1z2/liblk) 4 | ![GitHub Issues](https://img.shields.io/github/issues-raw/R0rt1z2/liblk?color=red) 5 | 6 | `liblk` is a simple and tiny python library for manipulating LK (_Little Kernel_) images. It's flexible and has an easy-to-use API. 7 | The library requires Python 3.8 or higher. 8 | 9 | ## Installation 10 | 11 | ```bash 12 | sudo apt install python3-pip # If you don't have pip installed. 13 | pip3 install --upgrade git+https://github.com/R0rt1z2/liblk 14 | ``` 15 | 16 | ## Examples 17 | The folder [examples](https://github.com/R0rt1z2/liblk/tree/master/examples) contains a set of examples that aim to show how to use the library and highlight its features. 18 | 19 | ## Quick Start 20 | ```python 21 | from liblk import LkImage 22 | 23 | # Load an LK image 24 | lk_image = LkImage("path/to/lk.img") 25 | 26 | # Get list of partitions 27 | partitions = lk_image.get_partition_list() 28 | for partition_name in partitions: 29 | partition = lk_image.get_partition_by_name(partition_name) 30 | print(f"Partition: {partition_name}, Size: {len(partition.data)} bytes") 31 | 32 | # Apply a binary patch 33 | lk_image.apply_patch("30b583b002ab", "00207047") 34 | ``` 35 | 36 | ## License 37 | This project is licensed under the GPL-3.0 License - see the [LICENSE](https://github.com/R0rt1z2/liblk/tree/master/LICENSE) file for details. -------------------------------------------------------------------------------- /examples/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | -------------------------------------------------------------------------------- /examples/apply_binary_patch.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | SPDX-FileCopyrightText: 2025 Roger Ortiz 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | """ 6 | 7 | from __future__ import annotations 8 | 9 | import argparse 10 | import logging 11 | import os 12 | import sys 13 | from typing import Optional 14 | 15 | sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) 16 | 17 | try: 18 | from liblk import LkImage, NeedleNotFoundException 19 | except ImportError: 20 | print('Error: liblk module not found') 21 | sys.exit(1) 22 | 23 | 24 | def setup_logging(verbose: bool = False) -> logging.Logger: 25 | """Configure logging for the script.""" 26 | log_level = logging.DEBUG if verbose else logging.INFO 27 | logging.basicConfig( 28 | level=log_level, 29 | format='%(asctime)s - %(levelname)s: %(message)s', 30 | datefmt='%Y-%m-%d %H:%M:%S', 31 | ) 32 | return logging.getLogger(__name__) 33 | 34 | 35 | def validate_patch_input(needle: str, patch: str) -> tuple[bytes, bytes]: 36 | """ 37 | Validate and convert patch inputs. 38 | 39 | Args: 40 | needle: Byte sequence to replace (hex string) 41 | patch: Replacement byte sequence (hex string) 42 | 43 | Returns: 44 | Tuple of needle and patch as bytes 45 | """ 46 | try: 47 | needle_bytes = bytes.fromhex(needle) 48 | patch_bytes = bytes.fromhex(patch) 49 | except ValueError as e: 50 | raise ValueError(f'Invalid hex input: {e}') 51 | 52 | return needle_bytes, patch_bytes 53 | 54 | 55 | def apply_binary_patch( 56 | image_path: str, 57 | needle: str, 58 | patch: str, 59 | output_path: Optional[str] = None, 60 | logger: Optional[logging.Logger] = None, 61 | ) -> None: 62 | """ 63 | Apply a binary patch to an LK image. 64 | 65 | Args: 66 | image_path: Path to the input LK image 67 | needle: Hex string of bytes to replace 68 | patch: Hex string of replacement bytes 69 | output_path: Optional path for patched image 70 | logger: Optional logger instance 71 | """ 72 | log = logger or logging.getLogger(__name__) 73 | 74 | output_path = ( 75 | output_path or os.path.splitext(image_path)[0] + '_patched.img' 76 | ) 77 | 78 | try: 79 | needle_bytes, patch_bytes = validate_patch_input(needle, patch) 80 | 81 | lk_image = LkImage(image_path) 82 | log.info(f'Loaded image: {image_path}') 83 | 84 | lk_image.apply_patch(needle_bytes, patch_bytes) 85 | log.info(f'Applied patch: {needle} -> {patch}') 86 | 87 | lk_image.save(output_path) 88 | log.info(f'Patched image saved: {output_path}') 89 | 90 | except NeedleNotFoundException as e: 91 | log.error(f'Patch failed: {e}') 92 | sys.exit(1) 93 | except Exception as e: 94 | log.error(f'Error processing image: {e}') 95 | sys.exit(1) 96 | 97 | 98 | def main() -> None: 99 | """ 100 | Main script entry point. 101 | Parse arguments and apply binary patch. 102 | """ 103 | parser = argparse.ArgumentParser( 104 | description='Apply binary patches to LK bootloader images' 105 | ) 106 | parser.add_argument('image_path', help='Path to the input LK image') 107 | parser.add_argument( 108 | 'needle', help="Hex string of bytes to replace (e.g., '30b583b002ab')" 109 | ) 110 | parser.add_argument( 111 | 'patch', help="Hex string of replacement bytes (e.g., '00207047')" 112 | ) 113 | parser.add_argument('-o', '--output', help='Path for the patched image') 114 | parser.add_argument( 115 | '-v', '--verbose', action='store_true', help='Enable verbose logging' 116 | ) 117 | 118 | args = parser.parse_args() 119 | 120 | logger = setup_logging(args.verbose) 121 | 122 | apply_binary_patch( 123 | args.image_path, args.needle, args.patch, args.output, logger 124 | ) 125 | 126 | 127 | if __name__ == '__main__': 128 | main() 129 | -------------------------------------------------------------------------------- /examples/dump_partitions.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | SPDX-FileCopyrightText: 2025 Roger Ortiz 4 | SPDX-License-Identifier: GPL-3.0-or-later 5 | """ 6 | 7 | from __future__ import annotations 8 | 9 | import argparse 10 | import logging 11 | import os 12 | import sys 13 | from typing import Optional 14 | 15 | sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) 16 | 17 | try: 18 | from liblk import InvalidLkPartition, LkImage 19 | from liblk.structures.partition import LkPartition 20 | except ImportError: 21 | print('Error: liblk module not found') 22 | sys.exit(1) 23 | 24 | 25 | def setup_logging(verbose: bool = False) -> logging.Logger: 26 | """ 27 | Configure logging for the script. 28 | 29 | Args: 30 | verbose: Enable detailed logging 31 | 32 | Returns: 33 | Configured logger instance 34 | """ 35 | log_level = logging.DEBUG if verbose else logging.INFO 36 | logging.basicConfig( 37 | level=log_level, 38 | format='%(asctime)s - %(levelname)s: %(message)s', 39 | datefmt='%Y-%m-%d %H:%M:%S', 40 | ) 41 | return logging.getLogger(__name__) 42 | 43 | 44 | def validate_image_path(path: str) -> str: 45 | """ 46 | Validate the input image path. 47 | 48 | Args: 49 | path: Path to the LK image file 50 | 51 | Returns: 52 | Validated absolute path 53 | 54 | Raises: 55 | FileNotFoundError: If file does not exist 56 | PermissionError: If file is not readable 57 | """ 58 | abs_path = os.path.abspath(path) 59 | 60 | if not os.path.exists(abs_path): 61 | raise FileNotFoundError(f'Image file not found: {abs_path}') 62 | 63 | if not os.access(abs_path, os.R_OK): 64 | raise PermissionError(f'Cannot read image file: {abs_path}') 65 | 66 | return abs_path 67 | 68 | 69 | def dump_partitions( 70 | image_path: str, 71 | output_dir: Optional[str] = None, 72 | logger: Optional[logging.Logger] = None, 73 | ) -> None: 74 | """ 75 | Extract and save partitions from an LK image. 76 | 77 | Args: 78 | image_path: Path to the LK image file 79 | output_dir: Optional directory to save partitions 80 | logger: Optional logger instance 81 | """ 82 | log = logger or logging.getLogger(__name__) 83 | 84 | output_dir = output_dir or os.path.join( 85 | os.path.dirname(image_path), 86 | f'{os.path.basename(image_path)}_partitions', 87 | ) 88 | 89 | os.makedirs(output_dir, exist_ok=True) 90 | 91 | try: 92 | lk_image = LkImage(image_path) 93 | log.info(f'Loaded image with {len(lk_image)} partitions') 94 | 95 | for partition_info in lk_image.partitions: 96 | name = str(partition_info['name']) 97 | partition = partition_info['partition'] 98 | 99 | if not isinstance(partition, LkPartition): 100 | log.warning(f'Skipping non-LkPartition item: {name}') 101 | continue 102 | 103 | safe_name = ''.join( 104 | c if c.isalnum() or c in ('-', '_') else '_' for c in name 105 | ) 106 | output_path = os.path.join(output_dir, f'{safe_name}.bin') 107 | 108 | partition.save(output_path) 109 | log.info(f'Extracted: {name} -> {output_path}') 110 | 111 | if log.getEffectiveLevel() == logging.DEBUG: 112 | log.debug(str(partition)) 113 | log.debug('-' * 40) 114 | 115 | except InvalidLkPartition as e: 116 | log.error(f'Partition parsing error: {e}') 117 | sys.exit(1) 118 | except Exception as e: 119 | log.error(f'Unexpected error processing image: {e}') 120 | sys.exit(1) 121 | 122 | 123 | def main() -> None: 124 | """ 125 | Main script entry point. 126 | Parse arguments and invoke partition dumping. 127 | """ 128 | parser = argparse.ArgumentParser( 129 | description='Extract partitions from LK bootloader images' 130 | ) 131 | parser.add_argument('image_path', help='Path to the LK image file') 132 | parser.add_argument( 133 | '-o', '--output', help='Output directory for extracted partitions' 134 | ) 135 | parser.add_argument( 136 | '-v', '--verbose', action='store_true', help='Enable verbose logging' 137 | ) 138 | 139 | args = parser.parse_args() 140 | 141 | logger = setup_logging(args.verbose) 142 | 143 | try: 144 | validated_path = validate_image_path(args.image_path) 145 | dump_partitions(validated_path, args.output, logger) 146 | logger.info('Partition extraction completed successfully') 147 | 148 | except Exception as e: 149 | logger.error(f'Error: {e}') 150 | sys.exit(1) 151 | 152 | 153 | if __name__ == '__main__': 154 | main() 155 | -------------------------------------------------------------------------------- /format.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | SOURCES="liblk tests examples" 4 | 5 | GREEN='\033[0;32m' 6 | YELLOW='\033[1;33m' 7 | NC='\033[0m' 8 | 9 | print_status() { 10 | echo -e "${YELLOW}$1${NC}" 11 | } 12 | 13 | main() { 14 | print_status "Formatting Python code..." 15 | ruff format $SOURCES 16 | 17 | print_status "Checking and fixing code..." 18 | ruff check $SOURCES --fix 19 | 20 | print_status "Running type checks..." 21 | mypy $SOURCES 22 | 23 | print_status "Running tests..." 24 | python3 -m pytest tests/ 25 | 26 | echo -e "${GREEN}Code formatting and checks complete!${NC}" 27 | } 28 | 29 | main 30 | -------------------------------------------------------------------------------- /liblk/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | __version__ = '2.1.0' 7 | 8 | from liblk.constants import AddressingMode, Magic 9 | from liblk.exceptions import InvalidLkPartition, NeedleNotFoundException 10 | from liblk.image import LkImage 11 | 12 | __all__ = [ 13 | 'LkImage', 14 | 'InvalidLkPartition', 15 | 'NeedleNotFoundException', 16 | 'Magic', 17 | 'AddressingMode', 18 | ] 19 | -------------------------------------------------------------------------------- /liblk/constants.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | from enum import IntEnum, unique 7 | from typing import Final 8 | 9 | 10 | @unique 11 | class Magic(IntEnum): 12 | """Magic numbers used in LK image headers.""" 13 | 14 | MAGIC = 0x58881688 15 | EXT_MAGIC = 0x58891689 16 | 17 | 18 | @unique 19 | class AddressingMode(IntEnum): 20 | """Addressing modes for memory addressing.""" 21 | 22 | NORMAL = -1 23 | BACKWARD = 0 24 | 25 | 26 | class Pattern: 27 | """Constant patterns used in LK image parsing.""" 28 | 29 | LOADADDR: Final[bytes] = bytes.fromhex('10FF2FE1') 30 | -------------------------------------------------------------------------------- /liblk/exceptions.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | from __future__ import annotations 7 | 8 | from typing import Union 9 | 10 | 11 | class LkImageError(Exception): 12 | """Base exception for LK image-related errors.""" 13 | 14 | def __init__(self, message: str): 15 | """ 16 | Initialize the LK image error. 17 | 18 | Args: 19 | message: Descriptive error message 20 | """ 21 | super().__init__(message) 22 | self.message = message 23 | 24 | 25 | class InvalidLkPartition(LkImageError): 26 | """ 27 | Raised when an invalid LK partition is encountered. 28 | 29 | Attributes: 30 | reason: Specific reason for partition invalidity 31 | """ 32 | 33 | def __init__(self, reason: str): 34 | """ 35 | Initialize the invalid partition error. 36 | 37 | Args: 38 | reason: Reason for partition invalidity 39 | """ 40 | super().__init__(f'Invalid LK partition: {reason}') 41 | self.reason = reason 42 | 43 | 44 | class NeedleNotFoundException(LkImageError): 45 | """ 46 | Raised when a specific byte sequence is not found in the LK image. 47 | 48 | Attributes: 49 | needle: The byte sequence that was not found 50 | """ 51 | 52 | def __init__(self, needle: Union[str, bytes]): 53 | """ 54 | Initialize the needle not found error. 55 | 56 | Args: 57 | needle: Byte sequence or hex string that was not found 58 | """ 59 | needle_repr = needle.hex() if isinstance(needle, bytes) else str(needle) 60 | super().__init__(f'Needle not found: {needle_repr}') 61 | self.needle = needle 62 | -------------------------------------------------------------------------------- /liblk/image.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | from __future__ import annotations 7 | 8 | from pathlib import Path 9 | from typing import Any, Dict, List, Optional, Union, overload 10 | 11 | from liblk.constants import Magic 12 | from liblk.exceptions import InvalidLkPartition, NeedleNotFoundException 13 | from liblk.structures.partition import LkPartition 14 | 15 | 16 | class LkImage: 17 | """ 18 | Represents an LK (Little Kernel) image for parsing and manipulation. 19 | 20 | Attributes: 21 | path: Optional path to the original image file 22 | contents: Raw image contents 23 | partitions: List of parsed partitions 24 | """ 25 | 26 | @overload 27 | def __init__(self, source: Union[str, Path]) -> None: ... 28 | 29 | @overload 30 | def __init__(self, source: Union[bytes, bytearray]) -> None: ... 31 | 32 | def __init__( 33 | self, 34 | source: Union[str, Path, bytes, bytearray], 35 | ) -> None: 36 | """ 37 | Initialize LK image from file or byte-like object. 38 | 39 | Args: 40 | source: Image source (file path or byte-like object) 41 | 42 | Raises: 43 | FileNotFoundError: If file path is invalid 44 | InvalidLkPartition: If image parsing fails 45 | """ 46 | if isinstance(source, (str, Path)): 47 | self.path: Optional[str] = str(source) 48 | self.contents = self._load_image(source) 49 | else: 50 | self.path = None 51 | self.contents = bytearray(source) 52 | 53 | self.partitions: List[Dict[str, Any]] = [] 54 | self._parse_partitions() 55 | 56 | def _load_image(self, path: Union[str, Path]) -> bytearray: 57 | """ 58 | Load image contents from file. 59 | 60 | Args: 61 | path: Path to the image file 62 | 63 | Returns: 64 | Raw image contents as bytearray 65 | """ 66 | with open(path, 'rb') as f: 67 | return bytearray(f.read()) 68 | 69 | def _parse_partitions(self) -> None: 70 | """ 71 | Parse partitions from image contents and associate certificates. 72 | 73 | Raises: 74 | InvalidLkPartition: If partition parsing fails 75 | """ 76 | offset = 0 77 | last_regular_part = None 78 | 79 | while offset < len(self.contents): 80 | try: 81 | partition = LkPartition.from_bytes( 82 | self.contents[offset:], offset 83 | ) 84 | except InvalidLkPartition: 85 | if self.partitions and self.partitions[-1].get('name') == 'lk': 86 | break 87 | raise 88 | 89 | if partition.header.magic != Magic.MAGIC: 90 | raise InvalidLkPartition( 91 | f'Invalid magic 0x{partition.header.magic:x} at offset 0x{offset:x}' 92 | ) 93 | 94 | name = partition.header.name 95 | 96 | if name.startswith('cert') and last_regular_part is not None: 97 | last_regular_part['partition'].certs.append(partition) 98 | else: 99 | self.partitions.append({'name': name, 'partition': partition}) 100 | last_regular_part = self.partitions[-1] 101 | 102 | if ( 103 | partition.has_ext 104 | and partition.ext_header 105 | and partition.ext_header.image_list_end 106 | ): 107 | break 108 | 109 | offset = partition.end_offset 110 | 111 | def apply_patch( 112 | self, 113 | needle: Union[str, bytes, bytearray], 114 | patch: Union[str, bytes, bytearray], 115 | ) -> None: 116 | """ 117 | Apply a binary patch to the image. 118 | 119 | Args: 120 | needle: Byte sequence to replace 121 | patch: Replacement byte sequence 122 | 123 | Raises: 124 | NeedleNotFoundException: If needle is not found 125 | """ 126 | needle_bytes = ( 127 | bytes.fromhex(needle) if isinstance(needle, str) else bytes(needle) 128 | ) 129 | patch_bytes = ( 130 | bytes.fromhex(patch) if isinstance(patch, str) else bytes(patch) 131 | ) 132 | 133 | offset = self.contents.find(needle_bytes) 134 | if offset != -1: 135 | self.contents[offset : offset + len(patch_bytes)] = patch_bytes 136 | else: 137 | raise NeedleNotFoundException(needle_bytes) 138 | 139 | def get_partition_list(self) -> List[str]: 140 | """ 141 | Retrieve names of all partitions. 142 | 143 | Returns: 144 | List of partition names 145 | """ 146 | return [str(entry['name']) for entry in self.partitions] 147 | 148 | def get_partition_by_name(self, name: str) -> Optional[LkPartition]: 149 | """ 150 | Retrieve a specific partition by name. 151 | 152 | Args: 153 | name: Name of the partition 154 | 155 | Returns: 156 | Matching partition or None if not found 157 | """ 158 | for entry in self.partitions: 159 | if entry['name'] == name: 160 | return entry['partition'] # type: ignore 161 | return None 162 | 163 | def save(self, path: Union[str, Path]) -> None: 164 | """ 165 | Save modified image contents to a file. 166 | 167 | Args: 168 | path: Destination file path 169 | """ 170 | with open(path, 'wb') as f: 171 | f.write(self.contents) 172 | 173 | def __len__(self) -> int: 174 | """ 175 | Get number of partitions in the image. 176 | 177 | Returns: 178 | Number of partitions 179 | """ 180 | return len(self.partitions) 181 | 182 | def __repr__(self) -> str: 183 | """ 184 | Provide a string representation of the LK image. 185 | 186 | Returns: 187 | Descriptive string with image details 188 | """ 189 | return ( 190 | f'LkImage(path={self.path}, ' 191 | f'partitions={len(self.partitions)}, ' 192 | f'size={len(self.contents)} bytes)' 193 | ) 194 | -------------------------------------------------------------------------------- /liblk/structures/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | from liblk.structures.ext_header import LkExtHeader 7 | from liblk.structures.header import LkHeader 8 | from liblk.structures.partition import LkPartition 9 | 10 | __all__ = [ 11 | 'LkExtHeader', 12 | 'LkHeader', 13 | 'LkPartition', 14 | ] 15 | -------------------------------------------------------------------------------- /liblk/structures/ext_header.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | from __future__ import annotations 7 | 8 | import struct 9 | from dataclasses import dataclass 10 | from typing import Optional 11 | 12 | 13 | @dataclass 14 | class LkExtHeader: 15 | """ 16 | Represents the extended header for an LK (Little Kernel) image partition. 17 | 18 | Attributes: 19 | header_size: Size of the extended header 20 | header_version: Version of the extended header 21 | image_type: Type of the image 22 | image_list_end: Flag indicating if this is the last image in the list 23 | alignment: Memory alignment requirement 24 | data_size: Size of the partition data (extended) 25 | memory_address: Extended memory address for the partition 26 | """ 27 | 28 | header_size: int 29 | header_version: int 30 | image_type: int 31 | image_list_end: int 32 | alignment: int 33 | data_size: int 34 | memory_address: int 35 | 36 | @classmethod 37 | def from_bytes(cls, contents: bytes) -> Optional[LkExtHeader]: 38 | """ 39 | Create an LK extended header from raw bytes. 40 | 41 | Args: 42 | contents: Raw byte contents containing the extended header 43 | 44 | Returns: 45 | Parsed LkExtHeader instance, or None if parsing fails 46 | """ 47 | try: 48 | header_size = struct.unpack_from(' str: 70 | """ 71 | Generate a string representation of the LK extended header. 72 | 73 | Returns: 74 | Formatted string with extended header details 75 | """ 76 | return ( 77 | f'Header Size : {self.header_size} bytes\n' 78 | f'Header Version : {self.header_version}\n' 79 | f'Image Type : 0x{self.image_type:08x}\n' 80 | f'Image List End : {bool(self.image_list_end)}\n' 81 | f'Alignment : {self.alignment} bytes\n' 82 | f'Data Size : {self.data_size} bytes\n' 83 | f'Memory Address : 0x{self.memory_address:08x}' 84 | ) 85 | -------------------------------------------------------------------------------- /liblk/structures/header.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | from __future__ import annotations 7 | 8 | import ctypes 9 | import struct 10 | from dataclasses import dataclass 11 | 12 | from liblk.constants import Pattern 13 | 14 | 15 | @dataclass 16 | class LkHeader: 17 | """ 18 | Represents the header of an LK (Little Kernel) image partition. 19 | 20 | Attributes: 21 | magic: Magic number identifying the header 22 | data_size: Size of the partition data 23 | name: Name of the partition 24 | addressing_mode: Memory addressing mode 25 | memory_address: Memory address for the partition 26 | """ 27 | 28 | magic: int 29 | data_size: int 30 | name: str 31 | addressing_mode: int 32 | memory_address: int 33 | 34 | @classmethod 35 | def from_bytes(cls, contents: bytes, start_offset: int = 0) -> LkHeader: 36 | """ 37 | Create an LK header from raw bytes. 38 | 39 | Args: 40 | contents: Raw byte contents containing the header 41 | start_offset: Starting offset for parsing the header 42 | 43 | Returns: 44 | Parsed LkHeader instance 45 | """ 46 | magic = struct.unpack_from(' str: 78 | """ 79 | Generate a string representation of the LK header. 80 | 81 | Returns: 82 | Formatted string with header details 83 | """ 84 | return ( 85 | f'Partition Name : {self.name}\n' 86 | f'Data Size : {self.data_size} bytes\n' 87 | f'Addressing Mode : {self.addressing_mode}\n' 88 | f'Memory Address : 0x{self.memory_address:08x}' 89 | ) 90 | 91 | def __bytes__(self) -> bytes: 92 | """ 93 | Convert the LK header to its 512-byte binary representation. 94 | 95 | Returns: 96 | 512-byte representation of the header 97 | """ 98 | header_bytes = bytearray(512) 99 | 100 | struct.pack_into(' 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | from __future__ import annotations 7 | 8 | import struct 9 | from typing import Any, List, Optional, Union 10 | 11 | from liblk.constants import Magic 12 | from liblk.exceptions import InvalidLkPartition 13 | from liblk.structures.ext_header import LkExtHeader 14 | from liblk.structures.header import LkHeader 15 | 16 | 17 | class LkPartition: 18 | """ 19 | Represents a partition in an LK (Little Kernel) image. 20 | 21 | Attributes: 22 | header: Primary partition header 23 | ext_header: Optional extended header 24 | data: Raw partition data 25 | end_offset: End offset of the partition in the image 26 | certs: List of certificate partitions associated with this partition 27 | """ 28 | 29 | def __init__( 30 | self, 31 | header: LkHeader, 32 | data: bytes, 33 | end_offset: int, 34 | ext_header: Optional[LkExtHeader] = None, 35 | certs: Optional[List['LkPartition']] = None, 36 | ): 37 | """ 38 | Initialize an LK partition. 39 | 40 | Args: 41 | header: Primary partition header 42 | data: Raw partition data 43 | end_offset: End offset of the partition in the image 44 | ext_header: Optional extended header 45 | certs: List of certificate partitions associated with this partition 46 | """ 47 | self.header = header 48 | self.data = data 49 | self.end_offset = end_offset 50 | self.ext_header = ext_header 51 | self.certs = certs or [] 52 | 53 | @property 54 | def cert1(self) -> Optional['LkPartition']: 55 | """Get the first certificate (cert1) if available""" 56 | return self.certs[0] if len(self.certs) >= 1 else None 57 | 58 | @property 59 | def cert2(self) -> Optional['LkPartition']: 60 | """Get the second certificate (cert2) if available""" 61 | return self.certs[1] if len(self.certs) >= 2 else None 62 | 63 | def has_cert(self, cert_type: str = '') -> bool: 64 | """ 65 | Check if the partition has certificates of the specified type. 66 | 67 | Args: 68 | cert_type: Certificate type to check for (e.g., 'cert1', 'cert2'). 69 | If empty, checks for any certificates. 70 | 71 | Returns: 72 | True if matching certificates exist 73 | """ 74 | if not cert_type: 75 | return len(self.certs) > 0 76 | 77 | for cert in self.certs: 78 | if cert.header.name.startswith(cert_type): 79 | return True 80 | return False 81 | 82 | @property 83 | def has_ext(self) -> bool: 84 | """ 85 | Check if the partition has an extended header. 86 | 87 | Returns: 88 | True if extended header exists, False otherwise 89 | """ 90 | return self.ext_header is not None 91 | 92 | @classmethod 93 | def from_bytes( 94 | cls, contents: Union[bytes, bytearray], offset: int = 0 95 | ) -> LkPartition: 96 | """ 97 | Create an LK partition from raw bytes. 98 | 99 | Args: 100 | contents: Raw byte contents of the image 101 | offset: Starting offset for parsing the partition 102 | 103 | Returns: 104 | Parsed LkPartition instance 105 | 106 | Raises: 107 | InvalidLkPartition: If the partition is invalid 108 | """ 109 | start_offset = 0x4040 if contents[:4] == b'BFBF' else 0 110 | 111 | try: 112 | header = LkHeader.from_bytes(contents, start_offset) 113 | 114 | has_ext = ( 115 | struct.unpack_from(' bytes: 150 | """ 151 | Get bytes representation of partition with all its certificates. 152 | 153 | Returns: 154 | Byte representation of this partition followed by all its certificates 155 | """ 156 | result = bytes(self) 157 | 158 | for cert in self.certs: 159 | result += bytes(cert) 160 | 161 | return result 162 | 163 | def rebuild(self, new_data: Optional[bytes] = None) -> 'LkPartition': 164 | """ 165 | Create a new partition with updated data. 166 | 167 | Args: 168 | new_data: New data to use (if None, uses current data) 169 | 170 | Returns: 171 | New LkPartition instance with the same headers but updated data 172 | """ 173 | data_to_use = new_data if new_data is not None else self.data 174 | 175 | return LkPartition( 176 | header=self.header, 177 | data=data_to_use, 178 | end_offset=self.end_offset, 179 | ext_header=self.ext_header, 180 | certs=self.certs, 181 | ) 182 | 183 | def save(self, filename: str) -> None: 184 | """ 185 | Save partition data to a file. 186 | 187 | Args: 188 | filename: Path to save the partition data 189 | """ 190 | with open(filename, 'wb') as f: 191 | f.write(self.data) 192 | 193 | def __str__(self) -> str: 194 | """ 195 | Generate a string representation of the LK partition. 196 | 197 | Returns: 198 | Formatted string with partition details 199 | """ 200 | details = [str(self.header)] 201 | if self.ext_header: 202 | details.append(str(self.ext_header)) 203 | return '\n'.join(details) 204 | 205 | def __repr__(self) -> str: 206 | """ 207 | Provide a detailed string representation of the partition. 208 | 209 | Returns: 210 | Descriptive string with partition details 211 | """ 212 | return ( 213 | f'LkPartition(name={self.header.name}, ' 214 | f'data_size={len(self.data)}, ' 215 | f'has_ext_header={bool(self.ext_header)}, ' 216 | f'certs={len(self.certs)})' 217 | ) 218 | 219 | def __eq__(self, other: Any) -> bool: 220 | """ 221 | Compare two LkPartition instances for equality. 222 | 223 | Args: 224 | other: Another object to compare with 225 | 226 | Returns: 227 | True if partitions are considered equal, False otherwise 228 | """ 229 | if not isinstance(other, LkPartition): 230 | return False 231 | 232 | return ( 233 | self.header == other.header 234 | and self.data == other.data 235 | and self.ext_header == other.ext_header 236 | and self.certs == other.certs 237 | ) 238 | 239 | def __len__(self) -> int: 240 | """ 241 | Get the size of the partition data. 242 | 243 | Returns: 244 | Size of partition data in bytes 245 | """ 246 | return len(self.data) 247 | 248 | def __bytes__(self) -> bytes: 249 | """ 250 | Convert the partition to bytes. 251 | 252 | Returns: 253 | Complete binary representation of the partition including header and data 254 | """ 255 | result = bytearray() 256 | header_size = self.ext_header.header_size if self.ext_header else 512 257 | header_bytes = bytearray(512) 258 | 259 | struct.pack_into('> 32 283 | ) 284 | struct.pack_into( 285 | '> 32 286 | ) 287 | 288 | result.extend(header_bytes[:header_size]) 289 | result.extend(self.data) 290 | 291 | alignment = self.ext_header.alignment if self.ext_header else 8 292 | if alignment and len(result) % alignment: 293 | padding_size = alignment - (len(result) % alignment) 294 | result.extend(b'\x00' * padding_size) 295 | 296 | return bytes(result) 297 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools>=61.0", "wheel"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [project] 6 | name = "liblk" 7 | version = "2.1.0" 8 | authors = [ 9 | { name = "Roger Ortiz", email = "me@r0rt1z2.com" } 10 | ] 11 | description = "A library for manipulating and modifying MTK device bootloaders (LK)" 12 | readme = "README.md" 13 | requires-python = ">=3.8" 14 | license = { file = "LICENSE" } 15 | classifiers = [ 16 | "Intended Audience :: Developers", 17 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 18 | "Operating System :: OS Independent", 19 | "Programming Language :: Python :: 3", 20 | "Topic :: Software Development :: Libraries :: Python Modules", 21 | "Topic :: System :: Hardware :: Hardware Drivers" 22 | ] 23 | 24 | [project.optional-dependencies] 25 | dev = [ 26 | "ruff", 27 | "mypy", 28 | "pytest" 29 | ] 30 | 31 | [project.scripts] 32 | lk-patch = "examples.apply_binary_patch:main" 33 | lk-dump = "examples.dump_partitions:main" 34 | 35 | [project.urls] 36 | Homepage = "https://github.com/R0rt1z2/liblk" 37 | Repository = "https://github.com/R0rt1z2/liblk" 38 | 39 | [tool.setuptools.packages.find] 40 | where = ["."] 41 | include = ["liblk*", "examples*"] 42 | 43 | [tool.mypy] 44 | python_version = "3.8" 45 | warn_return_any = true 46 | warn_unused_configs = true 47 | disallow_untyped_defs = true 48 | disallow_incomplete_defs = true 49 | -------------------------------------------------------------------------------- /ruff.toml: -------------------------------------------------------------------------------- 1 | line-length = 80 2 | 3 | [lint] 4 | extend-select = ['A', 'FA100', 'FA102', 'I'] 5 | 6 | [format] 7 | quote-style = 'single' -------------------------------------------------------------------------------- /tests/files/lk.img: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/R0rt1z2/liblk/f58fd75f4e52eb8b1c8eaec8c2d5a93cfef6ef71/tests/files/lk.img -------------------------------------------------------------------------------- /tests/files/lk_legacy.img: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/R0rt1z2/liblk/f58fd75f4e52eb8b1c8eaec8c2d5a93cfef6ef71/tests/files/lk_legacy.img -------------------------------------------------------------------------------- /tests/lk_image_test.py: -------------------------------------------------------------------------------- 1 | """ 2 | SPDX-FileCopyrightText: 2025 Roger Ortiz 3 | SPDX-License-Identifier: GPL-3.0-or-later 4 | """ 5 | 6 | from __future__ import annotations 7 | 8 | import os 9 | import sys 10 | import unittest 11 | from typing import ClassVar, Dict, List, Optional 12 | 13 | sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) 14 | 15 | try: 16 | from liblk import InvalidLkPartition, LkImage 17 | except ImportError: 18 | print('Error: liblk module not found') 19 | sys.exit(1) 20 | 21 | 22 | class TestLkImageVariants(unittest.TestCase): 23 | """ 24 | Test suite for different LK image types, including legacy images. 25 | """ 26 | 27 | test_images: ClassVar[Dict[str, str]] = {} 28 | 29 | @classmethod 30 | def setUpClass(cls) -> None: 31 | """ 32 | Prepare test resources for different image types. 33 | """ 34 | current_dir = os.path.dirname(os.path.abspath(__file__)) 35 | cls.test_images = { 36 | 'standard': os.path.join(current_dir, 'files', 'lk.img'), 37 | 'legacy': os.path.join(current_dir, 'files', 'lk_legacy.img'), 38 | } 39 | 40 | def _validate_image( 41 | self, image_path: str, expected_partitions: Optional[List[str]] = None 42 | ) -> None: 43 | """ 44 | Validate different types of LK images. 45 | 46 | Args: 47 | image_path: Path to the LK image 48 | expected_partitions: Optional list of expected partition names 49 | """ 50 | try: 51 | lk_image = LkImage(image_path) 52 | 53 | self.assertGreater( 54 | len(lk_image.contents), 55 | 1024, 56 | f'Image contents too small: {image_path}', 57 | ) 58 | 59 | if expected_partitions is not None: 60 | actual_partitions = lk_image.get_partition_list() 61 | 62 | self.assertEqual( 63 | len(actual_partitions), 64 | len(expected_partitions), 65 | f'Unexpected partition count for {image_path}', 66 | ) 67 | 68 | for expected, actual in zip( 69 | expected_partitions, actual_partitions 70 | ): 71 | self.assertEqual( 72 | actual, expected, f'Partition mismatch in {image_path}' 73 | ) 74 | 75 | except InvalidLkPartition as e: 76 | if 'legacy' not in image_path: 77 | self.fail(f'Unexpected parsing error: {e}') 78 | 79 | def test_standard_image(self) -> None: 80 | """ 81 | Test standard LK image parsing. 82 | """ 83 | self._validate_image( 84 | self.test_images['standard'], 85 | expected_partitions=['lk', 'lk_main_dtb'], 86 | ) 87 | 88 | def test_legacy_image(self) -> None: 89 | """ 90 | Test legacy LK image parsing. 91 | """ 92 | try: 93 | lk_image = LkImage(self.test_images['legacy']) 94 | 95 | self.assertGreaterEqual( 96 | len(lk_image.partitions), 0, 'Legacy image parsing failed' 97 | ) 98 | 99 | partitions = lk_image.get_partition_list() 100 | 101 | if partitions: 102 | for partition_name in partitions: 103 | partition = lk_image.get_partition_by_name(partition_name) 104 | self.assertIsNotNone( 105 | partition, 106 | f'Could not retrieve partition: {partition_name}', 107 | ) 108 | 109 | except Exception as e: 110 | self.fail(f'Legacy image parsing failed: {e}') 111 | 112 | def test_patch_compatibility(self) -> None: 113 | """ 114 | Verify patch functionality across image types. 115 | """ 116 | test_cases = [ 117 | (self.test_images['standard'], '30b583b002ab', '00207047'), 118 | (self.test_images['legacy'], '40f2a6534E', '00207047'), 119 | ] 120 | 121 | for image_path, needle, patch in test_cases: 122 | try: 123 | lk_image = LkImage(image_path) 124 | 125 | lk_image.apply_patch(needle, patch) 126 | 127 | self.assertIn( 128 | bytes.fromhex(patch), 129 | lk_image.contents, 130 | f'Patch not applied in {image_path}', 131 | ) 132 | 133 | except Exception as e: 134 | self.fail(f'Patch test failed for {image_path}: {e}') 135 | 136 | 137 | if __name__ == '__main__': 138 | unittest.main() 139 | --------------------------------------------------------------------------------