├── .gitignore ├── CMakeLists.txt ├── COPYING ├── CutterPlugin.h ├── README.md ├── VirtualTaggerPlugin.cpp ├── VirtualTaggerPlugin.h └── assets ├── before_after.png └── menu.png /.gitignore: -------------------------------------------------------------------------------- 1 | build/ -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.12) 2 | project(virtual-tagger-plugin) 3 | 4 | find_package(Cutter REQUIRED) 5 | find_package(Rizin REQUIRED) 6 | 7 | set(CUTTER_INSTALL_PLUGDIR "${Cutter_USER_PLUGINDIR}" CACHE STRING "Directory to install Cutter plugin into") 8 | 9 | set(CMAKE_AUTOMOC ON) 10 | 11 | add_library(virtual_tagger_plugin MODULE 12 | VirtualTaggerPlugin.h 13 | VirtualTaggerPlugin.cpp) 14 | 15 | target_link_libraries(virtual_tagger_plugin PRIVATE Cutter::Cutter Rizin::Core) 16 | install(TARGETS virtual_tagger_plugin DESTINATION "${CUTTER_INSTALL_PLUGDIR}") 17 | -------------------------------------------------------------------------------- /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 | 676 | -------------------------------------------------------------------------------- /CutterPlugin.h: -------------------------------------------------------------------------------- 1 | #ifndef CUTTERPLUGIN_H 2 | #define CUTTERPLUGIN_H 3 | 4 | class MainWindow; 5 | 6 | #include "widgets/CutterDockWidget.h" 7 | 8 | class CUTTER_EXPORT CutterPlugin 9 | { 10 | public: 11 | virtual ~CutterPlugin() = default; 12 | 13 | /** 14 | * @brief Initialize the Plugin 15 | * 16 | * called right when the plugin is loaded initially 17 | */ 18 | virtual void setupPlugin() = 0; 19 | 20 | /** 21 | * @brief Setup any UI components for the Plugin 22 | * @param main the MainWindow to add any UI to 23 | * 24 | * called after Cutter's core UI has been initialized 25 | */ 26 | virtual void setupInterface(MainWindow *main) = 0; 27 | 28 | /** 29 | * @brief Register any decompiler implemented by the Plugin 30 | * 31 | * called during initialization of Cutter, after setupPlugin() 32 | */ 33 | virtual void registerDecompilers() {} 34 | 35 | /** 36 | * @brief Shutdown the Plugin 37 | * 38 | * called just before the Plugin is deleted. 39 | * This method is usually only relevant for Python Plugins where there is no 40 | * direct equivalent of the destructor. 41 | */ 42 | virtual void terminate() {}; 43 | 44 | virtual QString getName() const = 0; 45 | virtual QString getAuthor() const = 0; 46 | virtual QString getDescription() const = 0; 47 | virtual QString getVersion() const = 0; 48 | }; 49 | 50 | #define CutterPlugin_iid "re.rizin.cutter.plugins.CutterPlugin" 51 | 52 | Q_DECLARE_INTERFACE(CutterPlugin, CutterPlugin_iid) 53 | 54 | #endif // CUTTERPLUGIN_H 55 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Virtual Tagger Plugin 2 | Virtual Tagger Plugin is a [Cutter](https://github.com/rizinorg/cutter) plugin that cleans up vtable entries and automatically adds named function definitions (with optional analysis and X-Refs) for virtual functions defined in classes, making it easier to search for/work with VMT functions. 3 | 4 | Tested on Windows Cutter release 2.2.0 (with x86 + x64 binaries - should work for most other architectures too) 5 | 6 | ![Menu](assets/menu.png) 7 | 8 | ![Before and after running plugin](assets/before_after.png) 9 | 10 | ### Settings/Features 11 | * Generate X-Refs 12 | * Generates X-Refs from vtable slot -> function 13 | * Clear strings in vtables 14 | * Removes string detections that occur inside vtable pointers 15 | * Set vtable entries to data 16 | * Sets each vtable method entry to data so Cutter interprets it as a pointer 17 | * Tag pure virtuals 18 | * Runs the tagger on "pure virtual" functions 19 | * Add function name comments 20 | * Adds a comment to each vtable entry with the name of the function it points to, making it easier to read X-Refs 21 | * Generate function entries 22 | * Generates function definitions so they show up in the functions panel 23 | * Analyse added functions 24 | * Runs analysis on virtual functions 25 | * Function analysis can be enabled + run after generating function entries, but can only be run ONCE 26 | * If this is disabled, only the first instruction of a virtual method will be associated with it's definition 27 | * Use analysis_function_add 28 | * Only enable this if you get weird results with it disabled 29 | * If this is disabled, Virtual Tagger uses a custom faster analysis implementation that is *almost* equivalent to the internal function Cutter uses: rz_core_analysis_function_add 30 | * If this is enabled, rz_core_analysis_function_add will be used (which can be multiple orders of magnitude slower - can take 10+ minutes to run for some binaries) 31 | * Must be enabled before first Virtual Tagger analysis in order to work 32 | * Recursive analyisis 33 | * Enables recursive function analysis 34 | * Must be enabled before first Virtual Tagger analysis in order to work 35 | * Propagate noreturn 36 | * If you don't know if you need this, you don't need it 37 | * Enables propagation of noreturn flags 38 | * This usually increases analysis time by over 10x 39 | * analysis_function_add always has this enabled 40 | * Must be enabled before first Virtual Tagger analysis in order to work 41 | 42 | ### Notes 43 | Generated names follow the form `vmt.[class name].[function name]` - if there is no symbol for the function name, Cutter will set `[function name]` to `virtual_[VMT offset]` 44 | 45 | If multiple classes use the same function due to inheritance, Virtual Tagger Plugin will attempt to find and use the name of the highest-super class that uses the function. 46 | 47 | If multiple classes use the same function without sharing a parent class, the name of the first class processed will be used. 48 | 49 | ### Install 50 | Copy to your Cutter native plugin directory. 51 | You can find this directory in Cutter via `edit` -> `preferences` -> `Plugins` -> `Plugins are loaded from ...` 52 | 53 | ### Usage 54 | The plugin should run automatically after analysis is finished. 55 | The plugin menu can be opened via `Windows` -> `Plugins` -> `Virtual Tagger` 56 | If you need to re-run the tagger, either use the plugin menu or: right click an instruction or function -> `plugins` -> `Force run virtual tagger` - note that this runs the tagger on ALL virtual functions. 57 | 58 | ### Compiling: 59 | Add `[cutter install dir]/lib/cmake` to `CMAKE_PREFIX_PATH` 60 | Add QT5 cmake dir to `CMAKE_PREFIX_PATH` ( `Qt/[version]/[compiler]/lib/cmake/Qt5` on my machine) 61 | ``` 62 | md build 63 | cd build 64 | cmake .. 65 | ``` 66 | Compile using your compiler (compile in `release` mode if you want it to work with release builds of Cutter) 67 | -------------------------------------------------------------------------------- /VirtualTaggerPlugin.cpp: -------------------------------------------------------------------------------- 1 | #include "VirtualTaggerPlugin.h" 2 | 3 | #include 4 | 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | // I couldn't find working plugin config/setting APIs in Cutter, so use Qt's 12 | #include 13 | 14 | #include 15 | 16 | #include 17 | #include 18 | 19 | // Adapted from "SamplePlugin" examples from the Cutter repo (GPLv3) 20 | 21 | void VirtualTaggerPlugin::setupPlugin() {} 22 | 23 | static std::mutex mutex; 24 | 25 | static const char* GENERATE_X_REFS_SETTING = "GenrateXRefs"; 26 | static const char* CLEAR_STRINGS_SETTING = "ClearStrings"; 27 | static const char* SET_DATA_SETTING = "SetData"; 28 | static const char* TAG_PURE_VIRTUALS_SETTING = "TagPureVirtuals"; 29 | static const char* ADD_NAME_COMMENT = "AddNameComment"; 30 | static const char* GENERATE_FUNCTION_ENTRIES = "GenerateFunctionEntries"; 31 | static const char* ANALYSE_ADDED_FUNCTIONS = "AnalyseAddedFunctions"; 32 | static const char* RECURSIVE_ANALYSIS = "RecursiveAnalysis"; 33 | static const char* PROPAGATE_NORETURN = "PropagateNoreturn"; 34 | static const char* USE_ANALYSIS_FUNCTION_ADD = "UseAnalysisFunctionAdd"; 35 | 36 | // rz_core_analysis_function_add replacement 37 | static bool RzAnalysisFunctionAddNoUpdate(RzCore* core, const char* name, size_t addr, bool propagateNoreturn, bool recursive) 38 | { 39 | int depth = rz_config_get_i(core->config, "analysis.depth"); 40 | RzAnalysisFunction* fcn = NULL; 41 | 42 | // fast 43 | rz_core_analysis_fcn(core, addr, UT64_MAX, RZ_ANALYSIS_XREF_TYPE_NULL, depth); 44 | // fast 45 | fcn = rz_analysis_get_fcn_in(core->analysis, addr, 0); 46 | if (fcn) { 47 | /* ensure we use a proper name */ 48 | // fast 49 | rz_core_analysis_function_rename(core, addr, fcn->name); 50 | if (core->analysis->opt.vars) { 51 | // fast 52 | rz_core_recover_vars(core, fcn, true); 53 | } 54 | // fast 55 | rz_analysis_fcn_vars_add_types(core->analysis, fcn); 56 | } 57 | else { 58 | RZ_LOG_DEBUG("Unable to analyze function at 0x%08" PFMT64x "\n", addr); 59 | } 60 | if (recursive) { 61 | fcn = rz_analysis_get_fcn_in(core->analysis, addr, 0); /// XXX wrong in case of nopskip 62 | if (fcn) { 63 | RzAnalysisXRef* xref; 64 | RzListIter* iter; 65 | RzList* xrefs = rz_analysis_function_get_xrefs_from(fcn); 66 | CutterRzListForeach(xrefs, iter, RzAnalysisXRef, xref) { 67 | if (xref->to == UT64_MAX) { 68 | // RZ_LOG_WARN("core: ignore 0x%08"PFMT64x" call 0x%08"PFMT64x"\n", ref->at, ref->addr); 69 | continue; 70 | } 71 | if (xref->type != RZ_ANALYSIS_XREF_TYPE_CODE && xref->type != RZ_ANALYSIS_XREF_TYPE_CALL) { 72 | /* only follow code/call references */ 73 | continue; 74 | } 75 | if (!rz_io_is_valid_offset(core->io, xref->to, !core->analysis->opt.noncode)) { 76 | continue; 77 | } 78 | rz_core_analysis_fcn(core, xref->to, fcn->addr, RZ_ANALYSIS_XREF_TYPE_CALL, depth); 79 | /* use recursivity here */ 80 | RzAnalysisFunction* f = rz_analysis_get_function_at(core->analysis, xref->to); 81 | if (f) { 82 | RzListIter* iter; 83 | RzAnalysisXRef* xref1; 84 | RzList* xrefs1 = rz_analysis_function_get_xrefs_from(f); 85 | CutterRzListForeach(xrefs1, iter, RzAnalysisXRef, xref1) { 86 | if (!rz_io_is_valid_offset(core->io, xref1->to, !core->analysis->opt.noncode)) { 87 | continue; 88 | } 89 | if (xref1->type != RZ_ANALYSIS_XREF_TYPE_CODE && xref1->type != RZ_ANALYSIS_XREF_TYPE_CALL) { 90 | continue; 91 | } 92 | rz_core_analysis_fcn(core, xref1->to, f->addr, RZ_ANALYSIS_XREF_TYPE_CALL, depth); 93 | // recursively follow fcn->refs again and again 94 | } 95 | rz_list_free(xrefs1); 96 | } 97 | else { 98 | f = rz_analysis_get_fcn_in(core->analysis, fcn->addr, 0); 99 | if (f) { 100 | /* cut function */ 101 | rz_analysis_function_resize(f, addr - fcn->addr); 102 | rz_core_analysis_fcn(core, xref->to, fcn->addr, 103 | RZ_ANALYSIS_XREF_TYPE_CALL, depth); 104 | f = rz_analysis_get_function_at(core->analysis, fcn->addr); 105 | } 106 | if (!f) { 107 | RZ_LOG_ERROR("core: cannot find function at 0x%08" PFMT64x "\n", fcn->addr); 108 | rz_list_free(xrefs); 109 | return false; 110 | } 111 | } 112 | } 113 | rz_list_free(xrefs); 114 | if (core->analysis->opt.vars) { 115 | rz_core_recover_vars(core, fcn, true); 116 | } 117 | } 118 | } 119 | // fast 120 | if (RZ_STR_ISNOTEMPTY(name) && !rz_core_analysis_function_rename(core, addr, name)) { 121 | RZ_LOG_ERROR("core: cannot find function at 0x%08" PFMT64x "\n", addr); 122 | return false; 123 | } 124 | 125 | // the above is enough to create named function definitions + associate function bodies with the function definition 126 | 127 | // slow 128 | // HACK I think not running this stops the function being put in TODO for rz_core_analysis_flag_every_function 129 | if(propagateNoreturn) 130 | rz_core_analysis_propagate_noreturn(core, addr); 131 | // skip this - we do it after all functions have been processed 132 | //rz_core_analysis_flag_every_function(core); 133 | return true; 134 | } 135 | 136 | static void runTagger(const SettingsMap &settings) 137 | { 138 | std::lock_guard lock(mutex); 139 | 140 | auto core = Core(); 141 | auto rizinCore = core->core(); 142 | 143 | core->message("VirtualTaggerPlugin: Running tagger..."); 144 | 145 | QElapsedTimer timer; 146 | timer.start(); 147 | 148 | bool generateXRefs = settings.value(GENERATE_X_REFS_SETTING); 149 | bool clearStrings = settings.value(CLEAR_STRINGS_SETTING); 150 | bool setToData = settings.value(SET_DATA_SETTING); 151 | bool tagPureVirtuals = settings.value(TAG_PURE_VIRTUALS_SETTING); 152 | bool addNameComment = settings.value(ADD_NAME_COMMENT); 153 | bool generateFunctionEntries = settings.value(GENERATE_FUNCTION_ENTRIES); 154 | bool analyseAddedFunctions = settings.value(ANALYSE_ADDED_FUNCTIONS); 155 | bool propagateNoreturn = settings.value(PROPAGATE_NORETURN); 156 | bool recursiveAnalysis = settings.value(RECURSIVE_ANALYSIS); 157 | bool useAnalysisFunctionAdd = settings.value(USE_ANALYSIS_FUNCTION_ADD); 158 | 159 | // core->getArchBits() seems to return byte size of pointer? Probably a bug? 160 | // Rizin gives the correct size, so I'm using that in case Cutter's API changes 161 | size_t pointerSize = rz_bin_object_get_info(rz_bin_cur_object(rizinCore->bin))->bits / 8; 162 | //core->message("Bits: " + QString::number(core->getArchBits()) + " bytes: " + QString::number(pointerSize)); 163 | auto classNames = core->getAllAnalysisClasses(false); 164 | 165 | size_t methodDefinitionsCreated = 0; 166 | size_t stringsRemoved = 0; 167 | size_t vtableXrefsCreated = 0; 168 | 169 | for (auto className : classNames) 170 | { 171 | // update name 172 | auto methods = core->getAnalysisClassMethods(className); 173 | auto baseClasses = core->getAnalysisClassBaseClasses(className); 174 | auto classVTables = core->getAnalysisClassVTables(className); 175 | if (classVTables.size() > 0) 176 | { 177 | if (classVTables[0].addr % pointerSize != 0) 178 | core->message("VirtualTaggerPlugin: Bad vtable address for " + className); 179 | 180 | // Used to find empty slots without entries 181 | size_t nextOffset = classVTables[0].addr; 182 | 183 | methodloop: 184 | for (auto method : methods) 185 | { 186 | // pure virtual methods (_purecall) don't have entries, this loop fills 187 | // in any missing entries + adds the current method 188 | for (size_t vtableEntryAddr = nextOffset; vtableEntryAddr <= classVTables[0].addr + method.vtableOffset; 189 | vtableEntryAddr += pointerSize) 190 | { 191 | // skip straight to method entry if skipping pure functions 192 | if (!tagPureVirtuals) 193 | vtableEntryAddr = classVTables[0].addr + method.vtableOffset; 194 | 195 | // Clean up vtable entry 196 | // Cutter often misinterprets vtable entries as strings, 197 | // which also messes up Cutter's interpretation after setting to data 198 | if (clearStrings) 199 | { 200 | // TODO we can probably do the whole vtable at once 201 | rz_meta_del(rizinCore->analysis, RZ_META_TYPE_STRING, vtableEntryAddr, pointerSize); 202 | for (int j = 0; j < pointerSize; ++j) 203 | { 204 | size_t addr = vtableEntryAddr + j; 205 | 206 | // early exit 207 | if (!rz_flag_exist_at(rizinCore->flags, "str.", 4, addr)) 208 | continue; 209 | 210 | // cleanup - clear string flags 211 | QStringList flags = core->listFlagsAsStringAt(addr).split(",");; 212 | for (auto flag : flags) 213 | { 214 | if (flag.startsWith("str.")) 215 | { 216 | // HACK I think the code here clears using the *non-unique* name, 217 | // so this might destroy all definitions of the flag... 218 | // HOWEVER, String defintions in Strings panel still seem to exist. 219 | // Unfortunately, hitting F5 in the strings panel after this freezes 220 | // Cutter... searches work though? 221 | rz_flag_unset_name(rizinCore->flags, flag.toStdString().c_str()); 222 | ++stringsRemoved; 223 | } 224 | } 225 | } 226 | } 227 | 228 | if(setToData) 229 | core->setToData(vtableEntryAddr, pointerSize); 230 | 231 | if (generateXRefs) 232 | { 233 | // add X-ref to vtable entry 234 | rz_analysis_xrefs_set(rizinCore->analysis, vtableEntryAddr, method.addr, RzAnalysisXRefType::RZ_ANALYSIS_XREF_TYPE_DATA); 235 | ++vtableXrefsCreated; 236 | } 237 | 238 | // add comment to make reading x-refs easier 239 | if (addNameComment) 240 | { 241 | // Cutter's API is slow, so we set the comment directly via Rizin (sketchy but works since we run early) 242 | //core->setComment(vtableEntryAddr, className + "." + method.name); 243 | rz_meta_set_string(rizinCore->analysis, RZ_META_TYPE_COMMENT, vtableEntryAddr, (className + "." + method.name).toStdString().c_str()); 244 | } 245 | } 246 | 247 | // update for next loop 248 | nextOffset = classVTables[0].addr + method.vtableOffset + pointerSize; 249 | 250 | // create function definitions 251 | if (generateFunctionEntries) 252 | { 253 | if (core->functionAt(method.addr) == nullptr) 254 | { 255 | // TODO should this be realName? 256 | QString funcName = ("vmt." + className + "." + method.name); 257 | 258 | // figure out the highest-level class that defines the function 259 | for (auto baseClass : baseClasses) 260 | for (auto parentMethod : core->getAnalysisClassMethods(baseClass.className)) 261 | if (parentMethod.addr == method.addr) 262 | // handle by processing parent 263 | goto skip; 264 | 265 | ++methodDefinitionsCreated; 266 | 267 | // Using this MASSIVELY increases performance cost (single-threaded analysis...) 268 | if (analyseAddedFunctions) 269 | { 270 | //core->createFunctionAt(method.addr, funcName); 271 | if(useAnalysisFunctionAdd) 272 | // This is *also* crazy slow (probably N^2? + single-threaded analysis...) 273 | rz_core_analysis_function_add(rizinCore, funcName.toStdString().c_str(), method.addr, recursiveAnalysis); 274 | else 275 | RzAnalysisFunctionAddNoUpdate(rizinCore, funcName.toStdString().c_str(), method.addr, propagateNoreturn, recursiveAnalysis); 276 | } 277 | else 278 | { 279 | //char* name = (char*)(new std::string(funcName.toStdString()))->c_str(); 280 | RzAnalysisFunction* funcDef = rz_analysis_create_function(rizinCore->analysis, funcName.toStdString().c_str(), method.addr, RzAnalysisFcnType::RZ_ANALYSIS_FCN_TYPE_ANY); 281 | } 282 | skip: 283 | ; 284 | } 285 | // if we've already made a definition, but it hasn't been analysed, and analysis is enabled, trigger analysis 286 | else if (analyseAddedFunctions && core->functionAt(method.addr)->ninstr == 0) 287 | { 288 | // backup name 289 | std::string funcName = core->functionAt(method.addr)->name; 290 | // recreate 291 | rz_analysis_function_delete(core->functionAt(method.addr)); 292 | if (useAnalysisFunctionAdd) 293 | rz_core_analysis_function_add(rizinCore, funcName.c_str(), method.addr, recursiveAnalysis); 294 | else 295 | RzAnalysisFunctionAddNoUpdate(rizinCore, funcName.c_str(), method.addr, propagateNoreturn, recursiveAnalysis); 296 | } 297 | } 298 | } 299 | } 300 | } 301 | 302 | // if we're using our bootleg analysis code, we almost certainly skipped this call 303 | if(analyseAddedFunctions && !useAnalysisFunctionAdd) 304 | rz_core_analysis_flag_every_function(rizinCore); 305 | 306 | core->functionsChanged(); 307 | core->flagsChanged(); 308 | core->message("VirtualTaggerPlugin: " + QString::number(classNames.size()) + " classes"); 309 | core->message("VirtualTaggerPlugin: " + QString::number(methodDefinitionsCreated) + " method definitions created"); 310 | core->message("VirtualTaggerPlugin: " + QString::number(stringsRemoved) + " strings removed"); 311 | core->message("VirtualTaggerPlugin: " + QString::number(vtableXrefsCreated) + " X-Refs created"); 312 | core->message("VirtualTaggerPlugin: Finished tagging in " + QString::number(timer.elapsed() / 1000.0) + "s"); 313 | } 314 | 315 | void VirtualTaggerPluginWidget::on_checkboxClicked(bool checked) 316 | { 317 | QWidget* widget = qobject_cast(sender()); 318 | settings.insert(widget->property("setting").toString(), checked); 319 | } 320 | 321 | void VirtualTaggerPluginWidget::on_runTaggerButtonClicked() 322 | { 323 | runTagger(settings); 324 | } 325 | 326 | void VirtualTaggerPluginWidget::on_saveSettingsButtonClicked() 327 | { 328 | QSettings settingsOut("BFrizzleFoShizzle", "VirtualTaggerPlugin"); 329 | for (auto key : settings.keys()) 330 | { 331 | settingsOut.setValue(key, settings.value(key)); 332 | } 333 | } 334 | 335 | QCheckBox* VirtualTaggerPluginWidget::addSetting(QString setting, QString label, QString tooltip, QLayout* layout, QWidget* parent) 336 | { 337 | QCheckBox* checkbox = new QCheckBox(label, parent); 338 | checkbox->setChecked(settings.value(setting)); 339 | checkbox->setFont(Config()->getFont()); 340 | checkbox->setToolTip(tooltip); 341 | checkbox->setProperty("setting", setting); 342 | connect(checkbox, &QCheckBox::clicked, this, &VirtualTaggerPluginWidget::on_checkboxClicked); 343 | layout->addWidget(checkbox); 344 | 345 | return checkbox; 346 | } 347 | 348 | void VirtualTaggerPluginWidget::on_generateFunctionEntriesClicked(bool checked) 349 | { 350 | if (checked) 351 | { 352 | analyseAddedFunctionsCheck->setDisabled(false); 353 | recursiveAnalysisCheck->setDisabled(!analyseAddedFunctionsCheck->isChecked()); 354 | useAnalysisFunctionAddCheck->setDisabled(!analyseAddedFunctionsCheck->isChecked()); 355 | propagateNoreturnCheck->setDisabled(!analyseAddedFunctionsCheck->isChecked() || useAnalysisFunctionAddCheck->isChecked()); 356 | } 357 | else 358 | { 359 | analyseAddedFunctionsCheck->setDisabled(true); 360 | recursiveAnalysisCheck->setDisabled(true); 361 | useAnalysisFunctionAddCheck->setDisabled(true); 362 | propagateNoreturnCheck->setDisabled(true); 363 | } 364 | } 365 | 366 | void VirtualTaggerPluginWidget::on_analyseAddedFunctionsClicked(bool checked) 367 | { 368 | if (checked) 369 | { 370 | recursiveAnalysisCheck->setDisabled(false); 371 | useAnalysisFunctionAddCheck->setDisabled(false); 372 | propagateNoreturnCheck->setDisabled(useAnalysisFunctionAddCheck->isChecked()); 373 | } 374 | else 375 | { 376 | recursiveAnalysisCheck->setDisabled(true); 377 | useAnalysisFunctionAddCheck->setDisabled(true); 378 | propagateNoreturnCheck->setDisabled(true); 379 | } 380 | } 381 | 382 | void VirtualTaggerPluginWidget::on_useAnalysisFunctionClicked(bool checked) 383 | { 384 | if (checked) 385 | { 386 | propagateNoreturnCheck->setDisabled(true); 387 | } 388 | else 389 | { 390 | propagateNoreturnCheck->setDisabled(false); 391 | } 392 | } 393 | 394 | VirtualTaggerPluginWidget::VirtualTaggerPluginWidget(MainWindow* main) : CutterDockWidget(main) 395 | { 396 | // read settings 397 | QSettings settingsIn("BFrizzleFoShizzle", "VirtualTaggerPlugin"); 398 | for (auto setting : settingsIn.allKeys()) 399 | settings.insert(setting, settingsIn.value(setting).toBool()); 400 | 401 | this->setObjectName("VirtualTaggerPluginWidget"); 402 | this->setWindowTitle("Virtual Tagger"); 403 | 404 | QWidget* content = new QWidget(); 405 | QVBoxLayout* layout = new QVBoxLayout(content); 406 | content->setLayout(layout); 407 | this->setWidget(content); 408 | 409 | QLabel* text = new QLabel(content); 410 | text->setFont(Config()->getFont()); 411 | text->setText("Virtual Tagger settings:"); 412 | layout->addWidget(text); 413 | 414 | addSetting(GENERATE_X_REFS_SETTING, "Generate X-Refs", "Generates X-Refs from vtable slot -> function", layout, content); 415 | addSetting(CLEAR_STRINGS_SETTING, "Clear strings in vtables", "Removes string detections that occur inside vtable pointers", layout, content); 416 | addSetting(SET_DATA_SETTING, "Set vtable entries to data", "Sets each vtable method entry to data so Cutter interprets it as a pointer", layout, content); 417 | addSetting(TAG_PURE_VIRTUALS_SETTING, "Tag pure virtuals", "Runs the tagger on \"pure virtual\" functions (or any detected vtable offsets that don't have class method entries)", layout, content); 418 | addSetting(ADD_NAME_COMMENT, "Add function name comments", "Adds a comment to each vtable entry with the name of the function it points to, making it easier to read X-Refs", layout, content); 419 | QCheckBox* generateFunctionEntriesCheck = addSetting(GENERATE_FUNCTION_ENTRIES, "Generate function entries", "Generates function definitions so they show up in the functions panel", layout, content); 420 | analyseAddedFunctionsCheck = addSetting(ANALYSE_ADDED_FUNCTIONS, "Analyse added functions", "Runs analysis on virtual functions." 421 | "\nFunction analysis can be enabled + run after generating function entries, but can only be run ONCE." 422 | "\nIf this is disabled, only the first instruction of a method will be associated with it's definition", layout, content); 423 | recursiveAnalysisCheck = addSetting(RECURSIVE_ANALYSIS, "Recursive analyisis", "Enables recursive function analysis." 424 | "\nMust be enabled before first Virtual Tagger analysis in order to work.", layout, content); 425 | useAnalysisFunctionAddCheck = addSetting(USE_ANALYSIS_FUNCTION_ADD, "Use analysis_function_add (slow) (not commonly needed)" 426 | , "Only enable this if you get weird results with it disabled." 427 | "\nIf this is disabled, Virtual Tagger uses a custom faster analysis implementation that is *almost* equivalent to the internal function Cutter uses: rz_core_analysis_function_add" 428 | "\nIf this is enabled, rz_core_analysis_function_add will be used (which can be multiple orders of magnitude slower - can take 10+ minutes to run for some binaries)" 429 | "\nMust be enabled before first Virtual Tagger analysis in order to work.", layout, content); 430 | propagateNoreturnCheck = addSetting(PROPAGATE_NORETURN, "Propagate noreturn (slow) (not commonly needed)", "if you don't know if you need this, you don't need it." 431 | "\nEnables propagation of noreturn flags." 432 | "\nThis usually increases analysis time by over 10x." 433 | "\nanalysis_function_add always has this enabled." 434 | "\nMust be enabled before first Virtual Tagger analysis in order to work.", layout, content); 435 | 436 | QPushButton* saveButton = new QPushButton(content); 437 | saveButton->setText("Save settings"); 438 | saveButton->setFont(Config()->getFont()); 439 | saveButton->setSizePolicy(QSizePolicy::Maximum, QSizePolicy::Maximum); 440 | saveButton->setMaximumHeight(30); 441 | layout->addWidget(saveButton, 1); 442 | connect(saveButton, &QPushButton::clicked, this, &VirtualTaggerPluginWidget::on_saveSettingsButtonClicked); 443 | 444 | // this sets up initial checkbox state 445 | on_generateFunctionEntriesClicked(generateFunctionEntriesCheck->isChecked()); 446 | 447 | // used to disable settings 448 | connect(generateFunctionEntriesCheck, &QCheckBox::clicked, this, &VirtualTaggerPluginWidget::on_generateFunctionEntriesClicked); 449 | connect(analyseAddedFunctionsCheck, &QCheckBox::clicked, this, &VirtualTaggerPluginWidget::on_analyseAddedFunctionsClicked); 450 | connect(useAnalysisFunctionAddCheck, &QCheckBox::clicked, this, &VirtualTaggerPluginWidget::on_useAnalysisFunctionClicked); 451 | 452 | layout->addStretch(); 453 | 454 | QPushButton* runTaggerButton = new QPushButton(content); 455 | runTaggerButton->setText("Force run virtual tagger"); 456 | runTaggerButton->setFont(Config()->getFont()); 457 | runTaggerButton->setSizePolicy(QSizePolicy::Maximum, QSizePolicy::Maximum); 458 | runTaggerButton->setMaximumHeight(50); 459 | layout->addWidget(runTaggerButton, 1); 460 | layout->setAlignment(runTaggerButton, Qt::AlignHCenter); 461 | connect(runTaggerButton, &QPushButton::clicked, this, &VirtualTaggerPluginWidget::on_runTaggerButtonClicked); 462 | 463 | QMetaObject::Connection con1 = connect(Core(), &CutterCore::refreshAll, [this]() 464 | { 465 | runTagger(settings); 466 | }); 467 | 468 | QAction* disassemblyAction = main->getContextMenuExtensions(MainWindow::ContextMenuType::Disassembly)->addAction("Force run virtual tagger"); 469 | QMetaObject::Connection con2 = connect(disassemblyAction, &QAction::triggered, [this]() 470 | { 471 | runTagger(settings); 472 | }); 473 | 474 | if (!con1 || !con2) 475 | Core()->message("VirtualTaggerPlugin: Connection failed"); 476 | } 477 | 478 | void VirtualTaggerPlugin::setupInterface(MainWindow *main) 479 | { 480 | QSettings settings("BFrizzleFoShizzle","VirtualTaggerPlugin"); 481 | 482 | // default settings 483 | if (!settings.contains(GENERATE_X_REFS_SETTING)) 484 | settings.setValue(GENERATE_X_REFS_SETTING, true); 485 | if (!settings.contains(CLEAR_STRINGS_SETTING)) 486 | settings.setValue(CLEAR_STRINGS_SETTING, true); 487 | if (!settings.contains(SET_DATA_SETTING)) 488 | settings.setValue(SET_DATA_SETTING, true); 489 | if (!settings.contains(TAG_PURE_VIRTUALS_SETTING)) 490 | settings.setValue(TAG_PURE_VIRTUALS_SETTING, true); 491 | if (!settings.contains(ADD_NAME_COMMENT)) 492 | settings.setValue(ADD_NAME_COMMENT, true); 493 | if (!settings.contains(GENERATE_FUNCTION_ENTRIES)) 494 | settings.setValue(GENERATE_FUNCTION_ENTRIES, true); 495 | if (!settings.contains(ANALYSE_ADDED_FUNCTIONS)) 496 | settings.setValue(ANALYSE_ADDED_FUNCTIONS, false); 497 | if (!settings.contains(PROPAGATE_NORETURN)) 498 | settings.setValue(PROPAGATE_NORETURN, false); 499 | if (!settings.contains(RECURSIVE_ANALYSIS)) 500 | settings.setValue(RECURSIVE_ANALYSIS, false); 501 | 502 | settings.sync(); 503 | 504 | VirtualTaggerPluginWidget* widget = new VirtualTaggerPluginWidget(main); 505 | main->addPluginDockWidget(widget); 506 | } 507 | -------------------------------------------------------------------------------- /VirtualTaggerPlugin.h: -------------------------------------------------------------------------------- 1 | #ifndef VIRTUALTAGGERPLUGIN_H 2 | #define VIRTUALTAGGERPLUGIN_H 3 | 4 | #include 5 | #include 6 | #include 7 | #include 8 | 9 | // Adapted from "SamplePlugin" examples from the Cutter repo (GPLv3) 10 | 11 | typedef QHash SettingsMap; 12 | 13 | class VirtualTaggerPlugin : public QObject, CutterPlugin 14 | { 15 | Q_OBJECT 16 | Q_PLUGIN_METADATA(IID "re.rizin.cutter.plugins.CutterPlugin") 17 | Q_INTERFACES(CutterPlugin) 18 | 19 | public: 20 | void setupPlugin() override; 21 | void setupInterface(MainWindow *main) override; 22 | 23 | QString getName() const override { return "Virtual Tagger Plugin"; } 24 | QString getAuthor() const override { return "Bryden Frizzell"; } 25 | QString getDescription() const override { return "A plugin for automatically tagging virtual functions with their class name + slot index."; } 26 | QString getVersion() const override { return "1.0"; } 27 | 28 | }; 29 | 30 | class VirtualTaggerPluginWidget : public CutterDockWidget 31 | { 32 | Q_OBJECT 33 | 34 | public: 35 | explicit VirtualTaggerPluginWidget(MainWindow* main); 36 | 37 | private: 38 | QCheckBox* addSetting(QString setting, QString label, QString tooltip, QLayout* layout, QWidget* parent); 39 | QCheckBox* analyseAddedFunctionsCheck; 40 | QCheckBox* recursiveAnalysisCheck; 41 | QCheckBox* useAnalysisFunctionAddCheck; 42 | QCheckBox* propagateNoreturnCheck; 43 | // pointer to prevent destructor from triggering - we want to trigger saving manually 44 | SettingsMap settings; 45 | 46 | private slots: 47 | void on_checkboxClicked(bool checked); 48 | void on_generateFunctionEntriesClicked(bool checked); 49 | void on_analyseAddedFunctionsClicked(bool checked); 50 | void on_useAnalysisFunctionClicked(bool checked); 51 | void on_saveSettingsButtonClicked(); 52 | void on_runTaggerButtonClicked(); 53 | }; 54 | 55 | 56 | #endif // VIRTUALTAGGERPLUGIN_H 57 | -------------------------------------------------------------------------------- /assets/before_after.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BFrizzleFoShizzle/VirtualTaggerPlugin/53a56194fa32292bae4c40417b35e655e47d6720/assets/before_after.png -------------------------------------------------------------------------------- /assets/menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/BFrizzleFoShizzle/VirtualTaggerPlugin/53a56194fa32292bae4c40417b35e655e47d6720/assets/menu.png --------------------------------------------------------------------------------