├── COPYING ├── README.md ├── man ├── me_cleaner.1 └── me_cleaner.md ├── me_cleaner.py └── setup.py /COPYING: -------------------------------------------------------------------------------- 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 | # me\_cleaner [![Donation](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=B5HCXCLZVCVZ8) 2 | 3 | _me\_cleaner_ is a Python script able to modify an Intel ME firmware image with 4 | the final purpose of reducing its ability to interact with the system. 5 | 6 | ## Intel ME 7 | 8 | Intel ME is a co-processor integrated in all post-2006 Intel boards, which is 9 | the base hardware for many Intel features like Intel AMT, Intel Boot Guard, 10 | Intel PAVP and many others. To provide such features, it requires full access to 11 | the system, including memory (through DMA) and network access (transparent to 12 | the user). 13 | 14 | Unlike many other firmware components, the Intel ME firmware can't be neither 15 | disabled nor reimplemented, as it is tightly integrated in the boot process and 16 | it is signed. 17 | 18 | This poses an issue both to the free firmware implementations like [coreboot]( 19 | https://www.coreboot.org/), which are forced to rely on a proprietary, obscure 20 | and always-on blob, and to the privacy-aware users, who are reasonably worried 21 | about such firmware, running on the lowest privilege ring on x86. 22 | 23 | ## What can be done 24 | 25 | Before Nehalem (ME version 6, 2008/2009) the ME firmware could be removed 26 | completely from the flash chip by setting a couple of bits inside the flash 27 | descriptor, effectively disabling it. 28 | 29 | Starting from Nehalem the Intel ME firmware can't be removed anymore: without a 30 | valid firmware the PC shuts off forcefully after 30 minutes, probably as an 31 | attempt to enforce the Intel Anti-Theft policies. 32 | 33 | However, while Intel ME can't be turned off completely, it is still possible to 34 | modify its firmware up to a point where Intel ME is active only during the boot 35 | process, effectively disabling it during the normal operation, which is what 36 | _me\_cleaner_ tries to accomplish. 37 | 38 | ## Platform support 39 | 40 | _me\_cleaner_ currently works on [most of the Intel platforms]( 41 | https://github.com/corna/me_cleaner/wiki/me_cleaner-status); while this doesn't 42 | mean it works on all the boards (due to the different firmware implementations), 43 | it has been proven quite reliable on a great number of them. 44 | 45 | ## Usage 46 | 47 | _me\_cleaner_ should handle all the steps necessary to the modification of an 48 | Intel ME firmware with the command: 49 | 50 | $ python me_cleaner.py -S -O modified_image.bin original_dump.bin 51 | 52 | However, obtaining the original firmware and flashing back the modified one is 53 | usually not trivial, as the Intel ME firmware region is often non-writable from 54 | the OS (and it's not a safe option anyways), requiring the use of an external 55 | SPI programmer. 56 | 57 | ## Results 58 | 59 | For generation 1 (before Nehalem, ME version <= 5) this tool removes the whole 60 | ME firmware and disables it completely. 61 | 62 | For generation 2 (Nehalem-Broadwell, ME version between 6 and 10) this tool 63 | removes almost everything, leaving only the two fundamental modules needed for 64 | the correct boot, `ROMP` and `BUP`. The firmware size is reduced from 1.5 MB 65 | (non-AMT firmware) or 5 MB (AMT firmware) to ~90 kB. 66 | 67 | For generation 3 (from Skylake onwards, ME version >= 11) the ME subsystem and 68 | the firmware structure have changed, requiring substantial changes 69 | in _me\_cleaner_. The fundamental modules required for the correct boot are now 70 | four (`rbe`, `kernel`, `syslib` and `bup`) and the minimum firmware size is 71 | ~300 kB (from the 2 MB of the non-AMT firmware and the 7 MB of the AMT one). 72 | 73 | On some boards the OEM firmware fails to boot without a valid Intel ME firmware; 74 | in the other cases the system should work with minor inconveniences (like longer 75 | boot times or warning messages) or without issues at all. 76 | 77 | Obviously, the features provided by Intel ME won't be functional anymore after 78 | the modifications. 79 | 80 | ## Documentation 81 | 82 | The detailed documentation about the working of _me\_cleaner_ can be found on 83 | the page ["How does it work?" page]( 84 | https://github.com/corna/me_cleaner/wiki/How-does-it-work%3F). 85 | 86 | Various guides and tutorials are available on the Internet, however a good 87 | starting point is the ["How to apply me_cleaner" guide]( 88 | https://github.com/corna/me_cleaner/wiki/How-to-apply-me_cleaner). 89 | 90 | -------------------------------------------------------------------------------- /man/me_cleaner.1: -------------------------------------------------------------------------------- 1 | .TH me_cleaner 1 "OCTOBER 2018" 2 | .SH me_cleaner 3 | .PP 4 | me_cleaner \- Tool for partial deblobbing of Intel ME/TXE firmware images 5 | .SH SYNOPSIS 6 | .PP 7 | \fB\fCme_cleaner.py\fR [\-h] [\-v] [\-O output_file] [\-S | \-s] [\-r] [\-k] 8 | [\-w whitelist | \-b blacklist] [\-d] [\-t] [\-c] [\-D output_descriptor] 9 | [\-M output_me_image] \fIfile\fP 10 | .SH DESCRIPTION 11 | .PP 12 | \fB\fCme_cleaner\fR is a tool able to disable parts of Intel ME/TXE by: 13 | .RS 14 | .IP \(bu 2 15 | removing most of the code from its firmware 16 | .IP \(bu 2 17 | setting a special bit to force it to disable itself after the hardware 18 | initialization 19 | .RE 20 | .PP 21 | Using both the modes seems to be the most reliable way on many platforms. 22 | .PP 23 | When used on ME firmware older than Nehalem (versions 1.x\-5.x), Intel ME is 24 | fully disabled and its firmware is removed completely. 25 | .PP 26 | The resulting modified firmware needs to be flashed (in most of the cases) with 27 | an external programmer, often a dedicated SPI programmer or a Linux board with 28 | a SPI master interface. 29 | .PP 30 | \fB\fCme_cleaner\fR works at least up to Coffee Lake (for Intel ME) and on 31 | Braswell/Cherry Trail (for Intel TXE), but may work as well on newer or 32 | different architectures. 33 | .PP 34 | While \fB\fCme_cleaner\fR have been tested on a great number of platforms, fiddling 35 | with the Intel ME/TXE firmware is \fIvery dangerous\fP and can easily lead to a 36 | dead PC. 37 | .PP 38 | \fIYOU HAVE BEEN WARNED.\fP 39 | .SH POSITIONAL ARGUMENTS 40 | .TP 41 | \fB\fCfile\fR 42 | ME/TXE image or full dump. 43 | .SH OPTIONAL ARGUMENTS 44 | .TP 45 | \fB\fC\-h\fR, \fB\fC\-\-help\fR 46 | Show the help message and exit. 47 | .TP 48 | \fB\fC\-v\fR, \fB\fC\-\-version\fR 49 | Show program's version number and exit. 50 | .TP 51 | \fB\fC\-O\fR, \fB\fC\-\-output\fR 52 | Save the modified image in a separate file, instead of modifying the 53 | original file. 54 | .TP 55 | \fB\fC\-S\fR, \fB\fC\-\-soft\-disable\fR 56 | In addition to the usual operations on the ME/TXE firmware, set the 57 | MeAltDisable bit or the HAP bit to ask Intel ME/TXE to disable itself after 58 | the hardware initialization (requires a full dump). 59 | .TP 60 | \fB\fC\-s\fR, \fB\fC\-\-soft\-disable\-only\fR 61 | Instead of the usual operations on the ME/TXE firmware, just set the 62 | MeAltDisable bit or the HAP bit to ask Intel ME/TXE to disable itself after 63 | the hardware initialization (requires a full dump). 64 | .TP 65 | \fB\fC\-r\fR, \fB\fC\-\-relocate\fR 66 | Relocate the FTPR partition to the top of the ME region to save even more 67 | space. 68 | .TP 69 | \fB\fC\-t\fR, \fB\fC\-\-truncate\fR 70 | Truncate the empty part of the firmware (requires a separated ME/TXE image or 71 | \fB\fC\-\-extract\-me\fR). 72 | .TP 73 | \fB\fC\-k\fR, \fB\fC\-\-keep\-modules\fR 74 | Don't remove the FTPR modules, even when possible. 75 | .TP 76 | \fB\fC\-w\fR, \fB\fC\-\-whitelist\fR 77 | Comma separated list of additional partitions to keep in the final image. 78 | This can be used to specify the MFS partition for example, which stores PCIe 79 | and clock settings. 80 | .TP 81 | \fB\fC\-b\fR, \fB\fC\-\-blacklist\fR 82 | Comma separated list of partitions to remove from the image. This option 83 | overrides the default removal list. 84 | .TP 85 | \fB\fC\-d\fR, \fB\fC\-\-descriptor\fR 86 | Remove the ME/TXE Read/Write permissions to the other regions on the flash 87 | from the Intel Flash Descriptor (requires a full dump). 88 | .TP 89 | \fB\fC\-D\fR, \fB\fC\-\-extract\-descriptor\fR 90 | Extract the flash descriptor from a full dump; when used with \fB\fC\-\-truncate\fR 91 | save a descriptor with adjusted regions start and end. 92 | .TP 93 | \fB\fC\-M\fR, \fB\fC\-\-extract\-me\fR 94 | Extract the ME firmware from a full dump; when used with \fB\fC\-\-truncate\fR save a 95 | truncated ME/TXE image. 96 | .TP 97 | \fB\fC\-c\fR, \fB\fC\-\-check\fR 98 | Verify the integrity of the fundamental parts of the firmware and exit. 99 | .SH SUPPORTED PLATFORMS 100 | .PP 101 | Currently \fB\fCme_cleaner\fR has been tested on the following platforms: 102 | .TS 103 | allbox; 104 | cb cb cb cb 105 | c c c c 106 | c c c c 107 | c c c c 108 | c c c c 109 | c c c c 110 | c c c c 111 | c c c c 112 | c c c c 113 | c c c c 114 | . 115 | PCH CPU ME SKU 116 | 1.x\-5.x 117 | Ibex Peak Nehalem/Westmere 6.0 Ignition 118 | Ibex Peak Nehalem/Westmere 6.x 1.5/5 MB 119 | Cougar Point Sandy Bridge 7.x 1.5/5 MB 120 | Panther Point Ivy Bridge 8.x 1.5/5 MB 121 | Lynx/Wildcat Point Haswell/Broadwell 9.x 1.5/5 MB 122 | Wildcat Point LP Broadwell Mobile 10.0 1.5/5 MB 123 | Sunrise Point Skylake/Kabylake 11.x CON/COR 124 | Union Point Kabylake 11.x CON/COR 125 | .TE 126 | .TS 127 | allbox; 128 | cb cb cb 129 | c c c 130 | . 131 | SoC TXE SKU 132 | Braswell/Cherry Trail 2.x 1.375 MB 133 | .TE 134 | .PP 135 | All the reports are available on the project's GitHub page \[la]https://github.com/corna/me_cleaner/issues/3\[ra]\&. 136 | .SH EXAMPLES 137 | .PP 138 | Check whether the provided image has a valid structure and signature: 139 | .IP 140 | \fB\fCme_cleaner.py \-c dumped_firmware.bin\fR 141 | .PP 142 | Remove most of the Intel ME firmware modules but don't set the HAP/AltMeDisable 143 | bit: 144 | .IP 145 | \fB\fCme_cleaner.py \-S \-O modified_me_firmware.bin dumped_firmware.bin\fR 146 | .PP 147 | Remove most of the Intel ME firmware modules and set the HAP/AltMeDisable bit, 148 | disable the Read/Write access of Intel ME to the other flash region, then 149 | relocate the code to the top of the image and truncate it, extracting a modified 150 | descriptor and ME image: 151 | .IP 152 | \fB\fCme_cleaner.py \-S \-r \-t \-d \-D ifd_shrinked.bin \-M me_shrinked.bin \-O modified_firmware.bin full_dumped_firmware.bin\fR 153 | .SH BUGS 154 | .PP 155 | Bugs should be reported on the project's GitHub page \[la]https://github.com/corna/me_cleaner\[ra]\&. 156 | .SH AUTHOR 157 | .PP 158 | Nicola Corna \[la]nicola@corna.info\[ra] 159 | .SH SEE ALSO 160 | .PP 161 | .BR flashrom (8), 162 | me_cleaner's Wiki \[la]https://github.com/corna/me_cleaner/wiki\[ra] 163 | -------------------------------------------------------------------------------- /man/me_cleaner.md: -------------------------------------------------------------------------------- 1 | [//]: # (Use md2man to generate the man page from this Markdown) 2 | [//]: # (https://github.com/sunaku/md2man) 3 | 4 | me_cleaner 1 "OCTOBER 2018" 5 | ======================================= 6 | 7 | me\_cleaner 8 | ---- 9 | 10 | me\_cleaner - Tool for partial deblobbing of Intel ME/TXE firmware images 11 | 12 | SYNOPSIS 13 | -------- 14 | 15 | `me_cleaner.py` [-h] [-v] [-O output\_file] [-S | -s] [-r] [-k] 16 | [-w whitelist | -b blacklist] [-d] [-t] [-c] [-D output\_descriptor] 17 | [-M output\_me\_image] *file* 18 | 19 | DESCRIPTION 20 | ----------- 21 | 22 | `me_cleaner` is a tool able to disable parts of Intel ME/TXE by: 23 | 24 | * removing most of the code from its firmware 25 | * setting a special bit to force it to disable itself after the hardware 26 | initialization 27 | 28 | Using both the modes seems to be the most reliable way on many platforms. 29 | 30 | When used on ME firmware older than Nehalem (versions 1.x-5.x), Intel ME is 31 | fully disabled and its firmware is removed completely. 32 | 33 | The resulting modified firmware needs to be flashed (in most of the cases) with 34 | an external programmer, often a dedicated SPI programmer or a Linux board with 35 | a SPI master interface. 36 | 37 | `me_cleaner` works at least up to Coffee Lake (for Intel ME) and on 38 | Braswell/Cherry Trail (for Intel TXE), but may work as well on newer or 39 | different architectures. 40 | 41 | While `me_cleaner` have been tested on a great number of platforms, fiddling 42 | with the Intel ME/TXE firmware is *very dangerous* and can easily lead to a 43 | dead PC. 44 | 45 | *YOU HAVE BEEN WARNED.* 46 | 47 | POSITIONAL ARGUMENTS 48 | -------------------- 49 | 50 | `file` 51 | ME/TXE image or full dump. 52 | 53 | OPTIONAL ARGUMENTS 54 | ------------------ 55 | 56 | `-h`, `--help` 57 | Show the help message and exit. 58 | 59 | `-v`, `--version` 60 | Show program's version number and exit. 61 | 62 | `-O`, `--output` 63 | Save the modified image in a separate file, instead of modifying the 64 | original file. 65 | 66 | `-S`, `--soft-disable` 67 | In addition to the usual operations on the ME/TXE firmware, set the 68 | MeAltDisable bit or the HAP bit to ask Intel ME/TXE to disable itself after 69 | the hardware initialization (requires a full dump). 70 | 71 | `-s`, `--soft-disable-only` 72 | Instead of the usual operations on the ME/TXE firmware, just set the 73 | MeAltDisable bit or the HAP bit to ask Intel ME/TXE to disable itself after 74 | the hardware initialization (requires a full dump). 75 | 76 | `-r`, `--relocate` 77 | Relocate the FTPR partition to the top of the ME region to save even more 78 | space. 79 | 80 | `-t`, `--truncate` 81 | Truncate the empty part of the firmware (requires a separated ME/TXE image or 82 | `--extract-me`). 83 | 84 | `-k`, `--keep-modules` 85 | Don't remove the FTPR modules, even when possible. 86 | 87 | `-w`, `--whitelist` 88 | Comma separated list of additional partitions to keep in the final image. 89 | This can be used to specify the MFS partition for example, which stores PCIe 90 | and clock settings. 91 | 92 | `-b`, `--blacklist` 93 | Comma separated list of partitions to remove from the image. This option 94 | overrides the default removal list. 95 | 96 | `-d`, `--descriptor` 97 | Remove the ME/TXE Read/Write permissions to the other regions on the flash 98 | from the Intel Flash Descriptor (requires a full dump). 99 | 100 | `-D`, `--extract-descriptor` 101 | Extract the flash descriptor from a full dump; when used with `--truncate` 102 | save a descriptor with adjusted regions start and end. 103 | 104 | `-M`, `--extract-me` 105 | Extract the ME firmware from a full dump; when used with `--truncate` save a 106 | truncated ME/TXE image. 107 | 108 | `-c`, `--check` 109 | Verify the integrity of the fundamental parts of the firmware and exit. 110 | 111 | SUPPORTED PLATFORMS 112 | ------------------- 113 | 114 | Currently `me_cleaner` has been tested on the following platforms: 115 | 116 | | PCH | CPU | ME | SKU | 117 | |:-----------------:|:-----------------:|:-------:|:--------:| 118 | | | | 1.x-5.x | | 119 | | Ibex Peak | Nehalem/Westmere | 6.0 | Ignition | 120 | | Ibex Peak | Nehalem/Westmere | 6.x | 1.5/5 MB | 121 | | Cougar Point | Sandy Bridge | 7.x | 1.5/5 MB | 122 | | Panther Point | Ivy Bridge | 8.x | 1.5/5 MB | 123 | | Lynx/Wildcat Point| Haswell/Broadwell | 9.x | 1.5/5 MB | 124 | | Wildcat Point LP | Broadwell Mobile | 10.0 | 1.5/5 MB | 125 | | Sunrise Point | Skylake/Kabylake | 11.x | CON/COR | 126 | | Union Point | Kabylake | 11.x | CON/COR | 127 | 128 | | SoC | TXE | SKU | 129 | |:---------------------:|:---:|:--------:| 130 | | Braswell/Cherry Trail | 2.x | 1.375 MB | 131 | 132 | All the reports are available on the [project's GitHub page]( 133 | https://github.com/corna/me_cleaner/issues/3). 134 | 135 | EXAMPLES 136 | -------- 137 | 138 | Check whether the provided image has a valid structure and signature: 139 | 140 | `me_cleaner.py -c dumped_firmware.bin` 141 | 142 | Remove most of the Intel ME firmware modules but don't set the HAP/AltMeDisable 143 | bit: 144 | 145 | `me_cleaner.py -S -O modified_me_firmware.bin dumped_firmware.bin` 146 | 147 | Remove most of the Intel ME firmware modules and set the HAP/AltMeDisable bit, 148 | disable the Read/Write access of Intel ME to the other flash region, then 149 | relocate the code to the top of the image and truncate it, extracting a modified 150 | descriptor and ME image: 151 | 152 | `me_cleaner.py -S -r -t -d -D ifd_shrinked.bin -M me_shrinked.bin -O modified_firmware.bin full_dumped_firmware.bin` 153 | 154 | BUGS 155 | ---- 156 | 157 | Bugs should be reported on the [project's GitHub page]( 158 | https://github.com/corna/me_cleaner). 159 | 160 | AUTHOR 161 | ------ 162 | 163 | Nicola Corna 164 | 165 | SEE ALSO 166 | -------- 167 | 168 | flashrom(8), [me\_cleaner's Wiki](https://github.com/corna/me_cleaner/wiki) 169 | -------------------------------------------------------------------------------- /me_cleaner.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # me_cleaner - Tool for partial deblobbing of Intel ME/TXE firmware images 4 | # Copyright (C) 2016-2018 Nicola Corna 5 | # 6 | # This program is free software; you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation; either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | 17 | from __future__ import division, print_function 18 | 19 | import argparse 20 | import binascii 21 | import hashlib 22 | import itertools 23 | import shutil 24 | import sys 25 | from struct import pack, unpack 26 | 27 | 28 | min_ftpr_offset = 0x400 29 | spared_blocks = 4 30 | unremovable_modules = ("ROMP", "BUP") 31 | unremovable_modules_gen3 = ("rbe", "kernel", "syslib", "bup") 32 | unremovable_partitions = ("FTPR",) 33 | 34 | pubkeys_md5 = { 35 | "8431285d43b0f2a2f520d7cab3d34178": ("ME", ("2.0.x.x", "2.1.x.x", 36 | "2.2.x.x")), 37 | "4c00dd06c28119b5c1e5bb8eb6f30596": ("ME", ("2.5.x.x", "2.6.x.x")), 38 | "9c24077a7f7490967855e9c4c16c6b9e": ("ME", ("3.x.x.x",)), 39 | "bf41464be736f5520d80c67f6789020e": ("ME", ("4.x.x.x",)), 40 | "5c7169b7e7065323fb7b3b5657b4d57a": ("ME", ("5.x.x.x",)), 41 | "763e59ebe235e45a197a5b1a378dfa04": ("ME", ("6.x.x.x",)), 42 | "3a98c847d609c253e145bd36512629cb": ("ME", ("6.0.50.x",)), 43 | "0903fc25b0f6bed8c4ed724aca02124c": ("ME", ("7.x.x.x", "8.x.x.x")), 44 | "2011ae6df87c40fba09e3f20459b1ce0": ("ME", ("9.0.x.x", "9.1.x.x")), 45 | "e8427c5691cf8b56bc5cdd82746957ed": ("ME", ("9.5.x.x", "10.x.x.x")), 46 | "986a78e481f185f7d54e4af06eb413f6": ("ME", ("11.x.x.x",)), 47 | "bda0b6bb8ca0bf0cac55ac4c4d55e0f2": ("TXE", ("1.x.x.x",)), 48 | "b726a2ab9cd59d4e62fe2bead7cf6997": ("TXE", ("1.x.x.x",)), 49 | "0633d7f951a3e7968ae7460861be9cfb": ("TXE", ("2.x.x.x",)), 50 | "1d0a36e9f5881540d8e4b382c6612ed8": ("TXE", ("3.x.x.x",)), 51 | "be900fef868f770d266b1fc67e887e69": ("SPS", ("2.x.x.x",)), 52 | "4622e3f2cb212a89c90a4de3336d88d2": ("SPS", ("3.x.x.x",)), 53 | "31ef3d950eac99d18e187375c0764ca4": ("SPS", ("4.x.x.x",)) 54 | } 55 | 56 | 57 | class OutOfRegionException(Exception): 58 | pass 59 | 60 | 61 | class RegionFile: 62 | def __init__(self, f, region_start, region_end): 63 | self.f = f 64 | self.region_start = region_start 65 | self.region_end = region_end 66 | 67 | def read(self, n): 68 | if f.tell() + n <= self.region_end: 69 | return self.f.read(n) 70 | else: 71 | raise OutOfRegionException() 72 | 73 | def readinto(self, b): 74 | if f.tell() + len(b) <= self.region_end: 75 | return self.f.readinto(b) 76 | else: 77 | raise OutOfRegionException() 78 | 79 | def seek(self, offset): 80 | if self.region_start + offset <= self.region_end: 81 | return self.f.seek(self.region_start + offset) 82 | else: 83 | raise OutOfRegionException() 84 | 85 | def write_to(self, offset, data): 86 | if self.region_start + offset + len(data) <= self.region_end: 87 | self.f.seek(self.region_start + offset) 88 | return self.f.write(data) 89 | else: 90 | raise OutOfRegionException() 91 | 92 | def fill_range(self, start, end, fill): 93 | if self.region_start + end <= self.region_end: 94 | if start < end: 95 | block = fill * 4096 96 | self.f.seek(self.region_start + start) 97 | self.f.writelines(itertools.repeat(block, 98 | (end - start) // 4096)) 99 | self.f.write(block[:(end - start) % 4096]) 100 | else: 101 | raise OutOfRegionException() 102 | 103 | def fill_all(self, fill): 104 | self.fill_range(0, self.region_end - self.region_start, fill) 105 | 106 | def move_range(self, offset_from, size, offset_to, fill): 107 | if self.region_start + offset_from + size <= self.region_end and \ 108 | self.region_start + offset_to + size <= self.region_end: 109 | for i in range(0, size, 4096): 110 | self.f.seek(self.region_start + offset_from + i, 0) 111 | block = self.f.read(min(size - i, 4096)) 112 | self.f.seek(self.region_start + offset_from + i, 0) 113 | self.f.write(fill * len(block)) 114 | self.f.seek(self.region_start + offset_to + i, 0) 115 | self.f.write(block) 116 | else: 117 | raise OutOfRegionException() 118 | 119 | def save(self, filename, size): 120 | if self.region_start + size <= self.region_end: 121 | self.f.seek(self.region_start) 122 | copyf = open(filename, "w+b") 123 | for i in range(0, size, 4096): 124 | copyf.write(self.f.read(min(size - i, 4096))) 125 | return copyf 126 | else: 127 | raise OutOfRegionException() 128 | 129 | 130 | def get_chunks_offsets(llut): 131 | chunk_count = unpack("> 4) & 7 170 | 171 | print(" {:<16} ({:<7}, ".format(name, comp_str[comp_type]), end="") 172 | 173 | if comp_type == 0x00 or comp_type == 0x02: 174 | print("0x{:06x} - 0x{:06x} ): " 175 | .format(offset, offset + size), end="") 176 | 177 | if name in unremovable_modules: 178 | end_addr = max(end_addr, offset + size) 179 | print("NOT removed, essential") 180 | else: 181 | end = min(offset + size, me_end) 182 | f.fill_range(offset, end, b"\xff") 183 | print("removed") 184 | 185 | elif comp_type == 0x01: 186 | if not chunks_offsets: 187 | f.seek(offset) 188 | llut = f.read(4) 189 | if llut == b"LLUT": 190 | llut += f.read(0x3c) 191 | 192 | chunk_count = unpack(" removable_chunk[0]: 238 | end = min(removable_chunk[1], me_end) 239 | f.fill_range(removable_chunk[0], end, b"\xff") 240 | 241 | end_addr = max(end_addr, 242 | max(unremovable_huff_chunks, key=lambda x: x[1])[1]) 243 | 244 | return end_addr 245 | 246 | 247 | def check_partition_signature(f, offset): 248 | f.seek(offset) 249 | header = f.read(0x80) 250 | modulus = int(binascii.hexlify(f.read(0x100)[::-1]), 16) 251 | public_exponent = unpack("> 4) & 7 == 0x01: 287 | llut_start = unpack("> 25 417 | 418 | modules.append((name, offset, comp_type)) 419 | 420 | modules.sort(key=lambda x: x[1]) 421 | 422 | for i in range(0, module_count): 423 | name = modules[i][0] 424 | offset = partition_offset + modules[i][1] 425 | end = partition_offset + modules[i + 1][1] 426 | removed = False 427 | 428 | if name.endswith(".man") or name.endswith(".met"): 429 | compression = "uncompressed" 430 | else: 431 | compression = comp_str[modules[i][2]] 432 | 433 | print(" {:<12} ({:<12}, 0x{:06x} - 0x{:06x}): " 434 | .format(name, compression, offset, end), end="") 435 | 436 | if name.endswith(".man"): 437 | print("NOT removed, partition manif.") 438 | elif name.endswith(".met"): 439 | print("NOT removed, module metadata") 440 | elif any(name.startswith(m) for m in unremovable_modules_gen3): 441 | print("NOT removed, essential") 442 | else: 443 | removed = True 444 | f.fill_range(offset, min(end, me_end), b"\xff") 445 | print("removed") 446 | 447 | if not removed: 448 | end_data = max(end_data, end) 449 | 450 | if relocate: 451 | new_offset = relocate_partition(f, me_end, 0x30, min_offset, []) 452 | end_data += new_offset - partition_offset 453 | partition_offset = new_offset 454 | 455 | return end_data, partition_offset 456 | 457 | 458 | def check_mn2_tag(f, offset, gen): 459 | f.seek(offset + 0x1c) 460 | tag = f.read(4) 461 | expected_tag = b"$MAN" if gen == 1 else b"$MN2" 462 | if tag != expected_tag: 463 | sys.exit("Wrong FTPR manifest tag ({}), this image may be corrupted" 464 | .format(tag)) 465 | 466 | 467 | def flreg_to_start_end(flreg): 468 | return (flreg & 0x7fff) << 12, (flreg >> 4 & 0x7fff000 | 0xfff) + 1 469 | 470 | 471 | def start_end_to_flreg(start, end): 472 | return (start & 0x7fff000) >> 12 | ((end - 1) & 0x7fff000) << 4 473 | 474 | 475 | if __name__ == "__main__": 476 | parser = argparse.ArgumentParser(description="Tool to remove as much code " 477 | "as possible from Intel ME/TXE firmware " 478 | "images") 479 | softdis = parser.add_mutually_exclusive_group() 480 | bw_list = parser.add_mutually_exclusive_group() 481 | 482 | parser.add_argument("-v", "--version", action="version", 483 | version="%(prog)s 1.2") 484 | 485 | parser.add_argument("file", help="ME/TXE image or full dump") 486 | parser.add_argument("-O", "--output", metavar='output_file', help="save " 487 | "the modified image in a separate file, instead of " 488 | "modifying the original file") 489 | softdis.add_argument("-S", "--soft-disable", help="in addition to the " 490 | "usual operations on the ME/TXE firmware, set the " 491 | "MeAltDisable bit or the HAP bit to ask Intel ME/TXE " 492 | "to disable itself after the hardware initialization " 493 | "(requires a full dump)", action="store_true") 494 | softdis.add_argument("-s", "--soft-disable-only", help="instead of the " 495 | "usual operations on the ME/TXE firmware, just set " 496 | "the MeAltDisable bit or the HAP bit to ask Intel " 497 | "ME/TXE to disable itself after the hardware " 498 | "initialization (requires a full dump)", 499 | action="store_true") 500 | parser.add_argument("-r", "--relocate", help="relocate the FTPR partition " 501 | "to the top of the ME region to save even more space", 502 | action="store_true") 503 | parser.add_argument("-t", "--truncate", help="truncate the empty part of " 504 | "the firmware (requires a separated ME/TXE image or " 505 | "--extract-me)", action="store_true") 506 | parser.add_argument("-k", "--keep-modules", help="don't remove the FTPR " 507 | "modules, even when possible", action="store_true") 508 | bw_list.add_argument("-w", "--whitelist", metavar="whitelist", 509 | help="Comma separated list of additional partitions " 510 | "to keep in the final image. This can be used to " 511 | "specify the MFS partition for example, which stores " 512 | "PCIe and clock settings.") 513 | bw_list.add_argument("-b", "--blacklist", metavar="blacklist", 514 | help="Comma separated list of partitions to remove " 515 | "from the image. This option overrides the default " 516 | "removal list.") 517 | parser.add_argument("-d", "--descriptor", help="remove the ME/TXE " 518 | "Read/Write permissions to the other regions on the " 519 | "flash from the Intel Flash Descriptor (requires a " 520 | "full dump)", action="store_true") 521 | parser.add_argument("-D", "--extract-descriptor", 522 | metavar='output_descriptor', help="extract the flash " 523 | "descriptor from a full dump; when used with " 524 | "--truncate save a descriptor with adjusted regions " 525 | "start and end") 526 | parser.add_argument("-M", "--extract-me", metavar='output_me_image', 527 | help="extract the ME firmware from a full dump; when " 528 | "used with --truncate save a truncated ME/TXE image") 529 | parser.add_argument("-c", "--check", help="verify the integrity of the " 530 | "fundamental parts of the firmware and exit", 531 | action="store_true") 532 | 533 | args = parser.parse_args() 534 | 535 | if args.check and (args.soft_disable_only or args.soft_disable or 536 | args.relocate or args.descriptor or args.truncate or args.output): 537 | sys.exit("-c can't be used with -S, -s, -r, -d, -t or -O") 538 | 539 | if args.soft_disable_only and (args.relocate or args.truncate): 540 | sys.exit("-s can't be used with -r or -t") 541 | 542 | if (args.whitelist or args.blacklist) and args.relocate: 543 | sys.exit("Relocation is not yet supported with custom whitelist or " 544 | "blacklist") 545 | 546 | gen = None 547 | 548 | f = open(args.file, "rb" if args.check or args.output else "r+b") 549 | magic0 = f.read(4) 550 | f.seek(0x10) 551 | magic10 = f.read(4) 552 | 553 | if b"$FPT" in {magic0, magic10}: 554 | print("ME/TXE image detected") 555 | 556 | if args.descriptor or args.extract_descriptor or args.extract_me or \ 557 | args.soft_disable or args.soft_disable_only: 558 | sys.exit("-d, -D, -M, -S and -s require a full dump") 559 | 560 | f.seek(0, 2) 561 | me_start = 0 562 | me_end = f.tell() 563 | mef = RegionFile(f, me_start, me_end) 564 | 565 | elif b"\x5a\xa5\xf0\x0f" in {magic0, magic10}: 566 | print("Full image detected") 567 | 568 | f.seek(0x4 if magic0 == b"\x5a\xa5\xf0\x0f" else 0x14) 569 | flmap0, flmap1, flmap2 = unpack("> 12 & 0xff0 571 | fmba = (flmap1 & 0xff) << 4 572 | 573 | # Generation 1 574 | fisba = flmap1 >> 12 & 0xff0 575 | fmsba = (flmap2 & 0xff) << 4 576 | 577 | # Generation 2-3 578 | fpsba = fisba 579 | 580 | f.seek(frba) 581 | flreg = unpack("= me_end: 588 | print("The ME region in this image has already been disabled") 589 | else: 590 | mef = RegionFile(f, me_start, me_end) 591 | 592 | if magic0 == b"\x5a\xa5\xf0\x0f": 593 | gen = 1 594 | 595 | else: 596 | sys.exit("Unknown image") 597 | 598 | if me_start < me_end: 599 | mef.seek(0) 600 | if mef.read(4) == b"$FPT": 601 | fpt_offset = 0 602 | else: 603 | mef.seek(0x10) 604 | if mef.read(4) == b"$FPT": 605 | fpt_offset = 0x10 606 | else: 607 | if me_start > 0: 608 | sys.exit("The ME/TXE region is valid but the firmware is " 609 | "corrupted or missing") 610 | else: 611 | sys.exit("Unknown error") 612 | 613 | if gen == 1: 614 | end_addr = 0 615 | else: 616 | end_addr = me_end 617 | 618 | if me_start < me_end: 619 | print("Found FPT header at {:#x}".format(mef.region_start + fpt_offset)) 620 | 621 | mef.seek(fpt_offset + 0x4) 622 | entries = unpack("= 0: 664 | check_mn2_tag(mef, ftpr_offset + ftpr_mn2_offset, gen) 665 | print("Found FTPR manifest at {:#x}" 666 | .format(ftpr_offset + ftpr_mn2_offset)) 667 | else: 668 | sys.exit("Can't find the manifest of the FTPR partition") 669 | 670 | else: 671 | check_mn2_tag(mef, ftpr_offset, gen) 672 | ftpr_mn2_offset = 0 673 | if not gen: 674 | gen = 2 675 | 676 | mef.seek(ftpr_offset + ftpr_mn2_offset + 0x24) 677 | version = unpack("= 6: 690 | variant = "ME" 691 | else: 692 | variant = "TXE" 693 | print("WARNING Unknown public key {}\n" 694 | " Assuming Intel {}\n" 695 | " Please report this warning to the project's " 696 | "maintainer!" 697 | .format(pubkey_md5, variant)) 698 | 699 | if not args.check and args.output: 700 | f.close() 701 | shutil.copy(args.file, args.output) 702 | f = open(args.output, "r+b") 703 | 704 | if me_start < me_end: 705 | mef = RegionFile(f, me_start, me_end) 706 | 707 | if me_start > 0: 708 | fdf = RegionFile(f, fd_start, fd_end) 709 | 710 | if gen == 1: 711 | for (ba, name) in ((fisba, "ICHSTRP0"), (fmsba, "MCHSTRP0")): 712 | fdf.seek(ba) 713 | strp = unpack(" me_end: 797 | print(" {:<4} ({:^24}, 0x{:08x} total bytes): nothing to " 798 | "remove" 799 | .format(part_name, "no data here", part_length)) 800 | else: 801 | print(" {:<4} (0x{:08x} - 0x{:09x}, 0x{:08x} total bytes): " 802 | .format(part_name, part_start, part_end, part_length), 803 | end="") 804 | if part_name in whitelist or (blacklist and 805 | part_name not in blacklist): 806 | unremovable_part_fpt += partition 807 | if part_name != "FTPR": 808 | extra_part_end = max(extra_part_end, part_end) 809 | print("NOT removed") 810 | else: 811 | mef.fill_range(part_start, part_end, b"\xff") 812 | print("removed") 813 | 814 | print("Removing partition entries in FPT...") 815 | mef.write_to(0x30, unremovable_part_fpt) 816 | mef.write_to(0x14, 817 | pack("= 11 (except for 843 | # 0x1b, the checksum itself). In other words, the sum of those 844 | # bytes must be always 0x00. 845 | mef.write_to(0x1b, pack("B", checksum)) 846 | 847 | print("Reading FTPR modules list...") 848 | if gen == 3: 849 | end_addr, ftpr_offset = \ 850 | check_and_remove_modules_gen3(mef, me_end, 851 | ftpr_offset, ftpr_length, 852 | min_ftpr_offset, 853 | args.relocate, 854 | args.keep_modules) 855 | else: 856 | end_addr, ftpr_offset = \ 857 | check_and_remove_modules(mef, me_end, ftpr_offset, 858 | min_ftpr_offset, args.relocate, 859 | args.keep_modules) 860 | 861 | if end_addr > 0: 862 | end_addr = max(end_addr, extra_part_end) 863 | end_addr = (end_addr // 0x1000 + 1) * 0x1000 864 | end_addr += spared_blocks * 0x1000 865 | 866 | print("The ME minimum size should be {0} bytes " 867 | "({0:#x} bytes)".format(end_addr)) 868 | 869 | if me_start > 0: 870 | print("The ME region can be reduced up to:\n" 871 | " {:08x}:{:08x} me" 872 | .format(me_start, me_start + end_addr - 1)) 873 | elif args.truncate: 874 | print("Truncating file at {:#x}...".format(end_addr)) 875 | f.truncate(end_addr) 876 | 877 | if args.soft_disable or args.soft_disable_only: 878 | if gen == 3: 879 | print("Setting the HAP bit in PCHSTRP0 to disable Intel ME...") 880 | pchstrp0 |= (1 << 16) 881 | fdf.write_to(fpsba, pack(" {:08x}:{:08x} me" 907 | .format(me_start, me_end - 1, 908 | me_start, me_start + end_addr - 1)) 909 | print(" {:08x}:{:08x} bios --> {:08x}:{:08x} bios" 910 | .format(bios_start, bios_end - 1, 911 | me_start + end_addr, bios_end - 1)) 912 | 913 | flreg1 = start_end_to_flreg(me_start + end_addr, bios_end) 914 | if gen != 1: 915 | flreg2 = start_end_to_flreg(me_start, me_start + end_addr) 916 | 917 | fdf_copy.seek(frba + 0x4) 918 | fdf_copy.write(pack("