├── .gitignore ├── LICENSE ├── README.md ├── config.py ├── dictionaries └── README.md ├── dst ├── __init__.py ├── dispatchers.py ├── libraries │ ├── __init__.py │ ├── al.py │ ├── dictionary_filter.py │ └── multiplier.py ├── listeners.py ├── miners.py ├── output.py └── worker.py ├── generate_model.py └── main.py /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | *.pyc 3 | -------------------------------------------------------------------------------- /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 | # Don't Skype & Type! 2 | 3 | S&T is a novel, powerful, and open-source research tool for keyboard acoustic eavesdropping. 4 | 5 | It allows users to perform *keyboard acoustic eavesdropping* attacks: training a Machine Learning model on the different 6 | noise of each key of someone's keyboard, and then use this model to understand what he's typing from keystroke noise 7 | alone. 8 | 9 | Don't Skype & Type! is a research project from [SPRITZ Group](http://spritz.math.unipd.it) (University of Padua, IT), and [SPROUT](http://sprout.ics.uci.edu) (UC Irvine, USA). 10 | For further information see our project webpage: http://spritz.math.unipd.it/projects/dst/ 11 | 12 | If you use our tool in your own research, please cite our paper: 13 | 14 | Compagno, A., Conti, M., Lain, D., & Tsudik, G. (2017, April). 15 | Don't Skype & Type!: Acoustic Eavesdropping in Voice-Over-IP. 16 | In Proceedings of the 2017 ACM on Asia Conference on Computer and Communications Security (pp. 703-715). ACM. 17 | 18 | 19 | ## Introduction 20 | 21 | S&T is built around the concept of *operator chains*, concatenated basic blocks that provide functionalities. 22 | This modular design allows for customization of every operation. 23 | 24 | A chain is composed of four main blocks: a *Listener*, a *Dispatcher*, a *Model*, and an *Output*. 25 | 26 | On each block, a different function can be loaded (provided that it can work with its previous and next block), as long 27 | as the correct interface is implemented. Each function has its own *subprocess*, and communicates using 28 | `multiprocessing.Queue` objects. 29 | 30 | *Listener* functions are responsible of loading sound and passing it to a *Dispatcher*, that extracts keypress sounds 31 | from the audio file or stream, and passes it to a trained *Model* that performs classification. Finally, results are 32 | passed to *Output* operators, that show classification results. 33 | 34 | ## Usage 35 | 36 | First, you need to create a `sklearn.Pipeline` containing a classifier, plus any other data transformation 37 | you want. 38 | 39 | A convenient way to create it is to use `generate_model`, passing training data to it: 40 | 41 | > generate_model.py training_files_and_folders output_model [...] 42 | 43 | Which will take as training data all the files passed as arguments, and all the files contained in folders that are 44 | passed as arguments. The trained model will be saved in the specified location. 45 | Please note: acoustic training data needs to be .wav (Microsoft), 32bit float PCM. 46 | For each .wav file passed as training, a corresponding .txt file with identical name needs to contain its ground truth, 47 | **one target/character per line**. NOTE: spaces are not allowed as characters in ground truth -- please replace them with another 48 | character. 49 | 50 | When launching S&T, operator chains can be specified manually through CLI parameters, such as: 51 | 52 | > main.py --listener wavfile --dispatcher offline ... 53 | 54 | or convenient *opmodes*, that automatically load blocks, can be used: 55 | 56 | > main.py --opmode from_file 57 | 58 | More information about each block, possible options, and usage can be found on the `User Guide`_. 59 | 60 | ## Examples 61 | 62 | Generate a model from training data in file1.wav, file1.txt, and all files in folder1 and folder2, and save it in folder3/model: 63 | 64 | > generate_model.py file1.wav file1.txt folder1 folder2 folder3/model 65 | 66 | Run S&T on target.wav, using the pipeline saved in folder3/model: 67 | 68 | > main.py --opmode from_file --target target.wav --pipeline folder3/model 69 | 70 | Run S&T on target.wav, using the pipeline saved in folder3/model, manually specifying a listener and dispatcher block: 71 | 72 | > main.py --listener wavfile --dispatcher offline --target target.wav --pipeline folder3/model 73 | 74 | ## Requirements 75 | 76 | Eventually, this software will have a proper installer and dependency management. 77 | For now, you'll need to install dependencies manually: 78 | 79 | sklearn 80 | numpy 81 | python_speech_features 82 | 83 | Additionally, if you want to fully leverage S&T against words in a known language, please provide your own dictionaries 84 | in the /dictionaries folder. 85 | 86 | ## TODO 87 | 88 | - Finish proper documentation and generate it 89 | - Upload unit tests 90 | -------------------------------------------------------------------------------- /config.py: -------------------------------------------------------------------------------- 1 | class Config: 2 | def __init__(self): 3 | pass 4 | 5 | VERSION = "1.0" 6 | PROJECT_URL = "http://spritz.math.unipd.it/projects/dst" 7 | LICENSE = "GPLv3" 8 | SPLASHSCREEN = """ 9 | SSSSSSSSSSSSSSS &&&&&&&&&& TTTTTTTTTTTTTTTTTTTTTTT 10 | SS:::::::::::::::S &::::::::::& T:::::::::::::::::::::T 11 | S:::::SSSSSS::::::S &::::&&&:::::&T:::::::::::::::::::::T 12 | S:::::S SSSSSSS &::::& &::::&T:::::TT:::::::TT:::::T 13 | S:::::S &::::& &::::&TTTTTT T:::::T TTTTTT 14 | S:::::S &::::&&&::::& T:::::T 15 | S::::SSSS &::::::::::& T:::::T 16 | SS::::::SSSSS &:::::::&& T:::::T 17 | SSS::::::::SS &::::::::& &&&& T:::::T 18 | SSSSSS::::S &:::::&&::& &:::& T:::::T 19 | S:::::S&:::::& &::&&:::&& T:::::T 20 | S:::::S&:::::& &:::::& T:::::T 21 | SSSSSSS S:::::S&:::::& &::::& TT:::::::TT 22 | S::::::SSSSSS:::::S&::::::&&&&::::::&& T:::::::::T 23 | S:::::::::::::::SS &&::::::::&&&::::& T:::::::::T 24 | SSSSSSSSSSSSSSS &&&&&&&& &&&&& TTTTTTTTTTT 25 | 26 | Skype&Type! Attack - v{} 27 | {} 28 | 29 | 30 | SPRITZ Group (www.spritz.math.unipd.it) 31 | - Dr. Alberto Compagno (Sapienza University of Rome, IT) 32 | - Prof. Mauro Conti (Univ. of Padua, IT) 33 | - M.Sc. Daniele Lain (Univ. of Padua, IT) 34 | 35 | SPROUT Group (sprout.ics.uci.edu) 36 | - Prof. Gene Tsudik (UC Irvine, USA) 37 | 38 | This Software developed by Daniele Lain 39 | 40 | 2017 - {} 41 | ___________________________________________________________ 42 | """.format(VERSION, PROJECT_URL, LICENSE).split("\n") 43 | 44 | # Dispatcher options 45 | dispatcher_threshold = 90 46 | dispatcher_min_interval = 8000 47 | dispatcher_window_size = 100 48 | dispatcher_step_size = 1 49 | dispatcher_persistence = True 50 | # Number of worker processes 51 | workers = 4 52 | # Output options 53 | dict_sep_threshold = 5 54 | dict_folder = 'dictionaries' 55 | 56 | 57 | CONFIG = Config() 58 | -------------------------------------------------------------------------------- /dictionaries/README.md: -------------------------------------------------------------------------------- 1 | Please put here your dictionary files, to leverage S&T against words and sentences. 2 | -------------------------------------------------------------------------------- /dst/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SPRITZ-Research-Group/Skype-Type/1f24f560fedc262ce564e0b5c822e0f0a417bd61/dst/__init__.py -------------------------------------------------------------------------------- /dst/dispatchers.py: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | from dst.libraries import al 3 | import warnings 4 | 5 | warnings.filterwarnings("ignore") 6 | 7 | 8 | def offline(in_queue, out_queue, display_queue, config): 9 | """ 10 | 11 | :param in_queue: Queue to receive audio file 12 | :type in_queue: multiprocessing.Queue 13 | :param out_queue: Queue where to put extracted keypress samples 14 | :type out_queue: multiprocessing.Queue 15 | :param display_queue: Queue where to put visual information to be displayed 16 | :type display_queue: multiprocessing.Queue 17 | :param config: a Config object 18 | :type config: Config 19 | :return: None 20 | :rtype: 21 | """ 22 | for data in iter(in_queue.get, None): 23 | rem = len(data) % 441 24 | data = np.array(data[:len(data) - rem]) 25 | minimum_interval = config.dispatcher_min_interval 26 | sample_length = (44100 * config.dispatcher_window_size) / 1000 27 | 28 | persistence = config.dispatcher_persistence 29 | 30 | peaks = [] 31 | for x in range(0, len(data) - 440): 32 | peaks.append(np.sum(np.absolute(np.fft.fft(data[x:x + 440])))) 33 | 34 | peaks = np.array(peaks) 35 | tau = np.percentile(peaks, config.dispatcher_threshold) 36 | 37 | x = 0 38 | events = [] 39 | step = config.dispatcher_step_size 40 | past_x = - minimum_interval - step 41 | idx = 0 42 | while x < peaks.size: 43 | if peaks[x] >= tau: 44 | if x - past_x >= minimum_interval: 45 | # It is a keypress event (maybe) 46 | keypress = al.normalize(data[x:x + sample_length]) 47 | past_x = x 48 | # Pass it immediately to workers 49 | out_queue.put([idx, keypress]) 50 | idx += 1 51 | # Display event point 52 | # display_queue.put(x) 53 | events.append(keypress) 54 | x = past_x + minimum_interval 55 | else: 56 | x += step 57 | 58 | display_queue.put(len(events)) 59 | # If persistence, save stuff to path 60 | # TODO implement it 61 | if persistence: 62 | pass 63 | 64 | # Send termination flag to workers 65 | for _x in xrange(config.workers): 66 | out_queue.put((-1, None)) 67 | -------------------------------------------------------------------------------- /dst/libraries/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SPRITZ-Research-Group/Skype-Type/1f24f560fedc262ce564e0b5c822e0f0a417bd61/dst/libraries/__init__.py -------------------------------------------------------------------------------- /dst/libraries/al.py: -------------------------------------------------------------------------------- 1 | import os 2 | import math 3 | import warnings 4 | import numpy as np 5 | import scipy.io.wavfile as wav 6 | 7 | 8 | def is_sequence(arg): 9 | return (not hasattr(arg, "strip") and 10 | hasattr(arg, "__getitem__") or 11 | hasattr(arg, "__iter__")) and not isinstance(arg, np.float64) 12 | 13 | 14 | def split_channels(data): 15 | return data[:, 0].astype(float), data[:, 1].astype(float) 16 | 17 | 18 | def __read_wav(filename): 19 | meta, data = wav.read(filename) 20 | data = np.array(data) 21 | try: 22 | ch1, ch2 = split_channels(data) 23 | except IndexError: 24 | warnings.warn('Given audio is mono') 25 | ch1, ch2 = data, np.zeros(len(data)) 26 | if filename.find('_') != -1: 27 | letter = filename.split('_')[-2] 28 | else: 29 | letter = '' 30 | return (ch1, ch2), normalize(ch1 + ch2), letter 31 | 32 | 33 | def __read_text(filename): 34 | return [], np.loadtxt(filename), os.path.splitext(filename)[0][-1] 35 | 36 | 37 | def reader(filename): 38 | if os.path.splitext(filename)[1] == '.wav': 39 | return __read_wav(filename) 40 | else: 41 | return __read_text(filename) 42 | 43 | 44 | def load(path): 45 | if os.path.isdir(path): 46 | stereo = {} 47 | mono = {} 48 | for filename in os.listdir(path): 49 | stereo_data, mono_data, letter = reader(path + filename) 50 | stereo[letter], mono[letter] = stereo_data, mono_data 51 | return stereo, mono 52 | else: 53 | stereo, mono, letter = reader(path) 54 | return stereo, mono 55 | 56 | 57 | def rms(series): 58 | return math.sqrt(sum(series ** 2) / series.size) 59 | 60 | 61 | def normalize(series): 62 | return series / rms(series) 63 | -------------------------------------------------------------------------------- /dst/libraries/dictionary_filter.py: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | import os 3 | 4 | 5 | def dictionary_filter(guesses, wl, howmany=50): 6 | 7 | wl = [x for x in wl if len(x) == len(guesses)] 8 | 9 | def score(word): 10 | penalty = 0 11 | for guess, letter in zip(guesses, word): 12 | if letter in guess: 13 | penalty += guess.index(letter) 14 | else: 15 | penalty += 10 16 | return penalty 17 | 18 | wls = sorted([(x, score(x)) for x in wl], key=lambda _x: _x[1]) 19 | 20 | return wls[:howmany] 21 | 22 | 23 | def dictionary_interactive(preds, config): 24 | ans = raw_input("ARE THESE WORDS? [Y/n] ") 25 | if ans == 'n': 26 | return 27 | separators = raw_input("Which are the word separators? (separated with spaces): ").split(" ") 28 | 29 | proposals = [i for i, x in enumerate(preds) if len(set(separators) & set(x)) and 30 | min([x.index(c) for c in set(separators) & set(x)]) < config.dict_sep_threshold] 31 | ans = raw_input("Hint me the correct word segmentation (Suggested spaces in {}): ".format(proposals)) 32 | if ans == '': 33 | spaces = proposals + [len(preds)] 34 | else: 35 | spaces = [int(x) for x in ans.split(" ")] + [len(preds)] 36 | last_idx = 0 37 | 38 | dictionaries = [] 39 | for r, d, fs in os.walk(config.dict_folder): 40 | for fn in fs: 41 | dictionaries.append(os.path.abspath(os.path.join(r, fn))) 42 | if len(dictionaries) == 0: 43 | print "No dictionaries available!" 44 | return 45 | print "Available dictionaries:" 46 | for i, d in enumerate(dictionaries): 47 | print "{} - {}".format(i, d) 48 | ans = raw_input("Select dictionary number ([0]): ") or 0 49 | 50 | wl = np.loadtxt(dictionaries[int(ans)], dtype=str) 51 | for space in spaces: 52 | word_guesses = preds[last_idx:space] 53 | print "WORD FROM CHARACTER {} to {}".format(last_idx, space) 54 | print dictionary_filter(word_guesses, wl, 30) 55 | print "" 56 | last_idx = space + 1 57 | -------------------------------------------------------------------------------- /dst/libraries/multiplier.py: -------------------------------------------------------------------------------- 1 | def multiplier(in_queue, out_queues): 2 | for res in iter(in_queue.get, None): 3 | for out in out_queues: 4 | out.put(res) 5 | -------------------------------------------------------------------------------- /dst/listeners.py: -------------------------------------------------------------------------------- 1 | from dst.libraries import al 2 | import warnings 3 | 4 | warnings.filterwarnings("ignore") 5 | 6 | 7 | def wavfile(in_file, out_queue, config): 8 | _, mono = al.load(in_file) 9 | out_queue.put(list(mono)) 10 | out_queue.put(None) 11 | 12 | 13 | def input_recording(): 14 | pass 15 | 16 | 17 | def input_interactive(): 18 | pass 19 | -------------------------------------------------------------------------------- /dst/miners.py: -------------------------------------------------------------------------------- 1 | import python_speech_features as sf 2 | from sklearn.base import BaseEstimator, ClassifierMixin 3 | import numpy as np 4 | 5 | 6 | class BaseMiner(BaseEstimator, ClassifierMixin): 7 | def fit(self, X, y): 8 | return self 9 | 10 | 11 | class MFCC(BaseMiner): 12 | @staticmethod 13 | def transform(X): 14 | return np.array([sf.mfcc(sample, 44100, 0.01, 0.0025, 32, 32, preemph=0, highfreq=12000, ceplifter=0, 15 | appendEnergy=False).flatten() for sample in X]) 16 | -------------------------------------------------------------------------------- /dst/output.py: -------------------------------------------------------------------------------- 1 | from dst.libraries.dictionary_filter import dictionary_interactive 2 | 3 | 4 | def console(in_queue, config): 5 | for s_line in config.SPLASHSCREEN: 6 | print s_line 7 | output = [] 8 | for idx, pred in iter(in_queue.get, None): 9 | output.append(pred) 10 | 11 | print "PREDICTIONS" 12 | print "" 13 | for i, p in enumerate(output): 14 | print "{} - {}".format(i, p) 15 | dictionary_interactive(output, config) 16 | -------------------------------------------------------------------------------- /dst/worker.py: -------------------------------------------------------------------------------- 1 | from sklearn.externals import joblib 2 | 3 | 4 | def worker(pipeline, in_queue, out_queue, n_preds, config): 5 | clf = joblib.load(pipeline.name) 6 | for idx, sample in iter(in_queue.get, None): 7 | if idx < 0: 8 | break 9 | prediction = clf.predict_proba(sample.reshape(1, -1))[0] 10 | values = [x[0] for x in 11 | sorted([(clf.classes_[x], val) for x, val in enumerate(prediction) if val != 0.0], 12 | key=lambda _x: _x[1], reverse=True)] 13 | out_queue.put((idx, values[:n_preds])) 14 | return 15 | -------------------------------------------------------------------------------- /generate_model.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/python2 2 | 3 | import argparse 4 | import importlib 5 | import os 6 | from multiprocessing import Process 7 | from multiprocessing import Queue 8 | import itertools 9 | import numpy as np 10 | from sklearn.externals import joblib 11 | from sklearn.feature_selection import RFECV 12 | from sklearn.model_selection import cross_val_score 13 | from sklearn.pipeline import Pipeline 14 | from sklearn.preprocessing import MinMaxScaler 15 | 16 | from config import * 17 | from dst.dispatchers import offline 18 | from dst.listeners import wavfile 19 | import dst.miners 20 | 21 | if __name__ == "__main__": 22 | 23 | # Argument parsing 24 | parser = argparse.ArgumentParser( 25 | formatter_class=argparse.RawDescriptionHelpFormatter, 26 | description='Generate a S&T attack model using specified training data', 27 | epilog='''\ 28 | 29 | This is a convenience program to train a ML model on a set of ground truth data, and generate the respective pipeline, 30 | to be used in S&T. 31 | 32 | Training data can be passed as any list of files and folders. 33 | Only requirement is that, for each WAV file containing training material, a corresponding ground truth file with 34 | identical name but .txt extension is present anywhere in the given files and folders. 35 | This means that if you call 36 | %(prog)s training.wav myfolder 37 | Then, a training.txt file, containing ground truth for training.wav, has to exist in folder "myfolder", or any of 38 | its subdirectories. 39 | 40 | If using a custom classifier, it needs to be passed as CLASS_NAME PACKAGE_NAME as argument. 41 | For example, to use sklearn.ensemble.RandomForestClassifier, you should pass 42 | %(prog)s --classifier RandomForestClassifier sklearn.linear_model 43 | as options to this program. 44 | ''' 45 | ) 46 | parser.add_argument('--version', '-v', action='version', version=CONFIG.VERSION) 47 | parser.add_argument('training_data', nargs='+', type=str, help='List of files and folders containing training data') 48 | parser.add_argument('output_file', type=str, help='Path of the resulting trained model') 49 | parser.add_argument('--features', '-f', default='MFCC', help='Feature extraction class') 50 | parser.add_argument('--no_feature_extraction', action='store_true', help='Whether to perform feature extraction') 51 | parser.add_argument('--no_scaling', action='store_true', help='Whether to scale features between [0,1] (suggested)') 52 | parser.add_argument('--no_feature_selection', action='store_true', help='Whether to perform Recursive Feature Elimination before training (slow)') 53 | parser.add_argument('--folds', type=int, default=5, help='How many folds to use for cross-validation') 54 | parser.add_argument('--n_threads', '-n', type=int, default=4, help='Parallelism') 55 | parser.add_argument('--classifier', '-c', nargs=2, default=['LogisticRegression', 'sklearn.linear_model'], help='Class name and package name of classifier') 56 | 57 | args = parser.parse_args() 58 | 59 | # Training files 60 | files_to_mine = {} 61 | mined_files = {} 62 | wav_files = [] 63 | label_files = [] 64 | press_files = [] 65 | 66 | 67 | def add_file(fl): 68 | ext = os.path.splitext(fl)[1] 69 | if ext == '.wav': 70 | wav_files.append(fl) 71 | elif ext == '.press': 72 | press_files.append(fl) 73 | elif ext == '.txt': 74 | label_files.append(fl) 75 | 76 | # Read training files from specified location 77 | for f_name in args.training_data: 78 | f = os.path.abspath(f_name) 79 | if os.path.isfile(f): 80 | add_file(f) 81 | elif os.path.isdir(f): 82 | for r, d, fs in os.walk(f): 83 | for fn in fs: 84 | f1 = os.path.abspath(os.path.join(r, fn)) 85 | add_file(f1) 86 | 87 | # Every wavfile and pressfile needs a corresponding label file (same name, any extension) 88 | # Otherwise exit and report the error 89 | wavfiles_map = {} 90 | for f in wav_files: 91 | basename = os.path.splitext(os.path.basename(f))[0] 92 | if os.path.splitext(f)[0] + '.press' not in press_files: 93 | wavfiles_map[f] = None 94 | for l_f in label_files: 95 | if os.path.splitext(os.path.basename(l_f))[0] == basename: 96 | wavfiles_map[f] = l_f 97 | pressfiles_map = {} 98 | for f in press_files: 99 | basename = os.path.splitext(os.path.basename(f))[0] 100 | pressfiles_map[f] = None 101 | for l_f in label_files: 102 | if os.path.splitext(os.path.basename(l_f))[0] == basename: 103 | pressfiles_map[f] = l_f 104 | 105 | mismatches = [x for x, y in wavfiles_map.iteritems() if y is None] + \ 106 | [x for x, y in pressfiles_map.iteritems() if y is None] 107 | if len(mismatches) != 0: 108 | print "Can't find labels for some wav files / press files!" 109 | print "Offending files:" 110 | for f in mismatches: 111 | print f 112 | exit() 113 | 114 | # Divide each file in samples corresponding to keys 115 | # For each worker get features and labels and put them in final arrays X and y 116 | # They start as lists (we don't know their lengths yet) 117 | print "Found {} files already mined".format(len(press_files)) 118 | print "Found {} files to mine".format(len(wav_files) - len(press_files)) 119 | f_X, f_y = [], [] 120 | error_queue = [] 121 | 122 | # We divide files in groups of n_thread size 123 | # We iterate over groups, and spawn a miner process for each file 124 | # We then wait for them to implicitly join when reporting results, and collect mined data 125 | for grp_idx, grp_it in itertools.groupby(enumerate(wavfiles_map.iteritems()), lambda _fg: _fg[0] / args.n_threads): 126 | events_queue = [] 127 | for i, (wav_file, label_file) in grp_it: 128 | print "Processing file #{}".format(i + 1) 129 | lq = Queue() 130 | p = Process(target=wavfile, args=(wav_file, lq, CONFIG)) 131 | p.daemon = True 132 | p.start() 133 | 134 | # Create offline dispatcher 135 | # Dispatch file 136 | oq, dq = Queue(), Queue() 137 | p = Process(target=offline, args=(lq, oq, dq, CONFIG)) 138 | p.daemon = True 139 | p.start() 140 | 141 | y = np.loadtxt(label_file, dtype=str) 142 | events_queue.append((wav_file, y, oq, dq)) 143 | 144 | for wav_file, y, oq, dq in events_queue: 145 | n_res = dq.get() 146 | if not len(y.shape): 147 | # Happens if a ground truth file has a single row 148 | # This is probably not what the user means, but we can't be sure 149 | # So we just assumes he intended it 150 | y = y.reshape(1) 151 | if n_res != len(y): 152 | # More mined events than ground truth values 153 | error_queue.append((wav_file, n_res, len(y))) 154 | else: 155 | _x = [] 156 | # Collect results until the number of letters we know is in the file 157 | while len(_x) < len(y): 158 | _x.append(oq.get()) 159 | X = [[] for _ in range(len(_x))] 160 | for idx, sample in _x: 161 | X[idx] = sample 162 | np.savetxt(os.path.splitext(wav_file)[0] + '.press', X) 163 | f_X.extend(X) 164 | f_y.extend(y) 165 | 166 | if len(error_queue) != 0: 167 | print "Error in reading some files - wrong n. of keypresses found:" 168 | for f, found, expected in error_queue: 169 | print "{} - found {}, expected {}".format(f, found, expected) 170 | exit() 171 | 172 | # .press files already present only need to be loaded from disk and appended to the matrix 173 | for i, (press_file, label_file) in enumerate(pressfiles_map.iteritems()): 174 | f_X.extend(np.loadtxt(press_file)) 175 | f_y.extend(np.loadtxt(label_file, dtype=str)) 176 | f_X, f_y = np.array(f_X), np.array(f_y) 177 | 178 | # Load pipeline steps 179 | # 1 - Feature extraction 180 | pipeline = [] 181 | if not args.no_feature_extraction: 182 | pipeline.append((args.features, getattr(dst.miners, args.features)())) 183 | if not args.no_scaling: 184 | pipeline.append(('Scaler', MinMaxScaler())) 185 | # 2 - Feature selector and classifier 186 | classifier = getattr(importlib.import_module(args.classifier[1]), args.classifier[0])() 187 | if not args.no_feature_selection: 188 | pipeline.append(('Feature Selection', 189 | RFECV(classifier, step=f_X.shape[1] / 10, cv=args.folds, verbose=0))) 190 | pipeline.append(('Classifier', classifier)) 191 | clf = Pipeline(pipeline) 192 | 193 | print "Learning..." 194 | # Fit and save fitted model to file. Output stats about estimated accuracy 195 | clf.fit(f_X, f_y) 196 | print "Learning task completed!" 197 | print "Writing model to disk" 198 | joblib.dump(clf, args.output_file) 199 | print "Estimating accuracy..." 200 | print np.mean(cross_val_score(clf, f_X, f_y, cv=args.folds+1)) 201 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | #! /usr/bin/python2 2 | 3 | import argparse 4 | import time 5 | from multiprocessing import active_children 6 | from dst.libraries.multiplier import multiplier 7 | from multiprocessing import Process, Queue 8 | from dst.output import console 9 | from dst.worker import worker 10 | import dst.dispatchers 11 | from threading import Thread 12 | import dst.listeners 13 | from config import * 14 | 15 | if __name__ == "__main__": 16 | 17 | # 18 | # Argument parsing 19 | # 20 | parser = argparse.ArgumentParser( 21 | formatter_class=argparse.RawDescriptionHelpFormatter, 22 | description='Runs S&T attack on specified target, using trained pipeline generated by generate_model.py', 23 | epilog='''\ 24 | 25 | S&T works with chains of operators - building blocks that pass data forward. 26 | Pre-made chains, called opmodes, can be selected with the syntax: 27 | 28 | %(prog)s --opmode MODE --target TARGET --pipeline PIPELINE 29 | 30 | Currently available chains are the following: 31 | - from_file loads specified wavfile and attacks it with specified pipeline 32 | 33 | Chains can also be specified block by block by setting the respective parameters. 34 | Data flow between blocks is the following: 35 | 36 | LISTENER --> DISPATCHER --> PIPELINE --> OUTPUT 37 | 38 | where 39 | - LISTENER is a function that loads audio. Right now only wavfile reader is provided. 40 | - DISPATCHER is a function that extracts keypress sounds. Right now only an offline dispatcher, that works on 41 | a complete audio file (i.e., not a stream) is provided. 42 | - PIPELINE is a file with a pickled, trained Sklearn pipeline performing feature extraction and classification. 43 | - OUTPUT shows attack results. Right now only screen output, that prints results on terminal, is provided. 44 | ''' 45 | ) 46 | # Misc arguments such as version and help 47 | parser.add_argument('--version', '-v', action='version', version=CONFIG.VERSION) 48 | # Opmode is a convenience to avoid specifying operator chains 49 | parser.add_argument("--opmode", choices=['from_file', ], 50 | help='Convenience syntax to avoid specifying operator chains') 51 | parser.add_argument("--target", "-t", type=str, 52 | help='Attack target. Valid values depend on the listener') 53 | # If no opmode is used you can specify operator chains with safe defaults 54 | parser.add_argument("--listener", "-l", choices=['wavfile', 'input', 'input_interactive']) 55 | parser.add_argument("--dispatcher", "-d", choices=['offline']) 56 | # Define the sklearn pipeline to use 57 | # Multiple pipelines will be allowed - each will receive from dispatcher 58 | # Watch out - right now only a SINGLE pipeline works 59 | parser.add_argument("--pipeline", "-p", action='append', type=file, required=True, 60 | help='Trained pipeline created by generate_model.py') 61 | # General options 62 | parser.add_argument("--workers", "-w", type=int, default=CONFIG.workers, 63 | help='Number of workers to dispatch') 64 | parser.add_argument("--dispatcher_window_size", type=int, default=CONFIG.dispatcher_window_size, 65 | help='Window size of keypress samples, in milliseconds') 66 | parser.add_argument("--dispatcher_threshold", type=int, default=CONFIG.dispatcher_threshold, 67 | help='Percentile threshold of keypress sound vs. background noise, [0, 100]') 68 | parser.add_argument("--dispatcher_min_interval", type=int, default=CONFIG.dispatcher_min_interval, 69 | help='Minimum interval between keystrokes, in milliseconds') 70 | parser.add_argument("--dispatcher_step_size", type=int, default=CONFIG.dispatcher_step_size, 71 | help='Scan granularity of dispatchers, in milliseconds') 72 | parser.add_argument("--dispatcher_persistence", type=int, default=CONFIG.dispatcher_persistence, 73 | help='Whether to save mined events') 74 | parser.add_argument("--n_predictions", "-n", type=int, default=10, 75 | help='Number of required predictions for each sample') 76 | 77 | args = parser.parse_args() 78 | 79 | # 80 | # Configuration - update values 81 | # 82 | for key in vars(CONFIG).iterkeys(): 83 | if key in vars(args).keys(): 84 | CONFIG.key = args[key] 85 | for key, val in vars(args).iteritems(): 86 | CONFIG.key = val 87 | 88 | # 89 | # Main matter 90 | # 91 | # Chain elements registration lists 92 | pipeline_list = [] 93 | # Multipliers and outputs need to be stopped separately 94 | output_list = [] 95 | multiplier_list = [] 96 | 97 | # Convert opmodes to chains first 98 | if args.opmode == 'from_file': 99 | args.listener, args.dispatcher = 'wavfile', 'offline' 100 | 101 | # For each chain part, import modules and register them to registration lists 102 | # First init the listener, remember its output queue 103 | lq = Queue() 104 | p = Process(target=getattr(dst.listeners, args.listener), args=(args.target, lq, CONFIG)) 105 | p.daemon = True 106 | p.start() 107 | 108 | # Create the required dispatcher 109 | oq, dq = Queue(), Queue() 110 | p = Process(target=getattr(dst.dispatchers, args.dispatcher), args=(lq, oq, dq, CONFIG)) 111 | p.daemon = True 112 | p.start() 113 | # For each pipeline, create a pool of workers 114 | for p_idx, pipeline in enumerate(args.pipeline): 115 | iq, rq = Queue(), Queue() 116 | for n_worker in xrange(args.workers): 117 | p = Process(target=worker, args=(pipeline, iq, rq, args.n_predictions, CONFIG)) 118 | p.daemon = True 119 | p.start() 120 | pipeline_list.append(iq) 121 | # Send the output of the pipeline to a terminal, to be displayed 122 | p = Thread(target=console, args=(rq, CONFIG)) 123 | p.daemon = True 124 | p.start() 125 | output_list.append((p, rq)) 126 | # Clone dispatcher output to each pipeline input 127 | p = Process(target=multiplier, args=(oq, [_q for _q in pipeline_list])) 128 | multiplier_list.append((p, oq)) 129 | p.daemon = True 130 | p.start() 131 | 132 | # 133 | # Exit: wait until everyone (except multipliers and outputs who cannot join() 134 | # 135 | while len(active_children()) > len(output_list) + len(multiplier_list): 136 | time.sleep(1) 137 | pass 138 | # Wait for user action to join output and terminate 139 | for _mulp in multiplier_list: 140 | _mulp[1].put(None) 141 | for _outp in output_list: 142 | _outp[1].put(None) 143 | _outp[0].join() 144 | --------------------------------------------------------------------------------