├── .gitignore ├── CODEOWNERS ├── LICENSE ├── README.md ├── go.mod ├── go.sum ├── type_provider.go └── type_provider_test.go /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.exe~ 4 | *.dll 5 | *.so 6 | *.dylib 7 | 8 | # Test binary, built with `go test -c` 9 | *.test 10 | 11 | # Output of the go coverage tool, specifically when used with LiteIDE 12 | *.out 13 | 14 | # Dependency directories (remove the comment below to include it) 15 | # vendor/ 16 | 17 | # PyCharm project dir 18 | .idea/ 19 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @Xenomega 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # go-fuzz-utils 2 | `go-fuzz-utils` is a helper package for use with [go-fuzz](https://github.com/dvyukov/go-fuzz) or other fuzzing utilities. It provides a simple interface to produce random values for various data types and can recursively populate complex structures from raw fuzz data generated by `go-fuzz`. Spend more time writing property tests, and less time with ugly data type conversions, edge cases supporting full value ranges, `nil` cases, etc. Simply feed `go-fuzz` data into `go-fuzz-utils` to produce fuzzed objects and use them in your property tests as needed. 3 | 4 | When populating variables, you can configure a number of parameters: 5 | - Minimum/maximum sizes of strings, maps, slices 6 | - Probability of `nil` for maps, slices, pointers 7 | - Depth limit for nested structures 8 | - Toggle for filling unexported fields in structures 9 | - Probability of skipping a field when filling (to randomly fuzz over valid structure fields) 10 | 11 | ## Setup 12 | Import this package into your `go-fuzz` tests: 13 | ```go 14 | import "github.com/trailofbits/go-fuzz-utils" 15 | ``` 16 | 17 | Construct a new `TypeProvider` using `NewTypeProvider(...)`. 18 | ```go 19 | func Fuzz(data []byte) int { 20 | // Create a new type provider 21 | tp, err := go_fuzz_utils.NewTypeProvider(data) 22 | if err != nil { 23 | return 0 // not enough data was supplied, exit gracefully for the next fuzzing iteration 24 | } 25 | [...] 26 | ``` 27 | Note: the data `go-fuzz` generates on some runs may be too small to construct the `TypeProvider` or derive all the values needed for your test. Ensure errors are handled appropriately. If one is encountered, exit gracefully to continue to the next run where more data may be produced. Fill parameters such as mapping/slice/string length and `nil` probability can be set using the `SetParams[...]` methods. 28 | 29 | ## Simple data types 30 | You can obtain the necessary type of data with exported functions such as: 31 | ```go 32 | // Obtain a byte 33 | b, err := tp.GetByte() 34 | ... 35 | // Obtain a bool 36 | bl, err := tp.GetBool() 37 | ... 38 | // Obtain an int16 39 | i16, err := tp.GetInt16() 40 | ... 41 | // Obtain a float32 42 | f32, err := tp.GetFloat32() 43 | ... 44 | // Obtain a fixed-length string 45 | strFixed, err := tp.GetFixedString(7) 46 | ... 47 | // Obtain a dynamic-length string 48 | strDynamic, err := tp.GetString() // uses TypeProvider parameters to determine length/nil possibility 49 | ... 50 | // Obtain a fixed-length byte array 51 | bytesFixed, err := tp.GetNBytes(2) 52 | ... 53 | // Obtain a dynamic-length byte array 54 | bytesDynamic, err := tp.GetBytes() // uses TypeProvider parameters to determine length/nil possibility 55 | ``` 56 | 57 | 58 | ## Structures 59 | `go-fuzz-utils` exposes a generic `Fill(...)` method which can populate simple data types, mappings, arrays, and arbitrary structures recursively via reflection. 60 | 61 | For example, given the following structure: 62 | ```go 63 | type Person struct { 64 | ID uint64 65 | Name string 66 | Photo []byte 67 | Employed bool 68 | EmergencyContact *Person 69 | } 70 | ``` 71 | 72 | You can simply perform a `Fill` call to populate it with the fuzz data. Even though `Person` has a circular reference in `EmergencyContact`, you can configure depth limits and `nil` bias settings to prevent infinite loops while giving us various deeply nested structures. 73 | ```go 74 | // Create a person struct and fill it recursively. 75 | var p Person 76 | err := tp.Fill(&p) 77 | ``` 78 | 79 | Similarly, you can fill other data types as needed: 80 | ```go 81 | // Create an array of mappings and fill them 82 | mappingArr := make([]map[string]int, 15) 83 | err = tp.Fill(&mappingArr) 84 | ``` 85 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/trailofbits/go-fuzz-utils 2 | 3 | go 1.17 4 | 5 | require github.com/stretchr/testify v1.7.0 6 | 7 | require ( 8 | github.com/davecgh/go-spew v1.1.0 // indirect 9 | github.com/pmezard/go-difflib v1.0.0 // indirect 10 | gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect 11 | gopkg.in/yaml.v3 v3.0.0 // indirect 12 | ) 13 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= 2 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 3 | github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI= 4 | github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= 5 | github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= 6 | github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= 7 | github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= 8 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 9 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 10 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 11 | github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= 12 | github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 13 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 14 | gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= 15 | gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= 16 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 17 | gopkg.in/yaml.v3 v3.0.0 h1:hjy8E9ON/egN1tAYqKb61G10WtihqetD4sz2H+8nIeA= 18 | gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 19 | -------------------------------------------------------------------------------- /type_provider.go: -------------------------------------------------------------------------------- 1 | package go_fuzz_utils 2 | 3 | import ( 4 | "encoding/binary" 5 | "errors" 6 | "fmt" 7 | "math" 8 | "math/rand" 9 | "reflect" 10 | "unsafe" 11 | ) 12 | 13 | // TypeProvider ingests an arbitrary byte array and uses it to extract common data types and populate structures 14 | // for use in fuzzing campaigns. 15 | type TypeProvider struct { 16 | // data represents the underlying buffer this TypeProvider will use to produce values of different data types. 17 | data []byte 18 | // position represents the offset into the data buffer which we are currently located at. 19 | position int 20 | // randomProvider represents a seeded random provider used to determine nil/skip probability and array/map/string 21 | // sizes. 22 | randomProvider *rand.Rand // initialized after seed is obtained from first few bytes of data 23 | 24 | // sliceMinSize describes the minimum size a slice value will be generated as 25 | sliceMinSize int 26 | // sliceMaxSize describes the maximum size a slice value will be generated as 27 | sliceMaxSize int 28 | // sliceNilBias describes the probability of a slice being set as nil (represented as a float between 0 and 1) 29 | sliceNilBias float32 30 | 31 | // mapMinSize describes the minimum size a map value will be generated as 32 | mapMinSize int 33 | // mapMaxSize describes the maximum size a map value will be generated as 34 | mapMaxSize int 35 | // mapNilBias describes the probability of a map being set as nil (represented as a float between 0 and 1) 36 | mapNilBias float32 37 | 38 | // ptrNilBias describes the probability of a pointer being set as nil (represented as a float between 0 and 1) 39 | ptrNilBias float32 40 | 41 | // stringMinLength describes the minimum size a string value will be generated as 42 | stringMinLength int 43 | // stringMaxLength describes the maximum size a string value will be generated as 44 | stringMaxLength int 45 | 46 | // depthLimit describes the maximum struct depth that values will be filled at. A value of zero indicates unlimited 47 | // depth. 48 | depthLimit int // zero indicates infinite depth 49 | // fillUnexportedFields indicates whether unexported fields should be filled. 50 | fillUnexportedFields bool 51 | // skipFieldBias describes the probability of a field being skipped during struct fill operations (represented as 52 | // a float between 0 and 1) 53 | skipFieldBias float32 54 | } 55 | 56 | // NewTypeProvider constructs a new TypeProvider instance with the provided data and default parameters. 57 | // Returns the newly constructed TypeProvider. 58 | func NewTypeProvider(data []byte) (*TypeProvider, error) { 59 | // Create a new type provider from the provided data and default settings 60 | t := &TypeProvider{ 61 | data: data, 62 | sliceMinSize: 0, 63 | sliceMaxSize: 15, 64 | sliceNilBias: 0.05, 65 | mapMinSize: 0, 66 | mapMaxSize: 15, 67 | mapNilBias: 0.05, 68 | ptrNilBias: 0.05, 69 | stringMinLength: 0, 70 | stringMaxLength: 15, 71 | depthLimit: 0, 72 | fillUnexportedFields: true, 73 | skipFieldBias: 0, 74 | } 75 | 76 | // Call reset to create our random provider from this data. 77 | err := t.Reset() 78 | if err != nil { 79 | return nil, err 80 | } 81 | 82 | return t, nil 83 | } 84 | 85 | // GetParamsStringBounds obtains the minimum and maximum string length parameters for use with Fill. 86 | func (t *TypeProvider) GetParamsStringBounds() (int, int) { 87 | return t.stringMinLength, t.stringMaxLength 88 | } 89 | 90 | // SetParamsStringBounds sets the minimum and maximum string length parameters for use with Fill. 91 | // Returns an error if any argument is negative or if a minSize is larger than maxSize. 92 | func (t *TypeProvider) SetParamsStringBounds(minSize int, maxSize int) error { 93 | // Validate our parameters and set them accordingly 94 | if minSize < 0 || maxSize < minSize { 95 | return fmt.Errorf("invalid string length bounds provided: min: %d, max: %d", minSize, maxSize) 96 | } 97 | t.stringMinLength = minSize 98 | t.stringMaxLength = maxSize 99 | return nil 100 | } 101 | 102 | // GetParamsMapBounds obtains the minimum and maximum map size parameters for use with Fill. 103 | func (t *TypeProvider) GetParamsMapBounds() (int, int) { 104 | return t.mapMinSize, t.mapMaxSize 105 | } 106 | 107 | // SetParamsMapBounds sets the minimum and maximum map size parameters for use with Fill. 108 | // Returns an error if any argument is negative or if a minSize is larger than maxSize. 109 | func (t *TypeProvider) SetParamsMapBounds(minSize int, maxSize int) error { 110 | // Validate our parameters and set them accordingly 111 | if minSize < 0 || maxSize < minSize { 112 | return fmt.Errorf("invalid map bounds provided: min: %d, max: %d", minSize, maxSize) 113 | } 114 | t.mapMinSize = minSize 115 | t.mapMaxSize = maxSize 116 | return nil 117 | } 118 | 119 | // GetParamsSliceBounds obtains the minimum and maximum slice size parameters for use with Fill. 120 | func (t *TypeProvider) GetParamsSliceBounds() (int, int) { 121 | return t.sliceMinSize, t.sliceMaxSize 122 | } 123 | 124 | // SetParamsSliceBounds sets the minimum and maximum slice size parameters for use with Fill. 125 | // Returns an error if any argument is negative or if a minSize is larger than maxSize. 126 | func (t *TypeProvider) SetParamsSliceBounds(minSize int, maxSize int) error { 127 | // Validate our parameters and set them accordingly 128 | if minSize < 0 || maxSize < minSize { 129 | return fmt.Errorf("invalid slice bounds provided: min: %d, max: %d", minSize, maxSize) 130 | } 131 | t.sliceMinSize = minSize 132 | t.sliceMaxSize = maxSize 133 | return nil 134 | } 135 | 136 | // GetParamsBiases obtains the bias parameters for use with Fill. 137 | // Returns four floats within range [0,1] indicating the probability of: nil maps, nil pointers, nil slices, and a field 138 | // being skipped when using Fill. 139 | func (t *TypeProvider) GetParamsBiases() (float32, float32, float32, float32) { 140 | return t.mapNilBias, t.ptrNilBias, t.sliceNilBias, t.skipFieldBias 141 | } 142 | 143 | // SetParamsBiases sets bias parameters for this TypeProvider, indicating the probability of nil fills or fields being 144 | // skipped. 145 | // Returns an error if any bias value was not within the [0,1] range. 146 | func (t *TypeProvider) SetParamsBiases(mapNilBias float32, ptrNilBias float32, sliceNilBias float32, skipFieldBias float32) error { 147 | // Validate our parameters 148 | if mapNilBias < 0 || mapNilBias > 1 || ptrNilBias < 0 || ptrNilBias > 1 || 149 | sliceNilBias < 0 || sliceNilBias > 1 || skipFieldBias < 0 || skipFieldBias > 1 { 150 | return errors.New("invalid bias provided. bias must be between [0,1]") 151 | } 152 | 153 | // Set our nil biases 154 | t.mapNilBias = mapNilBias 155 | t.ptrNilBias = ptrNilBias 156 | t.sliceNilBias = sliceNilBias 157 | 158 | // Set our skip bias 159 | t.skipFieldBias = skipFieldBias 160 | return nil 161 | } 162 | 163 | // SetParamsBiasesCommon sets bias parameters for this TypeProvider, indicating the probability of nil fills or fields 164 | // being skipped. This differs from SetParamsBiases as it sets all nil biases from a single common value. 165 | // Returns an error if any bias value was not within the [0,1] range. 166 | func (t *TypeProvider) SetParamsBiasesCommon(nilBias float32, skipFieldBias float32) error { 167 | return t.SetParamsBiases(nilBias, nilBias, nilBias, skipFieldBias) 168 | } 169 | 170 | // GetParamsFillUnexportedFields gets a parameter indicating whether unexported struct fields should be filled when 171 | // using Fill. 172 | func (t *TypeProvider) GetParamsFillUnexportedFields() bool { 173 | return t.fillUnexportedFields 174 | } 175 | 176 | // SetParamsFillUnexportedFields sets a parameter indicating that unexported struct fields should be filled when using 177 | // Fill. 178 | func (t *TypeProvider) SetParamsFillUnexportedFields(fill bool) { 179 | t.fillUnexportedFields = fill 180 | } 181 | 182 | // GetParamsDepthLimit gets the depth limit parameter used when filling nested structures recursively using Fill. 183 | func (t *TypeProvider) GetParamsDepthLimit() int { 184 | return t.depthLimit 185 | } 186 | 187 | // SetParamsDepthLimit sets the depth limit when filling nested structures recursively using Fill. Setting this value to zero 188 | // triggers a special case indicating infinite depth. 189 | // Returns an error if the depth limit is negative. 190 | func (t *TypeProvider) SetParamsDepthLimit(depthLimit int) error { 191 | // Validate our parameters and set them accordingly 192 | if depthLimit < 0 { 193 | return fmt.Errorf("invalid depth limit provided: %d. depth limit cannot be negative", depthLimit) 194 | } 195 | t.depthLimit = depthLimit 196 | return nil 197 | } 198 | 199 | // validateBounds checks if the remaining data in the buffer can satisfy an expected amount of bytes to be read. 200 | // Returns an error if the provided number of bytes left at the current position cannot satisfy the expected count. 201 | func (t *TypeProvider) validateBounds(expectedCount int) error { 202 | // If our expected count of bytes to read is negative, return an error as the caller likely had an arithmetic issue. 203 | if expectedCount < 0 { 204 | return fmt.Errorf("attempted to read a negative amount of bytes: %d", expectedCount) 205 | } 206 | 207 | // If our position is out of bounds, return an error. 208 | if t.position < 0 || len(t.data) < t.position { 209 | return fmt.Errorf("position out of bounds: (position: %d / length: %d)", t.position, len(t.data)) 210 | } 211 | 212 | // If there aren't enough bytes left, return an error. 213 | bytesLeft := len(t.data) - t.position 214 | if bytesLeft < expectedCount { 215 | return fmt.Errorf("end of stream reached: could not read %d bytes (position: %d / length: %d)", expectedCount, t.position, len(t.data)) 216 | } 217 | 218 | // Return no error 219 | return nil 220 | } 221 | 222 | // getRandomSize obtains a random int in the positive int range. 223 | func (t *TypeProvider) getRandomSize(min int, max int) int { 224 | // Obtain a random size. 225 | return t.randomProvider.Intn((max - min) + 1) + min 226 | } 227 | 228 | // getRandomBool obtains a random boolean given a probability between 0 and 1. 229 | func (t *TypeProvider) getRandomBool(probability float32) bool { 230 | return t.randomProvider.Float32() < probability 231 | } 232 | 233 | // Reset resets the position to extract data from in the stream and reconstructs the random provider with the seed 234 | // read from the first few bytes. This puts the TypeProvider in the same state as when it was created, unless the 235 | // underlying TypeProviderConfig was changed. 236 | func (t *TypeProvider) Reset() error { 237 | // Set the position to zero. 238 | t.position = 0 239 | t.randomProvider = nil 240 | 241 | // Read our random seed from the first int64 242 | seed, err := t.GetInt64() 243 | if err != nil { 244 | return err 245 | } 246 | 247 | // Create our random provider from the seed. 248 | t.randomProvider = rand.New(rand.NewSource(seed)) 249 | return nil 250 | } 251 | 252 | // GetNBytes obtains the requested number of bytes from the current position in the buffer. 253 | // This advances the position the provided length. 254 | // Returns the requested bytes, or an error if the end of stream has been reached. 255 | func (t *TypeProvider) GetNBytes(length int) ([]byte, error) { 256 | // Validate our boundaries 257 | err := t.validateBounds(length) 258 | if err != nil { 259 | return nil, err 260 | } 261 | 262 | // Obtain a slice of our data, advance position, and return the data. 263 | b := t.data[t.position:t.position + length] 264 | t.position += length 265 | return b, nil 266 | } 267 | 268 | // GetByte obtains a single byte from the current position in the buffer. 269 | // This advances the position by 1. 270 | // Returns the single read byte, or an error if the end of stream has been reached. 271 | func (t *TypeProvider) GetByte() (byte, error) { 272 | // Validate our boundaries 273 | err := t.validateBounds(1) 274 | if err != nil { 275 | return 0, err 276 | } 277 | 278 | // Obtain our single byte, advance position, and return the data. 279 | b := t.data[t.position] 280 | t.position += 1 281 | return b, nil 282 | } 283 | 284 | // GetBool obtains a bool from the current position in the buffer. 285 | // This advances the position by 1. 286 | // Returns the read bool, or an error if the end of stream has been reached. 287 | func (t *TypeProvider) GetBool() (bool, error) { 288 | // Obtain a byte and return a bool depending on if its even or odd. 289 | b, err := t.GetByte() 290 | return b % 2 == 0, err 291 | } 292 | 293 | // GetUint8 obtains an uint8 from the current position in the buffer. 294 | // This advances the position by 1. 295 | // Returns the read uint8, or an error if the end of stream has been reached. 296 | func (t *TypeProvider) GetUint8() (uint8, error) { 297 | // Obtain a byte and return it as the requested type. 298 | b, err := t.GetByte() 299 | return uint8(b), err 300 | } 301 | 302 | // GetInt8 obtains an int8 from the current position in the buffer. 303 | // This advances the position by 1. 304 | // Returns the read int8, or an error if the end of stream has been reached. 305 | func (t *TypeProvider) GetInt8() (int8, error) { 306 | // Obtain a byte and return it as the requested type. 307 | b, err := t.GetByte() 308 | return int8(b), err 309 | } 310 | 311 | // GetUint16 obtains an uint16 from the current position in the buffer. 312 | // This advances the position by 2. 313 | // Returns the read uint16, or an error if the end of stream has been reached. 314 | func (t *TypeProvider) GetUint16() (uint16, error) { 315 | // Obtain the data to back our value 316 | b, err := t.GetNBytes(2) 317 | if err != nil { 318 | return 0, err 319 | } 320 | 321 | // Convert our data to an uint16 and return 322 | return binary.BigEndian.Uint16(b), nil 323 | } 324 | 325 | // GetInt16 obtains an int16 from the current position in the buffer. 326 | // This advances the position by 2. 327 | // Returns the read int16, or an error if the end of stream has been reached. 328 | func (t *TypeProvider) GetInt16() (int16, error) { 329 | // Obtain an uint16 and convert it to an int16 330 | x, err := t.GetUint16() 331 | return int16(x), err 332 | } 333 | 334 | // GetUint32 obtains an uint32 from the current position in the buffer. 335 | // This advances the position by 4. 336 | // Returns the read uint32, or an error if the end of stream has been reached. 337 | func (t *TypeProvider) GetUint32() (uint32, error) { 338 | // Obtain the data to back our value 339 | b, err := t.GetNBytes(4) 340 | if err != nil { 341 | return 0, err 342 | } 343 | 344 | // Convert our data to an uint32 and return 345 | return binary.BigEndian.Uint32(b), nil 346 | } 347 | 348 | // GetInt32 obtains an int32 from the current position in the buffer. 349 | // This advances the position by 4. 350 | // Returns the read int32, or an error if the end of stream has been reached. 351 | func (t *TypeProvider) GetInt32() (int32, error) { 352 | // Obtain an uint32 and convert it to an int32 353 | x, err := t.GetUint32() 354 | return int32(x), err 355 | } 356 | 357 | // GetUint64 obtains an uint64 from the current position in the buffer. 358 | // This advances the position by 8. 359 | // Returns the read uint64, or an error if the end of stream has been reached. 360 | func (t *TypeProvider) GetUint64() (uint64, error) { 361 | // Obtain the data to back our value 362 | b, err := t.GetNBytes(8) 363 | if err != nil { 364 | return 0, err 365 | } 366 | 367 | // Convert our data to an uint64 and return 368 | return binary.BigEndian.Uint64(b), nil 369 | } 370 | 371 | // GetInt64 obtains an int64 from the current position in the buffer. 372 | // This advances the position by 64. 373 | // Returns the read int64, or an error if the end of stream has been reached. 374 | func (t *TypeProvider) GetInt64() (int64, error) { 375 | // Obtain an uint64 and convert it to an int64 376 | x, err := t.GetUint64() 377 | return int64(x), err 378 | } 379 | 380 | // GetUint obtains an uint from the current position in the buffer. 381 | // This advances the position by 8, reading an uint64 and casting it to the architecture-dependent width. 382 | // Returns the read uint, or an error if the end of stream has been reached. 383 | func (t *TypeProvider) GetUint() (uint, error) { 384 | // Obtain an uint64 and convert it to an uint 385 | x, err := t.GetUint64() 386 | return uint(x), err 387 | } 388 | 389 | // GetInt obtains an int from the current position in the buffer. 390 | // This advances the position by 8, reading an int64 and casting it to the architecture-dependent width. 391 | // Returns the read int, or an error if the end of stream has been reached. 392 | func (t *TypeProvider) GetInt() (int, error) { 393 | // Obtain an uint64 and convert it to an int 394 | x, err := t.GetUint64() 395 | return int(x), err 396 | } 397 | 398 | // GetFloat32 obtains a float32 from the current position in the buffer. 399 | // This advances the position by 4. 400 | // Returns the read float32, or an error if the end of stream has been reached. 401 | func (t *TypeProvider) GetFloat32() (float32, error) { 402 | // Obtain an uint32 and convert it to a float32 403 | x, err := t.GetUint32() 404 | return math.Float32frombits(x), err 405 | } 406 | 407 | // GetFloat64 obtains a float64 from the current position in the buffer. 408 | // This advances the position by 8. 409 | // Returns the read float64, or an error if the end of stream has been reached. 410 | func (t *TypeProvider) GetFloat64() (float64, error) { 411 | // Obtain an uint64 and convert it to a float64 412 | x, err := t.GetUint64() 413 | return math.Float64frombits(x), err 414 | } 415 | 416 | // GetFixedString obtains a string of the requested length from the current position in the buffer. 417 | // This advances the position the provided length. 418 | // Returns a string of the requested length, or an error if the end of stream has been reached. 419 | func (t *TypeProvider) GetFixedString(length int) (string, error) { 420 | // Obtain bytes to convert to a string. 421 | b, err := t.GetNBytes(length) 422 | if err != nil { 423 | return "", err 424 | } 425 | 426 | // Return a string from the bytes 427 | return string(b), nil 428 | } 429 | 430 | // GetBytes obtains a number of bytes of length within the range settings provided in the TypeProvider. 431 | // This advances the position by len(result) 432 | // Returns the read bytes, or an error if the end of stream has been reached. 433 | func (t *TypeProvider) GetBytes() ([]byte, error) { 434 | // Obtain a random size to read 435 | x := t.getRandomSize(t.sliceMinSize, t.sliceMaxSize) 436 | 437 | // Use the random size to determine how many bytes to read, then obtain them and return. 438 | return t.GetNBytes(x) 439 | } 440 | 441 | // GetString obtains a string of length within the range settings provided in the TypeProvider. 442 | // This advances the position by len(result) 443 | // Returns the read string, or an error if the end of stream has been reached. 444 | func (t *TypeProvider) GetString() (string, error) { 445 | // Obtain a random size to read 446 | x := t.getRandomSize(t.stringMinLength, t.stringMaxLength) 447 | 448 | // Use the random to determine how many bytes to read, then obtain them and return. 449 | b, err := t.GetNBytes(x) 450 | if err != nil { 451 | return "", err 452 | } 453 | 454 | return string(b), err 455 | } 456 | 457 | // Fill populates data into a variable at a provided pointer. This can be used for structs or basic types. 458 | // Returns an error if one is encountered. 459 | func (t *TypeProvider) Fill(i interface{}) error { 460 | // We should have been provided a pointer, so we obtain reflect pkg values and dereference. 461 | v := reflect.Indirect(reflect.ValueOf(i)) 462 | 463 | // Next we fill the value. 464 | return t.fillValue(v, 0) 465 | } 466 | 467 | // fillValue populates data into a variable based on reflection. Given the provided parameters, structures and simple 468 | // types can be recursively populated. See documentation surrounding the Fill method for more details. 469 | // Returns an error if one is encountered. 470 | func (t *TypeProvider) fillValue(v reflect.Value, currentDepth int) error { 471 | // If we can't set the value, we can stop immediately. 472 | if !v.CanSet() { 473 | return nil 474 | } 475 | 476 | // Determine if we should skip this field 477 | if t.getRandomBool(t.skipFieldBias) { 478 | return nil 479 | } 480 | 481 | // Determine how to set our value based on its type. 482 | if v.Kind() == reflect.Bool { 483 | bl, err := t.GetBool() 484 | if err != nil { 485 | return err 486 | } 487 | v.SetBool(bl) 488 | } else if v.Kind() == reflect.Int8 { 489 | i8, err := t.GetInt8() 490 | if err != nil { 491 | return err 492 | } 493 | v.SetInt(int64(i8)) 494 | } else if v.Kind() == reflect.Uint8 { 495 | u8, err := t.GetUint8() 496 | if err != nil { 497 | return err 498 | } 499 | v.SetUint(uint64(u8)) 500 | } else if v.Kind() == reflect.Int16 { 501 | i16, err := t.GetInt16() 502 | if err != nil { 503 | return err 504 | } 505 | v.SetInt(int64(i16)) 506 | } else if v.Kind() == reflect.Uint16 { 507 | u16, err := t.GetUint16() 508 | if err != nil { 509 | return err 510 | } 511 | v.SetUint(uint64(u16)) 512 | } else if v.Kind() == reflect.Int32 { 513 | i32, err := t.GetInt32() 514 | if err != nil { 515 | return err 516 | } 517 | v.SetInt(int64(i32)) 518 | } else if v.Kind() == reflect.Uint32 { 519 | u32, err := t.GetUint32() 520 | if err != nil { 521 | return err 522 | } 523 | v.SetUint(uint64(u32)) 524 | } else if v.Kind() == reflect.Int64 { 525 | i64, err := t.GetInt64() 526 | if err != nil { 527 | return err 528 | } 529 | v.SetInt(i64) 530 | } else if v.Kind() == reflect.Uint64 { 531 | u64, err := t.GetUint64() 532 | if err != nil { 533 | return err 534 | } 535 | v.SetUint(u64) 536 | } else if v.Kind() == reflect.Int { 537 | i, err := t.GetInt() 538 | if err != nil { 539 | return err 540 | } 541 | v.SetInt(int64(i)) 542 | } else if v.Kind() == reflect.Uint { 543 | u, err := t.GetUint() 544 | if err != nil { 545 | return err 546 | } 547 | v.SetUint(uint64(u)) 548 | } else if v.Kind() == reflect.Float32 { 549 | f32, err := t.GetFloat32() 550 | if err != nil { 551 | return err 552 | } 553 | v.SetFloat(float64(f32)) 554 | } else if v.Kind() == reflect.Float64 { 555 | f64, err := t.GetFloat64() 556 | if err != nil { 557 | return err 558 | } 559 | v.SetFloat(f64) 560 | } else if v.Kind() == reflect.Complex64 { 561 | f, err := t.GetFloat32() 562 | if err != nil { 563 | return err 564 | } 565 | f2, err := t.GetFloat32() 566 | if err != nil { 567 | return err 568 | } 569 | v.SetComplex(complex128(complex(f, f2))) 570 | } else if v.Kind() == reflect.Complex128 { 571 | f, err := t.GetFloat64() 572 | if err != nil { 573 | return err 574 | } 575 | f2, err := t.GetFloat64() 576 | if err != nil { 577 | return err 578 | } 579 | v.SetComplex(complex(f, f2)) 580 | }else if v.Kind() == reflect.String { 581 | s, err := t.GetString() 582 | if err != nil { 583 | return err 584 | } 585 | v.SetString(s) 586 | } else if v.Kind() == reflect.Slice { 587 | // Determine if the slice will be nil or if we'll actually populate it. 588 | if t.getRandomBool(t.sliceNilBias) { 589 | // Set nil slice 590 | v.Set(reflect.Zero(v.Type())) 591 | } else { 592 | // Obtain a random size 593 | sliceSize := t.getRandomSize(t.sliceMinSize, t.sliceMaxSize) 594 | 595 | // Typically, we just create a slice here and loop for each element and fill it. But we add a special case here 596 | // for byte arrays, as they're very common. Setting each element individually will take too long, so we read 597 | // a slice of bytes and set them all at once if we can detect the type is a []byte 598 | sliceElementType := v.Type().Elem() 599 | if sliceElementType.Kind() == reflect.Uint8 { 600 | b, err := t.GetNBytes(sliceSize) 601 | if err != nil { 602 | return err 603 | } 604 | v.SetBytes(b) 605 | } else { 606 | // If this isn't a byte array, create a generic slice of the correct type and fill it. 607 | slice := reflect.MakeSlice(v.Type(), sliceSize, sliceSize) 608 | for i := 0; i < sliceSize; i++ { 609 | err := t.fillValue(slice.Index(i), currentDepth) 610 | if err != nil { 611 | return err 612 | } 613 | } 614 | // Set our slice value 615 | v.Set(slice) 616 | } 617 | } 618 | } else if v.Kind() == reflect.Map { 619 | // Determine if the map will be nil or if we'll actually populate it. 620 | if t.getRandomBool(t.mapNilBias) { 621 | // Set nil map 622 | v.Set(reflect.Zero(v.Type())) 623 | } else { 624 | // Obtain a random size 625 | mapSize := t.getRandomSize(t.mapMinSize, t.mapMaxSize) 626 | 627 | // Create our map and set it now, so we can proceed to create key-value pairs for it. 628 | v.Set(reflect.MakeMap(v.Type())) 629 | 630 | // Loop for each element we wish to create 631 | for i := 0; i < mapSize; i++ { 632 | // First we need to create our key, depending on the key type 633 | mKey := reflect.New(v.Type().Key()).Elem() 634 | mValue := reflect.New(v.Type().Elem()).Elem() 635 | 636 | // Populate the key and value 637 | err := t.fillValue(mKey, currentDepth) 638 | if err != nil { 639 | return err 640 | } 641 | err = t.fillValue(mValue, currentDepth) 642 | if err != nil { 643 | return err 644 | } 645 | 646 | // Set the key-value pair in our dictionary 647 | v.SetMapIndex(mKey, mValue) 648 | } 649 | } 650 | } else if v.Kind() == reflect.Ptr { 651 | // Determine if the pointer will be nil or if we'll actually populate assign it to a populated value. 652 | if t.getRandomBool(t.ptrNilBias) { 653 | // Set nil ptr 654 | v.Set(reflect.Zero(v.Type())) 655 | } else { 656 | // If it's a pointer, we need to create a new underlying type to live at the pointer, then populate it. 657 | v.Set(reflect.New(v.Type().Elem())) 658 | err := t.fillValue(v.Elem(), currentDepth) 659 | if err != nil { 660 | return err 661 | } 662 | } 663 | } else if v.Kind() == reflect.Array { 664 | // Loop through each element and fill it recursively. 665 | for i := 0; i < v.Len(); i++ { 666 | err := t.fillValue(v.Index(i), currentDepth) 667 | if err != nil { 668 | return err 669 | } 670 | } 671 | } else if v.Kind() == reflect.Struct && (t.depthLimit == 0 || t.depthLimit > currentDepth) { 672 | // For structs we need to recursively populate every field 673 | for i := 0; i < v.NumField(); i++ { 674 | field := v.Field(i) 675 | 676 | // If it's private and we're not setting private fields, skip it 677 | if !field.CanSet() { 678 | if !t.fillUnexportedFields { 679 | continue 680 | } 681 | // If we are filling private fields, we continue by creating a new one here. 682 | // Reference: https://stackoverflow.com/questions/42664837/how-to-access-unexported-struct-fields 683 | field = reflect.NewAt(field.Type(), unsafe.Pointer(field.UnsafeAddr())).Elem() 684 | } 685 | 686 | // Now we're ready to set our data, so fill it accordingly. 687 | err := t.fillValue(field, currentDepth + 1) 688 | if err != nil { 689 | return err 690 | } 691 | } 692 | } 693 | 694 | // Unknown value types are simply skipped/ignored, so we continue to fuzz what we're able to. 695 | return nil 696 | } 697 | -------------------------------------------------------------------------------- /type_provider_test.go: -------------------------------------------------------------------------------- 1 | package go_fuzz_utils_test 2 | 3 | import ( 4 | "github.com/stretchr/testify/assert" 5 | "github.com/trailofbits/go-fuzz-utils" 6 | "sync" 7 | "testing" 8 | ) 9 | 10 | func generateTestData(length uint) []byte { 11 | // Create our test data 12 | b := make([]byte, length) 13 | 14 | // Loop through and set our bytes accordingly. We do it in descending order so the values we test will have 15 | // negative bits set if they're signed integers first. If tests don't use all the data, this will at least test 16 | // integer width properties better since more bits will be set. 17 | for i := 0; i < len(b); i++ { 18 | b[i] = 255 - byte(i % 256) 19 | } 20 | 21 | return b 22 | } 23 | 24 | func TestSimpleTypes(t *testing.T) { 25 | // Create our fuzz data 26 | b := generateTestData(256) 27 | 28 | // Create our type provider 29 | tp, err := go_fuzz_utils.NewTypeProvider(b) 30 | assert.Nil(t, err) 31 | 32 | // Basic values 33 | b1, err := tp.GetByte() 34 | assert.Nil(t, err) 35 | assert.EqualValues(t, 0xF7, b1) 36 | 37 | i16, err := tp.GetInt16() 38 | assert.Nil(t, err) 39 | assert.EqualValues(t, -2315, i16) 40 | 41 | u16, err := tp.GetUint16() 42 | assert.Nil(t, err) 43 | assert.EqualValues(t, 0xF4F3, u16) 44 | 45 | i32, err := tp.GetInt32() 46 | assert.Nil(t, err) 47 | assert.EqualValues(t, -219025169, i32) 48 | 49 | u32, err := tp.GetUint32() 50 | assert.Nil(t, err) 51 | assert.EqualValues(t, 0xEEEDECEB, u32) 52 | 53 | i64, err := tp.GetInt64() 54 | assert.Nil(t, err) 55 | assert.EqualValues(t, -1519427316551916317, i64) 56 | 57 | u64, err := tp.GetUint64() 58 | assert.Nil(t, err) 59 | assert.EqualValues(t, uint64(0xE2E1E0DFDEDDDCDB), u64) 60 | 61 | f32, err := tp.GetFloat32() 62 | assert.Nil(t, err) 63 | assert.EqualValues(t, -3.0659244e+16, f32) 64 | 65 | f64, err := tp.GetFloat64() 66 | assert.Nil(t, err) 67 | assert.EqualValues(t, -2.050874878169571e+110, f64) 68 | 69 | // Architecture dependent integer type tests 70 | i, err := tp.GetInt() 71 | assert.Nil(t, err) 72 | assert.EqualValues(t, -3544952156018063161, i) 73 | 74 | u, err := tp.GetUint() 75 | assert.Nil(t, err) 76 | assert.EqualValues(t, uint(0xC6C5C4C3C2C1C0BF), u) 77 | 78 | // Slices/strings 79 | bytesFixed, err := tp.GetNBytes(2) 80 | assert.Nil(t, err) 81 | assert.EqualValues(t, 2, len(bytesFixed)) 82 | assert.EqualValues(t, 0xBE, bytesFixed[0]) 83 | assert.EqualValues(t, 0xBD, bytesFixed[1]) 84 | 85 | bytesDynamic, err := tp.GetBytes() 86 | assert.Nil(t, err) 87 | assert.EqualValues(t, 3, len(bytesDynamic)) 88 | assert.EqualValues(t, 0XBC, bytesDynamic[0]) 89 | assert.EqualValues(t, 0xBB, bytesDynamic[1]) 90 | 91 | strDynamic, err := tp.GetString() 92 | assert.Nil(t, err) 93 | assert.EqualValues(t, 11, len(strDynamic)) 94 | 95 | strFixed, err := tp.GetFixedString(7) 96 | assert.Nil(t, err) 97 | assert.EqualValues(t, 7, len(strFixed)) 98 | } 99 | 100 | func TestPositionReachedEnd(t *testing.T) { 101 | // Create our fuzz data 102 | b := generateTestData(1) 103 | 104 | // Create our type provider. We should encounter an error since we need at least 64-bits to read a random seed from. 105 | tp, err := go_fuzz_utils.NewTypeProvider(b) 106 | assert.NotNil(t, err) 107 | 108 | // Create more fuzz data 109 | b = generateTestData(9) 110 | 111 | // Recreate our type provider, this time it should succeed, reading 8 bytes as a random seed, leaving 1 byte left. 112 | tp, err = go_fuzz_utils.NewTypeProvider(b) 113 | assert.Nil(t, err) 114 | 115 | // Assert the values are as expected 116 | b1, err := tp.GetByte() 117 | assert.Nil(t, err) 118 | assert.EqualValues(t, 0xF7, b1) 119 | 120 | // Now expect errors reading any type. 121 | _, err = tp.GetByte() 122 | assert.NotNil(t, err) 123 | 124 | _, err = tp.GetInt8() 125 | assert.NotNil(t, err) 126 | 127 | _, err = tp.GetUint8() 128 | assert.NotNil(t, err) 129 | 130 | _, err = tp.GetInt16() 131 | assert.NotNil(t, err) 132 | 133 | _, err = tp.GetUint16() 134 | assert.NotNil(t, err) 135 | 136 | _, err = tp.GetInt32() 137 | assert.NotNil(t, err) 138 | 139 | _, err = tp.GetUint32() 140 | assert.NotNil(t, err) 141 | 142 | _, err = tp.GetInt64() 143 | assert.NotNil(t, err) 144 | 145 | _, err = tp.GetUint64() 146 | assert.NotNil(t, err) 147 | 148 | _, err = tp.GetInt() 149 | assert.NotNil(t, err) 150 | 151 | _, err = tp.GetUint() 152 | assert.NotNil(t, err) 153 | 154 | _, err = tp.GetFloat32() 155 | assert.NotNil(t, err) 156 | 157 | _, err = tp.GetFloat64() 158 | assert.NotNil(t, err) 159 | 160 | _, err = tp.GetString() 161 | assert.NotNil(t, err) 162 | 163 | _, err = tp.GetBytes() 164 | assert.NotNil(t, err) 165 | 166 | _, err = tp.GetFixedString(1) 167 | assert.NotNil(t, err) 168 | 169 | _, err = tp.GetNBytes(1) 170 | assert.NotNil(t, err) 171 | 172 | // Validate zero length strings and bytes will return successfully. 173 | s, err := tp.GetFixedString(0) 174 | assert.Nil(t, err) 175 | assert.EqualValues(t, 0, len(s)) 176 | 177 | b, err = tp.GetNBytes(0) 178 | assert.Nil(t, err) 179 | assert.EqualValues(t, 0, len(b)) 180 | } 181 | 182 | type testStruct struct { 183 | s1 string 184 | st1 struct { 185 | s string 186 | s2 string 187 | i int 188 | } 189 | sArr []string 190 | bArr []byte 191 | stArr [] struct { 192 | b byte 193 | s string 194 | i8 int8 195 | i16 int16 196 | i32 int32 197 | i64 int64 198 | f32 float32 199 | f64 float64 200 | } 201 | PublicString string 202 | PublicByte byte 203 | testMutex sync.Mutex 204 | PublicBytes []byte 205 | } 206 | 207 | func TestFillStructs(t *testing.T) { 208 | // Create our fuzz data 209 | b := generateTestData(0x1000) 210 | 211 | // Create our type provider 212 | tp, err := go_fuzz_utils.NewTypeProvider(b) 213 | assert.Nil(t, err) 214 | 215 | // Create a test structure and fill it. 216 | st := testStruct{} 217 | err = tp.SetParamsBiasesCommon(0, 0) 218 | assert.Nil(t, err) 219 | tp.SetParamsFillUnexportedFields(true) 220 | err = tp.Fill(&st) 221 | 222 | // Ensure no error was encountered and private variables were filled in this instance. 223 | assert.Nil(t, err) 224 | assert.NotNil(t, st.sArr) // private variable, filled 225 | assert.NotNil(t, st.bArr) // private variable, filled 226 | assert.False(t, st.st1.s == "" && st.st1.s2 == "" && st.st1.i == 0) // depth 2, something should be non-default value. 227 | 228 | // Reset our provider state 229 | err = tp.Reset() 230 | assert.Nil(t, err) 231 | 232 | // Create a test structure and fill it. 233 | st2 := testStruct{} 234 | tp.SetParamsFillUnexportedFields(false) 235 | err = tp.Fill(&st2) 236 | 237 | // Ensure no error was encountered and private variables weren't filled in this instance. 238 | assert.Nil(t, err) 239 | assert.Nil(t, st2.sArr) // private variable, unfilled 240 | assert.Nil(t, st2.bArr) // private variable, unfilled 241 | assert.EqualValues(t, "", st2.st1.s) // private variable, unfilled 242 | assert.EqualValues(t, "", st2.st1.s2) // private variable, unfilled 243 | assert.EqualValues(t, 0, st2.st1.i) // private variable, unfilled 244 | 245 | // Reset our provider state 246 | err = tp.Reset() 247 | assert.Nil(t, err) 248 | 249 | // Create a test structure and fill it. 250 | st3 := testStruct{} 251 | assert.Nil(t, tp.SetParamsDepthLimit(1)) 252 | tp.SetParamsFillUnexportedFields(true) 253 | err = tp.Fill(&st3) 254 | 255 | // Ensure no error was encountered and private variables weren't filled in this instance. 256 | assert.Nil(t, err) 257 | assert.NotNil(t, st3.sArr) // private variable, unfilled 258 | assert.NotNil(t, st3.bArr) 259 | assert.EqualValues(t, "", st3.st1.s)// depth 2, not filled 260 | assert.EqualValues(t, "", st3.st1.s2)// depth 2, not filled 261 | assert.EqualValues(t, 0, st3.st1.i)// depth 2, not filled 262 | } 263 | 264 | func TestFillBasicTypes(t *testing.T) { 265 | // Create our fuzz data 266 | b := generateTestData(0x1000) 267 | 268 | // Create our type provider 269 | tp, err := go_fuzz_utils.NewTypeProvider(b) 270 | assert.Nil(t, err) 271 | 272 | // Create a test structure and fill it. 273 | st := testStruct{} 274 | err = tp.Fill(&st) 275 | 276 | // Ensure no error was encountered. 277 | assert.Nil(t, err) 278 | assert.NotNil(t, st.sArr) // private variable, filled 279 | assert.NotNil(t, st.bArr) // private variable, filled 280 | 281 | // Reset our provider state 282 | err = tp.Reset() 283 | assert.Nil(t, err) 284 | 285 | // Fill a int16 286 | var i16 int16 287 | err = tp.Fill(&i16) 288 | assert.Nil(t, err) 289 | assert.EqualValues(t, -2058, i16) 290 | 291 | // Fill a uint16 292 | var u16 uint16 293 | err = tp.Fill(&u16) 294 | assert.Nil(t, err) 295 | assert.EqualValues(t, 0xF5F4, u16) 296 | 297 | // Fill a int32 298 | var i32 int32 299 | err = tp.Fill(&i32) 300 | assert.Nil(t, err) 301 | assert.EqualValues(t, -202182160, i32) 302 | 303 | // Fill a uint32 304 | var u32 uint32 305 | err = tp.Fill(&u32) 306 | assert.Nil(t, err) 307 | assert.EqualValues(t, 0xEFEEEDEC, u32) 308 | 309 | // Fill a int64 310 | var i64 int64 311 | err = tp.Fill(&i64) 312 | assert.Nil(t, err) 313 | assert.EqualValues(t, -1447087143713839644, i64) 314 | 315 | // Fill a uint64 316 | var u64 uint64 317 | err = tp.Fill(&u64) 318 | assert.Nil(t, err) 319 | assert.EqualValues(t, uint64(0xE3E2E1E0DFDEDDDC), u64) 320 | 321 | // Fill a float32 322 | var f32 float32 323 | err = tp.Fill(&f32) 324 | assert.Nil(t, err) 325 | assert.EqualValues(t, -1.2320213e+17, f32) 326 | 327 | // Fill a float64 328 | var f64 float64 329 | err = tp.Fill(&f64) 330 | assert.Nil(t, err) 331 | assert.EqualValues(t, -1.405868428700574e+115, f64) 332 | } 333 | 334 | func TestFillComplexTypes(t *testing.T) { 335 | // Create our fuzz data 336 | b := generateTestData(0x1000) 337 | 338 | // Create our type provider 339 | tp, err := go_fuzz_utils.NewTypeProvider(b) 340 | assert.Nil(t, err) 341 | assert.Nil(t, tp.SetParamsBiasesCommon(0, 0)) 342 | 343 | // Create a mapping and fill it. 344 | m := make(map[string]int) 345 | err = tp.Fill(&m) 346 | 347 | // Ensure something was generated. 348 | assert.Nil(t, err) 349 | assert.GreaterOrEqual(t, len(m), 0) 350 | assert.LessOrEqual(t, len(m), 15) // no more than 15 entries based on our args 351 | 352 | // Create a slice and fill it. 353 | u64Arr := make([]uint64, 0) 354 | err = tp.Fill(&u64Arr) 355 | 356 | // Ensure something was generated. 357 | assert.Nil(t, err) 358 | assert.GreaterOrEqual(t, len(u64Arr), 0) 359 | assert.LessOrEqual(t, len(u64Arr), 15) // no more than 15 entries based on our args 360 | 361 | // Create a slice and fill it. 362 | mappingArr := make([]map[string]int, 0) 363 | assert.Nil(t, tp.SetParamsMapBounds(1, 1)) 364 | assert.Nil(t, tp.SetParamsSliceBounds(3, 3)) 365 | err = tp.Fill(&mappingArr) 366 | 367 | // Ensure something was generated. 368 | assert.Nil(t, err) 369 | assert.GreaterOrEqual(t, len(mappingArr), 0) 370 | assert.LessOrEqual(t, len(mappingArr), 15) // no more than 15 entries based on our args 371 | } 372 | 373 | func TestNilBiases(t *testing.T) { 374 | // Create our fuzz data 375 | b := generateTestData(0x1000) 376 | 377 | // Create our type provider 378 | tp, err := go_fuzz_utils.NewTypeProvider(b) 379 | assert.Nil(t, err) 380 | 381 | // Define a struct to test our nil biases for slice 382 | type TestStruct struct { 383 | x []uint8 384 | } 385 | var nestedSlices [20]TestStruct 386 | 387 | // Fill our slice and verify length 388 | assert.Nil(t, tp.SetParamsSliceBounds(15, 15)) 389 | assert.Nil(t, tp.SetParamsBiasesCommon(0, 0)) 390 | err = tp.Fill(&nestedSlices) 391 | assert.Nil(t, err) 392 | 393 | // Verify nothing in the struct is nil based on our 0 bias. 394 | for i := 0; i < len(nestedSlices); i++ { 395 | assert.NotNil(t, nestedSlices[i].x) 396 | assert.EqualValues(t, 15, len(nestedSlices[i].x)) 397 | } 398 | 399 | // Try to fill our slice again, this time with a full nil bias. 400 | var nestedSlices2 [20]TestStruct 401 | assert.Nil(t, tp.SetParamsBiasesCommon(1, 0)) 402 | err = tp.Fill(&nestedSlices2) 403 | assert.Nil(t, err) 404 | 405 | // Verify everything in the struct is nil based on our bias. 406 | for i := 0; i < len(nestedSlices2); i++ { 407 | assert.Nil(t, nestedSlices2[i].x) 408 | } 409 | } 410 | 411 | func TestByteArrayFilling(t *testing.T) { 412 | // We have a special optimization case for byte slices that is separate from other slice types, so we offer a quick 413 | // test to ensure that those types are populated without issue. 414 | 415 | // Create our fuzz data (the test data isn't great for this test, so we tweak it a bit) 416 | b := append([]byte{ 6 }, generateTestData(0x1000)...) 417 | 418 | // Create our type provider 419 | tp, err := go_fuzz_utils.NewTypeProvider(b) 420 | assert.Nil(t, err) 421 | 422 | // Create a slice and fill it. 423 | bSlice := make([]byte, 0) 424 | err = tp.Fill(&bSlice) 425 | 426 | // Ensure something was generated. 427 | assert.Nil(t, err) 428 | 429 | assert.GreaterOrEqual(t, len(bSlice), 0) 430 | assert.LessOrEqual(t, len(bSlice), 15) // no more than 15 entries based on our args 431 | } 432 | 433 | func TestSkipBiases(t *testing.T) { 434 | // Create our fuzz data 435 | b := generateTestData(0x1000) 436 | 437 | // Create our type provider 438 | tp, err := go_fuzz_utils.NewTypeProvider(b) 439 | assert.Nil(t, err) 440 | 441 | // Define a struct to test our skip biases. We define every type that is considered for skipping. 442 | type TestStruct struct { 443 | sliceVal []byte 444 | mapVal map[int]int 445 | ptrVal *int 446 | } 447 | x := 7 448 | skipStruct := TestStruct { 449 | sliceVal: []byte{ 0, 1, 2, 3 }, 450 | mapVal: map[int]int { 0: 0, 1: 1, 2: 2, 3: 3}, 451 | ptrVal: &x, 452 | } 453 | 454 | // We'll try to fill all maps/ptr/slices with nil, but also set skip to a full bias so it shouldn't ever actually 455 | // happen. 456 | assert.Nil(t, tp.SetParamsBiasesCommon(1, 1)) 457 | assert.Nil(t, tp.SetParamsSliceBounds(0, 0)) 458 | err = tp.Fill(&skipStruct) 459 | assert.Nil(t, err) 460 | 461 | // Ensure all values are not nil 462 | assert.NotNil(t, skipStruct.mapVal) 463 | assert.NotNil(t, skipStruct.ptrVal) 464 | assert.NotNil(t, skipStruct.sliceVal) 465 | 466 | // Now fill with the no skip bias, and they should all be nil 467 | assert.Nil(t, tp.SetParamsBiasesCommon(1, 0)) 468 | err = tp.Fill(&skipStruct) 469 | assert.Nil(t, err) 470 | 471 | // Ensure all values are now nil given we have full nil bias and no skip bias 472 | assert.Nil(t, skipStruct.mapVal) 473 | assert.Nil(t, skipStruct.ptrVal) 474 | assert.Nil(t, skipStruct.sliceVal) 475 | } --------------------------------------------------------------------------------