├── .gitignore ├── .travis.yml ├── Dockerfile ├── LICENSE ├── README.md ├── ocyara ├── __init__.py └── ocyara.py ├── requirements.txt ├── setup.py └── tests ├── Example.pdf ├── SSN-example-png-as.jpg ├── SSN-example-png-as.txt ├── SSN-example.bmp ├── SSN-example.gif ├── SSN-example.jpg ├── SSN-example.png ├── SSN-example.tif ├── ascii-file-as.jpg ├── example.yara ├── test_example_pdf.py ├── test_logging.py ├── test_magic.py └── test_path.py /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | *.pyc 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: required 2 | dist: trusty 3 | language: python 4 | services: 5 | - docker 6 | env: 7 | - PYTHON_VERSION=3.5 8 | - PYTHON_VERSION=3.6 9 | install: 10 | - docker pull bandrel/ocyara:latest 11 | - docker run --name travis -dt bandrel/ocyara:latest 12 | - docker cp /home/travis/build/bandrel/OCyara travis:/home # need to move this directory into the docker image for testing 13 | 14 | script: 15 | - docker exec travis bash -c "source /home/${PYTHON_VERSION}/bin/activate && cd /home/OCyara && python -m pytest" 16 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:16.10 2 | 3 | RUN apt-get update 4 | RUN apt-get install -y apt-utils 5 | RUN apt-get install -y python3-dev 6 | RUN apt-get install -y tesseract-ocr libtesseract-dev libleptonica-dev libpng-dev libjpeg-dev libtiff5-dev zlib1g-dev 7 | RUN apt-get install -y python3-pip 8 | RUN apt-get install -y python-pip 9 | RUN apt-get install -y python3 10 | RUN apt-get install -y virtualenv 11 | RUN apt-get install -y git 12 | RUN pip3 install --upgrade pip 13 | RUN apt-get install -y wget 14 | RUN pip3 install cython 15 | RUN wget -O requirements.txt https://raw.githubusercontent.com/bandrel/OCyara/master/requirements.txt && pip3 install -r requirements.txt 16 | RUN pip3 install pytest 17 | RUN git clone https://github.com/bandrel/OCyara.git 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OCyara 2 | [![Build Status](https://travis-ci.org/bandrel/OCyara.svg?branch=master)](https://travis-ci.org/bandrel/OCyara) 3 | 4 | [![PyPI version](https://badge.fury.io/py/OCyara.svg)](https://pypi.python.org/pypi/OCyara/) 5 | 6 | The OCyara module performs OCR (Optical Character Recognition) on image 7 | files and scans them for matches to Yara rules. OCyara also can process 8 | images embedded in PDF files. For more information about Yara, visit 9 | https://virustotal.github.io/yara/. 10 | 11 | ## Installation 12 | ### Operating System Requirements 13 | 14 | - **Python 3.5+** 15 | - **Debian-based Linux distros** are currently the only supported 16 | operating systems. Installation has only been tested on Kali 17 | Rolling and Ubuntu 16.10. (Other Debian-based distros may work as 18 | well, but may require manual compilation of Tesseract and/or Leptonica 19 | to get support for all image types. GIF, and TIFF library support 20 | seems to be troublesome with some Ubuntu LTS installations.) 21 | - **Tesseract OCR API** 22 | To install Tesseract: 23 | 24 | 1. `apt-get update` 25 | 1. Install python3 header files: `apt-get install python3-dev` 26 | 2. Install Tesseract and its required libraries: 27 | `apt-get install tesseract-ocr libtesseract-dev libleptonica-dev 28 | libpng12-dev libjpeg62-dev libtiff5-dev zlib1g-dev` 29 | 30 | 31 | 32 | ### Install Procedure 33 | The easiest way to install OCyara is through the use of pip: 34 | 35 | 1. Ensure all the Operating System Requirements listed above have been 36 | met 37 | 3. Run `pip install cython` (has to be installed separate like this 38 | due to tesserocr currently lacking an "install_requires") 39 | 2. Run `pip install ocyara` 40 | 41 | Along with OCyara, the following other packages will be automatically 42 | installed: 43 | - **cython** (>=0.25.2) A compiler for writing C extensions for the 44 | Python language. Used by the tesserocr python module. 45 | https://pypi.python.org/pypi/Cython/ 46 | - **tesserocr** (>=2.1.3) A Python wrapper for the tesseract-ocr API 47 | https://github.com/sirfz/tesserocr 48 | - **yara-python** (>=3.5.0) The Python interface for YARA 49 | https://github.com/VirusTotal/yara-python 50 | - **pillow** (>=4.0.0) Python Imaging Library fork 51 | https://github.com/python-pillow/Pillow 52 | - **tqdm** A fast, extensible progress bar for Python and CLI 53 | https://github.com/tqdm/tqdm 54 | - **colorlog** 55 | A colored formatter for the python logging module 56 | http://pypi.python.org/pypi/colorlog 57 | 58 | 59 | ## Usage 60 | 61 | 62 | ### OCyara Class Usage Examples 63 | 64 | ```python 65 | # Scan the current directory recursively for files that match rules in 66 | # "rulefile.yara" 67 | 68 | from ocyara import OCyara 69 | 70 | ocy = OCyara('./', recursive=True) 71 | ocy.run('rulefile.yara', file_magic=True) 72 | print(ocy.list_matches()) 73 | ``` 74 | 75 | Returns: 76 | ``` 77 | Visa tests/Example.pdf 78 | SSN tests/Example.pdf 79 | American_Express tests/Example.pdf 80 | Diners_Club tests/Example.pdf 81 | JCB tests/Example.pdf 82 | Discover tests/Example.pdf 83 | credit_card tests/Example.pdf 84 | MasterCard tests/Example.pdf 85 | card tests/Example.pdf 86 | ``` 87 | 88 | Each line printed has the rule that was matched and the file that 89 | matched it. 90 | 91 | ### CLI usage Example 92 | OCyara is not primarily intended to be used from the command line, but 93 | basic cli capablilities have been implemented to allow for 94 | easily-approachable testing of the library's core functionality. 95 | 96 | ``` 97 | usage: ocyara.py [-h] YARA_RULES_FILE TARGET_FILE/S` 98 | 99 | positional arguments: 100 | 101 | YARA_RULES_FILE Path of file containing yara rules 102 | TARGET_FILE/S Directory or file name of images to scan. 103 | 104 | optional arguments: 105 | -h, --help show this help message and exit 106 | ``` 107 | 108 | ### OCyara Class Structure 109 | 110 | ``` 111 | class OCyara(builtins.object) 112 | | Performs OCR (Optical Character Recognition) on image files and scans for matches to Yara rules. 113 | | 114 | | OCyara also can process images embedded in PDF files. 115 | | 116 | | Methods defined here: 117 | | 118 | | __call__(self) 119 | | Default call which outputs the results with the same output standard as the regular yara program 120 | | 121 | | __init__(self, path:str, recursive=False, worker_count=6, verbose=0) -> None 122 | | Create an OCyara object that can scan the specified directory or file and store the results. 123 | | 124 | | Arguments: 125 | | path -- File or directory to be processed 126 | | 127 | | Keyword Arguments: 128 | | recursive -- Whether the specified path should be recursivly searched for images (default False) 129 | | worker_count -- The number of worker processes that should be spawned when 130 | | run() is executed (default available CPU cores * 2) 131 | | verbose -- An int() from 0-2 that sets the verbosity level. 132 | | 0 is default, 1 is information and 2 is debug 133 | | 134 | | join(self, showprogress=True) 135 | | 136 | | list_matched_rules(self) -> set 137 | | Process the matchedfiles dictionary and return a list of rules that were matched. 138 | | 139 | | list_matches(self, rules=None) -> typing.Dict 140 | | List matched files and thier contexts (if available) in dictionary form. 141 | | 142 | | Keyword Arguments: 143 | | 144 | | rules -- Accepts a string or list of strings indicating specific rules. 145 | | Only matches pertaining to the specified rule/s will be returned. If no 146 | | rules are specified, all matches will be returned. 147 | | 148 | | run(self, yara_rule:str, auto_join=True, file_magic=False, save_context=False) -> None 149 | | Begin multithreaded processing of path files with the specified rule file. 150 | | 151 | | Arguments: 152 | | yara_rule -- A string file path of a Yara rule file 153 | | 154 | | Keyword Arguments: 155 | | auto_join -- If set to True, the main process will stall until all the 156 | | worker processes have completed their work. If set to False, join() 157 | | must be manually called following run() to ensure the queue is 158 | | cleared and all workers have terminated. 159 | | 160 | | show_progress -- Display a progress bar when join() is used. 161 | | 162 | | file_magic -- If file_magic is enabled, ocyara will examine the contents 163 | | of the target files to determine if they are an eligible image file 164 | | type. For example, a JPEG file named 'picture.txt' will be processed by 165 | | the OCR engine. file_magic uses the Linux "file" command. 166 | | 167 | | save_context -- If True, when a file matches a yara rule, the returned 168 | | results dictionary will also include the full ocr text of the matched 169 | | file. This text can be further processed by the user if needed. 170 | | 171 | | show_progress(self) -> None 172 | | Generate a progress bar based on the number of items remaining in queue. 173 | | 174 | | ---------------------------------------------------------------------- 175 | | Static methods defined here: 176 | | 177 | | check_file_type(path:str) -> str 178 | | Use the Linux "file" command to determine a file's type based on contents 179 | | instead of file extension. 180 | | 181 | | Arguments: 182 | | path -- A string file path to be processed 183 | | 184 | | ---------------------------------------------------------------------- 185 | | Data descriptors defined here: 186 | | 187 | | __dict__ 188 | | dictionary for instance variables (if defined) 189 | | 190 | | __weakref__ 191 | | list of weak references to the object (if defined) 192 | | 193 | | yara_output 194 | | Returns the same output format as the standard yara program: 195 | | RuleName FileName, FileName 196 | | RuleName FileName... 197 | | 198 | | Where: 199 | | RuleName is the name of the rule that was matched 200 | | FileName is the name of the file in which the match was found 201 | ``` 202 | -------------------------------------------------------------------------------- /ocyara/__init__.py: -------------------------------------------------------------------------------- 1 | from .ocyara import OCyara 2 | -------------------------------------------------------------------------------- /ocyara/ocyara.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import argparse 3 | import glob 4 | import io 5 | import os 6 | import tempfile 7 | import tesserocr 8 | import yara 9 | from multiprocessing import Process, JoinableQueue, Lock, Manager, cpu_count 10 | from queue import Empty 11 | from time import sleep 12 | 13 | import colorlog 14 | from PIL import Image 15 | from tqdm import tqdm 16 | import subprocess 17 | from typing import Dict, Set, Tuple, Union 18 | 19 | 20 | class OCyara: 21 | """ 22 | Performs OCR (Optical Character Recognition) on image files and scans for matches to Yara rules. 23 | 24 | OCyara also can process images embedded in PDF files. 25 | """ 26 | 27 | def __init__(self, path: str, recursive=False, worker_count=cpu_count() * 2, verbose=0) -> None: 28 | """ 29 | Create an OCyara object that can scan the specified directory or file and store the results. 30 | 31 | Arguments: 32 | path -- File or directory to be processed 33 | 34 | Keyword Arguments: 35 | recursive -- Whether the specified path should be recursivly searched for images (default False) 36 | worker_count -- The number of worker processes that should be spawned when 37 | run() is executed (default available CPU cores * 2) 38 | verbose -- An int() from 0-2 that sets the verbosity level. 39 | 0 is default, 1 is information and 2 is debug 40 | """ 41 | self.path = path 42 | self.recursive = recursive 43 | self.q = JoinableQueue() 44 | self.results = {} 45 | self.threads = worker_count 46 | self.lock = Lock() 47 | self.workers = [] 48 | if os.path.isdir(self.path): 49 | if self.path[-1] is '/': 50 | self.path += '*' 51 | else: 52 | self.path += '/*' 53 | self.manager = Manager() 54 | self.matchedfiles = None 55 | self.total_items_to_queue = None 56 | self.total_added_to_queue = None 57 | self.queue_items_completed = None 58 | self.tempdir = tempfile.TemporaryDirectory() 59 | handler = colorlog.StreamHandler() 60 | handler.setFormatter(colorlog.ColoredFormatter( 61 | '%(log_color)s%(levelname)s:%(name)s:%(message)s')) 62 | self.logger = colorlog.getLogger('OCyara') 63 | self.logger.addHandler(handler) 64 | if verbose == 1: 65 | self.logger.setLevel('INFO') 66 | elif verbose > 1: 67 | self.logger.setLevel('DEBUG') 68 | else: 69 | self.logger.setLevel('WARN') 70 | 71 | def run(self, yara_rule: str, auto_join=True, show_progress=True, file_magic=False, save_context=False) -> None: 72 | """ 73 | Begin multithreaded processing of path files with the specified rule file. 74 | 75 | Arguments: 76 | yara_rule -- A string file path of a Yara rule file 77 | 78 | Keyword Arguments: 79 | auto_join -- If set to True, the main process will stall until all the 80 | worker processes have completed their work. If set to False, join() 81 | must be manually called following run() to ensure the queue is 82 | cleared and all workers have terminated. 83 | 84 | show_progress -- Display a progress bar when join() is used. 85 | 86 | file_magic -- If file_magic is enabled, ocyara will examine the contents 87 | of the target files to determine if they are an eligible image file 88 | type. For example, a JPEG file named 'picture.txt' will be processed by 89 | the OCR engine. file_magic uses the Linux "file" command. 90 | 91 | save_context -- If True, when a file matches a yara rule, the returned 92 | results dictionary will also include the full ocr text of the matched 93 | file. This text can be further processed by the user if needed. 94 | """ 95 | 96 | # Populate the queue with work 97 | if type(self.path) == str: 98 | self.logger.debug('Input file detected as a path') 99 | if self.recursive: 100 | self.path = self.path.rstrip('/') + '/**' 101 | all_files = glob.glob(self.path, recursive=self.recursive) 102 | handled_file_extensions = ['png', 'jpg', 'jpeg', 'pdf', 'gif', 'bmp'] 103 | handled_mime_types = [ 104 | 'image/png', 'image/jpeg', 'application/pdf', 'image/gif', 'image/x-ms-bmp' 105 | ] 106 | # Intialize counters to 0 and create an empty matchedfiles dict 107 | self.total_items_to_queue = self.manager.list([0]) 108 | self.total_added_to_queue = self.manager.list([0]) 109 | self.queue_items_completed = self.manager.list([0]) 110 | self.matchedfiles = self.manager.list() 111 | self.matchedfiles.append({}) 112 | 113 | # Determine the number of items that will be queued so workers can exit only after queuing is completed 114 | if file_magic: 115 | # Queue files base on file contents 116 | items_to_queue = [ 117 | filepath for filepath in all_files if self.check_file_type(filepath) in handled_mime_types 118 | ] 119 | else: 120 | # Queue files based on extension 121 | items_to_queue = [ 122 | filepath for filepath in all_files if filepath.split('.')[-1] in handled_file_extensions 123 | ] 124 | self.total_items_to_queue[0] = len(items_to_queue) 125 | self.logger.info('{0} items detected and will be added to the Queue'.format(self.total_items_to_queue[0])) 126 | # Create and run the workers 127 | self.logger.info('{0} worker processes being generated to process images. from the ' 128 | 'queue'.format(self.threads)) 129 | for i in range(self.threads): 130 | p = Process(target=self._process_image, args=(yara_rule, save_context)) 131 | self.workers.append(p) 132 | p.start() 133 | # Add items to queue for processing 134 | for filepath in items_to_queue: 135 | # Strip jpegs from PDF files and add them to the queue 136 | if filepath.split('.')[-1].upper() == 'PDF': 137 | self._pdf_extract(filepath) 138 | for jpg_file in glob.glob(self.tempdir.name+'/*.jpg'): 139 | self.total_items_to_queue[0] += 1 140 | self.q.put([Image.open(jpg_file), filepath]) 141 | self.total_added_to_queue[0] += 1 142 | self.total_items_to_queue[0] -= 1 # Negate PNG file itself (vs jpegs) being added earlier 143 | else: 144 | try: 145 | self.q.put([Image.open(filepath), filepath]) 146 | self.total_added_to_queue[0] += 1 147 | except OSError: 148 | self.logger.warning('Warning: {0} is not a proper image file'.format(filepath)) 149 | self.total_items_to_queue[0] -= 1 150 | elif type(self.path) == io.BufferedReader: 151 | self.q.put(Image.open(self.path)) 152 | self.total_added_to_queue[0] += 1 153 | if auto_join: 154 | self.join(show_progress) 155 | 156 | def show_progress(self) -> None: 157 | """Generate a progress bar based on the number of items remaining in queue.""" 158 | previous_queue_items_completed = 0 159 | with tqdm(total=self.total_added_to_queue[0], desc='Processing Images', unit='Image') as progressbar: 160 | while True: 161 | difference = self.queue_items_completed[0] - previous_queue_items_completed 162 | previous_queue_items_completed = self.queue_items_completed[0] 163 | progressbar.update(difference) 164 | if self.queue_items_completed[0] == self.total_added_to_queue[0]: 165 | break 166 | sleep(.25) 167 | 168 | def join(self, showprogress=True): 169 | if showprogress: 170 | self.show_progress() 171 | self.q.join() 172 | for worker in self.workers: 173 | worker.join() 174 | 175 | def list_matches(self, rules_matched=None) -> Dict[str, Set[Tuple[str, Union[str, None]]]]: 176 | """ 177 | List matched files and thier contexts (if available) in dictionary form. 178 | 179 | Keyword Arguments: 180 | 181 | rules -- Accepts a string or list of strings indicating specific rules. 182 | Only matches pertaining to the specified rule/s will be returned. If no 183 | rules are specified, all matches will be returned. 184 | """ 185 | matches_to_return = {} 186 | if type(rules_matched) is str: 187 | rules_matched = [rules_matched] 188 | if rules_matched is None: 189 | rules_matched = self.list_matched_rules() 190 | # Step through each matched file and see if they matched any of the rules we're interested in. 191 | for filepath, matchedrules_with_contexts in self.matchedfiles[0].items(): 192 | for matchedrulename, context in matchedrules_with_contexts: 193 | for rulename in rules_matched: 194 | if matchedrulename == rulename: 195 | try: 196 | matches_to_return[rulename].add((filepath, context)) 197 | except KeyError: 198 | matches_to_return[rulename] = {(filepath, context)} 199 | return matches_to_return 200 | 201 | def list_matched_rules(self) -> set: 202 | """Process the matchedfiles dictionary and return a list of rules that were matched.""" 203 | rules = set() 204 | for filepath, matchedrules in self.matchedfiles[0].items(): 205 | [rules.add(matchedrule[0]) for matchedrule in matchedrules] 206 | return rules 207 | 208 | def _process_image(self, yara_rule: str, save_context: bool) -> None: 209 | """ 210 | Perform OCR and yara rule matching as a worker. 211 | 212 | process_image() is used by the run() method to create multiple worker processes for 213 | parallel execution. process_image normally will not be called directly. 214 | 215 | Arguments: 216 | yara_rule -- File path pointing to a Yara rule file 217 | """ 218 | context = None 219 | handler = colorlog.StreamHandler() 220 | handler.setFormatter(colorlog.ColoredFormatter( 221 | '%(log_color)s%(levelname)s:%(name)s:%(message)s')) 222 | # Creates a logger object for the individual workers that contains the PID as part of the message header 223 | worker_logger = colorlog.getLogger('worker_'+str(os.getpid())) 224 | worker_logger.addHandler(handler) 225 | worker_logger.setLevel(self.logger.level) 226 | worker_logger.info('PID {0} created to process queue'.format(str(os.getpid()))) 227 | while True: 228 | try: 229 | image, filepath = self.q.get(timeout=.25) 230 | except Empty: 231 | if self.total_added_to_queue[0] == self.total_items_to_queue[0]: 232 | worker_logger.debug('Queue Empty PID %d exiting' % os.getpid()) 233 | return 234 | else: 235 | worker_logger.debug('Queue still loading') 236 | continue 237 | ocrtext = tesserocr.image_to_text(image) 238 | try: 239 | rules = yara.compile(yara_rule) 240 | except yara.Error: 241 | worker_logger.error('Invalid rule file/rule file not found: {0}'.format(yara_rule)) 242 | matches = rules.match(data=ocrtext) 243 | # If there is a match, store the filename and the rule in a dictionary local to this process. 244 | # Create an editable copy of the master manager dict. 245 | with self.lock: 246 | local_results_dict = self.matchedfiles[0] 247 | if matches: 248 | if save_context: 249 | context = ocrtext 250 | for x in matches: 251 | try: 252 | local_results_dict[filepath].append((x.rule, context)) 253 | except KeyError: 254 | local_results_dict[filepath] = [(x.rule, context)] 255 | self.matchedfiles[0] = local_results_dict 256 | self.queue_items_completed[0] += 1 257 | self.q.task_done() 258 | 259 | def _pdf_extract(self, pdffile: str) -> None: 260 | """ 261 | Extract jpg images from pdf files and save them to temp directory. 262 | 263 | pdf_extract is used by the run() method and not be called directly in most 264 | circumstances. 265 | 266 | Arguments: 267 | pdffile -- A string file path pointing to a PDF 268 | """ 269 | self.logger.info('Opening %s and extracting JPG images' % pdffile) 270 | with open(pdffile, "rb") as file: 271 | pdf = file.read() 272 | 273 | startmark = b"\xff\xd8" 274 | startfix = 0 275 | endmark = b"\xff\xd9" 276 | endfix = 2 277 | i = 0 278 | njpg = 0 279 | while True: 280 | istream = pdf.find(b"stream", i) 281 | if istream < 0: 282 | break 283 | istart = pdf.find(startmark, istream, istream + 20) 284 | if istart < 0: 285 | i = istream + 20 286 | continue 287 | iend = pdf.find(b"endstream", istart) 288 | if iend < 0: 289 | raise Exception("Didn't find end of stream!") 290 | iend = pdf.find(endmark, iend - 20) 291 | if iend < 0: 292 | raise Exception("Didn't find end of JPG!") 293 | 294 | istart += startfix 295 | iend += endfix 296 | jpg = pdf[istart:iend] 297 | self.logger.debug('Creating temporary file ' + self.tempdir.name + "/jpg%d.jpg" % njpg) 298 | with open(self.tempdir.name + "/jpg%d.jpg" % njpg, "wb") as jpgfile: 299 | jpgfile.write(jpg) 300 | njpg += 1 301 | i = iend 302 | 303 | @staticmethod 304 | def check_file_type(path: str) -> str: 305 | """ 306 | Use the Linux "file" command to determine a file's type based on contents 307 | instead of file extension. 308 | 309 | Arguments: 310 | path -- A string file path to be processed 311 | """ 312 | process = subprocess.run(['file', '--mime-type', '-b', path], stdout=subprocess.PIPE) 313 | filemimetype = process.stdout.decode("utf-8").strip() 314 | return filemimetype 315 | 316 | def __call__(self): 317 | """Default call which outputs the results with the same output standard as the regular yara program """ 318 | print(ocy.yara_output) 319 | 320 | @property 321 | def yara_output(self) -> str: 322 | """ 323 | Returns the same output format as the standard yara program: 324 | RuleName FileName, FileName 325 | RuleName FileName... 326 | 327 | Where: 328 | RuleName is the name of the rule that was matched 329 | FileName is the name of the file in which the match was found 330 | """ 331 | output_text = '' 332 | for rule, matched_files_and_contexts in self.list_matches().items(): 333 | for matched_file_and_context in matched_files_and_contexts: 334 | output_text += rule + ' ' + matched_file_and_context[0] + '\n' 335 | return output_text 336 | 337 | 338 | if __name__ == '__main__': 339 | parser = argparse.ArgumentParser(description='OCyara performs OCR (Optical Character Recognition) on image ' 340 | 'files and scans them for matches to Yara rules ' 341 | '(https://virustotal.github.io/yara/). OCyara also can process images ' 342 | 'embedded in PDF files.') 343 | parser.add_argument('YARA_RULES_FILE', type=str, help='Path of file containing yara rules') 344 | parser.add_argument('TARGET_FILES', type=str, help='Directory or file name of images to scan.') 345 | parser.add_argument('-v', action='count', help='Enables verbose output, -v for verbose or -vv for very verbose', 346 | default=0) 347 | args = parser.parse_args() 348 | ocy = OCyara(args.TARGET_FILES, verbose=args.v) 349 | ocy.run(args.YARA_RULES_FILE) 350 | ocy() 351 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | ocyara 2 | Pillow>=4.0.0 3 | tqdm 4 | Cython>=0.25.2 5 | tesserocr>=2.1.3 6 | yara-python>=3.5.0 7 | colorlog -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | setup( 4 | name='OCyara', 5 | version='1.0.1', 6 | packages=find_packages(), 7 | url='https://github.com/bandrel/OCyara', 8 | license='GPL v3', 9 | author='Bandrel & ryman1', 10 | author_email='example@example.com', 11 | description='A Yara rule engine that scans images for matches using Optical Character Recognition (OCR). ' 12 | 'See the Github page for more information about the Cython, Tesseract, and Leptonica prerequsites.', 13 | install_requires=['Pillow>=4.0.0', 'tqdm', 'Cython>=0.25.2', 'tesserocr>=2.1.3', 'yara-python>=3.5.0', 'colorlog'] 14 | ) 15 | -------------------------------------------------------------------------------- /tests/Example.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bandrel/OCyara/4dfd5bd1c586f4b4bfa01572ef511e3f19039dd9/tests/Example.pdf -------------------------------------------------------------------------------- /tests/SSN-example-png-as.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bandrel/OCyara/4dfd5bd1c586f4b4bfa01572ef511e3f19039dd9/tests/SSN-example-png-as.jpg -------------------------------------------------------------------------------- /tests/SSN-example-png-as.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bandrel/OCyara/4dfd5bd1c586f4b4bfa01572ef511e3f19039dd9/tests/SSN-example-png-as.txt -------------------------------------------------------------------------------- /tests/SSN-example.bmp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bandrel/OCyara/4dfd5bd1c586f4b4bfa01572ef511e3f19039dd9/tests/SSN-example.bmp -------------------------------------------------------------------------------- /tests/SSN-example.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bandrel/OCyara/4dfd5bd1c586f4b4bfa01572ef511e3f19039dd9/tests/SSN-example.gif -------------------------------------------------------------------------------- /tests/SSN-example.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bandrel/OCyara/4dfd5bd1c586f4b4bfa01572ef511e3f19039dd9/tests/SSN-example.jpg -------------------------------------------------------------------------------- /tests/SSN-example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bandrel/OCyara/4dfd5bd1c586f4b4bfa01572ef511e3f19039dd9/tests/SSN-example.png -------------------------------------------------------------------------------- /tests/SSN-example.tif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bandrel/OCyara/4dfd5bd1c586f4b4bfa01572ef511e3f19039dd9/tests/SSN-example.tif -------------------------------------------------------------------------------- /tests/ascii-file-as.jpg: -------------------------------------------------------------------------------- 1 | 123-45-6789 2 | -------------------------------------------------------------------------------- /tests/example.yara: -------------------------------------------------------------------------------- 1 | rule SSN 2 | { 3 | strings: 4 | $a = /\d{3}-?\d{2}-?\d{4}/ 5 | condition: 6 | $a 7 | } 8 | 9 | rule credit_card 10 | { 11 | strings: 12 | $a = /\d{16}/ 13 | condition: 14 | $a 15 | } 16 | 17 | rule card 18 | { 19 | strings: 20 | $a = /[Cc]ard/ 21 | condition: 22 | $a 23 | } 24 | rule Visa 25 | { 26 | strings: 27 | $visa = /\b4[0-9]{12}([0-9]{3})?\b/ 28 | condition: 29 | $visa 30 | } 31 | rule MasterCard 32 | { 33 | strings: 34 | $mc = /\b(5[1-5][0-9]{2}|222[1-9]|22[3-9][0-9]|2[3-6][0-9]{2}|27[01][0-9]|2720)[0-9]{12}\b/ 35 | condition: 36 | $mc 37 | } 38 | rule American_Express 39 | { 40 | strings: 41 | $amex = /\b3[47][0-9]{13}\b/ 42 | condition: 43 | $amex 44 | } 45 | rule Diners_Club 46 | { 47 | strings: 48 | $diners = /\b3(0[0-5]|[68][0-9])[0-9]{11}\b/ 49 | condition: 50 | $diners 51 | } 52 | rule Discover 53 | { 54 | strings: 55 | $discover = /\b6(011|5[0-9]{2})[0-9]{12}\b/ 56 | condition: 57 | $discover 58 | } 59 | rule JCB 60 | { 61 | strings: 62 | $jcb = /\b(2131|1800|35\d{3})\d{11}\b/ 63 | condition: 64 | $jcb 65 | } 66 | 67 | rule Bogus 68 | { 69 | strings: 70 | $elephant = "Elephant" // just an dummy rule, that should not match in the examples 71 | condition: 72 | $elephant 73 | } 74 | -------------------------------------------------------------------------------- /tests/test_example_pdf.py: -------------------------------------------------------------------------------- 1 | #!/usr/env python3 2 | from ocyara import OCyara 3 | 4 | 5 | def num_unique_rule_matches(): 6 | return len(ocy.list_matched_rules()) 7 | 8 | 9 | def test_number_of_rules(): 10 | assert num_unique_rule_matches() == 9 11 | 12 | 13 | def test_example_pdf_rules(): 14 | assert ocy.list_matched_rules() == {'card', 15 | 'SSN', 16 | 'credit_card', 17 | 'JCB', 18 | 'Diners_Club', 19 | 'Visa', 20 | 'American_Express', 21 | 'MasterCard', 22 | 'Discover' 23 | } 24 | 25 | 26 | def test_dict_matches(): 27 | assert ocy.matchedfiles[0] == { 28 | 'tests/Example.pdf': [('SSN', None), ('credit_card', None), ('card', None), ('Visa', None), 29 | ('MasterCard', None), ('American_Express', None), ('Diners_Club', None), 30 | ('Discover', None), ('JCB', None)] 31 | } 32 | 33 | 34 | ocy = OCyara('tests/Example.pdf') 35 | ocy.run('tests/example.yara') 36 | -------------------------------------------------------------------------------- /tests/test_logging.py: -------------------------------------------------------------------------------- 1 | #!/usr/env python3 2 | from ocyara import OCyara 3 | 4 | 5 | def test_valid_log_levels(): 6 | keywords = [0, 1, 2, 3, -1] 7 | for verbose_level in keywords: 8 | try: 9 | ocy = OCyara('tests/Example.pdf', verbose=verbose_level) 10 | except TypeError: 11 | assert False 12 | 13 | 14 | def test_invalid_log_levels(): 15 | keywords = ['Foo', '', None] 16 | for verbose_level in keywords: 17 | try: 18 | ocy = OCyara('tests/Example.pdf', verbose=verbose_level) 19 | assert False 20 | except TypeError: 21 | continue 22 | assert True 23 | -------------------------------------------------------------------------------- /tests/test_magic.py: -------------------------------------------------------------------------------- 1 | #!/usr/env python3 2 | from ocyara import OCyara 3 | 4 | 5 | def test_png(): 6 | assert OCyara.check_file_type('tests/SSN-example.png') == 'image/png' 7 | 8 | 9 | def test_jpg(): 10 | assert OCyara.check_file_type('tests/SSN-example.jpg') == 'image/jpeg' 11 | 12 | 13 | def test_pdf(): 14 | assert OCyara.check_file_type('tests/Example.pdf') == 'application/pdf' 15 | 16 | 17 | def test_tiff(): 18 | assert OCyara.check_file_type('tests/SSN-example.tif') == 'image/tiff' 19 | 20 | 21 | def test_gif(): 22 | assert OCyara.check_file_type('tests/SSN-example.gif') == 'image/gif' 23 | 24 | 25 | def test_bmp(): 26 | assert OCyara.check_file_type('tests/SSN-example.bmp') == 'image/x-ms-bmp' 27 | 28 | 29 | def test_png_as_txt(): 30 | assert OCyara.check_file_type('tests/SSN-example-png-as.txt') == 'image/png' 31 | 32 | 33 | def test_png_as_jpg(): 34 | assert OCyara.check_file_type('tests/SSN-example-png-as.jpg') == 'image/png' 35 | -------------------------------------------------------------------------------- /tests/test_path.py: -------------------------------------------------------------------------------- 1 | #!/usr/env python3 2 | from ocyara import OCyara 3 | 4 | 5 | def num_unique_rule_matches(): 6 | return len(ocy.list_matched_rules()) 7 | 8 | 9 | def test_number_of_rules(): 10 | assert num_unique_rule_matches() == 9 11 | 12 | 13 | def test_example_pdf_rules(): 14 | assert ocy.list_matched_rules() == { 15 | 'card', 16 | 'SSN', 17 | 'credit_card', 18 | 'JCB', 19 | 'Diners_Club', 20 | 'Visa', 21 | 'American_Express', 22 | 'MasterCard', 23 | 'Discover' 24 | } 25 | 26 | 27 | def test_dict_matches(): 28 | findings = list(map(ocy.matchedfiles[0].get, [ 29 | 'tests/SSN-example.png', 'tests/SSN-example-png-as.jpg', 'tests/Example.pdf' 30 | ])) 31 | 32 | assert findings == [ 33 | [('SSN', None)], 34 | [('SSN', None)], 35 | [ 36 | ('SSN', None), ('credit_card', None), ('card', None), ('Visa', None), ('MasterCard', None), 37 | ('American_Express', None), ('Diners_Club', None), ('Discover', None), ('JCB', None) 38 | ] 39 | ] 40 | 41 | 42 | def test_list_files_matching_rules(): 43 | ssn_matches = ocy.list_matches('SSN') 44 | mastercard_matches = ocy.list_matches('MasterCard') 45 | assert (ssn_matches['SSN'], mastercard_matches['MasterCard']) == ( 46 | { 47 | ('tests/Example.pdf', None), 48 | ('tests/SSN-example.jpg', None), 49 | ('tests/SSN-example-png-as.jpg', None), 50 | ('tests/SSN-example.png', None), 51 | ('tests/SSN-example.bmp', None) 52 | }, 53 | { 54 | ('tests/Example.pdf', None) 55 | } 56 | ) 57 | 58 | 59 | def test_list_files_matching_rules_with_context(): 60 | ocy2 = OCyara('tests/') 61 | ocy2.run('tests/example.yara', save_context=True) 62 | jcb_matches = ocy2.list_matches('JCB') 63 | assert jcb_matches['JCB'] == ( 64 | { 65 | ('tests/Example.pdf', 'Testing1234\n' 66 | '0001273456\n' 67 | '000123456\n' 68 | '\n' 69 | 'Test credit card numbers\n' 70 | 'American Express\n' 71 | '\n' 72 | 'American Express\n' 73 | '\n' 74 | 'American Express Corporate\n' 75 | 'Australian BankCard\n' 76 | '\n' 77 | 'Diners Ciub\n' 78 | '\n' 79 | 'Diners Club\n' 80 | 'Discover\n' 81 | 'Discover\n' 82 | 'JCB\n' 83 | '\n' 84 | 'JCB\n' 85 | 'MasterCard\n' 86 | 'MasterCard\n' 87 | 'Visa\n' 88 | '\n' 89 | 'Visa\n' 90 | '\n' 91 | 'Visa\n' 92 | '\n' 93 | '378282246310005\n' 94 | '\n' 95 | '371449635398431\n' 96 | '\n' 97 | '378734493671000\n' 98 | '\n' 99 | '5610591081018250\n' 100 | '\n' 101 | '30569309025904\n' 102 | '\n' 103 | '38520000023237\n' 104 | '\n' 105 | '6011111111111117\n' 106 | '\n' 107 | '6011000990139424\n' 108 | '\n' 109 | '3530111333300000\n' 110 | '\n' 111 | '3566002020360505\n' 112 | '\n' 113 | '5555555555554444\n' 114 | '\n' 115 | '5105105105105100\n' 116 | '\n' 117 | '4111111111111111\n' 118 | '\n' 119 | '4012888888881881\n' 120 | '\n' 121 | '4222222222222\n' 122 | '\n' 123 | ) 124 | } 125 | ) 126 | 127 | 128 | def test_yara_output(): 129 | assert sorted(ocy.yara_output.strip().split('\n')) == [ 130 | 'American_Express tests/Example.pdf', 131 | 'Diners_Club tests/Example.pdf', 132 | 'Discover tests/Example.pdf', 133 | 'JCB tests/Example.pdf', 134 | 'MasterCard tests/Example.pdf', 135 | 'SSN tests/Example.pdf', 136 | 'SSN tests/SSN-example-png-as.jpg', 137 | 'SSN tests/SSN-example.bmp', 138 | 'SSN tests/SSN-example.jpg', 139 | 'SSN tests/SSN-example.png', 140 | 'Visa tests/Example.pdf', 141 | 'card tests/Example.pdf', 142 | 'credit_card tests/Example.pdf' 143 | ] 144 | 145 | ocy = OCyara('tests/') 146 | ocy.run('tests/example.yara') 147 | 148 | 149 | def test_ocyara_rerun(): 150 | ocy_rerun_test = OCyara('tests/') 151 | ocy_rerun_test.run('tests/example.yara') 152 | ocy_rerun_test.run('tests/example.yara') 153 | assert ocy_rerun_test.list_matched_rules() == { 154 | 'card', 155 | 'SSN', 156 | 'credit_card', 157 | 'JCB', 158 | 'Diners_Club', 159 | 'Visa', 160 | 'American_Express', 161 | 'MasterCard', 162 | 'Discover' 163 | } 164 | --------------------------------------------------------------------------------