├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── LICENSE.txt ├── MANIFEST.in ├── README.rst ├── pat.py ├── pat ├── __init__.py ├── __main__.py ├── init.py ├── main.py ├── pat.py └── utils.py ├── requirements.txt ├── setup.cfg ├── setup.py └── tests ├── getitem_test.py └── pat_test.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.o 2 | *.pyc 3 | dist 4 | *.egg-info 5 | .sconsign.dblite 6 | build 7 | .tox 8 | .cache 9 | 10 | 11 | githooks/pre-commit -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | notifications: 2 | email: false 3 | 4 | sudo: false 5 | 6 | language: python 7 | 8 | python: 9 | - "2.6" 10 | - "2.7" 11 | - "3.2" 12 | - "3.3" 13 | - "3.4" 14 | - "3.5" 15 | - "pypy" 16 | - "pypy3" 17 | 18 | install: 19 | - python setup.py install 20 | 21 | script: nosetests 22 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Pat 0.5.0 - March 17, 2016 2 | 3 | ## What's New 4 | 5 | - Added `[]` syntax. 6 | - Added colorized logging and options `-v` and `-q`. 7 | - Added i18n stub. 8 | 9 | ## What's Different 10 | 11 | - Changed API names. 12 | 13 | - `Pat.create_pattern` -> `Pat.create` 14 | - `Pat.locate_pattern` -> `Pat.locate` 15 | 16 | - Raised errors instead of returning `None` on failure. 17 | 18 | - `IndexError` from `Pat.create` 19 | - `KeyError` from `Pat.locate` 20 | 21 | 22 | # Pat 0.4.1 - March 6, 2016 23 | 24 | ## What's New 25 | 26 | - Added CLI flag `-b` / `--big-endian`. 27 | 28 | ## Fixed Bugs 29 | 30 | - Considered endianness, fixing #3. 31 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include *.txt 2 | include CHANGELOG.md 3 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Customizable Lazy Exploit Pattern Utility 2 | ========================================= 3 | 4 | .. image:: https://img.shields.io/pypi/v/pat.svg 5 | :target: https://pypi.python.org/pypi/Pat 6 | 7 | .. image:: https://travis-ci.org/NoviceLive/pat.svg?branch=master 8 | :target: https://travis-ci.org/NoviceLive/pat 9 | 10 | 11 | Official Mirrors 12 | ---------------- 13 | 14 | - https://gitlab.com/imtheforce/pat 15 | - https://bitbucket.org/fourthorigin/pat 16 | - https://github.com/NoviceLive/pat 17 | 18 | 19 | Latest Updates 20 | -------------- 21 | 22 | I learned from pwntools_ that there is another kind of sequences, 23 | named `De Bruijn sequence`_, 24 | which is powerful and has excessive potentials. 25 | 26 | Check it if you are interested. 27 | 28 | Its pattern looks like the following as produced by ``cyclic`` 29 | provided by pwntools_. 30 | 31 | :: 32 | 33 | $ cyclic 400 34 | aaaabaaacaaadaaaeaaafaaagaaahaaaiaaajaaakaaalaaamaaanaaaoaaapaaaqaaaraaasaaataaauaaavaaawaaaxaaayaaazaabbaabcaabdaabeaabfaabgaabhaabiaabjaabkaablaabmaabnaaboaabpaabqaabraabsaabtaabuaabvaabwaabxaabyaabzaacbaaccaacdaaceaacfaacgaachaaciaacjaackaaclaacmaacnaacoaacpaacqaacraacsaactaacuaacvaacwaacxaacyaaczaadbaadcaaddaadeaadfaadgaadhaadiaadjaadkaadlaadmaadnaadoaadpaadqaadraadsaadtaaduaadvaadwaadxaadyaad 35 | 36 | $ cyclic -l yaad 37 | 396 38 | 39 | 40 | Installation 41 | ------------ 42 | 43 | ``pip install pat`` works, elevate privilege if necessary. 44 | 45 | Requirements 46 | ++++++++++++ 47 | 48 | Click_ 49 | ****** 50 | Python composable command line utility. 51 | 52 | Colorama_ 53 | ********* 54 | 55 | Simple cross-platform colored terminal text in Python. 56 | 57 | Pyperclip_ 58 | ********** 59 | 60 | Python module for cross-platform clipboard functions. 61 | 62 | 63 | flufl.i18n_ 64 | *********** 65 | 66 | A high level API for Python internationalization. 67 | 68 | This is not used for the time being. 69 | 70 | 71 | Usage 72 | ----- 73 | 74 | :: 75 | 76 | ./pat.py --help 77 | Usage: pat.py [OPTIONS] ARGUMENT [SETS]... 78 | 79 | Customizable Lazy Exploit Pattern Utility. 80 | 81 | Options: 82 | -V, --version Show the version and exit. 83 | -b, --big-endian Use big-endian. 84 | -O, --optimal INTEGER Use the optimal profile in this position. 85 | -o, --output FILENAME Write to this file. 86 | -c, --clipboard Output to the clipboard. 87 | -v, --verbose Be verbose. 88 | -q, --quiet Be quiet. 89 | -h, --help Show this message and exit. 90 | 91 | 92 | Examples 93 | -------- 94 | 95 | - Create a pattern of length 100 using the default profile. 96 | 97 | :: 98 | 99 | ./pat.py 100 100 | Aa0Aa1Aa2Aa3Aa4Aa5Aa6Aa7Aa8Aa9Ab0Ab1Ab2Ab3Ab4Ab5Ab6Ab7Ab8Ab9Ac0Ac1Ac2Ac3Ac4Ac5Ac6Ac7Ac8Ac9Ad0Ad1Ad2A 101 | 102 | - Locate the pattern ``Cz9`` in the default profile. 103 | 104 | :: 105 | 106 | ./pat.py Cz9 107 | 2337 108 | 109 | - Locate the pattern in hex, ``0x5a6232``, using the default profile. 110 | 111 | For big-endian systems. 112 | 113 | :: 114 | 115 | ./pat.py 0x5a6232 -b 116 | 19536 117 | 118 | - Create a pattern of length 200 in optimal 3-position profile. 119 | 120 | :: 121 | 122 | ./pat.py 200 -O3 123 | AVqAVrAVsAVtAVuAVvAVwAVxAVyAVzAV0AV1AV2AV3AV4AV5AV6AV7AV8AV9AWqAWrAWsAWtAWuAWvAWwAWxAWyAWzAW0AW1AW2AW3AW4AW5AW6AW7AW8AW9AXqAXrAXsAXtAXuAXvAXwAXxAXyAXzAX0AX1AX2AX3AX4AX5AX6AX7AX8AX9AYqAYrAYsAYtAYuAYvAY 124 | 125 | - Search for pattern ``vAY`` in optimal 3-position profile. 126 | 127 | :: 128 | 129 | ./pat.py vAY -O3 130 | 197 131 | 132 | 133 | API 134 | --- 135 | 136 | 137 | See ``pydoc pat.Pat``. 138 | 139 | 140 | Mathematical Background 141 | ----------------------- 142 | 143 | 144 | Simply speaking, it is a string of continuous numbers 145 | in some special `positional numeral systems`_, 146 | where symbols in each position are mutually unique, 147 | often with a big radix. 148 | 149 | It can be created by taking the needed count of characters 150 | from the `Cartesian product`_ of chosen character sets. 151 | 152 | 153 | Profiles 154 | -------- 155 | 156 | Default Profile 157 | +++++++++++++++ 158 | 159 | - Three-position: The most popular choice 160 | 161 | - Maximum Length 162 | 163 | 26 :sup:`2` * 10 * 3 B = 20280 B = 19 KiB. 164 | 165 | :: 166 | 167 | ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz 0123456789 168 | 169 | 170 | Optimal Profiles 171 | ++++++++++++++++ 172 | 173 | Suppose that we have a limited set of characters, 174 | e.g. alphanumeric ones, in which there are 62 characters available. 175 | 176 | According to the `inequality of arithmetic and geometric means`_, 177 | fixed radix systems will achieve the best length. 178 | 179 | 180 | Three-position 181 | ************** 182 | 183 | - Maximum Length 184 | 185 | 21 :sup:`2` * 20 * 3 B = 26460 B = 25 KiB 186 | 187 | :: 188 | 189 | ABCDEFGHIJKLMNOPQRSTU VWXYZabcdefghijklmnop qrstuvwxyz0123456789 190 | 191 | Four-position 192 | ************* 193 | 194 | - Maximum Length 195 | 196 | 16 :sup:`2` * 15 :sup:`2` * 4 B = 230400 B = 225 KiB 197 | 198 | :: 199 | 200 | ABCDEFGHIJKLMNOP QRSTUVWXYZabcdef ghijklmnopqrstu vwxyz0123456789 201 | 202 | 203 | Eight-position 204 | ************** 205 | 206 | - Maximum Length 207 | 208 | 8 :sup:`6` * 7 :sup:`2` * 8 B = 102760448 B = 98 MiB 209 | 210 | :: 211 | 212 | ABCDEFGH IJKLMNOP QRSTUVWX YZabcdef ghijklmn opqrstuv wxyz012 3456789 213 | 214 | 215 | .. _positional numeral systems: https://en.wikipedia.org/wiki/Positional_notation 216 | 217 | .. _Cartesian product: https://en.wikipedia.org/wiki/Cartesian_product 218 | 219 | .. _inequality of arithmetic and geometric means: https://en.wikipedia.org/wiki/Inequality_of_arithmetic_and_geometric_means 220 | 221 | .. _Colorama: https://github.com/tartley/colorama 222 | .. _Click: https://github.com/mitsuhiko/click 223 | .. _Pyperclip: https://github.com/asweigart/pyperclip 224 | .. _flufl.i18n: https://gitlab.com/warsaw/flufl.i18n 225 | .. _pwntools: https://github.com/Gallopsled/pwntools 226 | .. _De Bruijn sequence: https://en.wikipedia.org/wiki/De_Bruijn_sequence 227 | -------------------------------------------------------------------------------- /pat.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | 4 | """ 5 | Copyright 2016 Gu Zhengxiong 6 | 7 | This file is part of Pat. 8 | 9 | Pat is free software: you can redistribute it and/or modify 10 | it under the terms of the GNU General Public License as published by 11 | the Free Software Foundation, either version 3 of the License, or 12 | (at your option) any later version. 13 | 14 | Pat is distributed in the hope that it will be useful, 15 | but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | GNU General Public License for more details. 18 | 19 | You should have received a copy of the GNU General Public License 20 | along with Pat. If not, see . 21 | """ 22 | 23 | 24 | from pat.main import main 25 | 26 | 27 | if __name__ == '__main__': 28 | main() 29 | -------------------------------------------------------------------------------- /pat/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2016 Gu Zhengxiong 3 | 4 | This file is part of Pat. 5 | 6 | Pat is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pat is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pat. If not, see . 18 | """ 19 | 20 | 21 | from __future__ import division, absolute_import, print_function 22 | from logging import Handler, getLogger 23 | try: 24 | from logging import NullHandler 25 | except ImportError: 26 | class NullHandler(Handler): 27 | def emit(self, record): 28 | pass 29 | 30 | from .pat import Pat 31 | 32 | 33 | __author__ = 'Gu Zhengxiong' 34 | __version__ = '0.5.3' 35 | 36 | 37 | PROGRAM_NAME = 'Pat' 38 | PACKAGE_NAME = 'pat' 39 | 40 | VERSION_PROMPT = ( 41 | '{version}\n\nCopyright 2015-2016 {author} ' 42 | '\n\n' 43 | 'This is free software; see the source for ' 44 | 'copying conditions.\nThere is NO warranty; ' 45 | 'not even for MERCHANTABILITY nor \nFITNESS FOR ' 46 | 'A PARTICULAR PURPOSE.'.format( 47 | version=__version__, author=__author__) 48 | ) 49 | 50 | 51 | __all__ = ['Pat'] 52 | 53 | 54 | getLogger(__name__).addHandler(NullHandler()) 55 | -------------------------------------------------------------------------------- /pat/__main__.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2016 Gu Zhengxiong 3 | 4 | This file is part of Pat. 5 | 6 | Pat is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pat is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pat. If not, see . 18 | """ 19 | 20 | 21 | from __future__ import division, absolute_import, print_function 22 | from .main import main 23 | 24 | 25 | if __name__ == '__main__': 26 | main() 27 | -------------------------------------------------------------------------------- /pat/init.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2016 Gu Zhengxiong 3 | 4 | This file is part of Pat. 5 | 6 | Pat is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pat is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pat. If not, see . 18 | """ 19 | 20 | 21 | from __future__ import division, absolute_import, print_function 22 | from logging import Formatter, DEBUG, INFO, WARNING, ERROR, CRITICAL 23 | import os 24 | 25 | from colorama import Fore, Style 26 | from pkg_resources import resource_filename 27 | try: 28 | from flufl.i18n import initialize 29 | except ImportError: 30 | pass 31 | 32 | 33 | try: 34 | os.environ['LOCPATH'] = resource_filename(__name__, 'share') 35 | _ = initialize('pat') 36 | except (KeyError, NameError): 37 | _ = lambda x: x 38 | 39 | 40 | def red(text): 41 | return Fore.RED + Style.BRIGHT + text 42 | 43 | 44 | def blue(text): 45 | return Fore.BLUE + Style.BRIGHT + text 46 | 47 | 48 | def cyan(text): 49 | return Fore.CYAN + Style.BRIGHT + text 50 | 51 | 52 | def yellow(text): 53 | return Fore.YELLOW + Style.BRIGHT + text 54 | 55 | 56 | def green(text): 57 | return Fore.GREEN + Style.BRIGHT + text 58 | 59 | 60 | class LevelFormatter(Formatter): 61 | """Logging formatter.""" 62 | critical_formatter = Formatter(red('critical: %(message)s')) 63 | error_formatter = Formatter(red('error: %(message)s')) 64 | warning_formatter = Formatter(yellow('warning: %(message)s')) 65 | info_formatter = Formatter(cyan('%(message)s')) 66 | debug_formatter = Formatter( 67 | green('debug: ') + blue('%(name)s.%(funcName)s: ') + 68 | green('%(message)s')) 69 | 70 | def __init__(self): 71 | Formatter.__init__(self) 72 | 73 | def format(self, record): 74 | """Format the record using the corresponding formatter.""" 75 | if record.levelno == DEBUG: 76 | return self.debug_formatter.format(record) 77 | if record.levelno == INFO: 78 | return self.info_formatter.format(record) 79 | if record.levelno == ERROR: 80 | return self.error_formatter.format(record) 81 | if record.levelno == WARNING: 82 | return self.warning_formatter.format(record) 83 | if record.levelno == CRITICAL: 84 | return self.critical_formatter.format(record) 85 | -------------------------------------------------------------------------------- /pat/main.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2016 Gu Zhengxiong 3 | 4 | This file is part of Pat. 5 | 6 | Pat is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pat is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pat. If not, see . 18 | """ 19 | 20 | 21 | from __future__ import division, absolute_import, print_function 22 | import logging 23 | import sys 24 | 25 | import click 26 | from pyperclip import copy 27 | 28 | from . import VERSION_PROMPT, PROGRAM_NAME 29 | from .init import LevelFormatter, _ 30 | from .pat import Pat 31 | 32 | 33 | @click.command( 34 | context_settings=dict(help_option_names=['-h', '--help'])) 35 | @click.version_option(VERSION_PROMPT, 36 | '-V', '--version', prog_name=PROGRAM_NAME) 37 | @click.argument('argument', required=True) 38 | @click.argument('sets', nargs=-1) 39 | @click.option('-b', '--big-endian', is_flag=True, 40 | help='Use big-endian.') 41 | @click.option('-O', '--optimal', type=int, 42 | help='Use the optimal profile in this position.') 43 | @click.option('-o', '--output', type=click.File('w'), 44 | help='Write to this file.') 45 | @click.option('-c', '--clipboard', is_flag=True, 46 | help='Output to the clipboard.') 47 | @click.option('-v', '--verbose', count=True, help='Be verbose.') 48 | @click.option('-q', '--quiet', count=True, help='Be quiet.') 49 | def main(argument, sets, big_endian, optimal, output, clipboard, 50 | quiet, verbose): 51 | """Customizable Lazy Exploit Pattern Utility.""" 52 | logger = logging.getLogger() 53 | handler = logging.StreamHandler(sys.stderr) 54 | handler.setFormatter(LevelFormatter()) 55 | logger.addHandler(handler) 56 | logger.setLevel(logging.WARNING + (quiet-verbose)*10) 57 | 58 | if sets and optimal: 59 | pat = Pat.from_chars(''.join(sets), optimal) 60 | elif optimal: 61 | pat = Pat.from_chars(optimal=optimal) 62 | elif sets: 63 | pat = Pat(sets) 64 | else: 65 | pat = Pat() 66 | 67 | if argument.isdigit(): 68 | count = int(argument) 69 | try: 70 | pattern = pat.create(count) 71 | except IndexError: 72 | logging.exception(_('Failed to create the pattern.')) 73 | sys.exit(1) 74 | else: 75 | if output: 76 | output.write(pattern) 77 | elif clipboard: 78 | copy(pattern) 79 | else: 80 | print(pattern) 81 | else: 82 | target = argument 83 | try: 84 | index = pat.locate(target, big_endian) 85 | except KeyError: 86 | logging.exception(_('Failed to locate the pattern.')) 87 | sys.exit(1) 88 | else: 89 | print(index) 90 | 91 | sys.exit(0) 92 | -------------------------------------------------------------------------------- /pat/pat.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2016 Gu Zhengxiong 3 | 4 | This file is part of Pat. 5 | 6 | Pat is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pat is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pat. If not, see . 18 | """ 19 | 20 | 21 | from __future__ import division, absolute_import, print_function 22 | from logging import getLogger 23 | from string import digits, ascii_lowercase, ascii_uppercase 24 | from itertools import product, chain, islice, tee 25 | from functools import reduce 26 | from operator import mul 27 | from binascii import unhexlify 28 | 29 | from .utils import most_even_chunk, window 30 | 31 | 32 | logging = getLogger(__name__) 33 | ALNUM = [ascii_uppercase, ascii_lowercase, digits] 34 | 35 | 36 | class Pat(object): 37 | """A Lazy Customizable Exploit Pattern.""" 38 | def __init__(self, sets=None): 39 | if not sets: 40 | sets = ALNUM 41 | logging.debug('sets: %s', sets) 42 | self.sets = sets 43 | self.position = len(sets) 44 | self.space = self._create_space() 45 | 46 | @classmethod 47 | def from_chars(cls, chars='', optimal=3): 48 | """Construct a Pat object from the specified string 49 | and optimal position count.""" 50 | if not chars: 51 | chars = ''.join(ALNUM) 52 | sets = most_even_chunk(chars, optimal) 53 | return cls(sets) 54 | 55 | def __getitem__(self, key): 56 | if str(key).isdigit(): 57 | count = int(key) 58 | return self.create(count) 59 | else: 60 | target = key 61 | return self.locate(target, big_endian=False) 62 | 63 | def create(self, count): 64 | """Create a pattern of the specified length.""" 65 | space, self.space = tee(self.space) 66 | limit = reduce(mul, map(len, self.sets)) * self.position 67 | logging.debug('limit: %s', limit) 68 | if limit >= count: 69 | return ''.join(islice(space, count)) 70 | else: 71 | raise IndexError('{count} Overflows {sets}!'.format( 72 | count=count, sets=self.sets)) 73 | 74 | def locate(self, pattern, big_endian=False): 75 | """Locate the pattern.""" 76 | space, self.space = tee(self.space) 77 | if pattern.startswith('0x'): 78 | target = unhexlify( 79 | pattern[2:].encode('utf-8')).decode('utf-8') 80 | if not big_endian: 81 | target = target[::-1] 82 | else: 83 | target = pattern 84 | for index, one in enumerate(window(space, self.position)): 85 | if ''.join(one) == target[:self.position]: 86 | return index 87 | raise KeyError('{target} Not Found In {sets}!'.format( 88 | target=pattern, sets=self.sets)) 89 | 90 | def _create_space(self): 91 | """Create the space used by creating and locating.""" 92 | return chain.from_iterable(map(''.join, product(*self.sets))) 93 | -------------------------------------------------------------------------------- /pat/utils.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2016 Gu Zhengxiong 3 | 4 | This file is part of Pat. 5 | 6 | Pat is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pat is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pat. If not, see . 18 | """ 19 | 20 | 21 | from __future__ import division, absolute_import, print_function 22 | from logging import getLogger 23 | from itertools import islice 24 | from sys import version_info 25 | 26 | 27 | # zip_longest & accumulate handling taken from fn.py 28 | 29 | if version_info[0] == 2: 30 | from itertools import izip_longest as zip_longest 31 | else: 32 | from itertools import zip_longest 33 | 34 | 35 | if version_info[0] == 3 and version_info[1] >= 3: 36 | from itertools import accumulate 37 | else: 38 | def accumulate(iterable, func=add): 39 | """Make an iterator that returns accumulated sums. 40 | Elements may be any addable type including Decimal or Fraction. 41 | If the optional func argument is supplied, it should be a 42 | function of two arguments and it will be used instead of addition. 43 | 44 | Origin implementation: 45 | http://docs.python.org/dev/library/itertools.html#itertools.accumulate 46 | 47 | Backported to work with all python versions (< 3.3) 48 | """ 49 | it = iter(iterable) 50 | total = next(it) 51 | yield total 52 | for element in it: 53 | total = func(total, element) 54 | yield total 55 | 56 | 57 | logging = getLogger(__name__) 58 | 59 | 60 | def most_even_chunk(string, group): 61 | """Divide a string into a list of strings as even as possible.""" 62 | counts = [0] + most_even(len(string), group) 63 | indices = accumulate(counts) 64 | slices = window(indices, 2) 65 | return [string[slice(*one)] for one in slices] 66 | 67 | 68 | def most_even(number, group): 69 | """Divide a number into a list of numbers as even as possible.""" 70 | count, rest = divmod(number, group) 71 | counts = zip_longest([count] * group, [1] * rest, fillvalue=0) 72 | chunks = [sum(one) for one in counts] 73 | logging.debug('chunks: %s', chunks) 74 | return chunks 75 | 76 | 77 | def window(seq, count=2): 78 | """Slide window.""" 79 | iseq = iter(seq) 80 | result = tuple(islice(iseq, count)) 81 | if len(result) == count: 82 | yield result 83 | for elem in iseq: 84 | result = result[1:] + (elem,) 85 | yield result 86 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | click 2 | colorama 3 | flufl.i18n==1.1.3 4 | pyperclip 5 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [bdist_wheel] 2 | universal = 1 3 | 4 | 5 | [metadata] 6 | license_file = LICENSE.txt 7 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright 2016 Gu Zhengxiong 3 | 4 | This file is part of Pat. 5 | 6 | Pat is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | Pat is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with Pat. If not, see . 18 | """ 19 | 20 | 21 | from setuptools import setup 22 | 23 | 24 | __author__ = 'Gu Zhengxiong' 25 | __version__ = '0.5.3' 26 | 27 | PROGRAM_NAME = 'Pat' 28 | PACKAGE_NAME = 'pat' 29 | 30 | 31 | with open('requirements.txt') as stream: 32 | requirements = stream.read().splitlines() 33 | 34 | 35 | setup( 36 | name=PROGRAM_NAME, 37 | version=__version__, 38 | packages=[PACKAGE_NAME], 39 | install_requires=requirements, 40 | entry_points={ 41 | 'console_scripts': [ 42 | 'pat={name}.main:main'.format(name=PACKAGE_NAME) 43 | ] 44 | }, 45 | 46 | author=__author__, 47 | author_email='rectigu@gmail.com', 48 | description='Customizable Lazy Exploit Pattern Utility', 49 | license='GPL-3', 50 | keywords='Exploit Pattern, Cartesian Product', 51 | url='https://github.com/NoviceLive/' + PACKAGE_NAME, 52 | 53 | classifiers=[ 54 | 'Development Status :: 4 - Beta', 55 | 'Environment :: Console', 56 | 'License :: OSI Approved :: ' 57 | 'GNU General Public License v3 or later (GPLv3+)', 58 | 'Operating System :: OS Independent', 59 | 'Programming Language :: Python :: 2.7', 60 | 'Programming Language :: Python :: 3', 61 | ] 62 | ) 63 | -------------------------------------------------------------------------------- /tests/getitem_test.py: -------------------------------------------------------------------------------- 1 | from pat import Pat 2 | 3 | 4 | pat = Pat() 5 | 6 | 7 | def test_getitem_create(): 8 | tests = { 9 | 1: 'A', 2: 'Aa', 3: 'Aa0' 10 | } 11 | for one in tests: 12 | assert pat[one] == tests[one] 13 | 14 | 15 | def test_getitem_locate(): 16 | tests = { 17 | 'Aa0': 0, 'Zz9': 20277, 'n2A': 397, 18 | '0x31634130': 62, '0x41326341': 66, '0x63413363': 70 19 | } 20 | for one in tests: 21 | assert pat[one] == tests[one] 22 | 23 | 24 | def test_getitem_exception(): 25 | try: 26 | pat[20281] 27 | except IndexError: 28 | pass 29 | else: 30 | assert False 31 | try: 32 | pat['Zzz'] 33 | except KeyError: 34 | pass 35 | else: 36 | assert False 37 | -------------------------------------------------------------------------------- /tests/pat_test.py: -------------------------------------------------------------------------------- 1 | from pat import Pat 2 | 3 | 4 | pat = Pat() 5 | 6 | 7 | def test_create(): 8 | tests = { 9 | 1: 'A', 2: 'Aa', 3: 'Aa0' 10 | } 11 | for one in tests: 12 | assert pat.create(one) == tests[one] 13 | 14 | 15 | def test_locate(): 16 | tests = { 17 | 'Aa0': 0, 'Zz9': 20277, 'n2A': 397, 18 | '0x31634130': 62, '0x41326341': 66, '0x63413363': 70 19 | } 20 | for one in tests: 21 | assert pat.locate(one, big_endian=False) == tests[one] 22 | 23 | 24 | def test_exception(): 25 | try: 26 | pat.create(20281) 27 | except IndexError: 28 | pass 29 | else: 30 | assert False 31 | try: 32 | pat.locate('Zzz') 33 | except KeyError: 34 | pass 35 | else: 36 | assert False 37 | --------------------------------------------------------------------------------