├── .gitignore ├── LICENSE ├── README.md ├── tweetsniff-kibana.json ├── tweetsniff.conf.sample └── tweetsniff.py /.gitignore: -------------------------------------------------------------------------------- 1 | tweetsniff.conf 2 | -------------------------------------------------------------------------------- /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 | 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | tweetsniff.py 2 | ============= 3 | Grabs a user's Twitter feed and tweets with specific keywords via the Twitter API for local processing 4 | (storing to ElasticSearch, regex highlighting, etc) 5 | 6 | Installation 7 | ------------ 8 | The following Python modules are required: 9 | - twitter 10 | - elasticsearch 11 | - termcolor 12 | - dateutil 13 | - hashlib 14 | - urllib 15 | - httplib 16 | 17 | Install them with: pip install 18 | 19 | Valid Twitter API key & token are required, see https://apps.twitter.com/ 20 | 21 | Usage 22 | ----- 23 | 
24 | usage: tweetsniff.py [-h] [-c CONFIG]
25 | 
26 | Display a Tweet feed
27 | 
28 | optional arguments:
29 |   -h, --help            show this help message and exit
30 |   -c CONFIG, --config CONFIG
31 |                         configuration file (default: /etc/tweetsniff.conf)
32 |
33 | 34 | Expand URLs 35 | ---- 36 | - Enable in config with "process_urls: True" 37 | - urllib2.url provides the same features but gets sometimes rejected by sites (403) 38 | - URLs have to be part of the twitter URL object, otherwise they do not get recognized 39 | - not yet in writeCEFEvent 40 | - ES object contains URL, expanded URL, MD5 and SHA1 of the (expanded) URL 41 | 42 | Todo 43 | ---- 44 | - Add more statistics -------------------------------------------------------------------------------- /tweetsniff-kibana.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Tweetsniff", 3 | "services": { 4 | "query": { 5 | "list": { 6 | "1": { 7 | "id": 1, 8 | "color": "#7EB26D", 9 | "alias": "", 10 | "pin": false, 11 | "type": "lucene", 12 | "enable": true, 13 | "query": "" 14 | } 15 | }, 16 | "ids": [ 17 | 1 18 | ] 19 | }, 20 | "filter": { 21 | "list": {}, 22 | "ids": [] 23 | } 24 | }, 25 | "rows": [ 26 | { 27 | "title": "Timeframe", 28 | "height": "200px", 29 | "editable": true, 30 | "collapse": false, 31 | "collapsable": true, 32 | "panels": [ 33 | { 34 | "error": false, 35 | "span": 8, 36 | "editable": true, 37 | "type": "text", 38 | "loadingEditor": false, 39 | "mode": "text", 40 | "content": "Dashboard for Tweetsniff.\nSee http://blog.rootshell.be/2014/12/23/tweetsniff-py-a-python-tweets-grabber/ and https://github.com/xme/tweetsniff.", 41 | "style": { 42 | "font-size": "8pt" 43 | }, 44 | "title": "Tweetsniff" 45 | }, 46 | { 47 | "error": false, 48 | "span": 4, 49 | "editable": true, 50 | "type": "stats", 51 | "loadingEditor": false, 52 | "queries": { 53 | "mode": "all", 54 | "ids": [ 55 | 1 56 | ] 57 | }, 58 | "style": { 59 | "font-size": "14pt" 60 | }, 61 | "format": "number", 62 | "mode": "count", 63 | "display_breakdown": "yes", 64 | "sort_field": "", 65 | "sort_reverse": false, 66 | "label_name": "Query", 67 | "value_name": "Value", 68 | "spyable": true, 69 | "show": { 70 | "count": true, 71 | "min": false, 72 | "max": false, 73 | "mean": false, 74 | "std_deviation": false, 75 | "sum_of_squares": false, 76 | "total": false, 77 | "variance": false 78 | }, 79 | "field": "@timestamp", 80 | "title": "Tweets" 81 | }, 82 | { 83 | "span": 12, 84 | "editable": true, 85 | "type": "histogram", 86 | "loadingEditor": false, 87 | "mode": "count", 88 | "time_field": "@timestamp", 89 | "value_field": null, 90 | "x-axis": true, 91 | "y-axis": true, 92 | "scale": 1, 93 | "y_format": "none", 94 | "grid": { 95 | "max": null, 96 | "min": 0 97 | }, 98 | "queries": { 99 | "mode": "all", 100 | "ids": [ 101 | 1 102 | ] 103 | }, 104 | "annotate": { 105 | "enable": false, 106 | "query": "*", 107 | "size": 20, 108 | "field": "_type", 109 | "sort": [ 110 | "_score", 111 | "desc" 112 | ] 113 | }, 114 | "auto_int": false, 115 | "resolution": 100, 116 | "interval": "10m", 117 | "intervals": [ 118 | "auto", 119 | "1s", 120 | "1m", 121 | "5m", 122 | "10m", 123 | "30m", 124 | "1h", 125 | "3h", 126 | "12h", 127 | "1d", 128 | "1w", 129 | "1y" 130 | ], 131 | "lines": false, 132 | "fill": 0, 133 | "linewidth": 3, 134 | "points": false, 135 | "pointradius": 5, 136 | "bars": true, 137 | "stack": true, 138 | "spyable": true, 139 | "zoomlinks": true, 140 | "options": true, 141 | "legend": true, 142 | "show_query": true, 143 | "interactive": true, 144 | "legend_counts": true, 145 | "timezone": "browser", 146 | "percentage": false, 147 | "zerofill": true, 148 | "derivative": false, 149 | "tooltip": { 150 | "value_type": "individual", 151 | "query_as_alias": true 152 | }, 153 | "title": "Timeframe" 154 | } 155 | ], 156 | "notice": false 157 | }, 158 | { 159 | "title": "Tweets (limited)", 160 | "height": "250px", 161 | "editable": true, 162 | "collapse": false, 163 | "collapsable": true, 164 | "panels": [ 165 | { 166 | "error": false, 167 | "span": 12, 168 | "editable": true, 169 | "type": "table", 170 | "loadingEditor": false, 171 | "size": 20, 172 | "pages": 10, 173 | "offset": 0, 174 | "sort": [ 175 | "@timestamp", 176 | "desc" 177 | ], 178 | "overflow": "min-height", 179 | "fields": [ 180 | "@timestamp", 181 | "user.screen_name", 182 | "text" 183 | ], 184 | "highlight": [], 185 | "sortable": true, 186 | "header": true, 187 | "paging": true, 188 | "field_list": false, 189 | "all_fields": false, 190 | "trimFactor": 300, 191 | "localTime": true, 192 | "timeField": "@timestamp", 193 | "spyable": true, 194 | "queries": { 195 | "mode": "all", 196 | "ids": [ 197 | 1 198 | ] 199 | }, 200 | "style": { 201 | "font-size": "9pt" 202 | }, 203 | "normTimes": true 204 | } 205 | ], 206 | "notice": false 207 | }, 208 | { 209 | "title": "Tops", 210 | "height": "250px", 211 | "editable": true, 212 | "collapse": false, 213 | "collapsable": true, 214 | "panels": [ 215 | { 216 | "error": false, 217 | "span": 6, 218 | "editable": true, 219 | "type": "terms", 220 | "loadingEditor": false, 221 | "field": "user.screen_name", 222 | "exclude": [], 223 | "missing": false, 224 | "other": false, 225 | "size": 10, 226 | "order": "count", 227 | "style": { 228 | "font-size": "10pt" 229 | }, 230 | "donut": false, 231 | "tilt": false, 232 | "labels": true, 233 | "arrangement": "horizontal", 234 | "chart": "bar", 235 | "counter_pos": "above", 236 | "spyable": true, 237 | "queries": { 238 | "mode": "all", 239 | "ids": [ 240 | 1 241 | ] 242 | }, 243 | "tmode": "terms", 244 | "tstat": "total", 245 | "valuefield": "", 246 | "title": "Top users" 247 | }, 248 | { 249 | "error": false, 250 | "span": 6, 251 | "editable": true, 252 | "type": "terms", 253 | "loadingEditor": false, 254 | "field": "hashtags", 255 | "exclude": [], 256 | "missing": false, 257 | "other": false, 258 | "size": 10, 259 | "order": "count", 260 | "style": { 261 | "font-size": "10pt" 262 | }, 263 | "donut": false, 264 | "tilt": false, 265 | "labels": true, 266 | "arrangement": "horizontal", 267 | "chart": "bar", 268 | "counter_pos": "above", 269 | "spyable": true, 270 | "queries": { 271 | "mode": "all", 272 | "ids": [ 273 | 1 274 | ] 275 | }, 276 | "tmode": "terms", 277 | "tstat": "total", 278 | "valuefield": "", 279 | "title": "Top Hashtags" 280 | } 281 | ], 282 | "notice": false 283 | }, 284 | { 285 | "title": "Tweetdata", 286 | "height": "200px", 287 | "editable": true, 288 | "collapse": false, 289 | "collapsable": true, 290 | "panels": [ 291 | { 292 | "error": false, 293 | "span": 6, 294 | "editable": true, 295 | "type": "terms", 296 | "loadingEditor": false, 297 | "field": "retweet_count", 298 | "exclude": [], 299 | "missing": false, 300 | "other": false, 301 | "size": 15, 302 | "order": "count", 303 | "style": { 304 | "font-size": "10pt" 305 | }, 306 | "donut": false, 307 | "tilt": false, 308 | "labels": true, 309 | "arrangement": "horizontal", 310 | "chart": "bar", 311 | "counter_pos": "above", 312 | "spyable": true, 313 | "queries": { 314 | "mode": "all", 315 | "ids": [ 316 | 1 317 | ] 318 | }, 319 | "tmode": "terms", 320 | "tstat": "total", 321 | "valuefield": "", 322 | "title": "Retweet count" 323 | }, 324 | { 325 | "error": false, 326 | "span": 6, 327 | "editable": true, 328 | "type": "terms", 329 | "loadingEditor": false, 330 | "field": "lang", 331 | "exclude": [], 332 | "missing": false, 333 | "other": false, 334 | "size": 10, 335 | "order": "count", 336 | "style": { 337 | "font-size": "10pt" 338 | }, 339 | "donut": false, 340 | "tilt": false, 341 | "labels": true, 342 | "arrangement": "horizontal", 343 | "chart": "pie", 344 | "counter_pos": "above", 345 | "spyable": true, 346 | "queries": { 347 | "mode": "all", 348 | "ids": [ 349 | 1 350 | ] 351 | }, 352 | "tmode": "terms", 353 | "tstat": "total", 354 | "valuefield": "", 355 | "title": "Tweet Language" 356 | } 357 | ], 358 | "notice": false 359 | }, 360 | { 361 | "title": "Tweeter data", 362 | "height": "200px", 363 | "editable": true, 364 | "collapse": false, 365 | "collapsable": true, 366 | "panels": [ 367 | { 368 | "error": false, 369 | "span": 4, 370 | "editable": true, 371 | "type": "terms", 372 | "loadingEditor": false, 373 | "field": "user.lang", 374 | "exclude": [], 375 | "missing": false, 376 | "other": false, 377 | "size": 15, 378 | "order": "count", 379 | "style": { 380 | "font-size": "10pt" 381 | }, 382 | "donut": false, 383 | "tilt": false, 384 | "labels": false, 385 | "arrangement": "horizontal", 386 | "chart": "pie", 387 | "counter_pos": "above", 388 | "spyable": true, 389 | "queries": { 390 | "mode": "all", 391 | "ids": [ 392 | 1 393 | ] 394 | }, 395 | "tmode": "terms", 396 | "tstat": "total", 397 | "valuefield": "", 398 | "title": "Tweeter Language" 399 | }, 400 | { 401 | "error": false, 402 | "span": 4, 403 | "editable": true, 404 | "type": "terms", 405 | "loadingEditor": false, 406 | "field": "user.location", 407 | "exclude": [], 408 | "missing": false, 409 | "other": false, 410 | "size": 15, 411 | "order": "count", 412 | "style": { 413 | "font-size": "10pt" 414 | }, 415 | "donut": false, 416 | "tilt": false, 417 | "labels": true, 418 | "arrangement": "horizontal", 419 | "chart": "bar", 420 | "counter_pos": "above", 421 | "spyable": true, 422 | "queries": { 423 | "mode": "all", 424 | "ids": [ 425 | 1 426 | ] 427 | }, 428 | "tmode": "terms", 429 | "tstat": "total", 430 | "valuefield": "", 431 | "title": "Tweeter Location" 432 | }, 433 | { 434 | "error": false, 435 | "span": 4, 436 | "editable": true, 437 | "type": "terms", 438 | "loadingEditor": false, 439 | "field": "user.time_zone", 440 | "exclude": [], 441 | "missing": false, 442 | "other": false, 443 | "size": 15, 444 | "order": "count", 445 | "style": { 446 | "font-size": "10pt" 447 | }, 448 | "donut": false, 449 | "tilt": false, 450 | "labels": true, 451 | "arrangement": "horizontal", 452 | "chart": "bar", 453 | "counter_pos": "above", 454 | "spyable": true, 455 | "queries": { 456 | "mode": "all", 457 | "ids": [ 458 | 1 459 | ] 460 | }, 461 | "tmode": "terms", 462 | "tstat": "total", 463 | "valuefield": "", 464 | "title": "Tweeter Timezone" 465 | } 466 | ], 467 | "notice": false 468 | }, 469 | { 470 | "title": "Tweeter data stats", 471 | "height": "200px", 472 | "editable": true, 473 | "collapse": false, 474 | "collapsable": true, 475 | "panels": [ 476 | { 477 | "error": false, 478 | "span": 4, 479 | "editable": true, 480 | "type": "terms", 481 | "loadingEditor": false, 482 | "field": "user.followers_count", 483 | "exclude": [], 484 | "missing": false, 485 | "other": false, 486 | "size": 15, 487 | "order": "count", 488 | "style": { 489 | "font-size": "10pt" 490 | }, 491 | "donut": false, 492 | "tilt": false, 493 | "labels": true, 494 | "arrangement": "horizontal", 495 | "chart": "bar", 496 | "counter_pos": "above", 497 | "spyable": true, 498 | "queries": { 499 | "mode": "all", 500 | "ids": [ 501 | 1 502 | ] 503 | }, 504 | "tmode": "terms", 505 | "tstat": "total", 506 | "valuefield": "", 507 | "title": "Tweeter Followers" 508 | }, 509 | { 510 | "error": false, 511 | "span": 4, 512 | "editable": true, 513 | "type": "terms", 514 | "loadingEditor": false, 515 | "field": "user.favourites_count", 516 | "exclude": [], 517 | "missing": false, 518 | "other": false, 519 | "size": 15, 520 | "order": "count", 521 | "style": { 522 | "font-size": "10pt" 523 | }, 524 | "donut": false, 525 | "tilt": false, 526 | "labels": true, 527 | "arrangement": "horizontal", 528 | "chart": "bar", 529 | "counter_pos": "above", 530 | "spyable": true, 531 | "queries": { 532 | "mode": "all", 533 | "ids": [ 534 | 1 535 | ] 536 | }, 537 | "tmode": "terms", 538 | "tstat": "total", 539 | "valuefield": "", 540 | "title": "Tweeter Favourites" 541 | } 542 | ], 543 | "notice": false 544 | }, 545 | { 546 | "title": "Tweets", 547 | "height": "350px", 548 | "editable": true, 549 | "collapse": false, 550 | "collapsable": true, 551 | "panels": [ 552 | { 553 | "error": false, 554 | "span": 12, 555 | "editable": true, 556 | "type": "table", 557 | "loadingEditor": false, 558 | "size": 100, 559 | "pages": 5, 560 | "offset": 0, 561 | "sort": [ 562 | "_score", 563 | "desc" 564 | ], 565 | "overflow": "min-height", 566 | "fields": [], 567 | "highlight": [], 568 | "sortable": true, 569 | "header": true, 570 | "paging": true, 571 | "field_list": true, 572 | "all_fields": false, 573 | "trimFactor": 300, 574 | "localTime": false, 575 | "timeField": "@timestamp", 576 | "spyable": true, 577 | "queries": { 578 | "mode": "all", 579 | "ids": [ 580 | 1 581 | ] 582 | }, 583 | "style": { 584 | "font-size": "9pt" 585 | }, 586 | "normTimes": true 587 | } 588 | ], 589 | "notice": false 590 | } 591 | ], 592 | "editable": true, 593 | "failover": false, 594 | "index": { 595 | "interval": "none", 596 | "pattern": "[logstash-]YYYY.MM.DD", 597 | "default": "_all", 598 | "warm_fields": false 599 | }, 600 | "style": "dark", 601 | "panel_hints": true, 602 | "pulldowns": [ 603 | { 604 | "type": "query", 605 | "collapse": false, 606 | "notice": false, 607 | "enable": true, 608 | "query": "*", 609 | "pinned": true, 610 | "history": [ 611 | "", 612 | "equation", 613 | "malware", 614 | "malware botner" 615 | ], 616 | "remember": 10 617 | }, 618 | { 619 | "type": "filtering", 620 | "collapse": false, 621 | "notice": false, 622 | "enable": true 623 | } 624 | ], 625 | "nav": [ 626 | { 627 | "type": "timepicker", 628 | "collapse": false, 629 | "notice": false, 630 | "enable": true, 631 | "status": "Stable", 632 | "time_options": [ 633 | "5m", 634 | "15m", 635 | "1h", 636 | "6h", 637 | "12h", 638 | "24h", 639 | "2d", 640 | "7d", 641 | "30d" 642 | ], 643 | "refresh_intervals": [ 644 | "5s", 645 | "10s", 646 | "30s", 647 | "1m", 648 | "5m", 649 | "15m", 650 | "30m", 651 | "1h", 652 | "2h", 653 | "1d" 654 | ], 655 | "timefield": "@timestamp" 656 | } 657 | ], 658 | "loader": { 659 | "save_gist": false, 660 | "save_elasticsearch": true, 661 | "save_local": true, 662 | "save_default": true, 663 | "save_temp": true, 664 | "save_temp_ttl_enable": true, 665 | "save_temp_ttl": "30d", 666 | "load_gist": false, 667 | "load_elasticsearch": true, 668 | "load_elasticsearch_size": 20, 669 | "load_local": false, 670 | "hide": false 671 | }, 672 | "refresh": false 673 | } -------------------------------------------------------------------------------- /tweetsniff.conf.sample: -------------------------------------------------------------------------------- 1 | [twitterapi] 2 | consumer_key: xxxx 3 | consumer_secret: xxxx 4 | access_token_key: xxxx 5 | access_token_secret: xxxx 6 | status_file: /var/run/tweetsniff.status 7 | 8 | [highlight] 9 | color: red 10 | regex: foo 11 | security 12 | 13 | [search] 14 | color: blue 15 | keywords: drone 16 | brucon 17 | malware 18 | 19 | [elasticsearch] 20 | server: http://127.0.0.1:9200 21 | index: twitter-%Y.%m.%d 22 | 23 | [cef] 24 | server: 192.168.0.1 25 | port: 514 26 | 27 | [urls] 28 | ua: "Mozilla/5.0 (Windows NT 6.3; rv:36.0) Gecko/20100101 Firefox/36.0" 29 | timeout: 30 30 | urls_process_urls: true 31 | -------------------------------------------------------------------------------- /tweetsniff.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Author: Xavier Mertens 4 | # Copyright: GPLv3 (http://gplv3.fsf.org/) 5 | # Feel free to use the code, but please share the changes you've made 6 | # 7 | import argparse 8 | import errno 9 | import ConfigParser 10 | import json 11 | import logging 12 | import logging.handlers 13 | import os 14 | import re 15 | import signal 16 | import sys 17 | import time 18 | 19 | try: 20 | import twitter 21 | except: 22 | print "[ERROR]: python-twitter is required. See https://github.com/bear/python-twitter" 23 | 24 | try: 25 | import syslog 26 | except: 27 | print "[INFO]: No Syslog support, logging to console" 28 | from datetime import datetime 29 | from dateutil import parser 30 | from dateutil import tz 31 | from elasticsearch import Elasticsearch 32 | from termcolor import colored 33 | 34 | import hashlib 35 | import urllib, httplib 36 | 37 | api = None 38 | logger = None 39 | 40 | # Default configuration 41 | config = { 42 | 'statusFile': '/var/run/tweetsniff.status', 43 | 'esServer': '', 44 | 'keywords': '', 45 | 'regex': '', 46 | 'highlightColor': 'red', 47 | 'keywordColor': 'blue', 48 | 'cefServer': '', 49 | 'cefPort': '' 50 | } 51 | 52 | def sigHandler(s, f): 53 | 54 | """Cleanup once CTRL-C is received""" 55 | 56 | print "Killed." 57 | sys.exit(0) 58 | 59 | def writeLog(msg): 60 | 61 | """Output a message to the console/Syslog depending on the host""" 62 | 63 | if os.name == "posix": 64 | syslog.openlog(logoption=syslog.LOG_PID,facility=syslog.LOG_MAIL) 65 | syslog.syslog(msg) 66 | else: 67 | print msg 68 | return 69 | 70 | def writeCEFEvent(tweet): 71 | 72 | """Send a CEF event to a Syslog destination""" 73 | 74 | # print "[Debug]: Writing CEF: %s" % tweet 75 | cefmsg = ' CEF:0|blog.rootshell.be|tweetsniff|1.0|TwitterMsg|Received Twitter Message|0|cs1Label=TweetHandle cs1=%s cs2Label=TweetTime cs2=%s msg=%s' % (tweet.user.screen_name, tweet.created_at, tweet.text) 76 | logger.info(cefmsg) 77 | return 78 | 79 | def time2Local(s): 80 | 81 | """Convert a 'created_at' date (UTC) to local time""" 82 | 83 | if not s: 84 | utc = datetime.utcnow() 85 | else: 86 | utc = datetime.strptime(parser.parse(s).strftime('%Y-%m-%d %H:%M:%S'), '%Y-%m-%d %H:%M:%S') 87 | 88 | from_zone = tz.tzutc() 89 | to_zone = tz.tzlocal() 90 | utc = utc.replace(tzinfo=from_zone) 91 | return(utc.astimezone(to_zone)) 92 | 93 | def indexEs(tweet, urls, tweet_message): 94 | 95 | """Index a new Tweet in Elasticsearch""" 96 | 97 | doc = tweet.AsDict() 98 | # Delete 'retweeted_status' - to be fixed later 99 | if 'retweeted_status' in doc: 100 | del doc['retweeted_status'] 101 | # Delete old urls' 102 | if 'urls' in doc: 103 | del doc['urls'] 104 | 105 | # To fix: support different timezones? (+00:00 106 | try: 107 | doc['@timestamp'] = parser.parse(doc['created_at']).strftime("%Y-%m-%dT%H:%M:%S+00:00") 108 | doc['text'] = tweet_message 109 | 110 | if config['urls_process_urls'] == True: 111 | if urls: 112 | x = 1 113 | for url in urls: 114 | doc['urls.' + str(x) + '.url'] = url['url'] 115 | doc['urls.' + str(x) + '.url_unshortened'] = url['url_unshortened'] 116 | doc['urls.' + str(x) + '.url_md5'] = url['url_md5'] 117 | doc['urls.' + str(x) + '.url_sha1'] = url['url_sha1'] 118 | x = x + 1 119 | res = es.index(index=time.strftime(esIndex, time.localtime()), 120 | doc_type='tweet', 121 | body=doc) 122 | except: 123 | print "[Warning] Can't connect to %s" % config['esServer'] 124 | 125 | return 126 | 127 | def processURL(urls): 128 | 129 | """ Process the short URLs to get expanded and get their hashes """ 130 | 131 | processed_urls = [] 132 | if urls: 133 | for url in urls: 134 | try: 135 | url_unshortened = unshortenURL(url.expanded_url.encode("utf-8")) 136 | url_md5 = hashlib.md5(url_unshortened.encode('utf-8')).hexdigest() 137 | url_sha1 = hashlib.sha1(url_unshortened.encode('utf-8')).hexdigest() 138 | processed_urls.append( { 'url': url.url.encode('utf-8'), 139 | 'url_unshortened': url_unshortened, 140 | 'url_md5': url_md5, 141 | 'url_sha1': url_sha1 }) 142 | except: 143 | continue 144 | return processed_urls 145 | 146 | def unshortenURL(url): 147 | 148 | """ unshortenURL https://github.com/cudeso/expandurl""" 149 | 150 | url_ua = config['urls_ua'] 151 | urls_timeout = config['urls_timeout'] 152 | currenturl = url.strip() 153 | previousurl = None 154 | while currenturl != previousurl: 155 | 156 | try: 157 | httprequest = httplib.urlsplit(currenturl) 158 | scheme = httprequest.scheme.lower() 159 | netloc = httprequest.netloc.lower() 160 | previousurl = currenturl 161 | if scheme == 'http': 162 | conn = httplib.HTTPConnection(netloc, timeout=5) 163 | req = currenturl[7+len(netloc):] 164 | location = "%s://%s" % (scheme, netloc) 165 | elif scheme=='https': 166 | conn = httplib.HTTPSConnection(netloc, timeout=5) 167 | req = currenturl[8+len(netloc):] 168 | location = "%s://%s" % (scheme, netloc) 169 | 170 | conn.request("HEAD", req, None, {'User-Agent': url_ua,'Accept': '*/*',}) 171 | res = conn.getresponse() 172 | 173 | if res.status in [301, 304]: 174 | currenturl = res.getheader('Location') 175 | httprequest_redirect = httplib.urlsplit(currenturl) 176 | 177 | if httprequest_redirect.scheme.lower() != 'http' and httprequest_redirect.scheme.lower() != 'https': 178 | # currenturl does not contain http(s) 179 | currenturl = "%s://%s%s" % (scheme, netloc,currenturl) 180 | except: 181 | currenturl = url 182 | 183 | return currenturl 184 | 185 | def updateTimeline(timeline_id): 186 | 187 | """Get new Tweets from twitter.com""" 188 | 189 | try: 190 | timeline = api.GetHomeTimeline(since_id=timeline_id) 191 | except twitter.error.TwitterError as e: 192 | print "[Error] Twitter returned: %s (%d)" % (e[0][0]['message'], e[0][0]['code']) 193 | return timeline_id 194 | 195 | if not timeline: 196 | return timeline_id 197 | 198 | last_id = timeline_id 199 | for t in reversed(timeline): 200 | text = t.text 201 | for r in config['regex']: 202 | if r: 203 | if re.search('('+r+')', text, re.I): 204 | text = text.replace(r, colored(r, config['highlightColor'])) 205 | 206 | tweet_message = text.encode("utf-8") 207 | if config['urls_process_urls'] == True: 208 | urls = processURL(t.urls) 209 | for url in urls: 210 | tweet_message = tweet_message.replace( url['url'] , url['url_unshortened']) 211 | else: 212 | urls = [] 213 | 214 | print "%s | %15s | %s" % (time2Local(t.created_at).strftime("%H:%M:%S"), 215 | t.user.screen_name.encode("utf-8"), 216 | tweet_message) 217 | 218 | if es: 219 | indexEs(t, urls, tweet_message) 220 | 221 | if logger: 222 | writeCEFEvent(t) 223 | 224 | if (long(t.id) > long(last_id)): 225 | last_id = t.id 226 | return(last_id) 227 | 228 | def updateSearch(search_id): 229 | 230 | """Get new Tweets containing specific keywords""" 231 | 232 | last_id = search_id 233 | for keyword in config['keywords']: 234 | if not keyword: 235 | continue 236 | try: 237 | tweets = api.GetSearch(term=keyword, since_id=search_id) 238 | except twitter.error.TwitterError as e: 239 | print "[Error] Twitter returned: %s (%s)" % (e[0][0]['message'], str(e[0][0]['code'])) 240 | return(search_id) 241 | 242 | if not tweets: 243 | continue 244 | 245 | for t in reversed(tweets): 246 | text = t.text 247 | 248 | # Highlight keyword 249 | if re.search('('+keyword+')', text, re.I): 250 | text = text.replace(keyword, colored(keyword, config['keywordColor'])) 251 | 252 | for r in config['regex']: 253 | if r: 254 | if re.search('('+r+')', text, re.I): 255 | text = text.replace(r, colored(r, config['highlightColor'])) 256 | 257 | tweet_message = text.encode("utf-8") 258 | if config['urls_process_urls'] == True: 259 | urls = processURL(t.urls) 260 | for url in urls: 261 | tweet_message = tweet_message.replace( url['url'] , url['url_unshortened']) 262 | else: 263 | urls = [] 264 | 265 | print "%s | %15s | %s" % (time2Local(t.created_at).strftime("%H:%M:%S"), 266 | t.user.screen_name.encode("utf-8"), 267 | tweet_message) 268 | 269 | if es: 270 | indexEs(t, urls, tweet_message) 271 | 272 | if logger: 273 | writeCEFEvent(t) 274 | 275 | if long(t.id) > long(last_id): 276 | last_id = t.id 277 | print "[DEBUG] last_id = %s" % last_id 278 | return(last_id) 279 | 280 | def main(): 281 | global api 282 | global config 283 | global es 284 | global esIndex 285 | global logger 286 | 287 | signal.signal(signal.SIGINT, sigHandler) 288 | 289 | parser = argparse.ArgumentParser( 290 | description='Display a Tweet feed') 291 | parser.add_argument('-c', '--config', 292 | dest = 'configFile', 293 | help = 'configuration file (default: /etc/tweetsniff.conf)', 294 | metavar = 'CONFIG') 295 | args = parser.parse_args() 296 | 297 | if not args.configFile: 298 | args.configFile = '/etc/tweetsniff.conf' 299 | 300 | try: 301 | c = ConfigParser.ConfigParser() 302 | c.read(args.configFile) 303 | # Twitter config 304 | consumerKey = c.get('twitterapi', 'consumer_key') 305 | consumerSecret = c.get('twitterapi', 'consumer_secret') 306 | accessTokenKey = c.get('twitterapi', 'access_token_key') 307 | accessTokenSecret = c.get('twitterapi', 'access_token_secret') 308 | config['statusFile'] = c.get('twitterapi', 'status_file') 309 | #Highligts 310 | config['highlightColor'] = c.get('highlight', 'color') 311 | highlightRegex = c.get('highlight', 'regex') 312 | # Search 313 | searchKeywords = c.get('search', 'keywords') 314 | config['keywordColor'] = c.get('search', 'color') 315 | # URLs 316 | config['urls_ua'] = c.get('urls', 'ua') 317 | config['urls_timeout'] = c.get('urls', 'timeout') 318 | config['urls_process_urls'] = c.get('urls', 'process_urls') 319 | if config['urls_process_urls'].lower() == 'true': 320 | config['urls_process_urls'] = True 321 | # Elasticsearch config (optional) 322 | config['esServer'] = c.get('elasticsearch', 'server') 323 | esIndex = c.get('elasticsearch', 'index') 324 | # CEF confit 325 | try: 326 | config['cefServer'] = c.get('cef', 'server') 327 | config['cefPort'] = c.get('cef', 'port') 328 | except: 329 | pass 330 | except OSError as e: 331 | writeLog('Cannot read config file %s: %s' % (args.configFile, e.errno())) 332 | exit 333 | 334 | print "DEBUG: %s, %s, %s, %s" % (consumerKey,consumerSecret,accessTokenKey,accessTokenSecret) 335 | print "DEBUG: Regex: %s" % highlightRegex 336 | 337 | if searchKeywords: 338 | config['keywords'] = searchKeywords.split('\n') 339 | print "DEBUG: keywords = %s" % config['keywords'] 340 | 341 | if highlightRegex: 342 | config['regex'] = highlightRegex.split('\n') 343 | 344 | try: 345 | api = twitter.Api(consumer_key = consumerKey, 346 | consumer_secret = consumerSecret, 347 | access_token_key = accessTokenKey, 348 | access_token_secret = accessTokenSecret) 349 | except: 350 | print "[Error] Can't connect to twitter.com" 351 | sys.exit(1) 352 | 353 | if config['esServer']: 354 | try: 355 | es = Elasticsearch( 356 | [config['esServer']] 357 | ) 358 | except: 359 | print "[Warning] Can't connect to %s" % config['esServer'] 360 | 361 | if config['cefServer']: 362 | try: 363 | logger = logging.getLogger('tweetsniff') 364 | logger.setLevel(logging.INFO) 365 | if config['cefPort']: 366 | handler = logging.handlers.SysLogHandler(address=(config['cefServer'], int(config['cefPort']))) 367 | else: 368 | handler = logging.handlers.SysLogHandler(address=(config['cefServer'], 514)) 369 | logger.addHandler(handler) 370 | except: 371 | print "[Warning] Can't configure CEF destination: %s:%s", (config['cefServer'],config['cefPort']) 372 | 373 | if not os.path.isfile(config['statusFile']): 374 | print "DEBUG: Status file not found, starting new feed" 375 | timeline_id = 0 376 | search_id = 0 377 | 378 | else: 379 | fd = open(config['statusFile'], 'r') 380 | data = fd.read().split(',') 381 | timeline_id = data[0] 382 | search_id = data[1] 383 | fd.close() 384 | print "DEBUG: Restarting feed from ID %s/%s" % (timeline_id, search_id) 385 | 386 | while 1: 387 | try: 388 | timeline_id = updateTimeline(timeline_id) 389 | search_id = updateSearch(search_id) 390 | except AttributeError: 391 | print "[Error] Can't connect to twitter.com" 392 | sys.exit(1) 393 | 394 | fd = open(config['statusFile'], 'w') 395 | fd.write("%s,%s" % (str(timeline_id), str(search_id))) 396 | fd.close() 397 | try: 398 | sleep_home = api.GetAverageSleepTime('statuses/home_timeline') 399 | sleep_search = api.GetAverageSleepTime('search/tweets') 400 | except twitter.error.TwitterError as e: 401 | print "[Error] Twitter returned: %s (%s)" % (e[0][0]['message'], str(e[0][0]['code'])) 402 | 403 | print "DEBUG: Sleep = %s / %s" % (sleep_home, sleep_search) 404 | if sleep_search > sleep_home: 405 | time.sleep(sleep_search) 406 | else: 407 | time.sleep(sleep_home) 408 | 409 | if __name__ == '__main__': 410 | main() 411 | --------------------------------------------------------------------------------