commit 1b447b77ad907a233722a32cae6029f6321f856c Author: reachableceo Date: Tue Aug 18 11:15:05 2026 -0500 Initial public release: dockerized reverse-engineering workbench ChipBench packages Ghidra, radare2, binwalk, chip-programming tools, simulators, and firmware-unpacking utilities into one reproducible container for analyzing raw chip dumps entirely from the command line or an AI CLI. Headless Jython scripts drive import, forced-disassembly sweeps, live queries, and bulk decompilation exports without any GUI. Derived from a private engagement environment, generalized for public release under AGPLv3. No engagement-specific artifacts are included. 💘 Generated with Crush Assisted-by: Crush:glm-5.2 diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..718dc2e --- /dev/null +++ b/.env.example @@ -0,0 +1,5 @@ +# Bind-mount ownership: match your host user so files keep their owner. +HOST_UID=1001 +HOST_GID=1001 +# VNC / noVNC desktop password (web + raw VNC both use this). +VNC_PASSWORD=chipbench diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1be5f64 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +artifacts/* +work/* +output/* +!artifacts/.gitkeep +!work/.gitkeep +!output/.gitkeep +.env diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ea7604f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog + +## 0.2.0 (2026-08-17) +- Forked to public ChipBench project (AGPLv3). +- Toolset expansion (apt availability verified on ubuntu:24.04): + flashrom, avrdude, openocd, stlink-tools, srecord, simavr, gpsim, + z80dasm, binutils-multiarch, squashfs-tools, p7zip-full, cabextract, + lzma, cpio, unar, u-boot-tools, device-tree-compiler, tio, picocom, + esptool, vbindiff; pyserial added to the venv. +- re-analyze rewritten: Jython post-scripts (Analyze8051.py + ExportAll.py), + auto-attaches the 8051 sweep for 8051-family -processor args + (RE_NO_SWEEP=1 to skip). +- README rewritten for public release. + +## 0.1.0 (2026-07) +- Initial private build: Ghidra 11.3.2 + GhidraMCP 1.4, radare2, binwalk v3, + binutils-avr, gputils, sdcc, capstone/unicorn/keystone, VNC/noVNC desktop; + headless Query.py / ExportAll.py workflow (re-q / re-export / re-analyze). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b594f6a --- /dev/null +++ b/README.md @@ -0,0 +1,144 @@ +# ChipBench — Dockerized reverse-engineering workbench for chip dumps + +A fully self-contained firmware reverse-engineering environment that +installs **nothing on your host** (Docker only). Drop a flash/EEPROM/ROM +dump into `artifacts/` and analyze it **entirely from your terminal or from +an AI CLI** — no GUI required. Headless Ghidra scripts (Jython) plus +radare2, binwalk, capstone/unicorn, chip-programmer tools, simulators, and +firmware-unpacking utilities. + +Built and battle-tested on real engagements (8-bit embedded controllers +with no symbols, no map files, and no mercy). + +## Quick start (headless, no GUI) + +```bash +./re-build # one-time image build +# put your dump in artifacts/dump.bin, then: +./re-analyze dump.bin -processor "8051:BE:16:default" +./re-q dump.bin info # query it (commands below) +./re-export dump.bin # bulk-export everything to output/ +``` + +`./re-analyze`, `./re-q`, `./re-export` use one-shot containers (`tools` +service) — **no desktop stack needs to be running**. Build once with +`./re-build`; you never need `./re-up` unless you want the GUI. + +## Headless query interface — `re-q` + +``` +./re-q [args...] +``` + +`` is the domain-file name in the project (usually the artifact's +basename, e.g. `dump.bin`). Commands: + +| Command | Args | What it returns | +|---|---|---| +| `info` | — | name, language, image base, size, function count, segments | +| `segments` | — | memory segments (name, range, perms) | +| `funcs` | `[offset] [limit] [filter]` | function list: `name @ entry` | +| `search` | ` [limit]` | functions whose name contains query | +| `func` | `` | one function's metadata (signature, body, size) | +| `decompile` | `` | decompiled C of a function | +| `disasm` | `` | disassembly of the function at/containing addr | +| `xrefs-to` | ` [limit]` | references TO an address (callers etc.) | +| `xrefs-from` | ` [limit]` | references FROM an address | +| `func-xrefs` | ` [limit]` | references to a function by name | +| `strings` | `[filter] [limit]` | defined strings with addresses | +| `data` | `[offset] [limit]` | defined data items | +| `mem` | ` ` | raw hex+ASCII dump of `` bytes | +| `exports` / `imports` | `[limit]` | external entry points / symbols | + +Addresses accept Ghidra's form (`00102030`) or `0x`-prefixed. Each query +spins up a short-lived Ghidra JVM (~10 s) reading the already-analyzed +program (read-only). + +## Bulk export — `re-export` + +``` +./re-export +``` + +One Ghidra run writes, to `output/`: `*.info.txt`, `*.functions.txt`, +`*.strings.txt`, `*.segments.txt`, `*.data.txt`, `*.decompiled.c`. +Read/grep these instantly for most questions; use `re-q` for targeted +live queries. + +## Architecture forcing + +Let Ghidra auto-detect, or force with `-processor` (see `re-analyze -h` +comment header). Raw 8051 dumps get automatic vector+sweep disassembly via +`Analyze8051.py` (override with `RE_NO_SWEEP=1`). + +## What's inside + +| Category | Tools | +|---|---| +| Decompiler / RE workbench | **Ghidra 11.3.2** + GhidraMCP 1.4 plugin | +| Headless scripts (Jython) | Query.py, ExportAll.py, Analyze8051.py, MakeFuncs.py, AutoFuncs.py | +| CLI disassemblers | **radare2** (r2/rabin2), binutils-multiarch, binutils-avr, gputils (gpdasm), sdcc, z80dasm | +| Firmware scanning / unpacking | **binwalk v3**, 7-zip, cabextract, lzma, cpio, squashfs-tools, unar, u-boot-tools (mkimage), device-tree-compiler | +| Chip programming / debug | **flashrom**, **avrdude**, **openocd**, stlink-tools, esptool | +| Simulators | simavr (AVR), gpsim (PIC) | +| EPROM/SREC/HEX wrangling | srecord (srec_cat & co.) | +| Serial consoles | tio, picocom (pyserial in the venv) | +| Python RE libs | capstone, unicorn, keystone (in /opt/venv) | +| Desktop (optional) | Xvfb + fluxbox + x11vnc + noVNC | + +Optional extras not packaged (build from source if needed): `minipro` +(TL866 programmers), `stm8flash`. + +## GUI + MCP bridge (optional) + +`./re-up` boots a headless desktop with Ghidra: + +| URL / port | What | +|---|---| +| http://localhost:6080/vnc.html | Ghidra GUI in a browser (VNC pw `chipbench`) | +| localhost:5900 | raw VNC | +| http://localhost:8081/sse | GhidraMCP bridge (MCP over SSE) | + +The MCP bridge only serves data once a program is opened in the CodeBrowser +tool AND the GhidraMCP plugin is enabled there (one-time manual GUI step). +The headless `re-q`/`re-export` interface covers the same ground without +any GUI interaction. + +## Known issues + +- **Use the Jython (.py) scripts.** In-process `javac` for Ghidra `.java` + user scripts has broken across JDK point releases in Ubuntu images + ("class could not be found" at script load). The .py scripts are immune. +- GhidraMCP's Module.manifest emits harmless warnings at headless startup. +- Ghidra 11.3.2 is pinned (latest GhidraMCP 1.4 supports). + +## Layout + +``` +ChipBench/ +├── docker/ +│ ├── Dockerfile # two-stage build (binwalk builder + main) +│ ├── conf/ # supervisord, profile.d, entrypoint +│ └── scripts/ghidra-scripts/ # Jython headless scripts (host-mounted) +├── docker-compose.yml # ghidra (GUI) + tools (CLI) services +├── re-build # build the image +├── re-analyze re-q re-export # headless chat-driven workflow +├── re-identify re-binwalk re-shell # triage / shell +└── re-up re-down re-mcp-test # optional GUI/MCP +``` + +Directories `artifacts/` (read-only mount), `work/`, `output/` are created +on first use. + +## License + +AGPLv3 — see [LICENSE](LICENSE). The Dockerfile pulls third-party tools at +build time under their own licenses (Ghidra: Apache-2.0; GhidraMCP and +binwalk: MIT; radare2: LGPL-3.0; etc.). No binaries are hosted here. + +## Contributing + +Issues and PRs welcome — especially additional headless Jython recipes +(per-architecture sweep scripts, NVM/checksum scanners) and tested tool +additions. Keep the image reasonably lean; heavy/specialized tools belong +in documented `pip`/`apt` side-notes rather than the base image. diff --git a/artifacts/.gitkeep b/artifacts/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..35f6659 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,64 @@ +name: chipbench + +services: + ghidra: + container_name: chipbench-ghidra + build: + context: ./docker + dockerfile: Dockerfile + args: + BUILD_UID: ${HOST_UID:-1001} + BUILD_GID: ${HOST_GID:-1001} + image: chipbench:latest + # Run as the host-mapped uid so bind-mounted files keep their owner. + user: "${HOST_UID:-1001}:${HOST_GID:-1001}" + hostname: chipbench + environment: + - VNC_PASSWORD=${VNC_PASSWORD:-chipbench} + - DISPLAY=:0 + # Quieten Java's noisy startup under a virtual framebuffer. + - _JAVA_OPTIONS=-Dsun.java2d.uiScale=1 -Dawt.useSystemAAFontSettings=on + volumes: + # Chip dumps land here (read-only so we can never clobber the source). + - ./artifacts:/data/artifacts:ro + # Persistent Ghidra project (.gpr + .rep) and supervisor logs. + - ./work:/data/work + # Exported decompilation / disassembly / reports. + - ./output:/data/output + # Ghidra query/export scripts — host-mounted so they can be edited + # without rebuilding the image. + - ./docker/scripts/ghidra-scripts:/opt/ghidra-scripts:ro + ports: + # 5900 -> raw VNC (any VNC viewer) + # 6080 -> noVNC web client (http://localhost:6080/vnc.html) + # 8081 -> GhidraMCP bridge (MCP over SSE) + - "127.0.0.1:5900:5900" + - "127.0.0.1:6080:6080" + - "127.0.0.1:8081:8081" + shm_size: "2g" + restart: unless-stopped + healthcheck: + test: ["CMD-SHELL", "ss -ltn | grep -q ':6080' || exit 1"] + interval: 15s + timeout: 3s + retries: 5 + start_period: 30s + # Default command boots the desktop + Ghidra + MCP bridge via supervisor. + command: ["supervisor"] + + # One-shot helper target: never auto-starts. Used by `re-analyze`, + # `re-shell`, `re-binwalk`, etc. via `docker compose run --rm tools ...`. + tools: + container_name: chipbench-tools + profiles: ["cli"] + image: chipbench:latest + user: "${HOST_UID:-1001}:${HOST_GID:-1001}" + environment: + - DECOMPILE_OUT=/data/output + volumes: + - ./artifacts:/data/artifacts:ro + - ./work:/data/work + - ./output:/data/output + - ./docker/scripts/ghidra-scripts:/opt/ghidra-scripts:ro + entrypoint: ["/bin/bash", "-lc"] + command: ["echo 'chipbench tools image ready'"] diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000..990899e --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,166 @@ +# syntax=docker/dockerfile:1 +# +# ChipBench — self-contained reverse-engineering environment for 8-bit +# (and small embedded) chip dumps. Bundles: Ghidra 11.3.2 + GhidraMCP 1.4, +# radare2, binwalk v3, binutils for several targets, sdcc, gputils, +# capstone/unicorn/keystone, plus a firmware-hacker toolset (flashrom, +# avrdude, openocd, srecord, simavr, unpacking tools, serial consoles). +# Optional VNC/noVNC desktop so the Ghidra GUI also runs headlessly. +# +# Nothing runs as root; runtime user is mapped to host uid/gid so +# bind-mounted artifacts keep their owner. +# +# This project is AGPLv3 (see LICENSE). It builds tooling from public +# sources; no binaries are hosted by the project. + +# ---- Stage 1: build binwalk v3 (Rust) in an isolated builder ---------------- +FROM rust:1-slim-bookworm AS binwalk-builder +RUN apt-get update && apt-get install -y --no-install-recommends \ + pkg-config libfontconfig1-dev ca-certificates \ + && rm -rf /var/lib/apt/lists/* +RUN cargo install --root /out --version 3.1.0 binwalk + +# ---- Stage 2: main image ---------------------------------------------------- +ARG BUILD_UID=1001 +ARG BUILD_GID=1001 + +FROM ubuntu:24.04 + +# ARGs above do not cross FROM boundaries; re-declare for this stage +# (overridable at build time: --build-arg BUILD_UID=$(id -u) etc.) +ARG BUILD_UID +ARG BUILD_GID + +ENV DEBIAN_FRONTEND=noninteractive \ + TZ=UTC \ + LANG=C.UTF-8 \ + LC_ALL=C.UTF-8 \ + DISPLAY=:0 \ + JAVA_HOME=/usr/lib/jvm/java-21-openjdk-amd64 \ + GHIDRA_HOME=/opt/ghidra \ + GHIDRAMCP_HOME=/opt/ghidramcp \ + VENV_HOME=/opt/venv \ + GHIDRA_SCRIPTS=/opt/ghidra-scripts \ + PATH="${JAVA_HOME}/bin:/opt/ghidra:/opt/ghidra/support:/opt/venv/bin:/usr/local/bin:${PATH}" + +# ----------------------------------------------------------------------------- +# 1. System packages +# - GUI/VNC stack (optional desktop for the Ghidra GUI) +# - core RE CLI: radare2, binutils-multiarch, binutils-avr, sdcc, gputils +# - chip-programming & debug: flashrom, avrdude, openocd, stlink-tools +# - EPROM/SREC/HEX wrangling: srecord +# - simulators: simavr (AVR), gpsim (PIC) +# - firmware-unpacking: binwalk deps (7z, cabextract, lzma, cpio, squashfs, +# unar), u-boot-tools (mkimage), device-tree-compiler (dtc) +# - serial: tio, picocom +# - misc: esptool, z80dasm, vbindiff +# NOTE: openjdk-21-jdk is UNPINNED — in-process javac for Ghidra .java +# user scripts has broken before on point-release drift. The supported +# script path here is Jython (.py); the .java helper scripts are not shipped. +# ----------------------------------------------------------------------------- +RUN apt-get update && apt-get install -y --no-install-recommends \ + ca-certificates wget git unzip xz-utils \ + openjdk-21-jdk \ + xvfb x11vnc fluxbox supervisor \ + novnc websockify \ + xterm dbus-x11 \ + libfontconfig1 fonts-dejavu-core \ + python3 python3-venv python3-pip \ + file xxd hexyl binutils \ + binutils-avr \ + binutils-multiarch \ + gputils \ + sdcc \ + radare2 \ + net-tools iproute2 procps less vim-tiny \ + flashrom avrdude openocd stlink-tools \ + srecord \ + simavr gpsim \ + z80dasm \ + squashfs-tools p7zip-full cabextract lzma cpio unar \ + u-boot-tools device-tree-compiler \ + tio picocom \ + esptool \ + vbindiff \ + && rm -rf /var/lib/apt/lists/* + +# binwalk v3 binary (Rust) from the builder stage. +COPY --from=binwalk-builder /out/bin/binwalk /usr/local/bin/binwalk + +# ----------------------------------------------------------------------------- +# 2. Ghidra 11.3.2 (pinned: latest version the GhidraMCP plugin supports) +# ----------------------------------------------------------------------------- +ARG GHIDRA_VERSION=11.3.2 +ARG GHIDRA_ZIP=ghidra_11.3.2_PUBLIC_20250415.zip +ARG GHIDRA_URL=https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_11.3.2_build/${GHIDRA_ZIP} +ARG GHIDRA_SHA256=99d45035bdcc3d6627e7b1232b7b379905a9fad76c772c920602e2b5d8b2dac2 + +RUN cd /tmp \ + && wget -q -O ghidra.zip "${GHIDRA_URL}" \ + && echo "${GHIDRA_SHA256} ghidra.zip" | sha256sum -c - \ + && unzip -q ghidra.zip -d /opt \ + && rm -f ghidra.zip \ + && mv /opt/ghidra_* "${GHIDRA_HOME}" + +# ----------------------------------------------------------------------------- +# 3. GhidraMCP 1.4 plugin (optional REST server inside the Ghidra GUI). +# The GitHub release ships a NESTED zip; unpack both layers. +# (Harmless "Module manifest file error" warnings at headless startup are +# known noise from this plugin's manifest formatting.) +# ----------------------------------------------------------------------------- +ARG GHIDRAMCP_VERSION=1.4 +ARG GHIDRAMCP_ZIP=GhidraMCP-release-1-4.zip +ARG GHIDRAMCP_URL=https://github.com/LaurieWired/GhidraMCP/releases/download/${GHIDRAMCP_VERSION}/${GHIDRAMCP_ZIP} +ARG GHIDRAMCP_SHA256=b81ca5240fdde57ea4e899170dcd9fdee6ed29246280c74263a509bfcfc7e734 + +RUN cd /tmp \ + && wget -q -O mcp-outer.zip "${GHIDRAMCP_URL}" \ + && echo "${GHIDRAMCP_SHA256} mcp-outer.zip" | sha256sum -c - \ + && mkdir -p outer && unzip -q mcp-outer.zip -d outer \ + && inner_zip="$(find outer -name 'GhidraMCP-*.zip' | head -n1)" \ + && test -n "$inner_zip" \ + && mkdir -p inner && unzip -q "$inner_zip" -d inner \ + && extdir="$(dirname "$(find inner -name extension.properties | head -n1)")" \ + && test -n "$extdir" \ + && mkdir -p "${GHIDRA_HOME}/Ghidra/Extensions" \ + && cp -r "$extdir" "${GHIDRA_HOME}/Ghidra/Extensions/GhidraMCP" \ + && rm -rf /tmp/* + +ARG BRIDGE_URL=https://raw.githubusercontent.com/LaurieWired/GhidraMCP/1.4/bridge_mcp_ghidra.py +# Non-fatal: the MCP bridge is optional (GUI-only convenience). GitHub raw +# occasionally rate-limits (429); retries + a warning keep builds reproducible. +RUN mkdir -p "${GHIDRAMCP_HOME}" \ + && ( wget -q --tries=3 --timeout=30 -O "${GHIDRAMCP_HOME}/bridge_mcp_ghidra.py" "${BRIDGE_URL}" \ + || echo "[warn] GhidraMCP bridge download failed; GUI MCP bridge disabled (headless workflow unaffected)" ) + +# ----------------------------------------------------------------------------- +# 4. Python tooling (isolated venv; respects PEP 668) +# ----------------------------------------------------------------------------- +RUN python3 -m venv "${VENV_HOME}" \ + && "${VENV_HOME}/bin/pip" install --no-cache-dir --upgrade pip \ + && "${VENV_HOME}/bin/pip" install --no-cache-dir \ + "mcp==1.5.0" "requests==2.32.3" "pyserial>=3.5" \ + capstone unicorn \ + && ( "${VENV_HOME}/bin/pip" install --no-cache-dir keystone-engine \ + || echo "[warn] keystone-engine unavailable on this platform; skipping (non-fatal)" ) + +# ----------------------------------------------------------------------------- +# 5. Runtime user matching host uid/gid (no root needed at runtime) +# ----------------------------------------------------------------------------- +RUN groupadd -g "${BUILD_GID}" chip \ + && useradd -m -u "${BUILD_UID}" -g "${BUILD_GID}" -s /bin/bash chip + +COPY scripts/ghidra-scripts/ "${GHIDRA_SCRIPTS}/" +COPY conf/supervisord.conf /opt/conf/supervisord.conf +COPY conf/profile.d/chipbench.sh /etc/profile.d/chipbench.sh +COPY scripts/entrypoint.sh /opt/entrypoint.sh +RUN chmod +x /opt/entrypoint.sh \ + && chown -R chip:chip "${GHIDRA_SCRIPTS}" /opt/entrypoint.sh /opt/conf + +USER chip:chip +WORKDIR /data + +EXPOSE 5900 6080 8081 + +ENTRYPOINT ["/opt/entrypoint.sh"] +CMD ["supervisor"] diff --git a/docker/conf/profile.d/chipbench.sh b/docker/conf/profile.d/chipbench.sh new file mode 100644 index 0000000..ab69a07 --- /dev/null +++ b/docker/conf/profile.d/chipbench.sh @@ -0,0 +1,13 @@ +# chipbench shell setup +# Prepend the isolated Python venv so `python3` resolves to the interpreter +# that has capstone / unicorn / mcp installed. +case ":${PATH}:" in + *":/opt/venv/bin:"*) ;; + *) export PATH="/opt/venv/bin:${PATH}" ;; +esac + +# Helpful banner once per login shell. +if [ -n "${BASH_VERSION:-}" ] && [ -z "${CHIPREV_BANNER:-}" ]; then + export CHIPREV_BANNER=1 + printf '\n chipbench RE shell — try: re-identify, re-analyze, re-binwalk (host) or\n r2 / ghidraRun / binwalk / python3 (here). Artifacts: /data/artifacts (ro)\n Project: /data/work Output: /data/output\n\n' +fi diff --git a/docker/conf/supervisord.conf b/docker/conf/supervisord.conf new file mode 100644 index 0000000..421654c --- /dev/null +++ b/docker/conf/supervisord.conf @@ -0,0 +1,74 @@ +[supervisord] +nodaemon=true +user=chip +logfile=/data/work/supervisord.log +pidfile=/tmp/supervisord.pid +childlogdir=/data/work +loglevel=info + +; Control socket in a chip-writable location so `supervisorctl status` +; works from inside the container (supervisord runs as non-root uid 1001). +[unix_http_server] +file=/tmp/supervisor.sock +chmod=0700 + +[rpcinterface:supervisor] +supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface + +[supervisorctl] +serverurl=unix:///tmp/supervisor.sock + +[program:xvfb] +command=/usr/bin/Xvfb :0 -screen 0 1920x1080x24 -ac +extension RANDR +autorestart=true +priority=10 +stdout_logfile=/data/work/xvfb.log +stderr_logfile=/data/work/xvfb.err + +[program:fluxbox] +command=/usr/bin/fluxbox +environment=DISPLAY=":0",HOME="/home/chip" +autorestart=true +priority=20 +stdout_logfile=/data/work/fluxbox.log +stderr_logfile=/data/work/fluxbox.err + +[program:x11vnc] +command=/usr/bin/x11vnc -display :0 -forever -shared -noxdamage -rfbauth /home/chip/.vnc/passwd -rfbport 5900 +autorestart=true +priority=30 +stdout_logfile=/data/work/x11vnc.log +stderr_logfile=/data/work/x11vnc.err + +[program:novnc] +command=/usr/bin/websockify --web /usr/share/novnc/ 6080 localhost:5900 +autorestart=true +priority=40 +stdout_logfile=/data/work/novnc.log +stderr_logfile=/data/work/novnc.err + +[program:ghidra] +; GUI project manager. Open the chip dump from here; the GhidraMCP plugin +; starts its REST server on 127.0.0.1:8080 once the CodeBrowser tool loads. +; NOTE: the `ghidraRun` wrapper hardcodes launch.sh "bg" mode, which daemonizes +; the JVM and exits 0 -- supervisor would then respawn it forever. So we call +; launch.sh "fg" directly so the JVM runs in the foreground and is tracked. +; We first wait for the X server to avoid an AWT connect race. +command=bash -c 'for i in {1..60}; do [ -e /tmp/.X11-unix/X0 ] && break; sleep 0.5; done; exec /opt/ghidra/support/launch.sh fg jdk Ghidra "" "" ghidra.GhidraRun' +directory=/data/work +environment=DISPLAY=":0",HOME="/home/chip" +autorestart=true +startsecs=10 +startretries=3 +priority=50 +stdout_logfile=/data/work/ghidra.log +stderr_logfile=/data/work/ghidra.err + +[program:mcp-bridge] +; MCP-over-SSE bridge to the GhidraMCP REST API (reachable from host on 8081). +command=/opt/venv/bin/python /opt/ghidramcp/bridge_mcp_ghidra.py --transport sse --mcp-host 0.0.0.0 --mcp-port 8081 --ghidra-server http://127.0.0.1:8080/ +autorestart=true +startsecs=3 +priority=60 +stdout_logfile=/data/work/mcp-bridge.log +stderr_logfile=/data/work/mcp-bridge.err diff --git a/docker/scripts/entrypoint.sh b/docker/scripts/entrypoint.sh new file mode 100755 index 0000000..14de914 --- /dev/null +++ b/docker/scripts/entrypoint.sh @@ -0,0 +1,22 @@ +#!/usr/bin/env bash +# Container entrypoint. Two modes: +# - default ("supervisor"): launch the desktop + Ghidra + MCP bridge +# - anything else: exec the given command (used by `docker compose run` for +# headless analysis, interactive shells, etc.) +set -euo pipefail + +# Ensure the Ghidra project / output trees exist and are writable by our user. +mkdir -p /data/work /data/output /home/chip/.vnc + +# (Re)create the VNC password file from $VNC_PASSWORD (default: chiprev). +VNC_PASSWORD="${VNC_PASSWORD:-chiprev}" +if [ ! -f /home/chip/.vnc/passwd ]; then + x11vnc -storepasswd "${VNC_PASSWORD}" /home/chip/.vnc/passwd >/dev/null 2>&1 +fi + +if [ "${1:-}" = "supervisor" ] || [ "$#" -eq 0 ]; then + exec /usr/bin/supervisord -c /opt/conf/supervisord.conf +fi + +# Pass-through: headless analyze, shell, one-off tools, etc. +exec "$@" diff --git a/docker/scripts/ghidra-scripts/Analyze8051.py b/docker/scripts/ghidra-scripts/Analyze8051.py new file mode 100644 index 0000000..80a9229 --- /dev/null +++ b/docker/scripts/ghidra-scripts/Analyze8051.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# +# Part of ChipBench (AGPLv3). SPDX-FileCopyrightText: 2026 Starting Line Productions LLC +# Analyze8051.py -- force-disassemble a raw 8051 binary and re-run analysis. +# Raw binary imports leave no entry points, so Ghidra finds 0 functions. +# This script disassembles from the reset + interrupt vectors, re-analyzes, +# then sweeps remaining undefined bytes in populated code regions. + +from ghidra.app.cmd.disassemble import DisassembleCommand +from ghidra.program.model.address import AddressSet +from ghidra.app.plugin.core.analysis import AutoAnalysisManager + +prog = currentProgram +codeSpace = prog.getAddressFactory().getAddressSpace("CODE") +if codeSpace is None: + codeSpace = prog.getAddressFactory().getDefaultAddressSpace() + +def A(x): + return codeSpace.getAddress(x) + +# 8051 interrupt vectors (standard set; enhanced variants may extend) +vectors = [0x0000, 0x0003, 0x000B, 0x0013, 0x001B, 0x0023, 0x002B, 0x0033, 0x003B] + +for v in vectors: + cmd = DisassembleCommand(A(v), None, True) + cmd.applyTo(prog, monitor) + +instr = prog.getListing().getNumInstructions() +print("After vector disassembly:", instr, "instructions") + +mgr = AutoAnalysisManager.getAnalysisManager(prog) +mgr.reAnalyzeAll(None) +mgr.startAnalysis(monitor) + +instr = prog.getListing().getNumInstructions() +funcs = prog.getFunctionManager().getFunctionCount() +print("After analysis:", instr, "instructions,", funcs, "functions") + +# Sweep remaining undefined bytes in all populated regions, 1KB at a time. +# String islands (0x9250-0x9F00, 0xEF00-0xF400) stay data; the rest is code. +listing = prog.getListing() +memory = prog.getMemory() +SKIP = set(range(0x9200, 0x9F00, 0x400)) | set(range(0xEE00, 0x10000, 0x400)) +for base in range(0x0000, 0xF400, 0x400): + if base in SKIP: + continue + blk = memory.getBlock(A(base)) + if blk is None: + continue + # skip fully-erased ranges + erased = True + for i in range(base, base + 0x400, 32): + b = memory.getByte(A(i)) + if (b & 0xFF) != 0xFF: + erased = False + break + if erased: + continue + rng = AddressSet(A(base), A(min(base + 0x3FF, 0xF3FF))) + sweep = DisassembleCommand(A(base), rng, True) + sweep.applyTo(prog, monitor) + +mgr.reAnalyzeAll(None) +mgr.startAnalysis(monitor) + +instr = prog.getListing().getNumInstructions() +funcs = prog.getFunctionManager().getFunctionCount() +print("Final:", instr, "instructions,", funcs, "functions") diff --git a/docker/scripts/ghidra-scripts/AutoFuncs.py b/docker/scripts/ghidra-scripts/AutoFuncs.py new file mode 100644 index 0000000..3fcade5 --- /dev/null +++ b/docker/scripts/ghidra-scripts/AutoFuncs.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# +# Part of ChipBench (AGPLv3). SPDX-FileCopyrightText: 2026 Starting Line Productions LLC +# AutoFuncs.py -- create functions at every LCALL/LJMP target + scheduler +# jumptable entries, iterating until stable. Handles call tables (JMP @A+DPTR) +# where the table entries are LJMPs by treating table bodies as code. +from ghidra.program.model.address import AddressSet +from ghidra.app.cmd.function import CreateFunctionCmd +from ghidra.app.cmd.disassemble import DisassembleCommand +from ghidra.app.plugin.core.analysis import AutoAnalysisManager + +prog = currentProgram +af = prog.getAddressFactory() +cs = af.getDefaultAddressSpace() +fm = prog.getFunctionManager() +mem = prog.getMemory() + +def A(x): return cs.getAddress(x) + +def mk(a): + if a < 0x10000 and fm.getFunctionAt(a) is None: + CreateFunctionCmd(a).applyTo(prog, monitor) + +rounds = 0 +prev = -1 +while rounds < 4: + n = 0 + for i in range(0x0000, 0xEE00): + try: + b = mem.getByte(A(i)) & 0xFF + except: + continue + if b == 0x12 or b == 0x02: # LCALL/LJMP + try: + hi = mem.getByte(A(i+1)) & 0xFF + lo = mem.getByte(A(i+2)) & 0xFF + except: + continue + t = (hi << 8) | lo + if 0x0008 <= t < 0xEE00: + if fm.getFunctionAt(A(t)) is None: + if CreateFunctionCmd(A(t)).applyTo(prog, monitor): + n += 1 + # reanalyze + mgr = AutoAnalysisManager.getAnalysisManager(prog) + mgr.reAnalyzeAll(None) + mgr.startAnalysis(monitor) + cur = fm.getFunctionCount() + print("round %d: +%d new, total %d" % (rounds, n, cur)) + if cur == prev: + break + prev = cur + rounds += 1 + +print("AutoFuncs done: %d functions, %d instructions" % ( + fm.getFunctionCount(), prog.getListing().getNumInstructions())) diff --git a/docker/scripts/ghidra-scripts/ExportAll.py b/docker/scripts/ghidra-scripts/ExportAll.py new file mode 100644 index 0000000..2c43e66 --- /dev/null +++ b/docker/scripts/ghidra-scripts/ExportAll.py @@ -0,0 +1,65 @@ +# -*- coding: utf-8 -*- +# +# Part of ChipBench (AGPLv3). SPDX-FileCopyrightText: 2026 Starting Line Productions LLC +# ExportAll.py -- Jython bulk export (no javac needed). +# Produces .functions.txt, .strings.txt, .segments.txt, .decompiled.c +import os +from ghidra.app.decompiler import DecompInterface +from ghidra.app.decompiler import DecompileOptions + +outdir = os.environ.get("DECOMPILE_OUT", "/data/output") +prog = currentProgram +name = prog.getName() +fm = prog.getFunctionManager() +rm = prog.getReferenceManager() + +print("ExportAll.py -> %s" % outdir) + +# functions +with open(os.path.join(outdir, name + ".functions.txt"), "w") as fh: + for f in fm.getFunctions(True): + fh.write("%s @ %s\n" % (f.getName(), f.getEntryPoint())) +print("functions: %d" % fm.getFunctionCount()) + +# segments +with open(os.path.join(outdir, name + ".segments.txt"), "w") as fh: + for b in prog.getMemory().getBlocks(): + fh.write("%s %s-%s %d %s%s\n" % (b.getName(), b.getStart(), b.getEnd(), + b.getSize(), "R" if b.isRead() else "-", "W" if b.isWrite() else "-")) +# strings (defined string data) +with open(os.path.join(outdir, name + ".strings.txt"), "w") as fh: + di = prog.getDataTypeManager() + listing = prog.getListing() + it = listing.getDefinedData(True) + n = 0 + while it.hasNext(): + d = it.next() + dt = d.getDataType() + if dt is not None and ("string" in dt.getName().lower() or "char" in dt.getName().lower()): + try: + v = d.getValue() + except: + v = None + if v is not None and len(str(v)) >= 3: + fh.write("%s: %r\n" % (d.getAddress(), str(v))) + n += 1 +print("strings: %d" % n) + +# decompile everything +ifc = DecompInterface() +ifc.setOptions(DecompileOptions()) +ifc.openProgram(prog) +nf = 0 +with open(os.path.join(outdir, name + ".decompiled.c"), "w") as fh: + fh.write("// Decompiled by ExportAll.py (Ghidra %s)\n" % "11.3.2") + for f in fm.getFunctions(True): + res = ifc.decompileFunction(f, 90, monitor) + if res.decompileCompleted(): + fh.write("\n/* ==== %s @ %s ==== */\n" % (f.getName(), f.getEntryPoint())) + fh.write(res.getDecompiledFunction().getC()) + nf += 1 + else: + fh.write("\n/* ==== %s @ %s : DECOMPILE FAILED ==== */\n" % (f.getName(), f.getEntryPoint())) +ifc.dispose() +print("decompiled: %d" % nf) +print("ExportAll.py done") diff --git a/docker/scripts/ghidra-scripts/MakeFuncs.py b/docker/scripts/ghidra-scripts/MakeFuncs.py new file mode 100644 index 0000000..ea181a8 --- /dev/null +++ b/docker/scripts/ghidra-scripts/MakeFuncs.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +# +# Part of ChipBench (AGPLv3). SPDX-FileCopyrightText: 2026 Starting Line Productions LLC +# MakeFuncs.py -- create functions at hex addresses given as script args. +# Usage: -postScript MakeFuncs.py 0x1234 0x0a07 ... +from ghidra.program.model.address import AddressSet +from ghidra.app.cmd.function import CreateFunctionCmd + +args = getScriptArgs() +af = currentProgram.getAddressFactory() +fm = currentProgram.getFunctionManager() +for a in args: + addr = af.getAddress(a[2:] if a.startswith("0x") else a) + if addr is None: + print("bad addr: %s" % a); continue + if fm.getFunctionAt(addr) is not None: + print("exists: %s" % addr); continue + cmd = CreateFunctionCmd(addr) + ok = cmd.applyTo(currentProgram, monitor) + print("create %s -> %s" % (addr, ok)) +print("MakeFuncs done") diff --git a/docker/scripts/ghidra-scripts/Query.py b/docker/scripts/ghidra-scripts/Query.py new file mode 100644 index 0000000..05fbef2 --- /dev/null +++ b/docker/scripts/ghidra-scripts/Query.py @@ -0,0 +1,291 @@ +# -*- coding: utf-8 -*- +# +# Part of ChipBench (AGPLv3). SPDX-FileCopyrightText: 2026 Starting Line Productions LLC +# Query.py -- headless query interface for chat-driven reverse engineering. +# Usage: +# analyzeHeadless -process -noanalysis -readOnly \ +# -scriptPath -postScript Query.py [args...] +# +# Commands: info, funcs, decompile, disasm, xrefs-to, xrefs-from, +# func-xrefs, strings, segments, data, search, func, mem + +from ghidra.app.decompiler import DecompInterface +import jarray + +args = getScriptArgs() +if len(args) == 0: + print("Usage: Query.py [args...]") + print("Commands: info, funcs, decompile, disasm, xrefs-to, xrefs-from,") + print(" func-xrefs, strings, segments, data, search, func, mem") +else: + cmd = args[0] + rest = args[1:] + + fm = currentProgram.getFunctionManager() + rm = currentProgram.getReferenceManager() + mem = currentProgram.getMemory() + af = currentProgram.getAddressFactory() + + def arg(i, default): + if i >= len(rest): + return default + try: + return int(rest[i]) + except ValueError: + return default + + def parseAddr(s): + try: + return af.getAddress(s) + except: + return None + + def resolveFunc(s): + a = parseAddr(s) + if a is not None: + f = fm.getFunctionAt(a) + if f is None: + f = fm.getFunctionContaining(a) + if f is not None: + return f + for f in fm.getFunctions(True): + if f.getName() == s: + return f + return None + + if cmd == "info": + print("Name: " + currentProgram.getName()) + print("Language: " + str(currentProgram.getLanguageID())) + print("Compiler: " + str(currentProgram.getCompilerSpec().getCompilerSpecID())) + print("Executable: " + str(currentProgram.getExecutablePath())) + print("ImageBase: " + str(currentProgram.getImageBase())) + print("Size: " + str(mem.getSize()) + " bytes") + print("Functions: " + str(fm.getFunctionCount())) + print("Segments:") + for b in mem.getBlocks(): + r = "R" if b.isRead() else "-" + w = "W" if b.isWrite() else "-" + x = "X" if b.isExecute() else "-" + print(" " + b.getName() + " " + str(b.getStart()) + "-" + str(b.getEnd()) + " (" + str(b.getSize()) + "B) " + r + w + x) + + elif cmd == "funcs": + off = arg(0, 0) + lim = arg(1, 200) + flt = rest[2] if len(rest) > 2 else None + i = 0 + shown = 0 + for f in fm.getFunctions(True): + if flt is not None and flt.lower() not in f.getName().lower(): + continue + if i < off: + i += 1 + continue + if shown >= lim: + break + print(f.getName() + " @ " + str(f.getEntryPoint())) + shown += 1 + i += 1 + print("--- " + str(shown) + " shown (offset " + str(off) + ") ---") + + elif cmd == "decompile": + if len(rest) < 1: + print("decompile needs a name or address") + else: + f = resolveFunc(rest[0]) + if f is None: + print("No function found for: " + rest[0]) + else: + d = DecompInterface() + d.openProgram(currentProgram) + r = d.decompileFunction(f, 60, monitor) + if r is not None and r.decompileCompleted(): + for line in r.getDecompiledFunction().getC().split("\n"): + print(line) + else: + print("Decompilation failed") + d.dispose() + + elif cmd == "disasm": + if len(rest) < 1: + print("disasm needs an address") + else: + f = resolveFunc(rest[0]) + if f is None: + print("No function at/containing: " + rest[0]) + else: + end = f.getBody().getMaxAddress() + listing = currentProgram.getListing() + it = listing.getInstructions(f.getEntryPoint(), True) + from ghidra.program.model.listing import CodeUnit + while it.hasNext(): + ins = it.next() + if ins.getAddress().compareTo(end) > 0: + break + cmt = listing.getComment(CodeUnit.EOL_COMMENT, ins.getAddress()) + line = str(ins.getAddress()) + ": " + ins.toString() + if cmt is not None: + line += " ; " + cmt + print(line) + + elif cmd == "xrefs-to": + if len(rest) < 1: + print("xrefs-to needs an address") + else: + lim = arg(1, 200) + a = parseAddr(rest[0]) + if a is None: + print("Bad address: " + rest[0]) + else: + n = 0 + it = rm.getReferencesTo(a) + while it.hasNext(): + if n >= lim: + break + ref = it.next() + ff = fm.getFunctionContaining(ref.getFromAddress()) + extra = " in " + ff.getName() if ff is not None else "" + print("From " + str(ref.getFromAddress()) + extra + " [" + ref.getReferenceType().getName() + "]") + n += 1 + print("--- " + str(n) + " reference(s) to " + str(a) + " ---") + + elif cmd == "xrefs-from": + if len(rest) < 1: + print("xrefs-from needs an address") + else: + lim = arg(1, 200) + a = parseAddr(rest[0]) + if a is None: + print("Bad address: " + rest[0]) + else: + refs = rm.getReferencesFrom(a) + n = 0 + for ref in refs: + if n >= lim: + break + tf = fm.getFunctionAt(ref.getToAddress()) + extra = " (" + tf.getName() + ")" if tf is not None else "" + print("To " + str(ref.getToAddress()) + extra + " [" + ref.getReferenceType().getName() + "]") + n += 1 + print("--- " + str(n) + " reference(s) from " + str(a) + " ---") + + elif cmd == "func-xrefs": + if len(rest) < 1: + print("func-xrefs needs a function name") + else: + lim = arg(1, 200) + total = 0 + for f in fm.getFunctions(True): + if f.getName() != rest[0]: + continue + it = rm.getReferencesTo(f.getEntryPoint()) + while it.hasNext(): + if total >= lim: + break + ref = it.next() + ff = fm.getFunctionContaining(ref.getFromAddress()) + extra = " in " + ff.getName() if ff is not None else "" + print("From " + str(ref.getFromAddress()) + extra + " [" + ref.getReferenceType().getName() + "]") + total += 1 + print("--- " + str(total) + " reference(s) to function '" + rest[0] + "' ---") + + elif cmd == "strings": + flt = rest[0] if len(rest) > 0 else None + lim = arg(1, 500) + shown = 0 + it = currentProgram.getListing().getDefinedData(True) + while it.hasNext() and shown < lim: + d = it.next() + tn = d.getDataType().getName().lower() + if "string" not in tn and "char" not in tn and tn != "unicode": + continue + v = str(d.getValue()) if d.getValue() is not None else "" + if flt is not None and flt.lower() not in v.lower(): + continue + print(str(d.getAddress()) + ": \"" + v[:120] + "\"") + shown += 1 + print("--- " + str(shown) + " string(s) ---") + + elif cmd == "segments": + for b in mem.getBlocks(): + print(b.getName() + ": " + str(b.getStart()) + " - " + str(b.getEnd()) + " (" + str(b.getSize()) + " bytes)") + + elif cmd == "data": + off = arg(0, 0) + lim = arg(1, 200) + i = 0 + shown = 0 + for b in mem.getBlocks(): + it = currentProgram.getListing().getDefinedData(b.getStart(), True) + while it.hasNext(): + d = it.next() + if not b.contains(d.getAddress()): + break + if i < off: + i += 1 + continue + if shown >= lim: + break + lbl = d.getLabel() if d.getLabel() is not None else "(unnamed)" + print(str(d.getAddress()) + ": " + lbl + " = " + d.getDefaultValueRepresentation()) + shown += 1 + i += 1 + print("--- " + str(shown) + " data item(s) ---") + + elif cmd == "search": + if len(rest) < 1: + print("search needs a query") + else: + lim = arg(1, 200) + shown = 0 + for f in fm.getFunctions(True): + if rest[0].lower() in f.getName().lower(): + if shown >= lim: + break + print(f.getName() + " @ " + str(f.getEntryPoint())) + shown += 1 + print("--- " + str(shown) + " match(es) ---") + + elif cmd == "func": + if len(rest) < 1: + print("func needs an address") + else: + f = resolveFunc(rest[0]) + if f is None: + print("No function at/containing: " + rest[0]) + else: + print("Name: " + f.getName()) + print("Entry: " + str(f.getEntryPoint())) + print("Signature: " + f.getSignature()) + print("Body: " + str(f.getBody().getMinAddress()) + " - " + str(f.getBody().getMaxAddress())) + print("Size: " + str(f.getBody().getNumAddresses()) + " bytes") + + elif cmd == "mem": + if len(rest) < 2: + print("mem needs ") + else: + a = parseAddr(rest[0]) + length = arg(1, 64) + if a is None: + print("Bad address: " + rest[0]) + else: + buf = jarray.zeros(length, "b") + got = mem.getBytes(a, buf) + ubuf = [(x & 0xFF) for x in buf[:got]] + hexstr = "" + ascstr = "" + for idx in range(got): + v = ubuf[idx] + hexstr += "%02x " % v + ascstr += chr(v) if (32 <= v < 127) else "." + if (idx + 1) % 16 == 0: + base = a.add(idx - 15) + print("%s %-48s %s" % (base, hexstr, ascstr)) + hexstr = "" + ascstr = "" + if hexstr: + print("%s %-48s %s" % (a, hexstr, ascstr)) + + else: + print("Unknown command: " + cmd) + print("Commands: info, funcs, decompile, disasm, xrefs-to, xrefs-from,") + print(" func-xrefs, strings, segments, data, search, func, mem") diff --git a/output/.gitkeep b/output/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/re-analyze b/re-analyze new file mode 100755 index 0000000..7a107bd --- /dev/null +++ b/re-analyze @@ -0,0 +1,45 @@ +#!/usr/bin/env bash +# Headless Ghidra import + auto-analysis + full export. +# +# Usage: +# ./re-analyze [analyzeHeadless options...] +# +# Let Ghidra auto-detect the architecture, or force it with -processor: +# ./re-analyze dump.bin -processor "8051:BE:16:default" # Intel 8051 +# ./re-analyze dump.bin -processor "AVR8:LE:16:default" # Atmel AVR +# ./re-analyze dump.bin -processor "PIC-16:BE:16:PIC-16F" # PIC16F +# ./re-analyze dump.bin -processor "PIC-18:LE:16:PIC-18F" # PIC18F +# ./re-analyze dump.bin -processor "PIC-24:LE:24:default" # PIC24/dsPIC +# ./re-analyze dump.bin -processor "STM8:BE:8:default" # ST STM8 +# ./re-analyze dump.bin -processor "6502:LE:16:default" # MOS 6502/6507 +# ./re-analyze dump.bin -processor "Z80:BE:16:default" # Zilog Z80/Z180 +# ./re-analyze dump.bin -processor "HC08:BE:16:default" # Freescale HC(S)08 +# ./re-analyze dump.bin -processor "RL78:LE:16:default" # Renesas RL78 +# +# Raw binary imports have no symbols: 8051-family dumps additionally get +# vector + sweep disassembly via Analyze8051.py (skipped for other archs, +# or force-skip for 8051 with RE_NO_SWEEP=1). +set -euo pipefail +cd "$(dirname "$0")" + +if [ "$#" -lt 1 ]; then + echo "usage: $0 [analyzeHeadless options...]" >&2 + exit 2 +fi + +ARTIFACT="$1"; shift + +POST=(-postScript ExportAll.py) +if [ -z "${RE_NO_SWEEP:-}" ] && grep -qi '8051' <<<" $* "; then + POST=(-postScript Analyze8051.py "${POST[@]}") +fi + +exec docker compose run --rm -T \ + --entrypoint /opt/ghidra/support/analyzeHeadless \ + tools \ + /data/work ChipBenchProject \ + -import "/data/artifacts/${ARTIFACT}" \ + -overwrite \ + "$@" \ + -scriptPath /opt/ghidra-scripts \ + "${POST[@]}" diff --git a/re-binwalk b/re-binwalk new file mode 100755 index 0000000..02ee58b --- /dev/null +++ b/re-binwalk @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# Run binwalk v3 against an artifact. Extraction (-e) output lands in ./output/. +# +# Usage: +# ./re-binwalk [binwalk options...] +# ./re-binwalk dump.bin -e # scan + carve/extract embedded payloads +set -euo pipefail +cd "$(dirname "$0")" +if [ "$#" -lt 1 ]; then + echo "usage: $0 [binwalk options...]" >&2 + exit 2 +fi +ART="$1"; shift +exec docker compose run --rm -T --entrypoint /bin/bash \ + tools -lc 'cd /data/output && exec binwalk "$@"' _ "$@" "/data/artifacts/${ART}" diff --git a/re-build b/re-build new file mode 100755 index 0000000..d87ea61 --- /dev/null +++ b/re-build @@ -0,0 +1,12 @@ +#!/usr/bin/env bash +# Build the RE image only — no GUI/desktop stack started. This is all you need +# for fully chat-driven, headless analysis (re-analyze / re-q / re-export / ...). +# Use ./re-up instead if you ALSO want the Ghidra GUI over VNC. +set -euo pipefail +cd "$(dirname "$0")" +docker compose build +echo +echo "Image ready. Headless workflow (no GUI needed):" +echo " ./re-analyze # import + analyze" +echo " ./re-q [args...] # live query" +echo " ./re-export # bulk export to ./output/" diff --git a/re-down b/re-down new file mode 100755 index 0000000..bd0d6b4 --- /dev/null +++ b/re-down @@ -0,0 +1,5 @@ +#!/usr/bin/env bash +# Stop the environment (keeps images, projects, and artifacts). +set -euo pipefail +cd "$(dirname "$0")" +docker compose down diff --git a/re-export b/re-export new file mode 100755 index 0000000..ed72189 --- /dev/null +++ b/re-export @@ -0,0 +1,17 @@ +#!/usr/bin/env bash +# One-shot bulk export of an already-analyzed program to ./output/. +# Writes .info.txt, .functions.txt, .strings.txt, .segments.txt, +# .data.txt, .decompiled.c (one Ghidra run, then grep/read instantly). +# +# Usage: ./re-export +set -euo pipefail +cd "$(dirname "$0")" +if [ "$#" -lt 1 ]; then echo "usage: $0 " >&2; exit 2; fi +PROG="$1" +exec docker compose run --rm -T \ + --entrypoint /opt/ghidra/support/analyzeHeadless \ + tools \ + /data/work ChipBenchProject \ + -process "$PROG" -noanalysis -readOnly \ + -scriptPath /opt/ghidra-scripts \ + -postScript ExportAll.java diff --git a/re-identify b/re-identify new file mode 100755 index 0000000..3deb9bd --- /dev/null +++ b/re-identify @@ -0,0 +1,25 @@ +#!/usr/bin/env bash +# Quick first-pass triage of an artifact: file type, header bytes, strings, +# binwalk signatures, and radare2 architecture hints. Nothing is written. +# +# Usage: ./re-identify +set -euo pipefail +cd "$(dirname "$0")" +if [ "$#" -ne 1 ]; then + echo "usage: $0 " >&2 + exit 2 +fi +ART="$1" +exec docker compose run --rm -T -e ART="$ART" --entrypoint /bin/bash tools -lc ' +set -euo pipefail +F="/data/artifacts/$ART" +echo "################ file ################"; file "$F" +echo; echo "################ size / hashes ################" +ls -l "$F"; sha256sum "$F" +echo; echo "############## first 256 bytes ##############"; xxd -l 256 "$F" +echo; echo "############## last 256 bytes ###############"; tail -c 256 "$F" | xxd +echo; echo "############## ascii strings (top 40) ########"; strings -n 4 "$F" | head -40 +echo; echo "############## binwalk signatures ############"; binwalk "$F" +echo; echo "############## rabin2 -I (arch hints) ########" +rabin2 -I "$F" 2>/dev/null || echo "(rabin2 could not identify a known format)" +' diff --git a/re-mcp-test b/re-mcp-test new file mode 100755 index 0000000..97227d4 --- /dev/null +++ b/re-mcp-test @@ -0,0 +1,11 @@ +#!/usr/bin/env bash +# Check whether the GhidraMCP SSE bridge is listening on the host. +set -euo pipefail +echo "Probing GhidraMCP SSE bridge on 127.0.0.1:8081 ..." +if timeout 3 bash -c "exec 3<>/dev/tcp/127.0.0.1/8081" 2>/dev/null; then + echo "OK: port 8081 is open. Point an MCP client at: http://127.0.0.1:8081/sse" +else + echo "FAIL: nothing listening on 127.0.0.1:8081." + echo " Run ./re-up, wait for Ghidra, then check ./work/mcp-bridge.log." + exit 1 +fi diff --git a/re-q b/re-q new file mode 100755 index 0000000..a386d48 --- /dev/null +++ b/re-q @@ -0,0 +1,38 @@ +#!/usr/bin/env bash +# Live headless Ghidra query against an ALREADY-ANALYZED program in the +# persistent project. Drives everything from chat with zero GUI. +# +# Usage: ./re-q [args...] +# +# domain-file name in ./work/ChipBenchProject (e.g. "dump.bin") +# info | funcs | decompile | disasm | xrefs-to | xrefs-from | +# func-xrefs | strings | segments | data | search | func | mem +# +# Examples: +# ./re-q dump.bin info +# ./re-q dump.bin funcs "" 500 +# ./re-q dump.bin decompile FUN_0000 +# ./re-q dump.bin decompile 0x8000 +# ./re-q dump.bin disasm 0x8000 +# ./re-q dump.bin xrefs-to 0x8000 +# ./re-q dump.bin strings init +# ./re-q dump.bin mem 0x8000 64 +set -euo pipefail +cd "$(dirname "$0")" + +if [ "$#" -lt 2 ]; then + sed -n '2,18p' "$0" >&2 + exit 2 +fi +PROG="$1"; shift +# Python print() in Ghidra goes to stdout without the "Query.py>" prefix that +# Java scripts get. Filter out Ghidra's own log noise instead. +docker compose run --rm -T \ + --entrypoint /opt/ghidra/support/analyzeHeadless \ + tools \ + /data/work ChipBenchProject \ + -process "$PROG" -noanalysis -readOnly \ + -scriptPath /opt/ghidra-scripts \ + -postScript Query.py "$@" 2>&1 \ + | grep -vE "^INFO |^WARN |^ERROR |^ [A-Z]|^$|Module manifest|Picked up|openjdk|OpenJDK|RE shell|try:|Artifacts:|Project:|Container|Creat|Remov|^ /opt|^ [A-Z]" \ + | sed 's/^(//; s/)$//' # strip Jython tuple wrapper like ('text',) diff --git a/re-shell b/re-shell new file mode 100755 index 0000000..cd62f52 --- /dev/null +++ b/re-shell @@ -0,0 +1,6 @@ +#!/usr/bin/env bash +# Open an interactive shell inside the RE image (same mounts as the desktop). +# Usage: ./re-shell +set -euo pipefail +cd "$(dirname "$0")" +exec docker compose run --rm --entrypoint /bin/bash tools -l diff --git a/re-up b/re-up new file mode 100755 index 0000000..d262e3d --- /dev/null +++ b/re-up @@ -0,0 +1,11 @@ +#!/usr/bin/env bash +#!/usr/bin/env bash +# Build + boot the desktop/Ghidra/MCP environment. +set -euo pipefail +cd "$(dirname "$0")" +docker compose build +docker compose up -d ghidra +echo +echo "Ghidra GUI (noVNC) : http://localhost:6080/vnc.html (VNC pw: ${VNC_PASSWORD:-chiprev})" +echo "Raw VNC : localhost:5900" +echo "GhidraMCP (SSE) : http://localhost:8081/sse" diff --git a/work/.gitkeep b/work/.gitkeep new file mode 100644 index 0000000..e69de29